diff --git a/docs/google-docs/index.md b/docs/google-docs/index.md index 607561c1dd..67fdeee534 100644 --- a/docs/google-docs/index.md +++ b/docs/google-docs/index.md @@ -21,12 +21,12 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; Cloud services from Google. -:::info Provider Summary (v24.09.00251) +:::info Provider Summary (v24.09.00254)
-total services: 167
-total resources: 1926
+total services: 168
+total resources: 1941
@@ -215,6 +215,7 @@ stackql.exe shell --auth=$Auth networkservices
notebooks
ondemandscanning
+oracledatabase
orgpolicy
osconfig
oslogin
diff --git a/docs/google-docs/providers/google/advisorynotifications/notifications/index.md b/docs/google-docs/providers/google/advisorynotifications/notifications/index.md index aecfcd0731..bcdad6395c 100644 --- a/docs/google-docs/providers/google/advisorynotifications/notifications/index.md +++ b/docs/google-docs/providers/google/advisorynotifications/notifications/index.md @@ -40,8 +40,8 @@ Creates, updates, deletes, gets or lists a notifications resource. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a notification. | -| | `SELECT` | | Lists notifications under a given parent. | +| | `SELECT` | | Gets a notification. | +| | `SELECT` | | Lists notifications under a given parent. | ## `SELECT` examples @@ -56,5 +56,5 @@ notificationType, subject FROM google.advisorynotifications.notifications WHERE locationsId = '{{ locationsId }}' -AND organizationsId = '{{ organizationsId }}'; +AND projectsId = '{{ projectsId }}'; ``` diff --git a/docs/google-docs/providers/google/advisorynotifications/settings/index.md b/docs/google-docs/providers/google/advisorynotifications/settings/index.md index 64b0ba7314..243e0c38c2 100644 --- a/docs/google-docs/providers/google/advisorynotifications/settings/index.md +++ b/docs/google-docs/providers/google/advisorynotifications/settings/index.md @@ -38,8 +38,8 @@ Creates, updates, deletes, gets or lists a settings resource. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Get notification settings. | -| | `UPDATE` | | Update notification settings. | +| | `SELECT` | | Get notification settings. | +| | `UPDATE` | | Update notification settings. | ## `SELECT` examples @@ -52,7 +52,7 @@ etag, notificationSettings FROM google.advisorynotifications.settings WHERE locationsId = '{{ locationsId }}' -AND organizationsId = '{{ organizationsId }}'; +AND projectsId = '{{ projectsId }}'; ``` ## `UPDATE` example @@ -64,9 +64,9 @@ Updates a settings resource. UPDATE google.advisorynotifications.settings SET etag = '{{ etag }}', -name = '{{ name }}', -notificationSettings = '{{ notificationSettings }}' +notificationSettings = '{{ notificationSettings }}', +name = '{{ name }}' WHERE locationsId = '{{ locationsId }}' -AND organizationsId = '{{ organizationsId }}'; +AND projectsId = '{{ projectsId }}'; ``` diff --git a/docs/google-docs/providers/google/aiplatform/artifacts/index.md b/docs/google-docs/providers/google/aiplatform/artifacts/index.md index 7ba6e20890..f62878b293 100644 --- a/docs/google-docs/providers/google/aiplatform/artifacts/index.md +++ b/docs/google-docs/providers/google/aiplatform/artifacts/index.md @@ -98,47 +98,47 @@ INSERT INTO google.aiplatform.artifacts ( locationsId, metadataStoresId, projectsId, -etag, -schemaTitle, -metadata, +uri, labels, +metadata, schemaVersion, -state, +schemaTitle, displayName, -description, -uri +state, +etag, +description ) SELECT '{{ locationsId }}', '{{ metadataStoresId }}', '{{ projectsId }}', -'{{ etag }}', -'{{ schemaTitle }}', -'{{ metadata }}', +'{{ uri }}', '{{ labels }}', +'{{ metadata }}', '{{ schemaVersion }}', -'{{ state }}', +'{{ schemaTitle }}', '{{ displayName }}', -'{{ description }}', -'{{ uri }}' +'{{ state }}', +'{{ etag }}', +'{{ description }}' ; ``` ```yaml -etag: string -schemaTitle: string -name: string -metadata: object -updateTime: string +createTime: string +uri: string labels: object +metadata: object schemaVersion: string -state: string +schemaTitle: string displayName: string +state: string +name: string +updateTime: string +etag: string description: string -uri: string -createTime: string ``` @@ -152,15 +152,15 @@ Updates a artifacts resource. /*+ update */ UPDATE google.aiplatform.artifacts SET -etag = '{{ etag }}', -schemaTitle = '{{ schemaTitle }}', -metadata = '{{ metadata }}', +uri = '{{ uri }}', labels = '{{ labels }}', +metadata = '{{ metadata }}', schemaVersion = '{{ schemaVersion }}', -state = '{{ state }}', +schemaTitle = '{{ schemaTitle }}', displayName = '{{ displayName }}', -description = '{{ description }}', -uri = '{{ uri }}' +state = '{{ state }}', +etag = '{{ etag }}', +description = '{{ description }}' WHERE artifactsId = '{{ artifactsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/batch_prediction_jobs/index.md b/docs/google-docs/providers/google/aiplatform/batch_prediction_jobs/index.md index 9a674aa4d1..946d9b7417 100644 --- a/docs/google-docs/providers/google/aiplatform/batch_prediction_jobs/index.md +++ b/docs/google-docs/providers/google/aiplatform/batch_prediction_jobs/index.md @@ -128,184 +128,184 @@ Use the following StackQL query and manifest file to create a new batch_pr INSERT INTO google.aiplatform.batch_prediction_jobs ( locationsId, projectsId, -disableContainerLogging, -displayName, labels, generateExplanation, -explanationSpec, -serviceAccount, -manualBatchTuningParameters, dedicatedResources, -model, -unmanagedContainerModel, +explanationSpec, +inputConfig, instanceConfig, outputConfig, -inputConfig, +encryptionSpec, +disableContainerLogging, +displayName, modelParameters, -encryptionSpec +serviceAccount, +manualBatchTuningParameters, +unmanagedContainerModel, +model ) SELECT '{{ locationsId }}', '{{ projectsId }}', -true|false, -'{{ displayName }}', '{{ labels }}', true|false, -'{{ explanationSpec }}', -'{{ serviceAccount }}', -'{{ manualBatchTuningParameters }}', '{{ dedicatedResources }}', -'{{ model }}', -'{{ unmanagedContainerModel }}', +'{{ explanationSpec }}', +'{{ inputConfig }}', '{{ instanceConfig }}', '{{ outputConfig }}', -'{{ inputConfig }}', +'{{ encryptionSpec }}', +true|false, +'{{ displayName }}', '{{ modelParameters }}', -'{{ encryptionSpec }}' +'{{ serviceAccount }}', +'{{ manualBatchTuningParameters }}', +'{{ unmanagedContainerModel }}', +'{{ model }}' ; ``` ```yaml +labels: object +generateExplanation: boolean +updateTime: string +state: string +startTime: string +dedicatedResources: + startingReplicaCount: integer + maxReplicaCount: integer + machineSpec: + acceleratorCount: integer + tpuTopology: string + machineType: string + acceleratorType: string + reservationAffinity: + reservationAffinityType: string + values: + - type: string + key: string +satisfiesPzi: boolean +resourcesConsumed: + replicaHours: number createTime: string -disableContainerLogging: boolean completionStats: successfulForecastPointCount: string failedCount: string successfulCount: string incompleteCount: string -displayName: string -satisfiesPzs: boolean -labels: object -error: - message: string - code: integer - details: - - additionalProperties: any - type: string -generateExplanation: boolean explanationSpec: metadata: - outputs: object + latentSpaceSource: string featureAttributionsSchemaUri: string + outputs: object inputs: object - latentSpaceSource: string parameters: + integratedGradientsAttribution: + blurBaselineConfig: + maxBlurSigma: number + smoothGradConfig: + featureNoiseSigma: + noiseSigma: + - name: string + sigma: number + noisySampleCount: integer + noiseSigma: number + stepCount: integer topK: integer + outputIndices: + - type: string + sampledShapleyAttribution: + pathCount: integer + xraiAttribution: + stepCount: integer examples: nearestNeighborSearchConfig: any neighborCount: integer exampleGcsSource: - dataFormat: string gcsSource: uris: - type: string + dataFormat: string presets: modality: string query: string - sampledShapleyAttribution: - pathCount: integer - xraiAttribution: - smoothGradConfig: - featureNoiseSigma: - noiseSigma: - - sigma: number - name: string - noisySampleCount: integer - noiseSigma: number - stepCount: integer - blurBaselineConfig: - maxBlurSigma: number - outputIndices: - - type: string - integratedGradientsAttribution: - stepCount: integer -serviceAccount: string -manualBatchTuningParameters: - batchSize: integer -dedicatedResources: - maxReplicaCount: integer - machineSpec: - acceleratorCount: integer - reservationAffinity: - key: string - reservationAffinityType: string - values: - - type: string - tpuTopology: string - acceleratorType: string - machineType: string - startingReplicaCount: integer -resourcesConsumed: - replicaHours: number -name: string -model: string -endTime: string -unmanagedContainerModel: - predictSchemata: - predictionSchemaUri: string - instanceSchemaUri: string - parametersSchemaUri: string - containerSpec: - startupProbe: - timeoutSeconds: integer - periodSeconds: integer - exec: - command: - - type: string - imageUri: string - grpcPorts: - - containerPort: integer - command: - - type: string - sharedMemorySizeMb: string - deploymentTimeout: string - healthRoute: string - predictRoute: string - args: - - type: string - env: - - value: string - name: string - ports: - - containerPort: integer - artifactUri: string -updateTime: string +error: + code: integer + message: string + details: + - additionalProperties: any + type: string +inputConfig: + instancesFormat: string + bigquerySource: + inputUri: string instanceConfig: - keyField: string - instanceType: string excludedFields: - type: string + instanceType: string includedFields: - type: string + keyField: string outputConfig: bigqueryDestination: outputUri: string predictionsFormat: string gcsDestination: outputUriPrefix: string -outputInfo: - bigqueryOutputDataset: string - bigqueryOutputTable: string - gcsOutputDirectory: string -inputConfig: - bigquerySource: - inputUri: string - instancesFormat: string -modelVersionId: string -state: string -satisfiesPzi: boolean +encryptionSpec: + kmsKeyName: string +endTime: string +disableContainerLogging: boolean +displayName: string +modelParameters: any +serviceAccount: string partialFailures: - - message: string - code: integer + - code: integer + message: string details: - additionalProperties: any type: string -modelParameters: any -encryptionSpec: - kmsKeyName: string -startTime: string +manualBatchTuningParameters: + batchSize: integer +outputInfo: + bigqueryOutputTable: string + bigqueryOutputDataset: string + gcsOutputDirectory: string +name: string +unmanagedContainerModel: + artifactUri: string + containerSpec: + imageUri: string + healthRoute: string + env: + - value: string + name: string + ports: + - containerPort: integer + args: + - type: string + command: + - type: string + deploymentTimeout: string + startupProbe: + exec: + command: + - type: string + timeoutSeconds: integer + periodSeconds: integer + grpcPorts: + - containerPort: integer + sharedMemorySizeMb: string + predictRoute: string + predictSchemata: + instanceSchemaUri: string + predictionSchemaUri: string + parametersSchemaUri: string +model: string +satisfiesPzs: boolean +modelVersionId: string ``` diff --git a/docs/google-docs/providers/google/aiplatform/contexts/index.md b/docs/google-docs/providers/google/aiplatform/contexts/index.md index 5567a73497..f499711cc8 100644 --- a/docs/google-docs/providers/google/aiplatform/contexts/index.md +++ b/docs/google-docs/providers/google/aiplatform/contexts/index.md @@ -96,45 +96,45 @@ INSERT INTO google.aiplatform.contexts ( locationsId, metadataStoresId, projectsId, +schemaVersion, +etag, +schemaTitle, description, -displayName, -labels, name, -schemaTitle, -metadata, -etag, -schemaVersion +labels, +displayName, +metadata ) SELECT '{{ locationsId }}', '{{ metadataStoresId }}', '{{ projectsId }}', +'{{ schemaVersion }}', +'{{ etag }}', +'{{ schemaTitle }}', '{{ description }}', -'{{ displayName }}', -'{{ labels }}', '{{ name }}', -'{{ schemaTitle }}', -'{{ metadata }}', -'{{ etag }}', -'{{ schemaVersion }}' +'{{ labels }}', +'{{ displayName }}', +'{{ metadata }}' ; ``` ```yaml -description: string -updateTime: string -displayName: string parentContexts: - type: string -createTime: string -labels: object -name: string +schemaVersion: string +etag: string schemaTitle: string +description: string +updateTime: string +name: string +labels: object +displayName: string metadata: object -etag: string -schemaVersion: string +createTime: string ``` @@ -148,14 +148,14 @@ Updates a contexts resource. /*+ update */ UPDATE google.aiplatform.contexts SET +schemaVersion = '{{ schemaVersion }}', +etag = '{{ etag }}', +schemaTitle = '{{ schemaTitle }}', description = '{{ description }}', -displayName = '{{ displayName }}', -labels = '{{ labels }}', name = '{{ name }}', -schemaTitle = '{{ schemaTitle }}', -metadata = '{{ metadata }}', -etag = '{{ etag }}', -schemaVersion = '{{ schemaVersion }}' +labels = '{{ labels }}', +displayName = '{{ displayName }}', +metadata = '{{ metadata }}' WHERE contextsId = '{{ contextsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/custom_jobs/index.md b/docs/google-docs/providers/google/aiplatform/custom_jobs/index.md index a941214e13..202b1854f8 100644 --- a/docs/google-docs/providers/google/aiplatform/custom_jobs/index.md +++ b/docs/google-docs/providers/google/aiplatform/custom_jobs/index.md @@ -99,60 +99,74 @@ INSERT INTO google.aiplatform.custom_jobs ( locationsId, projectsId, displayName, -encryptionSpec, labels, -jobSpec +jobSpec, +encryptionSpec ) SELECT '{{ locationsId }}', '{{ projectsId }}', '{{ displayName }}', -'{{ encryptionSpec }}', '{{ labels }}', -'{{ jobSpec }}' +'{{ jobSpec }}', +'{{ encryptionSpec }}' ; ``` ```yaml -satisfiesPzs: boolean -displayName: string -encryptionSpec: - kmsKeyName: string -webAccessUris: object -updateTime: string -state: string +startTime: string error: - message: string code: integer + message: string details: - additionalProperties: any type: string -satisfiesPzi: boolean +satisfiesPzs: boolean +endTime: string createTime: string -labels: object name: string +satisfiesPzi: boolean +displayName: string +labels: object jobSpec: + scheduling: + restartJobOnWorkerRestart: boolean + timeout: string + strategy: string + disableRetries: boolean + maxWaitDuration: string + persistentResourceId: string + baseOutputDirectory: + outputUriPrefix: string + experimentRun: string + protectedArtifactLocationId: string + serviceAccount: string workerPoolSpecs: - - machineSpec: + - pythonPackageSpec: + args: + - type: string + env: + - value: string + name: string + pythonModule: string + executorImageUri: string + packageUris: + - type: string + diskSpec: + bootDiskType: string + bootDiskSizeGb: integer + machineSpec: acceleratorCount: integer + tpuTopology: string + machineType: string + acceleratorType: string reservationAffinity: - key: string reservationAffinityType: string values: - type: string - tpuTopology: string - acceleratorType: string - machineType: string - nfsMounts: - - path: string - mountPoint: string - server: string - diskSpec: - bootDiskType: string - bootDiskSizeGb: integer - replicaCount: string + key: string containerSpec: command: - type: string @@ -162,39 +176,25 @@ jobSpec: env: - value: string name: string - pythonPackageSpec: - args: - - type: string - pythonModule: string - env: - - value: string - name: string - executorImageUri: string - packageUris: - - type: string - tensorboard: string - experimentRun: string - reservedIpRanges: - - type: string - scheduling: - timeout: string - disableRetries: boolean - strategy: string - restartJobOnWorkerRestart: boolean - maxWaitDuration: string - protectedArtifactLocationId: string - serviceAccount: string - baseOutputDirectory: - outputUriPrefix: string + nfsMounts: + - mountPoint: string + path: string + server: string + replicaCount: string + enableDashboardAccess: boolean + network: string enableWebAccess: boolean experiment: string + reservedIpRanges: + - type: string + tensorboard: string models: - type: string - persistentResourceId: string - network: string - enableDashboardAccess: boolean -endTime: string -startTime: string +encryptionSpec: + kmsKeyName: string +updateTime: string +state: string +webAccessUris: object ``` diff --git a/docs/google-docs/providers/google/aiplatform/data_labeling_jobs/index.md b/docs/google-docs/providers/google/aiplatform/data_labeling_jobs/index.md index 42213966a4..e6fe812043 100644 --- a/docs/google-docs/providers/google/aiplatform/data_labeling_jobs/index.md +++ b/docs/google-docs/providers/google/aiplatform/data_labeling_jobs/index.md @@ -106,31 +106,31 @@ Use the following StackQL query and manifest file to create a new data_lab INSERT INTO google.aiplatform.data_labeling_jobs ( locationsId, projectsId, -displayName, -encryptionSpec, +datasets, labelerCount, -annotationLabels, +instructionUri, +activeLearningConfig, inputsSchemaUri, inputs, -datasets, +encryptionSpec, +annotationLabels, +displayName, labels, -activeLearningConfig, -instructionUri, specialistPools ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ displayName }}', -'{{ encryptionSpec }}', +'{{ datasets }}', '{{ labelerCount }}', -'{{ annotationLabels }}', +'{{ instructionUri }}', +'{{ activeLearningConfig }}', '{{ inputsSchemaUri }}', '{{ inputs }}', -'{{ datasets }}', +'{{ encryptionSpec }}', +'{{ annotationLabels }}', +'{{ displayName }}', '{{ labels }}', -'{{ activeLearningConfig }}', -'{{ instructionUri }}', '{{ specialistPools }}' ; ``` @@ -138,43 +138,43 @@ SELECT ```yaml -createTime: string -displayName: string -encryptionSpec: - kmsKeyName: string -labelerCount: integer -annotationLabels: object -updateTime: string -inputsSchemaUri: string -inputs: any datasets: - type: string -labels: object -name: string -state: string -currentSpend: - units: string - nanos: integer - currencyCode: string +labelerCount: integer +instructionUri: string activeLearningConfig: + maxDataItemPercentage: integer + trainingConfig: + timeoutTrainingMilliHours: string + maxDataItemCount: string sampleConfig: sampleStrategy: string followingBatchSamplePercentage: integer initialBatchSamplePercentage: integer - maxDataItemCount: string - trainingConfig: - timeoutTrainingMilliHours: string - maxDataItemPercentage: integer -labelingProgress: integer -instructionUri: string +inputsSchemaUri: string +inputs: any +encryptionSpec: + kmsKeyName: string +annotationLabels: object +name: string +currentSpend: + currencyCode: string + units: string + nanos: integer +displayName: string +updateTime: string +state: string +labels: object +createTime: string specialistPools: - type: string error: - message: string code: integer + message: string details: - additionalProperties: any type: string +labelingProgress: integer ``` diff --git a/docs/google-docs/providers/google/aiplatform/dataset_versions/index.md b/docs/google-docs/providers/google/aiplatform/dataset_versions/index.md index 27004cad06..915459a84b 100644 --- a/docs/google-docs/providers/google/aiplatform/dataset_versions/index.md +++ b/docs/google-docs/providers/google/aiplatform/dataset_versions/index.md @@ -45,12 +45,12 @@ Creates, updates, deletes, gets or lists a dataset_versions resourc ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a Dataset version. | -| | `SELECT` | | Lists DatasetVersions in a Dataset. | -| | `INSERT` | | Create a version from a Dataset. | -| | `DELETE` | | Deletes a Dataset version. | -| | `UPDATE` | | Updates a DatasetVersion. | -| | `EXEC` | | Restores a dataset version. | +| | `SELECT` | | Gets a Dataset version. | +| | `SELECT` | | Lists DatasetVersions in a Dataset. | +| | `INSERT` | | Create a version from a Dataset. | +| | `DELETE` | | Deletes a Dataset version. | +| | `UPDATE` | | Updates a DatasetVersion. | +| | `EXEC` | | Restores a dataset version. | ## `SELECT` examples @@ -69,7 +69,9 @@ satisfiesPzi, satisfiesPzs, updateTime FROM google.aiplatform.dataset_versions -WHERE datasetsId = '{{ datasetsId }}'; +WHERE datasetsId = '{{ datasetsId }}' +AND locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; ``` ## `INSERT` example @@ -89,11 +91,15 @@ Use the following StackQL query and manifest file to create a new dataset_ /*+ create */ INSERT INTO google.aiplatform.dataset_versions ( datasetsId, +locationsId, +projectsId, etag, displayName ) SELECT '{{ datasetsId }}', +'{{ locationsId }}', +'{{ projectsId }}', '{{ etag }}', '{{ displayName }}' ; @@ -102,16 +108,16 @@ SELECT ```yaml +satisfiesPzs: boolean etag: string -satisfiesPzi: boolean -createTime: string -updateTime: string -bigQueryDatasetName: string modelReference: string -name: string metadata: any +updateTime: string +bigQueryDatasetName: string displayName: string -satisfiesPzs: boolean +satisfiesPzi: boolean +name: string +createTime: string ``` @@ -129,7 +135,9 @@ etag = '{{ etag }}', displayName = '{{ displayName }}' WHERE datasetVersionsId = '{{ datasetVersionsId }}' -AND datasetsId = '{{ datasetsId }}'; +AND datasetsId = '{{ datasetsId }}' +AND locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; ``` ## `DELETE` example @@ -140,5 +148,7 @@ Deletes the specified dataset_versions resource. /*+ delete */ DELETE FROM google.aiplatform.dataset_versions WHERE datasetVersionsId = '{{ datasetVersionsId }}' -AND datasetsId = '{{ datasetsId }}'; +AND datasetsId = '{{ datasetsId }}' +AND locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; ``` diff --git a/docs/google-docs/providers/google/aiplatform/datasets/index.md b/docs/google-docs/providers/google/aiplatform/datasets/index.md index d5abf85b59..daf720589a 100644 --- a/docs/google-docs/providers/google/aiplatform/datasets/index.md +++ b/docs/google-docs/providers/google/aiplatform/datasets/index.md @@ -51,11 +51,11 @@ Creates, updates, deletes, gets or lists a datasets resource. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a Dataset. | -| | `SELECT` | | Lists Datasets in a Location. | -| | `INSERT` | | Creates a Dataset. | -| | `DELETE` | | Deletes a Dataset. | -| | `UPDATE` | | Updates a Dataset. | +| | `SELECT` | | Gets a Dataset. | +| | `SELECT` | | Lists Datasets in a Location. | +| | `INSERT` | | Creates a Dataset. | +| | `DELETE` | | Deletes a Dataset. | +| | `UPDATE` | | Updates a Dataset. | | | `EXEC` | | Exports data from a Dataset. | | | `EXEC` | | Imports data into a Dataset. | | | `EXEC` | | Searches DataItems in a Dataset. | @@ -83,7 +83,8 @@ satisfiesPzs, savedQueries, updateTime FROM google.aiplatform.datasets -WHERE = '{{ }}'; +WHERE locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; ``` ## `INSERT` example @@ -102,61 +103,63 @@ Use the following StackQL query and manifest file to create a new datasets ```sql /*+ create */ INSERT INTO google.aiplatform.datasets ( -, +locationsId, +projectsId, +displayName, metadataSchemaUri, +encryptionSpec, description, metadata, -etag, -displayName, -labels, modelReference, -encryptionSpec, -savedQueries +savedQueries, +labels, +etag ) SELECT -'{{ }}', +'{{ locationsId }}', +'{{ projectsId }}', +'{{ displayName }}', '{{ metadataSchemaUri }}', +'{{ encryptionSpec }}', '{{ description }}', '{{ metadata }}', -'{{ etag }}', -'{{ displayName }}', -'{{ labels }}', '{{ modelReference }}', -'{{ encryptionSpec }}', -'{{ savedQueries }}' +'{{ savedQueries }}', +'{{ labels }}', +'{{ etag }}' ; ``` ```yaml -metadataSchemaUri: string +dataItemCount: string +displayName: string updateTime: string -satisfiesPzi: boolean -metadataArtifact: string +metadataSchemaUri: string +encryptionSpec: + kmsKeyName: string description: string -createTime: string -satisfiesPzs: boolean -metadata: any -etag: string -displayName: string -dataItemCount: string name: string -labels: object +metadata: any modelReference: string -encryptionSpec: - kmsKeyName: string savedQueries: - - annotationFilter: string + - createTime: string + etag: string metadata: any - annotationSpecCount: integer - createTime: string - displayName: string problemType: string + displayName: string + name: string supportAutomlTraining: boolean + annotationFilter: string + annotationSpecCount: integer updateTime: string - name: string - etag: string +labels: object +createTime: string +satisfiesPzi: boolean +etag: string +metadataArtifact: string +satisfiesPzs: boolean ``` @@ -170,17 +173,19 @@ Updates a datasets resource. /*+ update */ UPDATE google.aiplatform.datasets SET +displayName = '{{ displayName }}', metadataSchemaUri = '{{ metadataSchemaUri }}', +encryptionSpec = '{{ encryptionSpec }}', description = '{{ description }}', metadata = '{{ metadata }}', -etag = '{{ etag }}', -displayName = '{{ displayName }}', -labels = '{{ labels }}', modelReference = '{{ modelReference }}', -encryptionSpec = '{{ encryptionSpec }}', -savedQueries = '{{ savedQueries }}' +savedQueries = '{{ savedQueries }}', +labels = '{{ labels }}', +etag = '{{ etag }}' WHERE -datasetsId = '{{ datasetsId }}'; +datasetsId = '{{ datasetsId }}' +AND locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; ``` ## `DELETE` example @@ -190,5 +195,7 @@ Deletes the specified datasets resource. ```sql /*+ delete */ DELETE FROM google.aiplatform.datasets -WHERE datasetsId = '{{ datasetsId }}'; +WHERE datasetsId = '{{ datasetsId }}' +AND locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; ``` diff --git a/docs/google-docs/providers/google/aiplatform/deployment_resource_pools/index.md b/docs/google-docs/providers/google/aiplatform/deployment_resource_pools/index.md index 29812888cb..fc1fb38d37 100644 --- a/docs/google-docs/providers/google/aiplatform/deployment_resource_pools/index.md +++ b/docs/google-docs/providers/google/aiplatform/deployment_resource_pools/index.md @@ -87,47 +87,47 @@ Use the following StackQL query and manifest file to create a new deployme INSERT INTO google.aiplatform.deployment_resource_pools ( locationsId, projectsId, -deploymentResourcePoolId, -deploymentResourcePool +deploymentResourcePool, +deploymentResourcePoolId ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ deploymentResourcePoolId }}', -'{{ deploymentResourcePool }}' +'{{ deploymentResourcePool }}', +'{{ deploymentResourcePoolId }}' ; ``` ```yaml -deploymentResourcePoolId: string deploymentResourcePool: + satisfiesPzi: boolean + satisfiesPzs: boolean + name: string serviceAccount: string + disableContainerLogging: boolean + encryptionSpec: + kmsKeyName: string dedicatedResources: - spot: boolean machineSpec: acceleratorCount: integer + tpuTopology: string + machineType: string + acceleratorType: string reservationAffinity: - key: string reservationAffinityType: string values: - type: string - tpuTopology: string - acceleratorType: string - machineType: string + key: string autoscalingMetricSpecs: - - metricName: string - target: integer - minReplicaCount: integer + - target: integer + metricName: string maxReplicaCount: integer - disableContainerLogging: boolean - encryptionSpec: - kmsKeyName: string + minReplicaCount: integer + spot: boolean createTime: string - satisfiesPzs: boolean - satisfiesPzi: boolean - name: string +deploymentResourcePoolId: string ``` @@ -141,11 +141,11 @@ Updates a deployment_resource_pools resource. /*+ update */ UPDATE google.aiplatform.deployment_resource_pools SET +name = '{{ name }}', serviceAccount = '{{ serviceAccount }}', -dedicatedResources = '{{ dedicatedResources }}', disableContainerLogging = true|false, encryptionSpec = '{{ encryptionSpec }}', -name = '{{ name }}' +dedicatedResources = '{{ dedicatedResources }}' WHERE deploymentResourcePoolsId = '{{ deploymentResourcePoolsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/endpoints/index.md b/docs/google-docs/providers/google/aiplatform/endpoints/index.md index 4cbfc1e786..872db63c7c 100644 --- a/docs/google-docs/providers/google/aiplatform/endpoints/index.md +++ b/docs/google-docs/providers/google/aiplatform/endpoints/index.md @@ -59,18 +59,18 @@ Creates, updates, deletes, gets or lists a endpoints resource. | | `INSERT` | | Creates an Endpoint. | | | `DELETE` | | Deletes an Endpoint. | | | `UPDATE` | | Updates an Endpoint. | -| | `EXEC` | | Return a list of tokens based on the input text. | -| | `EXEC` | | Perform a token counting. | +| | `EXEC` | | Return a list of tokens based on the input text. | +| | `EXEC` | | Perform a token counting. | | | `EXEC` | | Deploys a Model into this Endpoint, creating a DeployedModel within it. | | | `EXEC` | | Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks. | | | `EXEC` | | Perform an unary online prediction request to a gRPC model server for custom containers. | | | `EXEC` | | 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. | -| | `EXEC` | | Generate content with multimodal inputs. | +| | `EXEC` | | Generate content with multimodal inputs. | | | `EXEC` | | 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). | | | `EXEC` | | Perform an online prediction. | | | `EXEC` | | 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. | | | `EXEC` | | Perform a server-side streaming online prediction request for Vertex LLM streaming. | -| | `EXEC` | | Generate content with multimodal inputs with streaming support. | +| | `EXEC` | | Generate content with multimodal inputs with streaming support. | | | `EXEC` | | Perform a streaming online prediction with an arbitrary HTTP payload. | | | `EXEC` | | Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using. | @@ -122,137 +122,137 @@ Use the following StackQL query and manifest file to create a new endpoint INSERT INTO google.aiplatform.endpoints ( locationsId, projectsId, -displayName, -trafficSplit, -predictRequestResponseLoggingConfig, -privateServiceConnectConfig, -encryptionSpec, etag, enablePrivateServiceConnect, -labels, +encryptionSpec, network, +privateServiceConnectConfig, +displayName, description, -dedicatedEndpointEnabled +dedicatedEndpointEnabled, +trafficSplit, +predictRequestResponseLoggingConfig, +labels ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ displayName }}', -'{{ trafficSplit }}', -'{{ predictRequestResponseLoggingConfig }}', -'{{ privateServiceConnectConfig }}', -'{{ encryptionSpec }}', '{{ etag }}', true|false, -'{{ labels }}', +'{{ encryptionSpec }}', '{{ network }}', +'{{ privateServiceConnectConfig }}', +'{{ displayName }}', '{{ description }}', -true|false +true|false, +'{{ trafficSplit }}', +'{{ predictRequestResponseLoggingConfig }}', +'{{ labels }}' ; ``` ```yaml -dedicatedEndpointDns: string -displayName: string -trafficSplit: object -predictRequestResponseLoggingConfig: - samplingRate: number - enabled: boolean - bigqueryDestination: - outputUri: string -updateTime: string +etag: string +enablePrivateServiceConnect: boolean +encryptionSpec: + kmsKeyName: string +satisfiesPzi: boolean +satisfiesPzs: boolean +network: string privateServiceConnectConfig: serviceAttachment: string - enablePrivateServiceConnect: boolean projectAllowlist: - type: string -encryptionSpec: - kmsKeyName: string -etag: string -name: string -enablePrivateServiceConnect: boolean + enablePrivateServiceConnect: boolean +displayName: string +dedicatedEndpointDns: string +updateTime: string +description: string +dedicatedEndpointEnabled: boolean +createTime: string modelDeploymentMonitoringJob: string -labels: object +name: string +trafficSplit: object deployedModels: - - createTime: string - disableExplanations: boolean - displayName: string + - displayName: string + modelVersionId: string model: string - dedicatedResources: - spot: boolean - machineSpec: - acceleratorCount: integer - reservationAffinity: - key: string - reservationAffinityType: string - values: - - type: string - tpuTopology: string - acceleratorType: string - machineType: string - autoscalingMetricSpecs: - - metricName: string - target: integer - minReplicaCount: integer - maxReplicaCount: integer + createTime: string + disableExplanations: boolean + privateEndpoints: + serviceAttachment: string + predictHttpUri: string + healthHttpUri: string + explainHttpUri: string + disableContainerLogging: boolean explanationSpec: metadata: - outputs: object + latentSpaceSource: string featureAttributionsSchemaUri: string + outputs: object inputs: object - latentSpaceSource: string parameters: + integratedGradientsAttribution: + blurBaselineConfig: + maxBlurSigma: number + smoothGradConfig: + featureNoiseSigma: + noiseSigma: + - name: string + sigma: number + noisySampleCount: integer + noiseSigma: number + stepCount: integer topK: integer + outputIndices: + - type: string + sampledShapleyAttribution: + pathCount: integer + xraiAttribution: + stepCount: integer examples: nearestNeighborSearchConfig: any neighborCount: integer exampleGcsSource: - dataFormat: string gcsSource: uris: - type: string + dataFormat: string presets: modality: string query: string - sampledShapleyAttribution: - pathCount: integer - xraiAttribution: - smoothGradConfig: - featureNoiseSigma: - noiseSigma: - - sigma: number - name: string - noisySampleCount: integer - noiseSigma: number - stepCount: integer - blurBaselineConfig: - maxBlurSigma: number - outputIndices: - - type: string - integratedGradientsAttribution: - stepCount: integer - id: string + automaticResources: + minReplicaCount: integer + maxReplicaCount: integer enableAccessLogging: boolean sharedResources: string serviceAccount: string - modelVersionId: string - privateEndpoints: - serviceAttachment: string - explainHttpUri: string - predictHttpUri: string - healthHttpUri: string - automaticResources: - minReplicaCount: integer + id: string + dedicatedResources: + machineSpec: + acceleratorCount: integer + tpuTopology: string + machineType: string + acceleratorType: string + reservationAffinity: + reservationAffinityType: string + values: + - type: string + key: string + autoscalingMetricSpecs: + - target: integer + metricName: string maxReplicaCount: integer - disableContainerLogging: boolean -satisfiesPzs: boolean -network: string -satisfiesPzi: boolean -description: string -createTime: string -dedicatedEndpointEnabled: boolean + minReplicaCount: integer + spot: boolean +predictRequestResponseLoggingConfig: + samplingRate: number + enabled: boolean + bigqueryDestination: + outputUri: string +labels: object ``` @@ -266,17 +266,17 @@ Updates a endpoints resource. /*+ update */ UPDATE google.aiplatform.endpoints SET -displayName = '{{ displayName }}', -trafficSplit = '{{ trafficSplit }}', -predictRequestResponseLoggingConfig = '{{ predictRequestResponseLoggingConfig }}', -privateServiceConnectConfig = '{{ privateServiceConnectConfig }}', -encryptionSpec = '{{ encryptionSpec }}', etag = '{{ etag }}', enablePrivateServiceConnect = true|false, -labels = '{{ labels }}', +encryptionSpec = '{{ encryptionSpec }}', network = '{{ network }}', +privateServiceConnectConfig = '{{ privateServiceConnectConfig }}', +displayName = '{{ displayName }}', description = '{{ description }}', -dedicatedEndpointEnabled = true|false +dedicatedEndpointEnabled = true|false, +trafficSplit = '{{ trafficSplit }}', +predictRequestResponseLoggingConfig = '{{ predictRequestResponseLoggingConfig }}', +labels = '{{ labels }}' WHERE endpointsId = '{{ endpointsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/entity_types/index.md b/docs/google-docs/providers/google/aiplatform/entity_types/index.md index 12f6f9d83a..abd11748ac 100644 --- a/docs/google-docs/providers/google/aiplatform/entity_types/index.md +++ b/docs/google-docs/providers/google/aiplatform/entity_types/index.md @@ -97,48 +97,48 @@ INSERT INTO google.aiplatform.entity_types ( featurestoresId, locationsId, projectsId, -etag, name, +etag, offlineStorageTtlDays, +labels, description, -monitoringConfig, -labels +monitoringConfig ) SELECT '{{ featurestoresId }}', '{{ locationsId }}', '{{ projectsId }}', -'{{ etag }}', '{{ name }}', +'{{ etag }}', '{{ offlineStorageTtlDays }}', +'{{ labels }}', '{{ description }}', -'{{ monitoringConfig }}', -'{{ labels }}' +'{{ monitoringConfig }}' ; ``` ```yaml -etag: string -createTime: string name: string -satisfiesPzi: boolean updateTime: string +etag: string offlineStorageTtlDays: integer -description: string +labels: object satisfiesPzs: boolean +createTime: string +satisfiesPzi: boolean +description: string monitoringConfig: + numericalThresholdConfig: + value: number snapshotAnalysis: - stalenessDays: integer disabled: boolean monitoringIntervalDays: integer - categoricalThresholdConfig: - value: number + stalenessDays: integer importFeaturesAnalysis: anomalyDetectionBaseline: string state: string -labels: object ``` @@ -152,12 +152,12 @@ Updates a entity_types resource. /*+ update */ UPDATE google.aiplatform.entity_types SET -etag = '{{ etag }}', name = '{{ name }}', +etag = '{{ etag }}', offlineStorageTtlDays = '{{ offlineStorageTtlDays }}', +labels = '{{ labels }}', description = '{{ description }}', -monitoringConfig = '{{ monitoringConfig }}', -labels = '{{ labels }}' +monitoringConfig = '{{ monitoringConfig }}' WHERE entityTypesId = '{{ entityTypesId }}' AND featurestoresId = '{{ featurestoresId }}' diff --git a/docs/google-docs/providers/google/aiplatform/executions/index.md b/docs/google-docs/providers/google/aiplatform/executions/index.md index 1e68452cab..33ef3256fd 100644 --- a/docs/google-docs/providers/google/aiplatform/executions/index.md +++ b/docs/google-docs/providers/google/aiplatform/executions/index.md @@ -31,9 +31,17 @@ Creates, updates, deletes, gets or lists a executions resource. ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `array` | The Artifact nodes in the subgraph. | -| | `array` | The Event edges between Artifacts and Executions in the subgraph. | -| | `array` | The Execution nodes in the subgraph. | +| | `string` | Output only. The resource name of the Execution. | +| | `string` | Description of the Execution | +| | `string` | Output only. Timestamp when this Execution was created. | +| | `string` | User provided display name of the Execution. May be up to 128 Unicode characters. | +| | `string` | An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| | `object` | 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). | +| | `object` | Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB. | +| | `string` | 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. | +| | `string` | 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. | +| | `string` | 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. | +| | `string` | Output only. Timestamp when this Execution was last updated. | ## Methods | Name | Accessible by | Required Params | Description | @@ -52,9 +60,17 @@ Lists Executions in the MetadataStore. ```sql SELECT -artifacts, -events, -executions +name, +description, +createTime, +displayName, +etag, +labels, +metadata, +schemaTitle, +schemaVersion, +state, +updateTime FROM google.aiplatform.executions WHERE locationsId = '{{ locationsId }}' AND metadataStoresId = '{{ metadataStoresId }}' @@ -80,44 +96,44 @@ INSERT INTO google.aiplatform.executions ( locationsId, metadataStoresId, projectsId, -description, -state, +schemaVersion, +metadata, labels, displayName, -schemaVersion, +description, +state, schemaTitle, -etag, -metadata +etag ) SELECT '{{ locationsId }}', '{{ metadataStoresId }}', '{{ projectsId }}', -'{{ description }}', -'{{ state }}', +'{{ schemaVersion }}', +'{{ metadata }}', '{{ labels }}', '{{ displayName }}', -'{{ schemaVersion }}', +'{{ description }}', +'{{ state }}', '{{ schemaTitle }}', -'{{ etag }}', -'{{ metadata }}' +'{{ etag }}' ; ``` ```yaml +schemaVersion: string +metadata: object +createTime: string +labels: object name: string +updateTime: string +displayName: string description: string state: string -labels: object -createTime: string -displayName: string -schemaVersion: string schemaTitle: string etag: string -updateTime: string -metadata: object ``` @@ -131,14 +147,14 @@ Updates a executions resource. /*+ update */ UPDATE google.aiplatform.executions SET -description = '{{ description }}', -state = '{{ state }}', +schemaVersion = '{{ schemaVersion }}', +metadata = '{{ metadata }}', labels = '{{ labels }}', displayName = '{{ displayName }}', -schemaVersion = '{{ schemaVersion }}', +description = '{{ description }}', +state = '{{ state }}', schemaTitle = '{{ schemaTitle }}', -etag = '{{ etag }}', -metadata = '{{ metadata }}' +etag = '{{ etag }}' WHERE executionsId = '{{ executionsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/executions_execution_events/index.md b/docs/google-docs/providers/google/aiplatform/executions_execution_events/index.md index a5e3d9a3c8..4864d38b19 100644 --- a/docs/google-docs/providers/google/aiplatform/executions_execution_events/index.md +++ b/docs/google-docs/providers/google/aiplatform/executions_execution_events/index.md @@ -72,11 +72,11 @@ SELECT ```yaml events: - - labels: object - eventTime: string - artifact: string - type: string + - eventTime: string execution: string + labels: object + type: string + artifact: string ``` diff --git a/docs/google-docs/providers/google/aiplatform/experiments/index.md b/docs/google-docs/providers/google/aiplatform/experiments/index.md index c2f26730a9..8551722e5c 100644 --- a/docs/google-docs/providers/google/aiplatform/experiments/index.md +++ b/docs/google-docs/providers/google/aiplatform/experiments/index.md @@ -91,34 +91,34 @@ locationsId, projectsId, tensorboardsId, labels, -displayName, source, -etag, -description +description, +displayName, +etag ) SELECT '{{ locationsId }}', '{{ projectsId }}', '{{ tensorboardsId }}', '{{ labels }}', -'{{ displayName }}', '{{ source }}', -'{{ etag }}', -'{{ description }}' +'{{ description }}', +'{{ displayName }}', +'{{ etag }}' ; ``` ```yaml +createTime: string labels: object -displayName: string -updateTime: string source: string -createTime: string +updateTime: string +description: string +displayName: string etag: string name: string -description: string ``` @@ -133,10 +133,10 @@ Updates a experiments resource. UPDATE google.aiplatform.experiments SET labels = '{{ labels }}', -displayName = '{{ displayName }}', source = '{{ source }}', -etag = '{{ etag }}', -description = '{{ description }}' +description = '{{ description }}', +displayName = '{{ displayName }}', +etag = '{{ etag }}' WHERE experimentsId = '{{ experimentsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/feature_groups/index.md b/docs/google-docs/providers/google/aiplatform/feature_groups/index.md index 9e2c261b31..2dcef20c9a 100644 --- a/docs/google-docs/providers/google/aiplatform/feature_groups/index.md +++ b/docs/google-docs/providers/google/aiplatform/feature_groups/index.md @@ -85,19 +85,19 @@ INSERT INTO google.aiplatform.feature_groups ( locationsId, projectsId, bigQuery, -name, -description, labels, -etag +etag, +description, +name ) SELECT '{{ locationsId }}', '{{ projectsId }}', '{{ bigQuery }}', -'{{ name }}', -'{{ description }}', '{{ labels }}', -'{{ etag }}' +'{{ etag }}', +'{{ description }}', +'{{ name }}' ; ``` @@ -106,19 +106,19 @@ SELECT ```yaml bigQuery: dense: boolean - bigQuerySource: - inputUri: string + entityIdColumns: + - type: string staticDataSource: boolean timeSeries: timestampColumn: string - entityIdColumns: - - type: string -updateTime: string -name: string -description: string + bigQuerySource: + inputUri: string labels: object -createTime: string etag: string +createTime: string +description: string +name: string +updateTime: string ``` @@ -133,10 +133,10 @@ Updates a feature_groups resource. UPDATE google.aiplatform.feature_groups SET bigQuery = '{{ bigQuery }}', -name = '{{ name }}', -description = '{{ description }}', labels = '{{ labels }}', -etag = '{{ etag }}' +etag = '{{ etag }}', +description = '{{ description }}', +name = '{{ name }}' WHERE featureGroupsId = '{{ featureGroupsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/feature_online_stores/index.md b/docs/google-docs/providers/google/aiplatform/feature_online_stores/index.md index 3a65d1a078..165c24dbac 100644 --- a/docs/google-docs/providers/google/aiplatform/feature_online_stores/index.md +++ b/docs/google-docs/providers/google/aiplatform/feature_online_stores/index.md @@ -94,54 +94,54 @@ Use the following StackQL query and manifest file to create a new feature_ INSERT INTO google.aiplatform.feature_online_stores ( locationsId, projectsId, -dedicatedServingEndpoint, +name, etag, +dedicatedServingEndpoint, +encryptionSpec, labels, -optimized, -name, bigtable, -encryptionSpec +optimized ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ dedicatedServingEndpoint }}', +'{{ name }}', '{{ etag }}', +'{{ dedicatedServingEndpoint }}', +'{{ encryptionSpec }}', '{{ labels }}', -'{{ optimized }}', -'{{ name }}', '{{ bigtable }}', -'{{ encryptionSpec }}' +'{{ optimized }}' ; ``` ```yaml +name: string +updateTime: string +etag: string dedicatedServingEndpoint: + publicEndpointDomainName: string + serviceAttachment: string privateServiceConnectConfig: serviceAttachment: string - enablePrivateServiceConnect: boolean projectAllowlist: - type: string - publicEndpointDomainName: string - serviceAttachment: string -updateTime: string -etag: string -satisfiesPzs: boolean + enablePrivateServiceConnect: boolean +state: string +encryptionSpec: + kmsKeyName: string labels: object +satisfiesPzi: boolean createTime: string -optimized: {} -name: string bigtable: autoScaling: cpuUtilizationTarget: integer minNodeCount: integer maxNodeCount: integer -state: string -encryptionSpec: - kmsKeyName: string -satisfiesPzi: boolean +satisfiesPzs: boolean +optimized: {} ``` @@ -155,13 +155,13 @@ Updates a feature_online_stores resource. /*+ update */ UPDATE google.aiplatform.feature_online_stores SET -dedicatedServingEndpoint = '{{ dedicatedServingEndpoint }}', +name = '{{ name }}', etag = '{{ etag }}', +dedicatedServingEndpoint = '{{ dedicatedServingEndpoint }}', +encryptionSpec = '{{ encryptionSpec }}', labels = '{{ labels }}', -optimized = '{{ optimized }}', -name = '{{ name }}', bigtable = '{{ bigtable }}', -encryptionSpec = '{{ encryptionSpec }}' +optimized = '{{ optimized }}' WHERE featureOnlineStoresId = '{{ featureOnlineStoresId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/feature_views/index.md b/docs/google-docs/providers/google/aiplatform/feature_views/index.md index 4d2c727c7f..c071b39bf9 100644 --- a/docs/google-docs/providers/google/aiplatform/feature_views/index.md +++ b/docs/google-docs/providers/google/aiplatform/feature_views/index.md @@ -98,26 +98,26 @@ INSERT INTO google.aiplatform.feature_views ( featureOnlineStoresId, locationsId, projectsId, -etag, -labels, bigQuerySource, -name, -featureRegistrySource, indexConfig, +name, +etag, vertexRagSource, +labels, +featureRegistrySource, syncConfig ) SELECT '{{ featureOnlineStoresId }}', '{{ locationsId }}', '{{ projectsId }}', -'{{ etag }}', -'{{ labels }}', '{{ bigQuerySource }}', -'{{ name }}', -'{{ featureRegistrySource }}', '{{ indexConfig }}', +'{{ name }}', +'{{ etag }}', '{{ vertexRagSource }}', +'{{ labels }}', +'{{ featureRegistrySource }}', '{{ syncConfig }}' ; ``` @@ -125,38 +125,38 @@ SELECT ```yaml -satisfiesPzs: boolean -createTime: string -etag: string -satisfiesPzi: boolean -labels: object bigQuerySource: entityIdColumns: - type: string uri: string -name: string -updateTime: string -featureRegistrySource: - featureGroups: - - featureIds: - - type: string - featureGroupId: string - projectNumber: string indexConfig: + treeAhConfig: + leafNodeEmbeddingCount: string + crowdingColumn: string bruteForceConfig: {} - embeddingDimension: integer distanceMeasureType: string - crowdingColumn: string + embeddingDimension: integer + embeddingColumn: string filterColumns: - type: string - treeAhConfig: - leafNodeEmbeddingCount: string - embeddingColumn: string +name: string +etag: string +satisfiesPzi: boolean vertexRagSource: uri: string ragCorpusId: string +labels: object +updateTime: string +satisfiesPzs: boolean +featureRegistrySource: + projectNumber: string + featureGroups: + - featureIds: + - type: string + featureGroupId: string syncConfig: cron: string +createTime: string ``` @@ -170,13 +170,13 @@ Updates a feature_views resource. /*+ update */ UPDATE google.aiplatform.feature_views SET -etag = '{{ etag }}', -labels = '{{ labels }}', bigQuerySource = '{{ bigQuerySource }}', -name = '{{ name }}', -featureRegistrySource = '{{ featureRegistrySource }}', indexConfig = '{{ indexConfig }}', +name = '{{ name }}', +etag = '{{ etag }}', vertexRagSource = '{{ vertexRagSource }}', +labels = '{{ labels }}', +featureRegistrySource = '{{ featureRegistrySource }}', syncConfig = '{{ syncConfig }}' WHERE featureOnlineStoresId = '{{ featureOnlineStoresId }}' diff --git a/docs/google-docs/providers/google/aiplatform/features/index.md b/docs/google-docs/providers/google/aiplatform/features/index.md index fb963a0304..84e230086d 100644 --- a/docs/google-docs/providers/google/aiplatform/features/index.md +++ b/docs/google-docs/providers/google/aiplatform/features/index.md @@ -95,26 +95,26 @@ INSERT INTO google.aiplatform.features ( featureGroupsId, locationsId, projectsId, -labels, versionColumnName, -valueType, disableMonitoring, -etag, description, name, +etag, +valueType, +labels, pointOfContact ) SELECT '{{ featureGroupsId }}', '{{ locationsId }}', '{{ projectsId }}', -'{{ labels }}', '{{ versionColumnName }}', -'{{ valueType }}', true|false, -'{{ etag }}', '{{ description }}', '{{ name }}', +'{{ etag }}', +'{{ valueType }}', +'{{ labels }}', '{{ pointOfContact }}' ; ``` @@ -122,25 +122,25 @@ true|false, ```yaml -labels: object -createTime: string versionColumnName: string -valueType: string +updateTime: string disableMonitoring: boolean -etag: string +createTime: string description: string -updateTime: string -name: string monitoringStatsAnomalies: - featureStatsAnomaly: - score: number + statsUri: string anomalyUri: string anomalyDetectionThreshold: number endTime: string distributionDeviation: number - statsUri: string startTime: string + score: number objective: string +name: string +etag: string +valueType: string +labels: object pointOfContact: string ``` @@ -155,13 +155,13 @@ Updates a features resource. /*+ update */ UPDATE google.aiplatform.features SET -labels = '{{ labels }}', versionColumnName = '{{ versionColumnName }}', -valueType = '{{ valueType }}', disableMonitoring = true|false, -etag = '{{ etag }}', description = '{{ description }}', name = '{{ name }}', +etag = '{{ etag }}', +valueType = '{{ valueType }}', +labels = '{{ labels }}', pointOfContact = '{{ pointOfContact }}' WHERE featureGroupsId = '{{ featureGroupsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/featurestores/index.md b/docs/google-docs/providers/google/aiplatform/featurestores/index.md index 0270bf60da..a23cd43aeb 100644 --- a/docs/google-docs/providers/google/aiplatform/featurestores/index.md +++ b/docs/google-docs/providers/google/aiplatform/featurestores/index.md @@ -95,8 +95,8 @@ INSERT INTO google.aiplatform.featurestores ( locationsId, projectsId, onlineStorageTtlDays, -encryptionSpec, labels, +encryptionSpec, etag, onlineServingConfig ) @@ -104,8 +104,8 @@ SELECT '{{ locationsId }}', '{{ projectsId }}', '{{ onlineStorageTtlDays }}', -'{{ encryptionSpec }}', '{{ labels }}', +'{{ encryptionSpec }}', '{{ etag }}', '{{ onlineServingConfig }}' ; @@ -115,22 +115,22 @@ SELECT ```yaml onlineStorageTtlDays: integer +updateTime: string +satisfiesPzs: boolean +labels: object encryptionSpec: kmsKeyName: string -name: string -state: string -createTime: string -labels: object etag: string +satisfiesPzi: boolean +state: string +name: string onlineServingConfig: + fixedNodeCount: integer scaling: cpuUtilizationTarget: integer - maxNodeCount: integer minNodeCount: integer - fixedNodeCount: integer -satisfiesPzs: boolean -updateTime: string -satisfiesPzi: boolean + maxNodeCount: integer +createTime: string ``` @@ -145,8 +145,8 @@ Updates a featurestores resource. UPDATE google.aiplatform.featurestores SET onlineStorageTtlDays = '{{ onlineStorageTtlDays }}', -encryptionSpec = '{{ encryptionSpec }}', labels = '{{ labels }}', +encryptionSpec = '{{ encryptionSpec }}', etag = '{{ etag }}', onlineServingConfig = '{{ onlineServingConfig }}' WHERE diff --git a/docs/google-docs/providers/google/aiplatform/hyperparameter_tuning_jobs/index.md b/docs/google-docs/providers/google/aiplatform/hyperparameter_tuning_jobs/index.md index ef2419515a..35f03fd484 100644 --- a/docs/google-docs/providers/google/aiplatform/hyperparameter_tuning_jobs/index.md +++ b/docs/google-docs/providers/google/aiplatform/hyperparameter_tuning_jobs/index.md @@ -106,204 +106,204 @@ Use the following StackQL query and manifest file to create a new hyperpar INSERT INTO google.aiplatform.hyperparameter_tuning_jobs ( locationsId, projectsId, -trialJobSpec, +displayName, studySpec, -maxTrialCount, -labels, maxFailedTrialCount, -displayName, +trialJobSpec, +maxTrialCount, encryptionSpec, -parallelTrialCount +parallelTrialCount, +labels ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ trialJobSpec }}', +'{{ displayName }}', '{{ studySpec }}', -'{{ maxTrialCount }}', -'{{ labels }}', '{{ maxFailedTrialCount }}', -'{{ displayName }}', +'{{ trialJobSpec }}', +'{{ maxTrialCount }}', '{{ encryptionSpec }}', -'{{ parallelTrialCount }}' +'{{ parallelTrialCount }}', +'{{ labels }}' ; ``` ```yaml -name: string -trialJobSpec: - workerPoolSpecs: - - machineSpec: - acceleratorCount: integer - reservationAffinity: - key: string - reservationAffinityType: string - values: - - type: string - tpuTopology: string - acceleratorType: string - machineType: string - nfsMounts: - - path: string - mountPoint: string - server: string - diskSpec: - bootDiskType: string - bootDiskSizeGb: integer - replicaCount: string - containerSpec: - command: - - type: string - args: - - type: string - imageUri: string - env: - - value: string - name: string - pythonPackageSpec: - args: - - type: string - pythonModule: string - env: - - value: string - name: string - executorImageUri: string - packageUris: - - type: string - tensorboard: string - experimentRun: string - reservedIpRanges: - - type: string - scheduling: - timeout: string - disableRetries: boolean - strategy: string - restartJobOnWorkerRestart: boolean - maxWaitDuration: string - protectedArtifactLocationId: string - serviceAccount: string - baseOutputDirectory: - outputUriPrefix: string - enableWebAccess: boolean - experiment: string - models: - - type: string - persistentResourceId: string - network: string - enableDashboardAccess: boolean -error: - message: string - code: integer - details: - - additionalProperties: any - type: string +displayName: string +createTime: string studySpec: - metrics: - - goal: string - metricId: string - safetyConfig: - desiredMinSafeTrialsFraction: number - safetyThreshold: number - observationNoise: string parameters: - - conditionalParameterSpecs: - - parentIntValues: + - discreteValueSpec: + values: + - type: string + format: string + defaultValue: number + categoricalValueSpec: + defaultValue: string + values: + - type: string + conditionalParameterSpecs: + - parentCategoricalValues: values: - - format: string - type: string + - type: string + parentDiscreteValues: + values: + - type: string + format: string parameterSpec: conditionalParameterSpecs: - - parentDiscreteValues: - values: - - type: string - format: string - parentCategoricalValues: + - parentIntValues: values: - - type: string + - format: string + type: string + scaleType: string integerValueSpec: maxValue: string defaultValue: string minValue: string - discreteValueSpec: - defaultValue: number - values: - - format: string - type: string + parameterId: string doubleValueSpec: defaultValue: number maxValue: number minValue: number - categoricalValueSpec: - defaultValue: string - values: - - type: string - parameterId: string - scaleType: string - parameterId: string scaleType: string + parameterId: string decayCurveStoppingSpec: useElapsedDuration: boolean - convexAutomatedStoppingSpec: + observationNoise: string + measurementSelectionType: string + medianAutomatedStoppingSpec: useElapsedDuration: boolean - minStepCount: string + convexAutomatedStoppingSpec: maxStepCount: string - learningRateParameterName: string updateAllStoppedTrials: boolean - minMeasurementCount: string - algorithm: string - medianAutomatedStoppingSpec: + minStepCount: string + learningRateParameterName: string useElapsedDuration: boolean - measurementSelectionType: string + minMeasurementCount: string + metrics: + - goal: string + metricId: string + safetyConfig: + desiredMinSafeTrialsFraction: number + safetyThreshold: number studyStoppingConfig: - minNumTrials: integer - shouldStopAsap: boolean + maxNumTrials: integer maxNumTrialsNoProgress: integer + shouldStopAsap: boolean maximumRuntimeConstraint: maxDuration: string endTime: string + minNumTrials: integer maxDurationNoProgress: string - maxNumTrials: integer -updateTime: string -createTime: string + algorithm: string +maxFailedTrialCount: integer +state: string +trialJobSpec: + scheduling: + restartJobOnWorkerRestart: boolean + timeout: string + strategy: string + disableRetries: boolean + maxWaitDuration: string + persistentResourceId: string + baseOutputDirectory: + outputUriPrefix: string + experimentRun: string + protectedArtifactLocationId: string + serviceAccount: string + workerPoolSpecs: + - pythonPackageSpec: + args: + - type: string + env: + - value: string + name: string + pythonModule: string + executorImageUri: string + packageUris: + - type: string + diskSpec: + bootDiskType: string + bootDiskSizeGb: integer + machineSpec: + acceleratorCount: integer + tpuTopology: string + machineType: string + acceleratorType: string + reservationAffinity: + reservationAffinityType: string + values: + - type: string + key: string + containerSpec: + command: + - type: string + args: + - type: string + imageUri: string + env: + - value: string + name: string + nfsMounts: + - mountPoint: string + path: string + server: string + replicaCount: string + enableDashboardAccess: boolean + network: string + enableWebAccess: boolean + experiment: string + reservedIpRanges: + - type: string + tensorboard: string + models: + - type: string +maxTrialCount: integer +endTime: string +name: string +satisfiesPzi: boolean +encryptionSpec: + kmsKeyName: string +error: + code: integer + message: string + details: + - additionalProperties: any + type: string +parallelTrialCount: integer +startTime: string trials: - - state: string - startTime: string + - id: string + clientId: string + name: string + customJob: string finalMeasurement: stepCount: string + elapsedDuration: string metrics: - value: number metricId: string - elapsedDuration: string - clientId: string - id: string + startTime: string measurements: - stepCount: string + elapsedDuration: string metrics: - value: number metricId: string - elapsedDuration: string + state: string + endTime: string webAccessUris: object parameters: - value: any parameterId: string - endTime: string infeasibleReason: string - name: string - customJob: string -maxTrialCount: integer +updateTime: string labels: object satisfiesPzs: boolean -state: string -maxFailedTrialCount: integer -endTime: string -satisfiesPzi: boolean -displayName: string -encryptionSpec: - kmsKeyName: string -startTime: string -parallelTrialCount: integer ``` diff --git a/docs/google-docs/providers/google/aiplatform/index_endpoints/index.md b/docs/google-docs/providers/google/aiplatform/index_endpoints/index.md index 70869face7..4bb3094cca 100644 --- a/docs/google-docs/providers/google/aiplatform/index_endpoints/index.md +++ b/docs/google-docs/providers/google/aiplatform/index_endpoints/index.md @@ -108,96 +108,99 @@ INSERT INTO google.aiplatform.index_endpoints ( locationsId, projectsId, encryptionSpec, +publicEndpointEnabled, network, +privateServiceConnectConfig, +labels, displayName, -publicEndpointEnabled, -enablePrivateServiceConnect, +description, etag, -labels, -privateServiceConnectConfig, -description +enablePrivateServiceConnect ) SELECT '{{ locationsId }}', '{{ projectsId }}', '{{ encryptionSpec }}', +true|false, '{{ network }}', +'{{ privateServiceConnectConfig }}', +'{{ labels }}', '{{ displayName }}', -true|false, -true|false, +'{{ description }}', '{{ etag }}', -'{{ labels }}', -'{{ privateServiceConnectConfig }}', -'{{ description }}' +true|false ; ``` ```yaml +satisfiesPzi: boolean encryptionSpec: kmsKeyName: string +publicEndpointEnabled: boolean +updateTime: string +createTime: string network: string +privateServiceConnectConfig: + serviceAttachment: string + projectAllowlist: + - type: string + enablePrivateServiceConnect: boolean +labels: object +satisfiesPzs: boolean displayName: string +description: string +name: string publicEndpointDomainName: string +etag: string deployedIndexes: - - createTime: string - dedicatedResources: - spot: boolean - machineSpec: - acceleratorCount: integer - reservationAffinity: - key: string - reservationAffinityType: string - values: - - type: string - tpuTopology: string - acceleratorType: string - machineType: string - autoscalingMetricSpecs: - - metricName: string - target: integer - minReplicaCount: integer - maxReplicaCount: integer + - deploymentGroup: string privateEndpoints: + matchGrpcAddress: string pscAutomatedEndpoints: - projectId: string network: string matchAddress: string - matchGrpcAddress: string serviceAttachment: string deployedIndexAuthConfig: authProvider: - allowedIssuers: - - type: string audiences: - type: string - automaticResources: - minReplicaCount: integer + allowedIssuers: + - type: string + indexSyncTime: string + enableAccessLogging: boolean + dedicatedResources: + machineSpec: + acceleratorCount: integer + tpuTopology: string + machineType: string + acceleratorType: string + reservationAffinity: + reservationAffinityType: string + values: + - type: string + key: string + autoscalingMetricSpecs: + - target: integer + metricName: string maxReplicaCount: integer - id: string - displayName: string + minReplicaCount: integer + spot: boolean reservedIpRanges: - type: string - enableAccessLogging: boolean - indexSyncTime: string + displayName: string + pscAutomationConfigs: + - projectId: string + network: string + id: string index: string - deploymentGroup: string -publicEndpointEnabled: boolean -name: string + createTime: string + automaticResources: + minReplicaCount: integer + maxReplicaCount: integer enablePrivateServiceConnect: boolean -satisfiesPzs: boolean -etag: string -labels: object -satisfiesPzi: boolean -privateServiceConnectConfig: - serviceAttachment: string - enablePrivateServiceConnect: boolean - projectAllowlist: - - type: string -createTime: string -description: string -updateTime: string ``` @@ -212,14 +215,14 @@ Updates a index_endpoints resource. UPDATE google.aiplatform.index_endpoints SET encryptionSpec = '{{ encryptionSpec }}', +publicEndpointEnabled = true|false, network = '{{ network }}', +privateServiceConnectConfig = '{{ privateServiceConnectConfig }}', +labels = '{{ labels }}', displayName = '{{ displayName }}', -publicEndpointEnabled = true|false, -enablePrivateServiceConnect = true|false, +description = '{{ description }}', etag = '{{ etag }}', -labels = '{{ labels }}', -privateServiceConnectConfig = '{{ privateServiceConnectConfig }}', -description = '{{ description }}' +enablePrivateServiceConnect = true|false WHERE indexEndpointsId = '{{ indexEndpointsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/indexes/index.md b/docs/google-docs/providers/google/aiplatform/indexes/index.md index c73b9bf0c9..430eccaff5 100644 --- a/docs/google-docs/providers/google/aiplatform/indexes/index.md +++ b/docs/google-docs/providers/google/aiplatform/indexes/index.md @@ -101,54 +101,54 @@ Use the following StackQL query and manifest file to create a new indexes< INSERT INTO google.aiplatform.indexes ( locationsId, projectsId, +metadataSchemaUri, indexUpdateMethod, +labels, +etag, encryptionSpec, -metadata, -metadataSchemaUri, -description, displayName, -labels, -etag +description, +metadata ) SELECT '{{ locationsId }}', '{{ projectsId }}', +'{{ metadataSchemaUri }}', '{{ indexUpdateMethod }}', +'{{ labels }}', +'{{ etag }}', '{{ encryptionSpec }}', -'{{ metadata }}', -'{{ metadataSchemaUri }}', -'{{ description }}', '{{ displayName }}', -'{{ labels }}', -'{{ etag }}' +'{{ description }}', +'{{ metadata }}' ; ``` ```yaml +metadataSchemaUri: string indexStats: - vectorsCount: string sparseVectorsCount: string shardsCount: integer -satisfiesPzi: boolean -satisfiesPzs: boolean -name: string + vectorsCount: string indexUpdateMethod: string +labels: object +createTime: string +satisfiesPzi: boolean +etag: string encryptionSpec: kmsKeyName: string -createTime: string -metadata: any -metadataSchemaUri: string -description: string +updateTime: string deployedIndexes: - deployedIndexId: string displayName: string indexEndpoint: string displayName: string -updateTime: string -labels: object -etag: string +satisfiesPzs: boolean +description: string +metadata: any +name: string ``` @@ -162,14 +162,14 @@ Updates a indexes resource. /*+ update */ UPDATE google.aiplatform.indexes SET +metadataSchemaUri = '{{ metadataSchemaUri }}', indexUpdateMethod = '{{ indexUpdateMethod }}', +labels = '{{ labels }}', +etag = '{{ etag }}', encryptionSpec = '{{ encryptionSpec }}', -metadata = '{{ metadata }}', -metadataSchemaUri = '{{ metadataSchemaUri }}', -description = '{{ description }}', displayName = '{{ displayName }}', -labels = '{{ labels }}', -etag = '{{ etag }}' +description = '{{ description }}', +metadata = '{{ metadata }}' WHERE indexesId = '{{ indexesId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/metadata_schemas/index.md b/docs/google-docs/providers/google/aiplatform/metadata_schemas/index.md index 0dfee0991a..fa28ca673c 100644 --- a/docs/google-docs/providers/google/aiplatform/metadata_schemas/index.md +++ b/docs/google-docs/providers/google/aiplatform/metadata_schemas/index.md @@ -82,31 +82,31 @@ INSERT INTO google.aiplatform.metadata_schemas ( locationsId, metadataStoresId, projectsId, -schemaType, schema, -description, -schemaVersion +schemaVersion, +schemaType, +description ) SELECT '{{ locationsId }}', '{{ metadataStoresId }}', '{{ projectsId }}', -'{{ schemaType }}', '{{ schema }}', -'{{ description }}', -'{{ schemaVersion }}' +'{{ schemaVersion }}', +'{{ schemaType }}', +'{{ description }}' ; ``` ```yaml -schemaType: string schema: string -description: string +createTime: string schemaVersion: string +schemaType: string +description: string name: string -createTime: string ``` diff --git a/docs/google-docs/providers/google/aiplatform/metadata_stores/index.md b/docs/google-docs/providers/google/aiplatform/metadata_stores/index.md index 0a3d93769e..cb31727204 100644 --- a/docs/google-docs/providers/google/aiplatform/metadata_stores/index.md +++ b/docs/google-docs/providers/google/aiplatform/metadata_stores/index.md @@ -84,15 +84,15 @@ INSERT INTO google.aiplatform.metadata_stores ( locationsId, projectsId, dataplexConfig, -description, -encryptionSpec +encryptionSpec, +description ) SELECT '{{ locationsId }}', '{{ projectsId }}', '{{ dataplexConfig }}', -'{{ description }}', -'{{ encryptionSpec }}' +'{{ encryptionSpec }}', +'{{ description }}' ; ``` @@ -101,14 +101,14 @@ SELECT ```yaml dataplexConfig: enabledPipelinesLineage: boolean -state: - diskUtilizationBytes: string name: string -createTime: string -description: string encryptionSpec: kmsKeyName: string updateTime: string +state: + diskUtilizationBytes: string +createTime: string +description: string ``` diff --git a/docs/google-docs/providers/google/aiplatform/model_deployment_monitoring_jobs/index.md b/docs/google-docs/providers/google/aiplatform/model_deployment_monitoring_jobs/index.md index 156a722b3c..2cf0a83d7f 100644 --- a/docs/google-docs/providers/google/aiplatform/model_deployment_monitoring_jobs/index.md +++ b/docs/google-docs/providers/google/aiplatform/model_deployment_monitoring_jobs/index.md @@ -123,116 +123,116 @@ Use the following StackQL query and manifest file to create a new model_de INSERT INTO google.aiplatform.model_deployment_monitoring_jobs ( locationsId, projectsId, -displayName, -samplePredictInstance, -predictInstanceSchemaUri, logTtl, statsAnomaliesBaseDirectory, +enableMonitoringPipelineLogs, +labels, modelDeploymentMonitoringScheduleConfig, -endpoint, -modelMonitoringAlertConfig, encryptionSpec, -labels, +predictInstanceSchemaUri, analysisInstanceSchemaUri, +modelDeploymentMonitoringObjectiveConfigs, +samplePredictInstance, loggingSamplingStrategy, -enableMonitoringPipelineLogs, -modelDeploymentMonitoringObjectiveConfigs +displayName, +endpoint, +modelMonitoringAlertConfig ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ displayName }}', -'{{ samplePredictInstance }}', -'{{ predictInstanceSchemaUri }}', '{{ logTtl }}', '{{ statsAnomaliesBaseDirectory }}', +true|false, +'{{ labels }}', '{{ modelDeploymentMonitoringScheduleConfig }}', -'{{ endpoint }}', -'{{ modelMonitoringAlertConfig }}', '{{ encryptionSpec }}', -'{{ labels }}', +'{{ predictInstanceSchemaUri }}', '{{ analysisInstanceSchemaUri }}', +'{{ modelDeploymentMonitoringObjectiveConfigs }}', +'{{ samplePredictInstance }}', '{{ loggingSamplingStrategy }}', -true|false, -'{{ modelDeploymentMonitoringObjectiveConfigs }}' +'{{ displayName }}', +'{{ endpoint }}', +'{{ modelMonitoringAlertConfig }}' ; ``` ```yaml -displayName: string -samplePredictInstance: any -bigqueryTables: - - requestResponseLoggingSchemaVersion: string - bigqueryTablePath: string - logType: string - logSource: string -nextScheduleTime: string -satisfiesPzi: boolean -scheduleState: string -predictInstanceSchemaUri: string logTtl: string -satisfiesPzs: boolean -state: string +createTime: string statsAnomaliesBaseDirectory: outputUriPrefix: string -modelDeploymentMonitoringScheduleConfig: - monitorWindow: string - monitorInterval: string -endpoint: string -modelMonitoringAlertConfig: - enableLogging: boolean - emailAlertConfig: - userEmails: - - type: string - notificationChannels: - - type: string +enableMonitoringPipelineLogs: boolean latestMonitoringPipelineMetadata: + runTime: string status: - message: string code: integer + message: string details: - additionalProperties: any type: string - runTime: string +labels: object +modelDeploymentMonitoringScheduleConfig: + monitorInterval: string + monitorWindow: string encryptionSpec: kmsKeyName: string -labels: object +predictInstanceSchemaUri: string +scheduleState: string +satisfiesPzi: boolean analysisInstanceSchemaUri: string -loggingSamplingStrategy: - randomSampleConfig: - sampleRate: number -name: string -enableMonitoringPipelineLogs: boolean -updateTime: string -createTime: string modelDeploymentMonitoringObjectiveConfigs: - - deployedModelId: string - objectiveConfig: + - objectiveConfig: + trainingDataset: + dataset: string + bigquerySource: + inputUri: string + loggingSamplingStrategy: + randomSampleConfig: + sampleRate: number + gcsSource: + uris: + - type: string + targetField: string + dataFormat: string explanationConfig: explanationBaseline: - predictionFormat: string bigquery: outputUri: string + predictionFormat: string enableFeatureAttributes: boolean - trainingDataset: - dataFormat: string - targetField: string - gcsSource: - uris: - - type: string - bigquerySource: - inputUri: string - dataset: string trainingPredictionSkewDetectionConfig: attributionScoreSkewThresholds: object skewThresholds: object defaultSkewThreshold: value: number predictionDriftDetectionConfig: - driftThresholds: object attributionScoreDriftThresholds: object + driftThresholds: object + deployedModelId: string +samplePredictInstance: any +state: string +displayName: string +name: string +satisfiesPzs: boolean +endpoint: string +nextScheduleTime: string +modelMonitoringAlertConfig: + enableLogging: boolean + notificationChannels: + - type: string + emailAlertConfig: + userEmails: + - type: string +bigqueryTables: + - logSource: string + requestResponseLoggingSchemaVersion: string + logType: string + bigqueryTablePath: string +updateTime: string ``` @@ -246,20 +246,20 @@ Updates a model_deployment_monitoring_jobs resource. /*+ update */ UPDATE google.aiplatform.model_deployment_monitoring_jobs SET -displayName = '{{ displayName }}', -samplePredictInstance = '{{ samplePredictInstance }}', -predictInstanceSchemaUri = '{{ predictInstanceSchemaUri }}', logTtl = '{{ logTtl }}', statsAnomaliesBaseDirectory = '{{ statsAnomaliesBaseDirectory }}', +enableMonitoringPipelineLogs = true|false, +labels = '{{ labels }}', modelDeploymentMonitoringScheduleConfig = '{{ modelDeploymentMonitoringScheduleConfig }}', -endpoint = '{{ endpoint }}', -modelMonitoringAlertConfig = '{{ modelMonitoringAlertConfig }}', encryptionSpec = '{{ encryptionSpec }}', -labels = '{{ labels }}', +predictInstanceSchemaUri = '{{ predictInstanceSchemaUri }}', analysisInstanceSchemaUri = '{{ analysisInstanceSchemaUri }}', +modelDeploymentMonitoringObjectiveConfigs = '{{ modelDeploymentMonitoringObjectiveConfigs }}', +samplePredictInstance = '{{ samplePredictInstance }}', loggingSamplingStrategy = '{{ loggingSamplingStrategy }}', -enableMonitoringPipelineLogs = true|false, -modelDeploymentMonitoringObjectiveConfigs = '{{ modelDeploymentMonitoringObjectiveConfigs }}' +displayName = '{{ displayName }}', +endpoint = '{{ endpoint }}', +modelMonitoringAlertConfig = '{{ modelMonitoringAlertConfig }}' WHERE locationsId = '{{ locationsId }}' AND modelDeploymentMonitoringJobsId = '{{ modelDeploymentMonitoringJobsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/models/index.md b/docs/google-docs/providers/google/aiplatform/models/index.md index cc97870971..84c0c7b57d 100644 --- a/docs/google-docs/providers/google/aiplatform/models/index.md +++ b/docs/google-docs/providers/google/aiplatform/models/index.md @@ -137,23 +137,23 @@ Updates a models resource. /*+ update */ UPDATE google.aiplatform.models SET -dataStats = '{{ dataStats }}', -containerSpec = '{{ containerSpec }}', -versionAliases = '{{ versionAliases }}', -baseModelSource = '{{ baseModelSource }}', -etag = '{{ etag }}', -predictSchemata = '{{ predictSchemata }}', -metadata = '{{ metadata }}', -metadataSchemaUri = '{{ metadataSchemaUri }}', -artifactUri = '{{ artifactUri }}', +pipelineJob = '{{ pipelineJob }}', explanationSpec = '{{ explanationSpec }}', -description = '{{ description }}', -labels = '{{ labels }}', +name = '{{ name }}', versionDescription = '{{ versionDescription }}', -pipelineJob = '{{ pipelineJob }}', -displayName = '{{ displayName }}', encryptionSpec = '{{ encryptionSpec }}', -name = '{{ name }}' +artifactUri = '{{ artifactUri }}', +predictSchemata = '{{ predictSchemata }}', +etag = '{{ etag }}', +containerSpec = '{{ containerSpec }}', +baseModelSource = '{{ baseModelSource }}', +labels = '{{ labels }}', +dataStats = '{{ dataStats }}', +description = '{{ description }}', +versionAliases = '{{ versionAliases }}', +metadataSchemaUri = '{{ metadataSchemaUri }}', +metadata = '{{ metadata }}', +displayName = '{{ displayName }}' WHERE locationsId = '{{ locationsId }}' AND modelsId = '{{ modelsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/nas_jobs/index.md b/docs/google-docs/providers/google/aiplatform/nas_jobs/index.md index 042fc5e075..d5b709ee62 100644 --- a/docs/google-docs/providers/google/aiplatform/nas_jobs/index.md +++ b/docs/google-docs/providers/google/aiplatform/nas_jobs/index.md @@ -100,61 +100,69 @@ Use the following StackQL query and manifest file to create a new nas_jobs INSERT INTO google.aiplatform.nas_jobs ( locationsId, projectsId, -encryptionSpec, +enableRestrictedImageTraining, +labels, nasJobSpec, displayName, -enableRestrictedImageTraining, -labels +encryptionSpec ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ encryptionSpec }}', +true|false, +'{{ labels }}', '{{ nasJobSpec }}', '{{ displayName }}', -true|false, -'{{ labels }}' +'{{ encryptionSpec }}' ; ``` ```yaml -createTime: string -encryptionSpec: - kmsKeyName: string -startTime: string -error: - message: string - code: integer - details: - - additionalProperties: any - type: string -satisfiesPzi: boolean +enableRestrictedImageTraining: boolean +labels: object nasJobSpec: multiTrialAlgorithmSpec: + multiTrialAlgorithm: string trainTrialSpec: - frequency: integer trainTrialJobSpec: + scheduling: + restartJobOnWorkerRestart: boolean + timeout: string + strategy: string + disableRetries: boolean + maxWaitDuration: string + persistentResourceId: string + baseOutputDirectory: + outputUriPrefix: string + experimentRun: string + protectedArtifactLocationId: string + serviceAccount: string workerPoolSpecs: - - machineSpec: + - pythonPackageSpec: + args: + - type: string + env: + - value: string + name: string + pythonModule: string + executorImageUri: string + packageUris: + - type: string + diskSpec: + bootDiskType: string + bootDiskSizeGb: integer + machineSpec: acceleratorCount: integer + tpuTopology: string + machineType: string + acceleratorType: string reservationAffinity: - key: string reservationAffinityType: string values: - type: string - tpuTopology: string - acceleratorType: string - machineType: string - nfsMounts: - - path: string - mountPoint: string - server: string - diskSpec: - bootDiskType: string - bootDiskSizeGb: integer - replicaCount: string + key: string containerSpec: command: - type: string @@ -164,74 +172,66 @@ nasJobSpec: env: - value: string name: string - pythonPackageSpec: - args: - - type: string - pythonModule: string - env: - - value: string - name: string - executorImageUri: string - packageUris: - - type: string - tensorboard: string - experimentRun: string - reservedIpRanges: - - type: string - scheduling: - timeout: string - disableRetries: boolean - strategy: string - restartJobOnWorkerRestart: boolean - maxWaitDuration: string - protectedArtifactLocationId: string - serviceAccount: string - baseOutputDirectory: - outputUriPrefix: string + nfsMounts: + - mountPoint: string + path: string + server: string + replicaCount: string + enableDashboardAccess: boolean + network: string enableWebAccess: boolean experiment: string + reservedIpRanges: + - type: string + tensorboard: string models: - type: string - persistentResourceId: string - network: string - enableDashboardAccess: boolean maxParallelTrialCount: integer + frequency: integer searchTrialSpec: - maxParallelTrialCount: integer - maxTrialCount: integer maxFailedTrialCount: integer - multiTrialAlgorithm: string + maxTrialCount: integer + maxParallelTrialCount: integer metric: goal: string metricId: string - searchSpaceSpec: string resumeNasJobId: string + searchSpaceSpec: string +error: + code: integer + message: string + details: + - additionalProperties: any + type: string +displayName: string +startTime: string +state: string satisfiesPzs: boolean +updateTime: string +endTime: string nasJobOutput: multiTrialJobOutput: trainTrials: - - endTime: string - id: string - state: string - finalMeasurement: + - finalMeasurement: stepCount: string + elapsedDuration: string metrics: - value: number metricId: string - elapsedDuration: string - startTime: string - searchTrials: - - endTime: string id: string + endTime: string + startTime: string state: string + searchTrials: + - id: string + endTime: string startTime: string -displayName: string -endTime: string -updateTime: string -enableRestrictedImageTraining: boolean -labels: object + state: string +createTime: string +encryptionSpec: + kmsKeyName: string +satisfiesPzi: boolean name: string -state: string ``` diff --git a/docs/google-docs/providers/google/aiplatform/notebook_execution_jobs/index.md b/docs/google-docs/providers/google/aiplatform/notebook_execution_jobs/index.md index ca4a745b8f..ade7a256bb 100644 --- a/docs/google-docs/providers/google/aiplatform/notebook_execution_jobs/index.md +++ b/docs/google-docs/providers/google/aiplatform/notebook_execution_jobs/index.md @@ -103,66 +103,66 @@ Use the following StackQL query and manifest file to create a new notebook INSERT INTO google.aiplatform.notebook_execution_jobs ( locationsId, projectsId, -notebookRuntimeTemplateResourceName, executionTimeout, -gcsOutputUri, -serviceAccount, -encryptionSpec, +notebookRuntimeTemplateResourceName, +labels, +directNotebookSource, displayName, -dataformRepositorySource, -executionUser, +serviceAccount, gcsNotebookSource, -labels, -directNotebookSource +executionUser, +gcsOutputUri, +encryptionSpec, +dataformRepositorySource ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ notebookRuntimeTemplateResourceName }}', '{{ executionTimeout }}', -'{{ gcsOutputUri }}', -'{{ serviceAccount }}', -'{{ encryptionSpec }}', +'{{ notebookRuntimeTemplateResourceName }}', +'{{ labels }}', +'{{ directNotebookSource }}', '{{ displayName }}', -'{{ dataformRepositorySource }}', -'{{ executionUser }}', +'{{ serviceAccount }}', '{{ gcsNotebookSource }}', -'{{ labels }}', -'{{ directNotebookSource }}' +'{{ executionUser }}', +'{{ gcsOutputUri }}', +'{{ encryptionSpec }}', +'{{ dataformRepositorySource }}' ; ``` ```yaml -updateTime: string -createTime: string -notebookRuntimeTemplateResourceName: string -executionTimeout: string -gcsOutputUri: string -serviceAccount: string -encryptionSpec: - kmsKeyName: string -displayName: string -dataformRepositorySource: - commitSha: string - dataformRepositoryResourceName: string -executionUser: string scheduleResourceName: string -name: string -gcsNotebookSource: - generation: string - uri: string +executionTimeout: string +notebookRuntimeTemplateResourceName: string +createTime: string labels: object directNotebookSource: content: string +name: string +displayName: string +updateTime: string +serviceAccount: string status: - message: string code: integer + message: string details: - additionalProperties: any type: string jobState: string +gcsNotebookSource: + uri: string + generation: string +executionUser: string +gcsOutputUri: string +encryptionSpec: + kmsKeyName: string +dataformRepositorySource: + commitSha: string + dataformRepositoryResourceName: string ``` diff --git a/docs/google-docs/providers/google/aiplatform/notebook_runtime_templates/index.md b/docs/google-docs/providers/google/aiplatform/notebook_runtime_templates/index.md index 1a56e2520e..2fe1d33f9d 100644 --- a/docs/google-docs/providers/google/aiplatform/notebook_runtime_templates/index.md +++ b/docs/google-docs/providers/google/aiplatform/notebook_runtime_templates/index.md @@ -106,85 +106,85 @@ Use the following StackQL query and manifest file to create a new notebook INSERT INTO google.aiplatform.notebook_runtime_templates ( locationsId, projectsId, -machineSpec, -notebookRuntimeType, -shieldedVmConfig, +serviceAccount, +encryptionSpec, name, -description, -displayName, +dataPersistentDiskSpec, labels, -eucConfig, -encryptionSpec, -serviceAccount, +shieldedVmConfig, +displayName, +networkTags, +machineSpec, +description, networkSpec, idleShutdownConfig, +notebookRuntimeType, etag, -dataPersistentDiskSpec, -networkTags +eucConfig ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ machineSpec }}', -'{{ notebookRuntimeType }}', -'{{ shieldedVmConfig }}', +'{{ serviceAccount }}', +'{{ encryptionSpec }}', '{{ name }}', -'{{ description }}', -'{{ displayName }}', +'{{ dataPersistentDiskSpec }}', '{{ labels }}', -'{{ eucConfig }}', -'{{ encryptionSpec }}', -'{{ serviceAccount }}', +'{{ shieldedVmConfig }}', +'{{ displayName }}', +'{{ networkTags }}', +'{{ machineSpec }}', +'{{ description }}', '{{ networkSpec }}', '{{ idleShutdownConfig }}', +'{{ notebookRuntimeType }}', '{{ etag }}', -'{{ dataPersistentDiskSpec }}', -'{{ networkTags }}' +'{{ eucConfig }}' ; ``` ```yaml +serviceAccount: string +encryptionSpec: + kmsKeyName: string +name: string +dataPersistentDiskSpec: + diskSizeGb: string + diskType: string +labels: object +shieldedVmConfig: + enableSecureBoot: boolean +displayName: string +networkTags: + - type: string machineSpec: acceleratorCount: integer + tpuTopology: string + machineType: string + acceleratorType: string reservationAffinity: - key: string reservationAffinityType: string values: - type: string - tpuTopology: string - acceleratorType: string - machineType: string -notebookRuntimeType: string -shieldedVmConfig: - enableSecureBoot: boolean -name: string + key: string description: string -displayName: string -labels: object -eucConfig: - eucDisabled: boolean - bypassActasCheck: boolean -encryptionSpec: - kmsKeyName: string -isDefault: boolean -serviceAccount: string networkSpec: - subnetwork: string enableInternetAccess: boolean + subnetwork: string network: string -createTime: string +updateTime: string idleShutdownConfig: - idleTimeout: string idleShutdownDisabled: boolean + idleTimeout: string +notebookRuntimeType: string +isDefault: boolean etag: string -dataPersistentDiskSpec: - diskType: string - diskSizeGb: string -updateTime: string -networkTags: - - type: string +eucConfig: + eucDisabled: boolean + bypassActasCheck: boolean +createTime: string ``` @@ -198,21 +198,21 @@ Updates a notebook_runtime_templates resource. /*+ update */ UPDATE google.aiplatform.notebook_runtime_templates SET -machineSpec = '{{ machineSpec }}', -notebookRuntimeType = '{{ notebookRuntimeType }}', -shieldedVmConfig = '{{ shieldedVmConfig }}', +serviceAccount = '{{ serviceAccount }}', +encryptionSpec = '{{ encryptionSpec }}', name = '{{ name }}', -description = '{{ description }}', -displayName = '{{ displayName }}', +dataPersistentDiskSpec = '{{ dataPersistentDiskSpec }}', labels = '{{ labels }}', -eucConfig = '{{ eucConfig }}', -encryptionSpec = '{{ encryptionSpec }}', -serviceAccount = '{{ serviceAccount }}', +shieldedVmConfig = '{{ shieldedVmConfig }}', +displayName = '{{ displayName }}', +networkTags = '{{ networkTags }}', +machineSpec = '{{ machineSpec }}', +description = '{{ description }}', networkSpec = '{{ networkSpec }}', idleShutdownConfig = '{{ idleShutdownConfig }}', +notebookRuntimeType = '{{ notebookRuntimeType }}', etag = '{{ etag }}', -dataPersistentDiskSpec = '{{ dataPersistentDiskSpec }}', -networkTags = '{{ networkTags }}' +eucConfig = '{{ eucConfig }}' WHERE locationsId = '{{ locationsId }}' AND notebookRuntimeTemplatesId = '{{ notebookRuntimeTemplatesId }}' diff --git a/docs/google-docs/providers/google/aiplatform/operations/index.md b/docs/google-docs/providers/google/aiplatform/operations/index.md index d7da65d1c0..a662882a6d 100644 --- a/docs/google-docs/providers/google/aiplatform/operations/index.md +++ b/docs/google-docs/providers/google/aiplatform/operations/index.md @@ -40,11 +40,11 @@ Creates, updates, deletes, gets or lists a operations resource. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | 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. | -| | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | -| | `DELETE` | | 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`. | -| | `EXEC` | | 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`. | -| | `EXEC` | | 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. | +| | `SELECT` | | 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. | +| | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| | `DELETE` | | 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`. | +| | `EXEC` | | 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`. | +| | `EXEC` | | 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. | ## `SELECT` examples @@ -58,9 +58,8 @@ error, metadata, response FROM google.aiplatform.operations -WHERE executionsId = '{{ executionsId }}' +WHERE indexEndpointsId = '{{ indexEndpointsId }}' AND locationsId = '{{ locationsId }}' -AND metadataStoresId = '{{ metadataStoresId }}' AND projectsId = '{{ projectsId }}'; ``` @@ -71,9 +70,8 @@ Deletes the specified operations resource. ```sql /*+ delete */ DELETE FROM google.aiplatform.operations -WHERE executionsId = '{{ executionsId }}' +WHERE indexEndpointsId = '{{ indexEndpointsId }}' AND locationsId = '{{ locationsId }}' -AND metadataStoresId = '{{ metadataStoresId }}' AND operationsId = '{{ operationsId }}' AND projectsId = '{{ projectsId }}'; ``` diff --git a/docs/google-docs/providers/google/aiplatform/persistent_resources/index.md b/docs/google-docs/providers/google/aiplatform/persistent_resources/index.md index 9495273a76..68efac7c33 100644 --- a/docs/google-docs/providers/google/aiplatform/persistent_resources/index.md +++ b/docs/google-docs/providers/google/aiplatform/persistent_resources/index.md @@ -103,86 +103,86 @@ Use the following StackQL query and manifest file to create a new persiste INSERT INTO google.aiplatform.persistent_resources ( locationsId, projectsId, -resourcePools, -displayName, -network, -resourceRuntimeSpec, +encryptionSpec, labels, -reservedIpRanges, +resourceRuntimeSpec, name, -encryptionSpec +reservedIpRanges, +network, +resourcePools, +displayName ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ resourcePools }}', -'{{ displayName }}', -'{{ network }}', -'{{ resourceRuntimeSpec }}', +'{{ encryptionSpec }}', '{{ labels }}', -'{{ reservedIpRanges }}', +'{{ resourceRuntimeSpec }}', '{{ name }}', -'{{ encryptionSpec }}' +'{{ reservedIpRanges }}', +'{{ network }}', +'{{ resourcePools }}', +'{{ displayName }}' ; ``` ```yaml -updateTime: string +state: string +encryptionSpec: + kmsKeyName: string +satisfiesPzs: boolean +error: + code: integer + message: string + details: + - additionalProperties: any + type: string +satisfiesPzi: boolean +createTime: string +labels: object +startTime: string +resourceRuntimeSpec: + raySpec: + imageUri: string + rayMetricSpec: + disabled: boolean + resourcePoolImages: object + headNodeResourcePoolId: string + rayLogsSpec: + disabled: boolean + serviceAccountSpec: + serviceAccount: string + enableCustomServiceAccount: boolean +name: string +reservedIpRanges: + - type: string +network: string resourcePools: - - usedReplicaCount: string - replicaCount: string - id: string + - replicaCount: string diskSpec: bootDiskType: string bootDiskSizeGb: integer + usedReplicaCount: string machineSpec: acceleratorCount: integer + tpuTopology: string + machineType: string + acceleratorType: string reservationAffinity: - key: string reservationAffinityType: string values: - type: string - tpuTopology: string - acceleratorType: string - machineType: string + key: string + id: string autoscalingSpec: - minReplicaCount: string maxReplicaCount: string -error: - message: string - code: integer - details: - - additionalProperties: any - type: string -satisfiesPzs: boolean + minReplicaCount: string displayName: string -network: string -resourceRuntimeSpec: - serviceAccountSpec: - enableCustomServiceAccount: boolean - serviceAccount: string - raySpec: - resourcePoolImages: object - rayMetricSpec: - disabled: boolean - imageUri: string - rayLogsSpec: - disabled: boolean - headNodeResourcePoolId: string -createTime: string resourceRuntime: accessUris: object -state: string -satisfiesPzi: boolean -startTime: string -labels: object -reservedIpRanges: - - type: string -name: string -encryptionSpec: - kmsKeyName: string +updateTime: string ``` @@ -196,14 +196,14 @@ Updates a persistent_resources resource. /*+ update */ UPDATE google.aiplatform.persistent_resources SET -resourcePools = '{{ resourcePools }}', -displayName = '{{ displayName }}', -network = '{{ network }}', -resourceRuntimeSpec = '{{ resourceRuntimeSpec }}', +encryptionSpec = '{{ encryptionSpec }}', labels = '{{ labels }}', -reservedIpRanges = '{{ reservedIpRanges }}', +resourceRuntimeSpec = '{{ resourceRuntimeSpec }}', name = '{{ name }}', -encryptionSpec = '{{ encryptionSpec }}' +reservedIpRanges = '{{ reservedIpRanges }}', +network = '{{ network }}', +resourcePools = '{{ resourcePools }}', +displayName = '{{ displayName }}' WHERE locationsId = '{{ locationsId }}' AND persistentResourcesId = '{{ persistentResourcesId }}' diff --git a/docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md b/docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md index 1ee41f0db7..b2fe9c9915 100644 --- a/docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md +++ b/docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md @@ -112,119 +112,119 @@ Use the following StackQL query and manifest file to create a new pipeline INSERT INTO google.aiplatform.pipeline_jobs ( locationsId, projectsId, -runtimeConfig, -labels, -templateUri, +pipelineSpec, displayName, -encryptionSpec, network, -reservedIpRanges, -pipelineSpec, preflightValidations, -serviceAccount +labels, +templateUri, +serviceAccount, +reservedIpRanges, +encryptionSpec, +runtimeConfig ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ runtimeConfig }}', -'{{ labels }}', -'{{ templateUri }}', +'{{ pipelineSpec }}', '{{ displayName }}', -'{{ encryptionSpec }}', '{{ network }}', -'{{ reservedIpRanges }}', -'{{ pipelineSpec }}', true|false, -'{{ serviceAccount }}' +'{{ labels }}', +'{{ templateUri }}', +'{{ serviceAccount }}', +'{{ reservedIpRanges }}', +'{{ encryptionSpec }}', +'{{ runtimeConfig }}' ; ``` ```yaml -runtimeConfig: - gcsOutputDirectory: string - parameters: object - inputArtifacts: object - failurePolicy: string - parameterValues: object -labels: object -templateUri: string -state: string -name: string +pipelineSpec: object displayName: string -encryptionSpec: - kmsKeyName: string -updateTime: string +templateMetadata: + version: string +network: string +preflightValidations: boolean startTime: string +labels: object createTime: string +updateTime: string +templateUri: string +scheduleName: string +name: string error: - message: string code: integer + message: string details: - additionalProperties: any type: string -templateMetadata: - version: string -network: string -reservedIpRanges: - - type: string -pipelineSpec: object -preflightValidations: boolean -serviceAccount: string -scheduleName: string +endTime: string +state: string jobDetail: + pipelineRunContext: + parentContexts: + - type: string + schemaVersion: string + etag: string + schemaTitle: string + description: string + updateTime: string + name: string + labels: object + displayName: string + metadata: object + createTime: string taskDetails: - - endTime: string - executorDetail: + - executorDetail: containerDetail: - mainJob: string - preCachingCheckJob: string failedPreCachingCheckJobs: - type: string + mainJob: string + preCachingCheckJob: string failedMainJobs: - type: string customJobDetail: failedJobs: - type: string job: string - state: string - outputs: object - taskName: string inputs: object - taskId: string - parentTaskId: string - startTime: string execution: + schemaVersion: string + metadata: object + createTime: string + labels: object name: string + updateTime: string + displayName: string description: string state: string - labels: object - createTime: string - displayName: string - schemaVersion: string schemaTitle: string etag: string - updateTime: string - metadata: object - createTime: string pipelineTaskStatus: - - state: string - updateTime: string - pipelineContext: - description: string - updateTime: string - displayName: string - parentContexts: - - type: string - createTime: string - labels: object - name: string - schemaTitle: string - metadata: object - etag: string - schemaVersion: string -endTime: string + - updateTime: string + state: string + taskName: string + createTime: string + outputs: object + endTime: string + parentTaskId: string + state: string + startTime: string + taskId: string +serviceAccount: string +reservedIpRanges: + - type: string +encryptionSpec: + kmsKeyName: string +runtimeConfig: + failurePolicy: string + inputArtifacts: object + parameters: object + parameterValues: object + gcsOutputDirectory: string ``` diff --git a/docs/google-docs/providers/google/aiplatform/runs/index.md b/docs/google-docs/providers/google/aiplatform/runs/index.md index a4dfa23d78..ab1283126a 100644 --- a/docs/google-docs/providers/google/aiplatform/runs/index.md +++ b/docs/google-docs/providers/google/aiplatform/runs/index.md @@ -105,16 +105,16 @@ SELECT ```yaml requests: - - tensorboardRun: + - tensorboardRunId: string + parent: string + tensorboardRun: createTime: string - name: string updateTime: string - displayName: string - etag: string description: string labels: object - tensorboardRunId: string - parent: string + name: string + etag: string + displayName: string ``` @@ -128,10 +128,10 @@ Updates a runs resource. /*+ update */ UPDATE google.aiplatform.runs SET -displayName = '{{ displayName }}', -etag = '{{ etag }}', description = '{{ description }}', -labels = '{{ labels }}' +labels = '{{ labels }}', +etag = '{{ etag }}', +displayName = '{{ displayName }}' WHERE experimentsId = '{{ experimentsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/schedules/index.md b/docs/google-docs/providers/google/aiplatform/schedules/index.md index c339f49aed..56c6d5e762 100644 --- a/docs/google-docs/providers/google/aiplatform/schedules/index.md +++ b/docs/google-docs/providers/google/aiplatform/schedules/index.md @@ -110,30 +110,30 @@ Use the following StackQL query and manifest file to create a new schedule INSERT INTO google.aiplatform.schedules ( locationsId, projectsId, -maxRunCount, +displayName, allowQueueing, -createNotebookExecutionJobRequest, cron, endTime, +createNotebookExecutionJobRequest, +maxConcurrentRunCount, +maxRunCount, startTime, -createPipelineJobRequest, name, -displayName, -maxConcurrentRunCount +createPipelineJobRequest ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ maxRunCount }}', +'{{ displayName }}', true|false, -'{{ createNotebookExecutionJobRequest }}', '{{ cron }}', '{{ endTime }}', +'{{ createNotebookExecutionJobRequest }}', +'{{ maxConcurrentRunCount }}', +'{{ maxRunCount }}', '{{ startTime }}', -'{{ createPipelineJobRequest }}', '{{ name }}', -'{{ displayName }}', -'{{ maxConcurrentRunCount }}' +'{{ createPipelineJobRequest }}' ; ``` @@ -141,135 +141,135 @@ true|false, ```yaml lastPauseTime: string -catchUp: boolean -maxRunCount: string +displayName: string +nextRunTime: string +lastScheduledRunResponse: + runResponse: string + scheduledRunTime: string allowQueueing: boolean +createTime: string +startedRunCount: string +lastResumeTime: string +cron: string +endTime: string createNotebookExecutionJobRequest: + notebookExecutionJobId: string + parent: string notebookExecutionJob: - updateTime: string - createTime: string - notebookRuntimeTemplateResourceName: string - executionTimeout: string - gcsOutputUri: string - serviceAccount: string - encryptionSpec: - kmsKeyName: string - displayName: string - dataformRepositorySource: - commitSha: string - dataformRepositoryResourceName: string - executionUser: string scheduleResourceName: string - name: string - gcsNotebookSource: - generation: string - uri: string + executionTimeout: string + notebookRuntimeTemplateResourceName: string + createTime: string labels: object directNotebookSource: content: string + name: string + displayName: string + updateTime: string + serviceAccount: string status: - message: string code: integer + message: string details: - additionalProperties: any type: string jobState: string - parent: string - notebookExecutionJobId: string + gcsNotebookSource: + uri: string + generation: string + executionUser: string + gcsOutputUri: string + encryptionSpec: + kmsKeyName: string + dataformRepositorySource: + commitSha: string + dataformRepositoryResourceName: string +catchUp: boolean +maxConcurrentRunCount: string state: string -cron: string -endTime: string +maxRunCount: string startTime: string +name: string createPipelineJobRequest: pipelineJobId: string parent: string pipelineJob: - runtimeConfig: - gcsOutputDirectory: string - parameters: object - inputArtifacts: object - failurePolicy: string - parameterValues: object - labels: object - templateUri: string - state: string - name: string + pipelineSpec: object displayName: string - updateTime: string - startTime: string - createTime: string templateMetadata: version: string network: string - reservedIpRanges: - - type: string - pipelineSpec: object preflightValidations: boolean - serviceAccount: string + startTime: string + labels: object + createTime: string + updateTime: string + templateUri: string scheduleName: string + name: string + endTime: string + state: string jobDetail: + pipelineRunContext: + parentContexts: + - type: string + schemaVersion: string + etag: string + schemaTitle: string + description: string + updateTime: string + name: string + labels: object + displayName: string + metadata: object + createTime: string taskDetails: - - endTime: string - executorDetail: + - executorDetail: containerDetail: - mainJob: string - preCachingCheckJob: string failedPreCachingCheckJobs: - type: string + mainJob: string + preCachingCheckJob: string failedMainJobs: - type: string customJobDetail: failedJobs: - type: string job: string - state: string - outputs: object - taskName: string inputs: object - taskId: string - parentTaskId: string - startTime: string execution: + schemaVersion: string + metadata: object + createTime: string + labels: object name: string + updateTime: string + displayName: string description: string state: string - labels: object - createTime: string - displayName: string - schemaVersion: string schemaTitle: string etag: string - updateTime: string - metadata: object - createTime: string pipelineTaskStatus: - - state: string - updateTime: string - pipelineContext: - description: string - updateTime: string - displayName: string - parentContexts: - - type: string - createTime: string - labels: object - name: string - schemaTitle: string - metadata: object - etag: string - schemaVersion: string - endTime: string -name: string -lastResumeTime: string -createTime: string -displayName: string + - updateTime: string + state: string + taskName: string + createTime: string + outputs: object + endTime: string + parentTaskId: string + state: string + startTime: string + taskId: string + serviceAccount: string + reservedIpRanges: + - type: string + runtimeConfig: + failurePolicy: string + inputArtifacts: object + parameters: object + parameterValues: object + gcsOutputDirectory: string updateTime: string -maxConcurrentRunCount: string -nextRunTime: string -lastScheduledRunResponse: - scheduledRunTime: string - runResponse: string -startedRunCount: string ``` @@ -283,16 +283,16 @@ Updates a schedules resource. /*+ update */ UPDATE google.aiplatform.schedules SET -maxRunCount = '{{ maxRunCount }}', +displayName = '{{ displayName }}', allowQueueing = true|false, -createNotebookExecutionJobRequest = '{{ createNotebookExecutionJobRequest }}', cron = '{{ cron }}', endTime = '{{ endTime }}', +createNotebookExecutionJobRequest = '{{ createNotebookExecutionJobRequest }}', +maxConcurrentRunCount = '{{ maxConcurrentRunCount }}', +maxRunCount = '{{ maxRunCount }}', startTime = '{{ startTime }}', -createPipelineJobRequest = '{{ createPipelineJobRequest }}', name = '{{ name }}', -displayName = '{{ displayName }}', -maxConcurrentRunCount = '{{ maxConcurrentRunCount }}' +createPipelineJobRequest = '{{ createPipelineJobRequest }}' WHERE locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/specialist_pools/index.md b/docs/google-docs/providers/google/aiplatform/specialist_pools/index.md index bc71bbdcbe..1828c34d1a 100644 --- a/docs/google-docs/providers/google/aiplatform/specialist_pools/index.md +++ b/docs/google-docs/providers/google/aiplatform/specialist_pools/index.md @@ -83,32 +83,32 @@ INSERT INTO google.aiplatform.specialist_pools ( locationsId, projectsId, specialistManagerEmails, -specialistWorkerEmails, displayName, -name +name, +specialistWorkerEmails ) SELECT '{{ locationsId }}', '{{ projectsId }}', '{{ specialistManagerEmails }}', -'{{ specialistWorkerEmails }}', '{{ displayName }}', -'{{ name }}' +'{{ name }}', +'{{ specialistWorkerEmails }}' ; ``` ```yaml -pendingDataLabelingJobs: - - type: string specialistManagerEmails: - type: string -specialistManagersCount: integer -specialistWorkerEmails: - - type: string displayName: string name: string +pendingDataLabelingJobs: + - type: string +specialistWorkerEmails: + - type: string +specialistManagersCount: integer ``` @@ -123,9 +123,9 @@ Updates a specialist_pools resource. UPDATE google.aiplatform.specialist_pools SET specialistManagerEmails = '{{ specialistManagerEmails }}', -specialistWorkerEmails = '{{ specialistWorkerEmails }}', displayName = '{{ displayName }}', -name = '{{ name }}' +name = '{{ name }}', +specialistWorkerEmails = '{{ specialistWorkerEmails }}' WHERE locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/studies/index.md b/docs/google-docs/providers/google/aiplatform/studies/index.md index dc8bbcc0ca..0cd57ea424 100644 --- a/docs/google-docs/providers/google/aiplatform/studies/index.md +++ b/docs/google-docs/providers/google/aiplatform/studies/index.md @@ -82,14 +82,14 @@ Use the following StackQL query and manifest file to create a new studies< INSERT INTO google.aiplatform.studies ( locationsId, projectsId, -displayName, -studySpec +studySpec, +displayName ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ displayName }}', -'{{ studySpec }}' +'{{ studySpec }}', +'{{ displayName }}' ; ``` @@ -97,76 +97,76 @@ SELECT ```yaml name: string -displayName: string -createTime: string +inactiveReason: string +state: string studySpec: - metrics: - - goal: string - metricId: string - safetyConfig: - desiredMinSafeTrialsFraction: number - safetyThreshold: number - observationNoise: string parameters: - - conditionalParameterSpecs: - - parentIntValues: + - discreteValueSpec: + values: + - type: string + format: string + defaultValue: number + categoricalValueSpec: + defaultValue: string + values: + - type: string + conditionalParameterSpecs: + - parentCategoricalValues: + values: + - type: string + parentDiscreteValues: values: - - format: string - type: string + - type: string + format: string parameterSpec: conditionalParameterSpecs: - - parentDiscreteValues: + - parentIntValues: values: - - type: string - format: string - parentCategoricalValues: - values: - - type: string + - format: string + type: string + scaleType: string integerValueSpec: maxValue: string defaultValue: string minValue: string - discreteValueSpec: - defaultValue: number - values: - - format: string - type: string + parameterId: string doubleValueSpec: defaultValue: number maxValue: number minValue: number - categoricalValueSpec: - defaultValue: string - values: - - type: string - parameterId: string - scaleType: string - parameterId: string scaleType: string + parameterId: string decayCurveStoppingSpec: useElapsedDuration: boolean - convexAutomatedStoppingSpec: + observationNoise: string + measurementSelectionType: string + medianAutomatedStoppingSpec: useElapsedDuration: boolean - minStepCount: string + convexAutomatedStoppingSpec: maxStepCount: string - learningRateParameterName: string updateAllStoppedTrials: boolean - minMeasurementCount: string - algorithm: string - medianAutomatedStoppingSpec: + minStepCount: string + learningRateParameterName: string useElapsedDuration: boolean - measurementSelectionType: string + minMeasurementCount: string + metrics: + - goal: string + metricId: string + safetyConfig: + desiredMinSafeTrialsFraction: number + safetyThreshold: number studyStoppingConfig: - minNumTrials: integer - shouldStopAsap: boolean + maxNumTrials: integer maxNumTrialsNoProgress: integer + shouldStopAsap: boolean maximumRuntimeConstraint: maxDuration: string endTime: string + minNumTrials: integer maxDurationNoProgress: string - maxNumTrials: integer -state: string -inactiveReason: string + algorithm: string +displayName: string +createTime: string ``` diff --git a/docs/google-docs/providers/google/aiplatform/tensorboards/index.md b/docs/google-docs/providers/google/aiplatform/tensorboards/index.md index f0c5550358..cee057dc3c 100644 --- a/docs/google-docs/providers/google/aiplatform/tensorboards/index.md +++ b/docs/google-docs/providers/google/aiplatform/tensorboards/index.md @@ -99,42 +99,42 @@ Use the following StackQL query and manifest file to create a new tensorbo INSERT INTO google.aiplatform.tensorboards ( locationsId, projectsId, +etag, +displayName, +labels, description, isDefault, -displayName, -encryptionSpec, -etag, -labels +encryptionSpec ) SELECT '{{ locationsId }}', '{{ projectsId }}', +'{{ etag }}', +'{{ displayName }}', +'{{ labels }}', '{{ description }}', true|false, -'{{ displayName }}', -'{{ encryptionSpec }}', -'{{ etag }}', -'{{ labels }}' +'{{ encryptionSpec }}' ; ``` ```yaml +blobStoragePathPrefix: string runCount: integer satisfiesPzi: boolean -createTime: string -description: string -isDefault: boolean name: string -displayName: string -encryptionSpec: - kmsKeyName: string -blobStoragePathPrefix: string etag: string updateTime: string satisfiesPzs: boolean +displayName: string labels: object +description: string +createTime: string +isDefault: boolean +encryptionSpec: + kmsKeyName: string ``` @@ -148,12 +148,12 @@ Updates a tensorboards resource. /*+ update */ UPDATE google.aiplatform.tensorboards SET +etag = '{{ etag }}', +displayName = '{{ displayName }}', +labels = '{{ labels }}', description = '{{ description }}', isDefault = true|false, -displayName = '{{ displayName }}', -encryptionSpec = '{{ encryptionSpec }}', -etag = '{{ etag }}', -labels = '{{ labels }}' +encryptionSpec = '{{ encryptionSpec }}' WHERE locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/time_series/index.md b/docs/google-docs/providers/google/aiplatform/time_series/index.md index 025bbc9e58..974eccc6ac 100644 --- a/docs/google-docs/providers/google/aiplatform/time_series/index.md +++ b/docs/google-docs/providers/google/aiplatform/time_series/index.md @@ -100,11 +100,11 @@ projectsId, runsId, tensorboardsId, description, -pluginName, pluginData, valueType, etag, -displayName +displayName, +pluginName ) SELECT '{{ experimentsId }}', @@ -113,30 +113,30 @@ SELECT '{{ runsId }}', '{{ tensorboardsId }}', '{{ description }}', -'{{ pluginName }}', '{{ pluginData }}', '{{ valueType }}', '{{ etag }}', -'{{ displayName }}' +'{{ displayName }}', +'{{ pluginName }}' ; ``` ```yaml -description: string -createTime: string -pluginName: string -pluginData: string metadata: + maxStep: string maxWallTime: string maxBlobSequenceLength: string - maxStep: string -updateTime: string +description: string +pluginData: string name: string valueType: string etag: string displayName: string +pluginName: string +updateTime: string +createTime: string ``` @@ -151,11 +151,11 @@ Updates a time_series resource. UPDATE google.aiplatform.time_series SET description = '{{ description }}', -pluginName = '{{ pluginName }}', pluginData = '{{ pluginData }}', valueType = '{{ valueType }}', etag = '{{ etag }}', -displayName = '{{ displayName }}' +displayName = '{{ displayName }}', +pluginName = '{{ pluginName }}' WHERE experimentsId = '{{ experimentsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/aiplatform/training_pipelines/index.md b/docs/google-docs/providers/google/aiplatform/training_pipelines/index.md index 771c3fd513..7068322cbc 100644 --- a/docs/google-docs/providers/google/aiplatform/training_pipelines/index.md +++ b/docs/google-docs/providers/google/aiplatform/training_pipelines/index.md @@ -104,204 +104,204 @@ Use the following StackQL query and manifest file to create a new training INSERT INTO google.aiplatform.training_pipelines ( locationsId, projectsId, -trainingTaskDefinition, -inputDataConfig, -parentModel, -modelToUpload, +displayName, labels, modelId, +modelToUpload, encryptionSpec, -trainingTaskInputs, -displayName +inputDataConfig, +trainingTaskDefinition, +parentModel, +trainingTaskInputs ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ trainingTaskDefinition }}', -'{{ inputDataConfig }}', -'{{ parentModel }}', -'{{ modelToUpload }}', +'{{ displayName }}', '{{ labels }}', '{{ modelId }}', +'{{ modelToUpload }}', '{{ encryptionSpec }}', -'{{ trainingTaskInputs }}', -'{{ displayName }}' +'{{ inputDataConfig }}', +'{{ trainingTaskDefinition }}', +'{{ parentModel }}', +'{{ trainingTaskInputs }}' ; ``` ```yaml +displayName: string +state: string +labels: object +modelId: string +updateTime: string +error: + code: integer + message: string + details: + - additionalProperties: any + type: string createTime: string -startTime: string -trainingTaskDefinition: string -inputDataConfig: - stratifiedSplit: - key: string - trainingFraction: number - testFraction: number - validationFraction: number - timestampSplit: - validationFraction: number - key: string - trainingFraction: number - testFraction: number - predefinedSplit: - key: string - gcsDestination: - outputUriPrefix: string - datasetId: string - filterSplit: - validationFilter: string - testFilter: string - trainingFilter: string - annotationsFilter: string - fractionSplit: - trainingFraction: number - validationFraction: number - testFraction: number - bigqueryDestination: - outputUri: string - savedQueryId: string - persistMlUseAssignment: boolean - annotationSchemaUri: string trainingTaskMetadata: any -parentModel: string -endTime: string modelToUpload: - dataStats: - testAnnotationsCount: string - trainingAnnotationsCount: string - trainingDataItemsCount: string - testDataItemsCount: string - validationDataItemsCount: string - validationAnnotationsCount: string - supportedDeploymentResourcesTypes: - - enum: string - type: string - enumDescriptions: string - versionId: string - createTime: string - satisfiesPzi: boolean - containerSpec: - startupProbe: - timeoutSeconds: integer - periodSeconds: integer - exec: - command: - - type: string - imageUri: string - grpcPorts: - - containerPort: integer - command: - - type: string - sharedMemorySizeMb: string - deploymentTimeout: string - healthRoute: string - predictRoute: string - args: - - type: string - env: - - value: string - name: string - ports: - - containerPort: integer - versionAliases: - - type: string - deployedModels: - - deployedModelId: string - endpoint: string - baseModelSource: - modelGardenSource: - publicModelName: string - genieSource: - baseModelUri: string - versionCreateTime: string - etag: string - predictSchemata: - predictionSchemaUri: string - instanceSchemaUri: string - parametersSchemaUri: string - modelSourceInfo: - sourceType: string - copy: boolean - supportedOutputStorageFormats: - - type: string - metadata: any - metadataSchemaUri: string - supportedExportFormats: - - id: string - exportableContents: - - type: string - enum: string - enumDescriptions: string - artifactUri: string - supportedInputStorageFormats: - - type: string + pipelineJob: string explanationSpec: metadata: - outputs: object + latentSpaceSource: string featureAttributionsSchemaUri: string + outputs: object inputs: object - latentSpaceSource: string parameters: + integratedGradientsAttribution: + blurBaselineConfig: + maxBlurSigma: number + smoothGradConfig: + featureNoiseSigma: + noiseSigma: + - name: string + sigma: number + noisySampleCount: integer + noiseSigma: number + stepCount: integer topK: integer + outputIndices: + - type: string + sampledShapleyAttribution: + pathCount: integer + xraiAttribution: + stepCount: integer examples: nearestNeighborSearchConfig: any neighborCount: integer exampleGcsSource: - dataFormat: string gcsSource: uris: - type: string + dataFormat: string presets: modality: string query: string - sampledShapleyAttribution: - pathCount: integer - xraiAttribution: - smoothGradConfig: - featureNoiseSigma: - noiseSigma: - - sigma: number - name: string - noisySampleCount: integer - noiseSigma: number - stepCount: integer - blurBaselineConfig: - maxBlurSigma: number - outputIndices: - - type: string - integratedGradientsAttribution: - stepCount: integer - satisfiesPzs: boolean - versionUpdateTime: string - updateTime: string - description: string - trainingPipeline: string - labels: object + supportedOutputStorageFormats: + - type: string + name: string versionDescription: string - metadataArtifact: string - pipelineJob: string - displayName: string encryptionSpec: kmsKeyName: string - name: string originalModelInfo: model: string -updateTime: string -labels: object -modelId: string -state: string -trainingTaskInputs: any -displayName: string -name: string -error: - message: string - code: integer - details: - - additionalProperties: any + satisfiesPzs: boolean + supportedInputStorageFormats: + - type: string + artifactUri: string + metadataArtifact: string + predictSchemata: + instanceSchemaUri: string + predictionSchemaUri: string + parametersSchemaUri: string + createTime: string + etag: string + containerSpec: + imageUri: string + healthRoute: string + env: + - value: string + name: string + ports: + - containerPort: integer + args: + - type: string + command: + - type: string + deploymentTimeout: string + startupProbe: + exec: + command: + - type: string + timeoutSeconds: integer + periodSeconds: integer + grpcPorts: + - containerPort: integer + sharedMemorySizeMb: string + predictRoute: string + baseModelSource: + genieSource: + baseModelUri: string + modelGardenSource: + publicModelName: string + labels: object + versionUpdateTime: string + satisfiesPzi: boolean + deployedModels: + - endpoint: string + deployedModelId: string + dataStats: + validationDataItemsCount: string + testDataItemsCount: string + validationAnnotationsCount: string + testAnnotationsCount: string + trainingDataItemsCount: string + trainingAnnotationsCount: string + description: string + versionAliases: + - type: string + metadataSchemaUri: string + metadata: any + supportedDeploymentResourcesTypes: + - enumDescriptions: string + enum: string type: string + displayName: string + versionCreateTime: string + versionId: string + supportedExportFormats: + - exportableContents: + - enumDescriptions: string + enum: string + type: string + id: string + updateTime: string + trainingPipeline: string + modelSourceInfo: + sourceType: string + copy: boolean +name: string +inputDataConfig: + stratifiedSplit: + testFraction: number + key: string + validationFraction: number + trainingFraction: number + fractionSplit: + trainingFraction: number + validationFraction: number + testFraction: number + datasetId: string + savedQueryId: string + filterSplit: + trainingFilter: string + validationFilter: string + testFilter: string + annotationSchemaUri: string + persistMlUseAssignment: boolean + gcsDestination: + outputUriPrefix: string + bigqueryDestination: + outputUri: string + predefinedSplit: + key: string + timestampSplit: + trainingFraction: number + key: string + validationFraction: number + testFraction: number + annotationsFilter: string +startTime: string +trainingTaskDefinition: string +endTime: string +parentModel: string +trainingTaskInputs: any ``` diff --git a/docs/google-docs/providers/google/aiplatform/trials/index.md b/docs/google-docs/providers/google/aiplatform/trials/index.md index 05adb5bfc7..84dc2c6997 100644 --- a/docs/google-docs/providers/google/aiplatform/trials/index.md +++ b/docs/google-docs/providers/google/aiplatform/trials/index.md @@ -110,30 +110,30 @@ SELECT ```yaml -state: string -startTime: string +id: string +clientId: string +name: string +customJob: string finalMeasurement: stepCount: string + elapsedDuration: string metrics: - value: number metricId: string - elapsedDuration: string -clientId: string -id: string +startTime: string measurements: - stepCount: string + elapsedDuration: string metrics: - value: number metricId: string - elapsedDuration: string +state: string +endTime: string webAccessUris: object parameters: - value: any parameterId: string -endTime: string infeasibleReason: string -name: string -customJob: string ``` diff --git a/docs/google-docs/providers/google/aiplatform/trials_trial_measurement/index.md b/docs/google-docs/providers/google/aiplatform/trials_trial_measurement/index.md index b7662dd78f..1181bde164 100644 --- a/docs/google-docs/providers/google/aiplatform/trials_trial_measurement/index.md +++ b/docs/google-docs/providers/google/aiplatform/trials_trial_measurement/index.md @@ -73,10 +73,10 @@ SELECT ```yaml measurement: stepCount: string + elapsedDuration: string metrics: - value: number metricId: string - elapsedDuration: string ``` diff --git a/docs/google-docs/providers/google/aiplatform/tuning_jobs/index.md b/docs/google-docs/providers/google/aiplatform/tuning_jobs/index.md index 70d8cdf7e8..30881061b0 100644 --- a/docs/google-docs/providers/google/aiplatform/tuning_jobs/index.md +++ b/docs/google-docs/providers/google/aiplatform/tuning_jobs/index.md @@ -42,7 +42,7 @@ Creates, updates, deletes, gets or lists a tuning_jobs resource. | | `object` | 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. | | | `string` | Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. | | | `string` | Output only. The detailed state of the job. | -| | `object` | Tuning Spec for Supervised Tuning. | +| | `object` | Tuning Spec for Supervised Tuning for first party models. | | | `object` | The Model Registry Model and Online Prediction Endpoint assiociated with this TuningJob. | | | `string` | Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. | | | `object` | The tuning data statistic values for TuningJob. | @@ -101,100 +101,100 @@ Use the following StackQL query and manifest file to create a new tuning_j INSERT INTO google.aiplatform.tuning_jobs ( locationsId, projectsId, -supervisedTuningSpec, +baseModel, encryptionSpec, -tunedModelDisplayName, +supervisedTuningSpec, description, -baseModel, -labels +labels, +tunedModelDisplayName ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ supervisedTuningSpec }}', +'{{ baseModel }}', '{{ encryptionSpec }}', -'{{ tunedModelDisplayName }}', +'{{ supervisedTuningSpec }}', '{{ description }}', -'{{ baseModel }}', -'{{ labels }}' +'{{ labels }}', +'{{ tunedModelDisplayName }}' ; ``` ```yaml -supervisedTuningSpec: - validationDatasetUri: string - trainingDatasetUri: string - hyperParameters: - adapterSize: string - learningRateMultiplier: number - epochCount: string +state: string +tunedModel: + model: string + endpoint: string +endTime: string +baseModel: string tuningDataStats: supervisedTuningDataStats: - tuningDatasetExampleCount: string + totalTruncatedExampleCount: string + totalTuningCharacterCount: string + totalBillableTokenCount: string + truncatedExampleIndices: + - format: string + type: string tuningStepCount: string - userOutputTokenDistribution: + userMessagePerExampleDistribution: + p95: number + min: number sum: string - p5: number - mean: number billableSum: string max: number + median: number + mean: number + p5: number buckets: - - count: number + - left: number + count: number right: number - left: number - median: number - p95: number - min: number - totalBillableCharacterCount: string - totalTruncatedExampleCount: string userDatasetExamples: - role: string parts: - - videoMetadata: - endOffset: string - startOffset: string + - fileData: + mimeType: string + fileUri: string functionCall: - name: string args: object + name: string + videoMetadata: + endOffset: string + startOffset: string + text: string inlineData: - mimeType: string data: string - text: string + mimeType: string functionResponse: - response: object name: string - fileData: - fileUri: string - mimeType: string - totalBillableTokenCount: string - truncatedExampleIndices: - - format: string - type: string - totalTuningCharacterCount: string -name: string -state: string -updateTime: string -tunedModel: - model: string - endpoint: string -encryptionSpec: - kmsKeyName: string -tunedModelDisplayName: string -endTime: string -experiment: string + response: object + tuningDatasetExampleCount: string + totalBillableCharacterCount: string +createTime: string error: - message: string code: integer + message: string details: - additionalProperties: any type: string -description: string +encryptionSpec: + kmsKeyName: string startTime: string -createTime: string -baseModel: string +supervisedTuningSpec: + hyperParameters: + adapterSize: string + learningRateMultiplier: number + epochCount: string + validationDatasetUri: string + trainingDatasetUri: string +name: string +description: string labels: object +updateTime: string +experiment: string +tunedModelDisplayName: string ``` diff --git a/docs/google-docs/providers/google/apigee/aliases/index.md b/docs/google-docs/providers/google/apigee/aliases/index.md index aa3cddace5..c02043fe18 100644 --- a/docs/google-docs/providers/google/apigee/aliases/index.md +++ b/docs/google-docs/providers/google/apigee/aliases/index.md @@ -80,16 +80,16 @@ environmentsId, keystoresId, organizationsId, contentType, -extensions, -data +data, +extensions ) SELECT '{{ environmentsId }}', '{{ keystoresId }}', '{{ organizationsId }}', '{{ contentType }}', -'{{ extensions }}', -'{{ data }}' +'{{ data }}', +'{{ extensions }}' ; ``` @@ -97,10 +97,10 @@ SELECT ```yaml contentType: string +data: string extensions: - additionalProperties: any type: string -data: string ``` @@ -115,8 +115,8 @@ Replaces all fields in the specified aliases resource. REPLACE google.apigee.aliases SET contentType = '{{ contentType }}', -extensions = '{{ extensions }}', -data = '{{ data }}' +data = '{{ data }}', +extensions = '{{ extensions }}' WHERE aliasesId = '{{ aliasesId }}' AND environmentsId = '{{ environmentsId }}' diff --git a/docs/google-docs/providers/google/apigee/apicategories/index.md b/docs/google-docs/providers/google/apigee/apicategories/index.md index 744a21568c..8df8711778 100644 --- a/docs/google-docs/providers/google/apigee/apicategories/index.md +++ b/docs/google-docs/providers/google/apigee/apicategories/index.md @@ -80,24 +80,24 @@ Use the following StackQL query and manifest file to create a new apicateg INSERT INTO google.apigee.apicategories ( organizationsId, sitesId, -siteId, -name +name, +siteId ) SELECT '{{ organizationsId }}', '{{ sitesId }}', -'{{ siteId }}', -'{{ name }}' +'{{ name }}', +'{{ siteId }}' ; ``` ```yaml +updateTime: string +name: string siteId: string id: string -name: string -updateTime: string ``` @@ -111,8 +111,8 @@ Updates a apicategories resource. /*+ update */ UPDATE google.apigee.apicategories SET -siteId = '{{ siteId }}', -name = '{{ name }}' +name = '{{ name }}', +siteId = '{{ siteId }}' WHERE apicategoriesId = '{{ apicategoriesId }}' AND organizationsId = '{{ organizationsId }}' diff --git a/docs/google-docs/providers/google/apigee/apidocs/index.md b/docs/google-docs/providers/google/apigee/apidocs/index.md index 98ed79faab..482e2af984 100644 --- a/docs/google-docs/providers/google/apigee/apidocs/index.md +++ b/docs/google-docs/providers/google/apigee/apidocs/index.md @@ -80,62 +80,62 @@ Use the following StackQL query and manifest file to create a new apidocs< INSERT INTO google.apigee.apidocs ( organizationsId, sitesId, -graphqlEndpointUrl, -anonAllowed, apiProductName, -requireCallbackUrl, -title, -description, graphqlSchema, -graphqlSchemaDisplayName, +anonAllowed, +description, +edgeAPIProductName, published, +visibility, +title, +requireCallbackUrl, +categoryIds, imageUrl, specId, -visibility, -edgeAPIProductName, -categoryIds +graphqlSchemaDisplayName, +graphqlEndpointUrl ) SELECT '{{ organizationsId }}', '{{ sitesId }}', -'{{ graphqlEndpointUrl }}', -true|false, '{{ apiProductName }}', +'{{ graphqlSchema }}', true|false, -'{{ title }}', '{{ description }}', -'{{ graphqlSchema }}', -'{{ graphqlSchemaDisplayName }}', +'{{ edgeAPIProductName }}', true|false, +true|false, +'{{ title }}', +true|false, +'{{ categoryIds }}', '{{ imageUrl }}', '{{ specId }}', -true|false, -'{{ edgeAPIProductName }}', -'{{ categoryIds }}' +'{{ graphqlSchemaDisplayName }}', +'{{ graphqlEndpointUrl }}' ; ``` ```yaml -graphqlEndpointUrl: string -anonAllowed: boolean apiProductName: string -requireCallbackUrl: boolean -siteId: string -title: string -description: string graphqlSchema: string modified: string -graphqlSchemaDisplayName: string -published: boolean +anonAllowed: boolean id: string -imageUrl: string -specId: string -visibility: boolean +description: string edgeAPIProductName: string +published: boolean +visibility: boolean +title: string +requireCallbackUrl: boolean categoryIds: - type: string +imageUrl: string +siteId: string +specId: string +graphqlSchemaDisplayName: string +graphqlEndpointUrl: string ``` @@ -149,20 +149,20 @@ Replaces all fields in the specified apidocs resource. /*+ update */ REPLACE google.apigee.apidocs SET -graphqlEndpointUrl = '{{ graphqlEndpointUrl }}', -anonAllowed = true|false, apiProductName = '{{ apiProductName }}', -requireCallbackUrl = true|false, -title = '{{ title }}', -description = '{{ description }}', graphqlSchema = '{{ graphqlSchema }}', -graphqlSchemaDisplayName = '{{ graphqlSchemaDisplayName }}', +anonAllowed = true|false, +description = '{{ description }}', +edgeAPIProductName = '{{ edgeAPIProductName }}', published = true|false, +visibility = true|false, +title = '{{ title }}', +requireCallbackUrl = true|false, +categoryIds = '{{ categoryIds }}', imageUrl = '{{ imageUrl }}', specId = '{{ specId }}', -visibility = true|false, -edgeAPIProductName = '{{ edgeAPIProductName }}', -categoryIds = '{{ categoryIds }}' +graphqlSchemaDisplayName = '{{ graphqlSchemaDisplayName }}', +graphqlEndpointUrl = '{{ graphqlEndpointUrl }}' WHERE apidocsId = '{{ apidocsId }}' AND organizationsId = '{{ organizationsId }}' diff --git a/docs/google-docs/providers/google/apigee/apiproducts/index.md b/docs/google-docs/providers/google/apigee/apiproducts/index.md index 6bcda0e845..3db695d180 100644 --- a/docs/google-docs/providers/google/apigee/apiproducts/index.md +++ b/docs/google-docs/providers/google/apigee/apiproducts/index.md @@ -107,107 +107,107 @@ Use the following StackQL query and manifest file to create a new apiprodu /*+ create */ INSERT INTO google.apigee.apiproducts ( organizationsId, -displayName, +quota, +lastModifiedAt, +environments, scopes, -apiResources, -quotaInterval, -proxies, -createdAt, -approvalType, -name, attributes, -grpcOperationGroup, quotaTimeUnit, +quotaInterval, description, -quota, -lastModifiedAt, -environments, -graphqlOperationGroup, +grpcOperationGroup, operationGroup, -quotaCounterScope +createdAt, +graphqlOperationGroup, +name, +approvalType, +apiResources, +proxies, +quotaCounterScope, +displayName ) SELECT '{{ organizationsId }}', -'{{ displayName }}', +'{{ quota }}', +'{{ lastModifiedAt }}', +'{{ environments }}', '{{ scopes }}', -'{{ apiResources }}', -'{{ quotaInterval }}', -'{{ proxies }}', -'{{ createdAt }}', -'{{ approvalType }}', -'{{ name }}', '{{ attributes }}', -'{{ grpcOperationGroup }}', '{{ quotaTimeUnit }}', +'{{ quotaInterval }}', '{{ description }}', -'{{ quota }}', -'{{ lastModifiedAt }}', -'{{ environments }}', -'{{ graphqlOperationGroup }}', +'{{ grpcOperationGroup }}', '{{ operationGroup }}', -'{{ quotaCounterScope }}' +'{{ createdAt }}', +'{{ graphqlOperationGroup }}', +'{{ name }}', +'{{ approvalType }}', +'{{ apiResources }}', +'{{ proxies }}', +'{{ quotaCounterScope }}', +'{{ displayName }}' ; ``` ```yaml -displayName: string -scopes: - - type: string -apiResources: +quota: string +lastModifiedAt: string +environments: - type: string -quotaInterval: string -proxies: +scopes: - type: string -createdAt: string -approvalType: string -name: string attributes: - - value: string - name: string + - name: string + value: string +quotaTimeUnit: string +quotaInterval: string +description: string grpcOperationGroup: operationConfigs: - - methods: + - apiSource: string + methods: - type: string - apiSource: string + service: string quota: + timeUnit: string interval: string limit: string - timeUnit: string attributes: - - value: string - name: string - service: string -quotaTimeUnit: string -description: string -quota: string -lastModifiedAt: string -environments: - - type: string -graphqlOperationGroup: + - name: string + value: string +operationGroup: operationConfigs: - - attributes: - - value: string - name: string + - apiSource: string operations: - - operation: string - operationTypes: + - resource: string + methods: - type: string - apiSource: string + attributes: + - name: string + value: string operationConfigType: string -operationGroup: +createdAt: string +graphqlOperationGroup: operationConfigType: string operationConfigs: - - operations: - - methods: - - type: string - resource: string + - attributes: + - name: string + value: string apiSource: string - attributes: - - value: string - name: string + operations: + - operation: string + operationTypes: + - type: string +name: string +approvalType: string +apiResources: + - type: string +proxies: + - type: string quotaCounterScope: string +displayName: string ``` @@ -221,24 +221,24 @@ Replaces all fields in the specified apiproducts resource. /*+ update */ REPLACE google.apigee.apiproducts SET -displayName = '{{ displayName }}', +quota = '{{ quota }}', +lastModifiedAt = '{{ lastModifiedAt }}', +environments = '{{ environments }}', scopes = '{{ scopes }}', -apiResources = '{{ apiResources }}', -quotaInterval = '{{ quotaInterval }}', -proxies = '{{ proxies }}', -createdAt = '{{ createdAt }}', -approvalType = '{{ approvalType }}', -name = '{{ name }}', attributes = '{{ attributes }}', -grpcOperationGroup = '{{ grpcOperationGroup }}', quotaTimeUnit = '{{ quotaTimeUnit }}', +quotaInterval = '{{ quotaInterval }}', description = '{{ description }}', -quota = '{{ quota }}', -lastModifiedAt = '{{ lastModifiedAt }}', -environments = '{{ environments }}', -graphqlOperationGroup = '{{ graphqlOperationGroup }}', +grpcOperationGroup = '{{ grpcOperationGroup }}', operationGroup = '{{ operationGroup }}', -quotaCounterScope = '{{ quotaCounterScope }}' +createdAt = '{{ createdAt }}', +graphqlOperationGroup = '{{ graphqlOperationGroup }}', +name = '{{ name }}', +approvalType = '{{ approvalType }}', +apiResources = '{{ apiResources }}', +proxies = '{{ proxies }}', +quotaCounterScope = '{{ quotaCounterScope }}', +displayName = '{{ displayName }}' WHERE apiproductsId = '{{ apiproductsId }}' AND organizationsId = '{{ organizationsId }}'; diff --git a/docs/google-docs/providers/google/apigee/apis/index.md b/docs/google-docs/providers/google/apigee/apis/index.md index f6417eec03..f8d11aaa2a 100644 --- a/docs/google-docs/providers/google/apigee/apis/index.md +++ b/docs/google-docs/providers/google/apigee/apis/index.md @@ -83,14 +83,14 @@ Use the following StackQL query and manifest file to create a new apis @@ -98,10 +98,10 @@ SELECT ```yaml contentType: string +data: string extensions: - additionalProperties: any type: string -data: string ``` diff --git a/docs/google-docs/providers/google/apigee/appgroups/index.md b/docs/google-docs/providers/google/apigee/appgroups/index.md index d96619d203..3876aac92f 100644 --- a/docs/google-docs/providers/google/apigee/appgroups/index.md +++ b/docs/google-docs/providers/google/apigee/appgroups/index.md @@ -88,41 +88,41 @@ Use the following StackQL query and manifest file to create a new appgroup /*+ create */ INSERT INTO google.apigee.appgroups ( organizationsId, -organization, -channelId, -status, -attributes, name, +displayName, +status, channelUri, -displayName +channelId, +organization, +attributes ) SELECT '{{ organizationsId }}', -'{{ organization }}', -'{{ channelId }}', -'{{ status }}', -'{{ attributes }}', '{{ name }}', +'{{ displayName }}', +'{{ status }}', '{{ channelUri }}', -'{{ displayName }}' +'{{ channelId }}', +'{{ organization }}', +'{{ attributes }}' ; ``` ```yaml -appGroupId: string -organization: string -channelId: string -status: string -attributes: - - value: string - name: string name: string -channelUri: string -lastModifiedAt: string displayName: string +status: string +appGroupId: string createdAt: string +lastModifiedAt: string +channelUri: string +channelId: string +organization: string +attributes: + - name: string + value: string ``` @@ -136,13 +136,13 @@ Replaces all fields in the specified appgroups resource. /*+ update */ REPLACE google.apigee.appgroups SET -organization = '{{ organization }}', -channelId = '{{ channelId }}', -status = '{{ status }}', -attributes = '{{ attributes }}', name = '{{ name }}', +displayName = '{{ displayName }}', +status = '{{ status }}', channelUri = '{{ channelUri }}', -displayName = '{{ displayName }}' +channelId = '{{ channelId }}', +organization = '{{ organization }}', +attributes = '{{ attributes }}' WHERE appgroupsId = '{{ appgroupsId }}' AND organizationsId = '{{ organizationsId }}'; diff --git a/docs/google-docs/providers/google/apigee/apps/index.md b/docs/google-docs/providers/google/apigee/apps/index.md index 4ba2903628..a47fa436f3 100644 --- a/docs/google-docs/providers/google/apigee/apps/index.md +++ b/docs/google-docs/providers/google/apigee/apps/index.md @@ -102,63 +102,63 @@ Use the following StackQL query and manifest file to create a new apps ```yaml -createdAt: string +callbackUrl: string +appId: string apiProducts: - type: string -attributes: - - value: string - name: string +scopes: + - type: string keyExpiresIn: string +status: string appGroup: string +lastModifiedAt: string +createdAt: string +name: string +attributes: + - name: string + value: string credentials: - - consumerSecret: string - consumerKey: string + - expiresAt: string + consumerSecret: string apiProducts: - status: string apiproduct: string scopes: - type: string - status: string - expiresAt: string issuedAt: string + consumerKey: string attributes: - - value: string - name: string -scopes: - - type: string -status: string -name: string -lastModifiedAt: string -callbackUrl: string -appId: string + - name: string + value: string + status: string ``` @@ -172,15 +172,15 @@ Replaces all fields in the specified apps resource. /*+ update */ REPLACE google.apigee.apps SET +callbackUrl = '{{ callbackUrl }}', +appId = '{{ appId }}', apiProducts = '{{ apiProducts }}', -attributes = '{{ attributes }}', -keyExpiresIn = '{{ keyExpiresIn }}', -appGroup = '{{ appGroup }}', scopes = '{{ scopes }}', +keyExpiresIn = '{{ keyExpiresIn }}', status = '{{ status }}', +appGroup = '{{ appGroup }}', name = '{{ name }}', -callbackUrl = '{{ callbackUrl }}', -appId = '{{ appId }}' +attributes = '{{ attributes }}' WHERE appgroupsId = '{{ appgroupsId }}' AND appsId = '{{ appsId }}' diff --git a/docs/google-docs/providers/google/apigee/archive_deployments/index.md b/docs/google-docs/providers/google/apigee/archive_deployments/index.md index 6a20793d3d..ed5b993697 100644 --- a/docs/google-docs/providers/google/apigee/archive_deployments/index.md +++ b/docs/google-docs/providers/google/apigee/archive_deployments/index.md @@ -84,15 +84,15 @@ Use the following StackQL query and manifest file to create a new archive_ INSERT INTO google.apigee.archive_deployments ( environmentsId, organizationsId, -gcsUri, name, +gcsUri, labels ) SELECT '{{ environmentsId }}', '{{ organizationsId }}', -'{{ gcsUri }}', '{{ name }}', +'{{ gcsUri }}', '{{ labels }}' ; ``` @@ -101,9 +101,9 @@ SELECT ```yaml createdAt: string -gcsUri: string name: string operation: string +gcsUri: string updatedAt: string labels: object @@ -119,8 +119,8 @@ Updates a archive_deployments resource. /*+ update */ UPDATE google.apigee.archive_deployments SET -gcsUri = '{{ gcsUri }}', name = '{{ name }}', +gcsUri = '{{ gcsUri }}', labels = '{{ labels }}' WHERE archiveDeploymentsId = '{{ archiveDeploymentsId }}' diff --git a/docs/google-docs/providers/google/apigee/attachments/index.md b/docs/google-docs/providers/google/apigee/attachments/index.md index 94364a42e0..f1b8d85dcf 100644 --- a/docs/google-docs/providers/google/apigee/attachments/index.md +++ b/docs/google-docs/providers/google/apigee/attachments/index.md @@ -31,10 +31,9 @@ Creates, updates, deletes, gets or lists a attachments resource. ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `string` | ID of the environment group attachment. | -| | `string` | Output only. The time at which the environment group attachment was created as milliseconds since epoch. | -| | `string` | Required. ID of the attached environment. | -| | `string` | Output only. ID of the environment group. | +| | `string` | Output only. ID of the attachment. | +| | `string` | Output only. Time the attachment was created in milliseconds since epoch. | +| | `string` | ID of the attached environment. | ## Methods | Name | Accessible by | Required Params | Description | @@ -56,8 +55,7 @@ Lists all attachments of an environment group. SELECT name, createdAt, -environment, -environmentGroupId +environment FROM google.apigee.attachments WHERE envgroupsId = '{{ envgroupsId }}' AND organizationsId = '{{ organizationsId }}'; @@ -95,10 +93,10 @@ SELECT ```yaml -createdAt: string -environmentGroupId: string environment: string name: string +environmentGroupId: string +createdAt: string ``` diff --git a/docs/google-docs/providers/google/apigee/attributes_api_product_attribute/index.md b/docs/google-docs/providers/google/apigee/attributes_api_product_attribute/index.md index 0c6148a2a2..cb69fc9080 100644 --- a/docs/google-docs/providers/google/apigee/attributes_api_product_attribute/index.md +++ b/docs/google-docs/providers/google/apigee/attributes_api_product_attribute/index.md @@ -45,8 +45,8 @@ Updates a attributes_api_product_attribute resource. /*+ update */ UPDATE google.apigee.attributes_api_product_attribute SET -value = '{{ value }}', -name = '{{ name }}' +name = '{{ name }}', +value = '{{ value }}' WHERE apiproductsId = '{{ apiproductsId }}' AND attributesId = '{{ attributesId }}' diff --git a/docs/google-docs/providers/google/apigee/attributes_developer_app_attribute/index.md b/docs/google-docs/providers/google/apigee/attributes_developer_app_attribute/index.md index dbca10d271..ff728b904d 100644 --- a/docs/google-docs/providers/google/apigee/attributes_developer_app_attribute/index.md +++ b/docs/google-docs/providers/google/apigee/attributes_developer_app_attribute/index.md @@ -45,8 +45,8 @@ Updates a attributes_developer_app_attribute resource. /*+ update */ UPDATE google.apigee.attributes_developer_app_attribute SET -value = '{{ value }}', -name = '{{ name }}' +name = '{{ name }}', +value = '{{ value }}' WHERE appsId = '{{ appsId }}' AND attributesId = '{{ attributesId }}' diff --git a/docs/google-docs/providers/google/apigee/attributes_developer_attribute/index.md b/docs/google-docs/providers/google/apigee/attributes_developer_attribute/index.md index c7a5fd6c2d..893e2de8f4 100644 --- a/docs/google-docs/providers/google/apigee/attributes_developer_attribute/index.md +++ b/docs/google-docs/providers/google/apigee/attributes_developer_attribute/index.md @@ -45,8 +45,8 @@ Updates a attributes_developer_attribute resource. /*+ update */ UPDATE google.apigee.attributes_developer_attribute SET -value = '{{ value }}', -name = '{{ name }}' +name = '{{ name }}', +value = '{{ value }}' WHERE attributesId = '{{ attributesId }}' AND developersId = '{{ developersId }}' diff --git a/docs/google-docs/providers/google/apigee/canaryevaluations/index.md b/docs/google-docs/providers/google/apigee/canaryevaluations/index.md index dbc923b403..a9ef2035ac 100644 --- a/docs/google-docs/providers/google/apigee/canaryevaluations/index.md +++ b/docs/google-docs/providers/google/apigee/canaryevaluations/index.md @@ -86,19 +86,19 @@ Use the following StackQL query and manifest file to create a new canaryev INSERT INTO google.apigee.canaryevaluations ( instancesId, organizationsId, -startTime, -endTime, control, +endTime, metricLabels, +startTime, treatment ) SELECT '{{ instancesId }}', '{{ organizationsId }}', -'{{ startTime }}', -'{{ endTime }}', '{{ control }}', +'{{ endTime }}', '{{ metricLabels }}', +'{{ startTime }}', '{{ treatment }}' ; ``` @@ -106,17 +106,17 @@ SELECT ```yaml -startTime: string -endTime: string +createTime: string control: string +endTime: string metricLabels: - instance_id: string env: string location: string -createTime: string + instance_id: string +startTime: string +verdict: string treatment: string name: string -verdict: string state: string ``` diff --git a/docs/google-docs/providers/google/apigee/create/index.md b/docs/google-docs/providers/google/apigee/create/index.md index 84ad3790c6..488703df6d 100644 --- a/docs/google-docs/providers/google/apigee/create/index.md +++ b/docs/google-docs/providers/google/apigee/create/index.md @@ -57,28 +57,28 @@ appsId, developersId, organizationsId, consumerKey, -expiresInSeconds, -consumerSecret, -attributes, apiProducts, -status, +consumerSecret, issuedAt, scopes, -expiresAt +status, +expiresAt, +attributes, +expiresInSeconds ) SELECT '{{ appsId }}', '{{ developersId }}', '{{ organizationsId }}', '{{ consumerKey }}', -'{{ expiresInSeconds }}', -'{{ consumerSecret }}', -'{{ attributes }}', '{{ apiProducts }}', -'{{ status }}', +'{{ consumerSecret }}', '{{ issuedAt }}', '{{ scopes }}', -'{{ expiresAt }}' +'{{ status }}', +'{{ expiresAt }}', +'{{ attributes }}', +'{{ expiresInSeconds }}' ; ``` @@ -86,18 +86,18 @@ SELECT ```yaml consumerKey: string -expiresInSeconds: string -consumerSecret: string -attributes: - - value: string - name: string apiProducts: - type: string -status: string +consumerSecret: string issuedAt: string scopes: - type: string +status: string expiresAt: string +attributes: + - name: string + value: string +expiresInSeconds: string ``` diff --git a/docs/google-docs/providers/google/apigee/datacollectors/index.md b/docs/google-docs/providers/google/apigee/datacollectors/index.md index 7ca501ebd8..c34d1d5a7d 100644 --- a/docs/google-docs/providers/google/apigee/datacollectors/index.md +++ b/docs/google-docs/providers/google/apigee/datacollectors/index.md @@ -93,11 +93,11 @@ SELECT ```yaml -type: string createdAt: string +type: string description: string -name: string lastModifiedAt: string +name: string ``` diff --git a/docs/google-docs/providers/google/apigee/datastores/index.md b/docs/google-docs/providers/google/apigee/datastores/index.md index 88f015eab9..b363728830 100644 --- a/docs/google-docs/providers/google/apigee/datastores/index.md +++ b/docs/google-docs/providers/google/apigee/datastores/index.md @@ -99,17 +99,17 @@ SELECT ```yaml datastoreConfig: - datasetName: string - tablePrefix: string path: string projectId: string bucketName: string -lastUpdateTime: string -org: string + datasetName: string + tablePrefix: string displayName: string +org: string +lastUpdateTime: string self: string -targetType: string createTime: string +targetType: string ``` diff --git a/docs/google-docs/providers/google/apigee/debugsessions/index.md b/docs/google-docs/providers/google/apigee/debugsessions/index.md index b83e77e1b0..015bbe1912 100644 --- a/docs/google-docs/providers/google/apigee/debugsessions/index.md +++ b/docs/google-docs/providers/google/apigee/debugsessions/index.md @@ -86,37 +86,37 @@ apisId, environmentsId, organizationsId, revisionsId, -filter, timeout, -count, validity, -tracesize, -name +name, +count, +filter, +tracesize ) SELECT '{{ apisId }}', '{{ environmentsId }}', '{{ organizationsId }}', '{{ revisionsId }}', -'{{ filter }}', '{{ timeout }}', -'{{ count }}', '{{ validity }}', -'{{ tracesize }}', -'{{ name }}' +'{{ name }}', +'{{ count }}', +'{{ filter }}', +'{{ tracesize }}' ; ``` ```yaml -filter: string -createTime: string timeout: string -count: integer validity: integer -tracesize: integer name: string +count: integer +filter: string +tracesize: integer +createTime: string ``` diff --git a/docs/google-docs/providers/google/apigee/developers/index.md b/docs/google-docs/providers/google/apigee/developers/index.md index 04b17de5fd..54edfef190 100644 --- a/docs/google-docs/providers/google/apigee/developers/index.md +++ b/docs/google-docs/providers/google/apigee/developers/index.md @@ -98,53 +98,53 @@ Use the following StackQL query and manifest file to create a new develope /*+ create */ INSERT INTO google.apigee.developers ( organizationsId, -userName, -apps, companies, developerId, -attributes, -lastName, +apps, +email, +appFamily, firstName, +userName, +attributes, accessType, -appFamily, -email +lastName ) SELECT '{{ organizationsId }}', -'{{ userName }}', -'{{ apps }}', '{{ companies }}', '{{ developerId }}', -'{{ attributes }}', -'{{ lastName }}', +'{{ apps }}', +'{{ email }}', +'{{ appFamily }}', '{{ firstName }}', +'{{ userName }}', +'{{ attributes }}', '{{ accessType }}', -'{{ appFamily }}', -'{{ email }}' +'{{ lastName }}' ; ``` ```yaml -userName: string -lastModifiedAt: string -apps: - - type: string companies: - type: string -developerId: string -attributes: - - value: string - name: string -lastName: string -firstName: string -accessType: string status: string +developerId: string +apps: + - type: string +createdAt: string +email: string appFamily: string +firstName: string +userName: string organizationName: string -email: string -createdAt: string +attributes: + - name: string + value: string +lastModifiedAt: string +accessType: string +lastName: string ``` @@ -158,16 +158,16 @@ Replaces all fields in the specified developers resource. /*+ update */ REPLACE google.apigee.developers SET -userName = '{{ userName }}', -apps = '{{ apps }}', companies = '{{ companies }}', developerId = '{{ developerId }}', -attributes = '{{ attributes }}', -lastName = '{{ lastName }}', +apps = '{{ apps }}', +email = '{{ email }}', +appFamily = '{{ appFamily }}', firstName = '{{ firstName }}', +userName = '{{ userName }}', +attributes = '{{ attributes }}', accessType = '{{ accessType }}', -appFamily = '{{ appFamily }}', -email = '{{ email }}' +lastName = '{{ lastName }}' WHERE developersId = '{{ developersId }}' AND organizationsId = '{{ organizationsId }}'; diff --git a/docs/google-docs/providers/google/apigee/endpoint_attachments/index.md b/docs/google-docs/providers/google/apigee/endpoint_attachments/index.md index ce7f2266b8..32167986f4 100644 --- a/docs/google-docs/providers/google/apigee/endpoint_attachments/index.md +++ b/docs/google-docs/providers/google/apigee/endpoint_attachments/index.md @@ -80,26 +80,26 @@ Use the following StackQL query and manifest file to create a new endpoint INSERT INTO google.apigee.endpoint_attachments ( organizationsId, name, -serviceAttachment, -location +location, +serviceAttachment ) SELECT '{{ organizationsId }}', '{{ name }}', -'{{ serviceAttachment }}', -'{{ location }}' +'{{ location }}', +'{{ serviceAttachment }}' ; ``` ```yaml -name: string -connectionState: string -serviceAttachment: string -location: string state: string +connectionState: string +name: string host: string +location: string +serviceAttachment: string ``` diff --git a/docs/google-docs/providers/google/apigee/entries/index.md b/docs/google-docs/providers/google/apigee/entries/index.md index a989efbd02..45c2da1431 100644 --- a/docs/google-docs/providers/google/apigee/entries/index.md +++ b/docs/google-docs/providers/google/apigee/entries/index.md @@ -84,22 +84,22 @@ Use the following StackQL query and manifest file to create a new entries< INSERT INTO google.apigee.entries ( keyvaluemapsId, organizationsId, -value, -name +name, +value ) SELECT '{{ keyvaluemapsId }}', '{{ organizationsId }}', -'{{ value }}', -'{{ name }}' +'{{ name }}', +'{{ value }}' ; ``` ```yaml -value: string name: string +value: string ``` @@ -113,8 +113,8 @@ Replaces all fields in the specified entries resource. /*+ update */ REPLACE google.apigee.entries SET -value = '{{ value }}', -name = '{{ name }}' +name = '{{ name }}', +value = '{{ value }}' WHERE entriesId = '{{ entriesId }}' AND keyvaluemapsId = '{{ keyvaluemapsId }}' diff --git a/docs/google-docs/providers/google/apigee/envgroups/index.md b/docs/google-docs/providers/google/apigee/envgroups/index.md index 40e301984d..744bc1f929 100644 --- a/docs/google-docs/providers/google/apigee/envgroups/index.md +++ b/docs/google-docs/providers/google/apigee/envgroups/index.md @@ -92,11 +92,11 @@ SELECT ```yaml lastModifiedAt: string -state: string name: string hostnames: - type: string createdAt: string +state: string ``` diff --git a/docs/google-docs/providers/google/apigee/environments/index.md b/docs/google-docs/providers/google/apigee/environments/index.md index 69773a8651..463e809d8c 100644 --- a/docs/google-docs/providers/google/apigee/environments/index.md +++ b/docs/google-docs/providers/google/apigee/environments/index.md @@ -100,54 +100,54 @@ Use the following StackQL query and manifest file to create a new environm /*+ create */ INSERT INTO google.apigee.environments ( organizationsId, -deploymentType, -forwardProxyUri, -description, nodeConfig, +displayName, +description, properties, -name, hasAttachedFlowHooks, -type, -displayName, -apiProxyType +apiProxyType, +name, +deploymentType, +forwardProxyUri, +type ) SELECT '{{ organizationsId }}', -'{{ deploymentType }}', -'{{ forwardProxyUri }}', -'{{ description }}', '{{ nodeConfig }}', +'{{ displayName }}', +'{{ description }}', '{{ properties }}', -'{{ name }}', true|false, -'{{ type }}', -'{{ displayName }}', -'{{ apiProxyType }}' +'{{ apiProxyType }}', +'{{ name }}', +'{{ deploymentType }}', +'{{ forwardProxyUri }}', +'{{ type }}' ; ``` ```yaml -deploymentType: string -forwardProxyUri: string -description: string +createdAt: string state: string nodeConfig: minNodeCount: string - maxNodeCount: string currentAggregateNodeCount: string + maxNodeCount: string +displayName: string +description: string properties: property: - - value: string - name: string -name: string -createdAt: string + - name: string + value: string hasAttachedFlowHooks: boolean +apiProxyType: string +name: string +deploymentType: string +forwardProxyUri: string lastModifiedAt: string type: string -displayName: string -apiProxyType: string ``` @@ -161,16 +161,16 @@ Replaces all fields in the specified environments resource. /*+ update */ REPLACE google.apigee.environments SET -deploymentType = '{{ deploymentType }}', -forwardProxyUri = '{{ forwardProxyUri }}', -description = '{{ description }}', nodeConfig = '{{ nodeConfig }}', +displayName = '{{ displayName }}', +description = '{{ description }}', properties = '{{ properties }}', -name = '{{ name }}', hasAttachedFlowHooks = true|false, -type = '{{ type }}', -displayName = '{{ displayName }}', -apiProxyType = '{{ apiProxyType }}' +apiProxyType = '{{ apiProxyType }}', +name = '{{ name }}', +deploymentType = '{{ deploymentType }}', +forwardProxyUri = '{{ forwardProxyUri }}', +type = '{{ type }}' WHERE environmentsId = '{{ environmentsId }}' AND organizationsId = '{{ organizationsId }}'; diff --git a/docs/google-docs/providers/google/apigee/environments_debugmask/index.md b/docs/google-docs/providers/google/apigee/environments_debugmask/index.md index 8f956421a1..a57b5be4f4 100644 --- a/docs/google-docs/providers/google/apigee/environments_debugmask/index.md +++ b/docs/google-docs/providers/google/apigee/environments_debugmask/index.md @@ -75,15 +75,15 @@ Updates a environments_debugmask resource. /*+ update */ UPDATE google.apigee.environments_debugmask SET -faultJSONPaths = '{{ faultJSONPaths }}', -faultXPaths = '{{ faultXPaths }}', -requestJSONPaths = '{{ requestJSONPaths }}', -variables = '{{ variables }}', name = '{{ name }}', -responseJSONPaths = '{{ responseJSONPaths }}', +variables = '{{ variables }}', +requestJSONPaths = '{{ requestJSONPaths }}', requestXPaths = '{{ requestXPaths }}', +faultXPaths = '{{ faultXPaths }}', namespaces = '{{ namespaces }}', -responseXPaths = '{{ responseXPaths }}' +responseXPaths = '{{ responseXPaths }}', +responseJSONPaths = '{{ responseJSONPaths }}', +faultJSONPaths = '{{ faultJSONPaths }}' WHERE environmentsId = '{{ environmentsId }}' AND organizationsId = '{{ organizationsId }}'; diff --git a/docs/google-docs/providers/google/apigee/environments_environment/index.md b/docs/google-docs/providers/google/apigee/environments_environment/index.md index c3aa1a1a91..cd4c2c1f02 100644 --- a/docs/google-docs/providers/google/apigee/environments_environment/index.md +++ b/docs/google-docs/providers/google/apigee/environments_environment/index.md @@ -45,16 +45,16 @@ Updates a environments_environment resource. /*+ update */ UPDATE google.apigee.environments_environment SET -deploymentType = '{{ deploymentType }}', -forwardProxyUri = '{{ forwardProxyUri }}', -description = '{{ description }}', nodeConfig = '{{ nodeConfig }}', +displayName = '{{ displayName }}', +description = '{{ description }}', properties = '{{ properties }}', -name = '{{ name }}', hasAttachedFlowHooks = true|false, -type = '{{ type }}', -displayName = '{{ displayName }}', -apiProxyType = '{{ apiProxyType }}' +apiProxyType = '{{ apiProxyType }}', +name = '{{ name }}', +deploymentType = '{{ deploymentType }}', +forwardProxyUri = '{{ forwardProxyUri }}', +type = '{{ type }}' WHERE environmentsId = '{{ environmentsId }}' AND organizationsId = '{{ organizationsId }}'; diff --git a/docs/google-docs/providers/google/apigee/environments_security_actions_config/index.md b/docs/google-docs/providers/google/apigee/environments_security_actions_config/index.md index fe1ad966e1..9233113cc4 100644 --- a/docs/google-docs/providers/google/apigee/environments_security_actions_config/index.md +++ b/docs/google-docs/providers/google/apigee/environments_security_actions_config/index.md @@ -63,8 +63,8 @@ Updates a environments_security_actions_config resource. /*+ update */ UPDATE google.apigee.environments_security_actions_config SET -name = '{{ name }}', -enabled = true|false +enabled = true|false, +name = '{{ name }}' WHERE environmentsId = '{{ environmentsId }}' AND organizationsId = '{{ organizationsId }}'; diff --git a/docs/google-docs/providers/google/apigee/environments_trace_config/index.md b/docs/google-docs/providers/google/apigee/environments_trace_config/index.md index 13643aaa78..3cb1fca3e9 100644 --- a/docs/google-docs/providers/google/apigee/environments_trace_config/index.md +++ b/docs/google-docs/providers/google/apigee/environments_trace_config/index.md @@ -64,8 +64,8 @@ Updates a environments_trace_config resource. UPDATE google.apigee.environments_trace_config SET exporter = '{{ exporter }}', -samplingConfig = '{{ samplingConfig }}', -endpoint = '{{ endpoint }}' +endpoint = '{{ endpoint }}', +samplingConfig = '{{ samplingConfig }}' WHERE environmentsId = '{{ environmentsId }}' AND organizationsId = '{{ organizationsId }}'; diff --git a/docs/google-docs/providers/google/apigee/exports/index.md b/docs/google-docs/providers/google/apigee/exports/index.md index ff3c0ee2f8..ff28aca037 100644 --- a/docs/google-docs/providers/google/apigee/exports/index.md +++ b/docs/google-docs/providers/google/apigee/exports/index.md @@ -86,36 +86,36 @@ Use the following StackQL query and manifest file to create a new exports< INSERT INTO google.apigee.exports ( environmentsId, organizationsId, +description, csvDelimiter, -name, outputFormat, -dateRange, datastoreName, -description +name, +dateRange ) SELECT '{{ environmentsId }}', '{{ organizationsId }}', +'{{ description }}', '{{ csvDelimiter }}', -'{{ name }}', '{{ outputFormat }}', -'{{ dateRange }}', '{{ datastoreName }}', -'{{ description }}' +'{{ name }}', +'{{ dateRange }}' ; ``` ```yaml +description: string csvDelimiter: string -name: string outputFormat: string +datastoreName: string +name: string dateRange: end: string start: string -datastoreName: string -description: string ``` diff --git a/docs/google-docs/providers/google/apigee/host_queries/index.md b/docs/google-docs/providers/google/apigee/host_queries/index.md index 1dffb6cfab..9cde5684bf 100644 --- a/docs/google-docs/providers/google/apigee/host_queries/index.md +++ b/docs/google-docs/providers/google/apigee/host_queries/index.md @@ -92,54 +92,54 @@ Use the following StackQL query and manifest file to create a new host_que /*+ create */ INSERT INTO google.apigee.host_queries ( organizationsId, -dimensions, +name, +metrics, +filter, +envgroupHostname, +timeRange, limit, csvDelimiter, -envgroupHostname, -filter, +reportDefinitionId, +dimensions, outputFormat, -name, -timeRange, -metrics, -groupByTimeUnit, -reportDefinitionId +groupByTimeUnit ) SELECT '{{ organizationsId }}', -'{{ dimensions }}', +'{{ name }}', +'{{ metrics }}', +'{{ filter }}', +'{{ envgroupHostname }}', +'{{ timeRange }}', '{{ limit }}', '{{ csvDelimiter }}', -'{{ envgroupHostname }}', -'{{ filter }}', +'{{ reportDefinitionId }}', +'{{ dimensions }}', '{{ outputFormat }}', -'{{ name }}', -'{{ timeRange }}', -'{{ metrics }}', -'{{ groupByTimeUnit }}', -'{{ reportDefinitionId }}' +'{{ groupByTimeUnit }}' ; ``` ```yaml -dimensions: - - type: string -limit: integer -csvDelimiter: string -envgroupHostname: string -filter: string -outputFormat: string name: string -timeRange: any metrics: - - name: string - function: string - alias: string + - function: string + name: string value: string operator: string -groupByTimeUnit: string + alias: string +filter: string +envgroupHostname: string +timeRange: any +limit: integer +csvDelimiter: string reportDefinitionId: string +dimensions: + - type: string +outputFormat: string +groupByTimeUnit: string ``` diff --git a/docs/google-docs/providers/google/apigee/host_security_reports/index.md b/docs/google-docs/providers/google/apigee/host_security_reports/index.md index d2b56a55e4..66ae7c0669 100644 --- a/docs/google-docs/providers/google/apigee/host_security_reports/index.md +++ b/docs/google-docs/providers/google/apigee/host_security_reports/index.md @@ -92,54 +92,54 @@ Use the following StackQL query and manifest file to create a new host_sec /*+ create */ INSERT INTO google.apigee.host_security_reports ( organizationsId, -reportDefinitionId, envgroupHostname, -limit, -metrics, -dimensions, +displayName, groupByTimeUnit, -mimeType, +limit, timeRange, -csvDelimiter, +reportDefinitionId, filter, -displayName +csvDelimiter, +metrics, +dimensions, +mimeType ) SELECT '{{ organizationsId }}', -'{{ reportDefinitionId }}', '{{ envgroupHostname }}', -'{{ limit }}', -'{{ metrics }}', -'{{ dimensions }}', +'{{ displayName }}', '{{ groupByTimeUnit }}', -'{{ mimeType }}', +'{{ limit }}', '{{ timeRange }}', -'{{ csvDelimiter }}', +'{{ reportDefinitionId }}', '{{ filter }}', -'{{ displayName }}' +'{{ csvDelimiter }}', +'{{ metrics }}', +'{{ dimensions }}', +'{{ mimeType }}' ; ``` ```yaml -reportDefinitionId: string envgroupHostname: string +displayName: string +groupByTimeUnit: string limit: integer +timeRange: any +reportDefinitionId: string +filter: string +csvDelimiter: string metrics: - - operator: string - alias: string + - alias: string name: string aggregationFunction: string value: string + operator: string dimensions: - type: string -groupByTimeUnit: string mimeType: string -timeRange: any -csvDelimiter: string -filter: string -displayName: string ``` diff --git a/docs/google-docs/providers/google/apigee/instances/index.md b/docs/google-docs/providers/google/apigee/instances/index.md index 6dcecfdc9b..48504bf6e3 100644 --- a/docs/google-docs/providers/google/apigee/instances/index.md +++ b/docs/google-docs/providers/google/apigee/instances/index.md @@ -101,52 +101,52 @@ Use the following StackQL query and manifest file to create a new instance /*+ create */ INSERT INTO google.apigee.instances ( organizationsId, -accessLoggingConfig, +location, +consumerAcceptList, ipRange, name, -displayName, +accessLoggingConfig, +diskEncryptionKeyName, description, -location, peeringCidrRange, -diskEncryptionKeyName, -consumerAcceptList +displayName ) SELECT '{{ organizationsId }}', -'{{ accessLoggingConfig }}', +'{{ location }}', +'{{ consumerAcceptList }}', '{{ ipRange }}', '{{ name }}', -'{{ displayName }}', +'{{ accessLoggingConfig }}', +'{{ diskEncryptionKeyName }}', '{{ description }}', -'{{ location }}', '{{ peeringCidrRange }}', -'{{ diskEncryptionKeyName }}', -'{{ consumerAcceptList }}' +'{{ displayName }}' ; ``` ```yaml +location: string +createdAt: string +consumerAcceptList: + - type: string +ipRange: string +name: string serviceAttachment: string -runtimeVersion: string accessLoggingConfig: - enabled: boolean filter: string -ipRange: string + enabled: boolean +state: string +runtimeVersion: string host: string -lastModifiedAt: string -name: string -displayName: string +diskEncryptionKeyName: string description: string -location: string -peeringCidrRange: string port: string -diskEncryptionKeyName: string -state: string -consumerAcceptList: - - type: string -createdAt: string +lastModifiedAt: string +peeringCidrRange: string +displayName: string ``` @@ -160,15 +160,15 @@ Updates a instances resource. /*+ update */ UPDATE google.apigee.instances SET -accessLoggingConfig = '{{ accessLoggingConfig }}', +location = '{{ location }}', +consumerAcceptList = '{{ consumerAcceptList }}', ipRange = '{{ ipRange }}', name = '{{ name }}', -displayName = '{{ displayName }}', +accessLoggingConfig = '{{ accessLoggingConfig }}', +diskEncryptionKeyName = '{{ diskEncryptionKeyName }}', description = '{{ description }}', -location = '{{ location }}', peeringCidrRange = '{{ peeringCidrRange }}', -diskEncryptionKeyName = '{{ diskEncryptionKeyName }}', -consumerAcceptList = '{{ consumerAcceptList }}' +displayName = '{{ displayName }}' WHERE instancesId = '{{ instancesId }}' AND organizationsId = '{{ organizationsId }}'; diff --git a/docs/google-docs/providers/google/apigee/keys/index.md b/docs/google-docs/providers/google/apigee/keys/index.md index 8d90fbc9c3..b0555b715d 100644 --- a/docs/google-docs/providers/google/apigee/keys/index.md +++ b/docs/google-docs/providers/google/apigee/keys/index.md @@ -93,43 +93,43 @@ INSERT INTO google.apigee.keys ( appgroupsId, appsId, organizationsId, -attributes, +scopes, expiresInSeconds, -consumerKey, consumerSecret, -status, -scopes +consumerKey, +attributes, +status ) SELECT '{{ appgroupsId }}', '{{ appsId }}', '{{ organizationsId }}', -'{{ attributes }}', +'{{ scopes }}', '{{ expiresInSeconds }}', -'{{ consumerKey }}', '{{ consumerSecret }}', -'{{ status }}', -'{{ scopes }}' +'{{ consumerKey }}', +'{{ attributes }}', +'{{ status }}' ; ``` ```yaml -attributes: - - value: string - name: string +scopes: + - type: string expiresInSeconds: string -issuedAt: string -consumerKey: string expiresAt: string +consumerSecret: string +consumerKey: string +attributes: + - name: string + value: string +status: string apiProducts: - status: string apiproduct: string -consumerSecret: string -status: string -scopes: - - type: string +issuedAt: string ``` @@ -144,14 +144,14 @@ Replaces all fields in the specified keys resource. REPLACE google.apigee.keys SET consumerKey = '{{ consumerKey }}', -expiresInSeconds = '{{ expiresInSeconds }}', -consumerSecret = '{{ consumerSecret }}', -attributes = '{{ attributes }}', apiProducts = '{{ apiProducts }}', -status = '{{ status }}', +consumerSecret = '{{ consumerSecret }}', issuedAt = '{{ issuedAt }}', scopes = '{{ scopes }}', -expiresAt = '{{ expiresAt }}' +status = '{{ status }}', +expiresAt = '{{ expiresAt }}', +attributes = '{{ attributes }}', +expiresInSeconds = '{{ expiresInSeconds }}' WHERE appsId = '{{ appsId }}' AND developersId = '{{ developersId }}' diff --git a/docs/google-docs/providers/google/apigee/keys_developer_app_key/index.md b/docs/google-docs/providers/google/apigee/keys_developer_app_key/index.md index 20d9bb3203..fc640c8afa 100644 --- a/docs/google-docs/providers/google/apigee/keys_developer_app_key/index.md +++ b/docs/google-docs/providers/google/apigee/keys_developer_app_key/index.md @@ -46,14 +46,14 @@ Updates a keys_developer_app_key resource. UPDATE google.apigee.keys_developer_app_key SET consumerKey = '{{ consumerKey }}', -expiresInSeconds = '{{ expiresInSeconds }}', -consumerSecret = '{{ consumerSecret }}', -attributes = '{{ attributes }}', apiProducts = '{{ apiProducts }}', -status = '{{ status }}', +consumerSecret = '{{ consumerSecret }}', issuedAt = '{{ issuedAt }}', scopes = '{{ scopes }}', -expiresAt = '{{ expiresAt }}' +status = '{{ status }}', +expiresAt = '{{ expiresAt }}', +attributes = '{{ attributes }}', +expiresInSeconds = '{{ expiresInSeconds }}' WHERE appsId = '{{ appsId }}' AND developersId = '{{ developersId }}' diff --git a/docs/google-docs/providers/google/apigee/keyvaluemaps/index.md b/docs/google-docs/providers/google/apigee/keyvaluemaps/index.md index 5acce780ca..6dbabc5618 100644 --- a/docs/google-docs/providers/google/apigee/keyvaluemaps/index.md +++ b/docs/google-docs/providers/google/apigee/keyvaluemaps/index.md @@ -59,21 +59,21 @@ Use the following StackQL query and manifest file to create a new keyvalue /*+ create */ INSERT INTO google.apigee.keyvaluemaps ( organizationsId, -name, -encrypted +encrypted, +name ) SELECT '{{ organizationsId }}', -'{{ name }}', -true|false +true|false, +'{{ name }}' ; ``` ```yaml -name: string encrypted: boolean +name: string ``` diff --git a/docs/google-docs/providers/google/apigee/nat_addresses/index.md b/docs/google-docs/providers/google/apigee/nat_addresses/index.md index acdc3a9b5f..39e19bf395 100644 --- a/docs/google-docs/providers/google/apigee/nat_addresses/index.md +++ b/docs/google-docs/providers/google/apigee/nat_addresses/index.md @@ -89,8 +89,8 @@ SELECT ```yaml state: string -ipAddress: string name: string +ipAddress: string ``` diff --git a/docs/google-docs/providers/google/apigee/organizations/index.md b/docs/google-docs/providers/google/apigee/organizations/index.md index ed40b9aa1b..b96ea9edd7 100644 --- a/docs/google-docs/providers/google/apigee/organizations/index.md +++ b/docs/google-docs/providers/google/apigee/organizations/index.md @@ -126,99 +126,99 @@ Use the following StackQL query and manifest file to create a new organiza /*+ create */ INSERT INTO google.apigee.organizations ( , -portalDisabled, -disableVpcPeering, -apiConsumerDataLocation, -analyticsRegion, -billingType, -authorizedNetwork, -controlPlaneEncryptionKeyName, -runtimeDatabaseEncryptionKeyName, -runtimeType, +customerName, type, +apiConsumerDataLocation, +disableVpcPeering, +description, displayName, -apiConsumerDataEncryptionKeyName, +analyticsRegion, properties, -description, -customerName, attributes, -addonsConfig +runtimeType, +apiConsumerDataEncryptionKeyName, +authorizedNetwork, +addonsConfig, +controlPlaneEncryptionKeyName, +portalDisabled, +billingType, +runtimeDatabaseEncryptionKeyName ) SELECT '{{ }}', -true|false, -true|false, -'{{ apiConsumerDataLocation }}', -'{{ analyticsRegion }}', -'{{ billingType }}', -'{{ authorizedNetwork }}', -'{{ controlPlaneEncryptionKeyName }}', -'{{ runtimeDatabaseEncryptionKeyName }}', -'{{ runtimeType }}', +'{{ customerName }}', '{{ type }}', +'{{ apiConsumerDataLocation }}', +true|false, +'{{ description }}', '{{ displayName }}', -'{{ apiConsumerDataEncryptionKeyName }}', +'{{ analyticsRegion }}', '{{ properties }}', -'{{ description }}', -'{{ customerName }}', '{{ attributes }}', -'{{ addonsConfig }}' +'{{ runtimeType }}', +'{{ apiConsumerDataEncryptionKeyName }}', +'{{ authorizedNetwork }}', +'{{ addonsConfig }}', +'{{ controlPlaneEncryptionKeyName }}', +true|false, +'{{ billingType }}', +'{{ runtimeDatabaseEncryptionKeyName }}' ; ``` ```yaml +subscriptionType: string +name: string +customerName: string +type: string lastModifiedAt: string -subscriptionPlan: string -portalDisabled: boolean -caCertificate: string -disableVpcPeering: boolean apiConsumerDataLocation: string -analyticsRegion: string -billingType: string -authorizedNetwork: string -controlPlaneEncryptionKeyName: string -runtimeDatabaseEncryptionKeyName: string -expiresAt: string -runtimeType: string -environments: - - type: string -type: string +disableVpcPeering: boolean +description: string displayName: string -apiConsumerDataEncryptionKeyName: string -name: string +analyticsRegion: string properties: property: - - value: string - name: string -projectId: string -description: string -state: string -customerName: string -apigeeProjectId: string + - name: string + value: string attributes: - type: string -subscriptionType: string +runtimeType: string +apigeeProjectId: string +apiConsumerDataEncryptionKeyName: string +subscriptionPlan: string +projectId: string +authorizedNetwork: string addonsConfig: - analyticsConfig: - updateTime: string - state: string - enabled: boolean - expireTimeMillis: string - integrationConfig: - enabled: boolean advancedApiOpsConfig: enabled: boolean - monetizationConfig: - enabled: boolean connectorsPlatformConfig: - expiresAt: string enabled: boolean + expiresAt: string apiSecurityConfig: enabled: boolean expiresAt: string + monetizationConfig: + enabled: boolean + integrationConfig: + enabled: boolean + analyticsConfig: + updateTime: string + enabled: boolean + expireTimeMillis: string + state: string +controlPlaneEncryptionKeyName: string +caCertificate: string +environments: + - type: string +portalDisabled: boolean +billingType: string +state: string +expiresAt: string createdAt: string +runtimeDatabaseEncryptionKeyName: string ``` @@ -232,23 +232,23 @@ Replaces all fields in the specified organizations resource. /*+ update */ REPLACE google.apigee.organizations SET -portalDisabled = true|false, -disableVpcPeering = true|false, -apiConsumerDataLocation = '{{ apiConsumerDataLocation }}', -analyticsRegion = '{{ analyticsRegion }}', -billingType = '{{ billingType }}', -authorizedNetwork = '{{ authorizedNetwork }}', -controlPlaneEncryptionKeyName = '{{ controlPlaneEncryptionKeyName }}', -runtimeDatabaseEncryptionKeyName = '{{ runtimeDatabaseEncryptionKeyName }}', -runtimeType = '{{ runtimeType }}', +customerName = '{{ customerName }}', type = '{{ type }}', +apiConsumerDataLocation = '{{ apiConsumerDataLocation }}', +disableVpcPeering = true|false, +description = '{{ description }}', displayName = '{{ displayName }}', -apiConsumerDataEncryptionKeyName = '{{ apiConsumerDataEncryptionKeyName }}', +analyticsRegion = '{{ analyticsRegion }}', properties = '{{ properties }}', -description = '{{ description }}', -customerName = '{{ customerName }}', attributes = '{{ attributes }}', -addonsConfig = '{{ addonsConfig }}' +runtimeType = '{{ runtimeType }}', +apiConsumerDataEncryptionKeyName = '{{ apiConsumerDataEncryptionKeyName }}', +authorizedNetwork = '{{ authorizedNetwork }}', +addonsConfig = '{{ addonsConfig }}', +controlPlaneEncryptionKeyName = '{{ controlPlaneEncryptionKeyName }}', +portalDisabled = true|false, +billingType = '{{ billingType }}', +runtimeDatabaseEncryptionKeyName = '{{ runtimeDatabaseEncryptionKeyName }}' WHERE organizationsId = '{{ organizationsId }}'; ``` diff --git a/docs/google-docs/providers/google/apigee/overrides/index.md b/docs/google-docs/providers/google/apigee/overrides/index.md index 566c4eee34..4b697195e6 100644 --- a/docs/google-docs/providers/google/apigee/overrides/index.md +++ b/docs/google-docs/providers/google/apigee/overrides/index.md @@ -76,27 +76,27 @@ Use the following StackQL query and manifest file to create a new override INSERT INTO google.apigee.overrides ( environmentsId, organizationsId, -name, +apiProxy, samplingConfig, -apiProxy +name ) SELECT '{{ environmentsId }}', '{{ organizationsId }}', -'{{ name }}', +'{{ apiProxy }}', '{{ samplingConfig }}', -'{{ apiProxy }}' +'{{ name }}' ; ``` ```yaml -name: string +apiProxy: string samplingConfig: sampler: string samplingRate: number -apiProxy: string +name: string ``` @@ -110,9 +110,9 @@ Updates a overrides resource. /*+ update */ UPDATE google.apigee.overrides SET -name = '{{ name }}', +apiProxy = '{{ apiProxy }}', samplingConfig = '{{ samplingConfig }}', -apiProxy = '{{ apiProxy }}' +name = '{{ name }}' WHERE environmentsId = '{{ environmentsId }}' AND organizationsId = '{{ organizationsId }}' diff --git a/docs/google-docs/providers/google/apigee/queries/index.md b/docs/google-docs/providers/google/apigee/queries/index.md index 07b4bf5c3e..3d71e07066 100644 --- a/docs/google-docs/providers/google/apigee/queries/index.md +++ b/docs/google-docs/providers/google/apigee/queries/index.md @@ -94,55 +94,55 @@ Use the following StackQL query and manifest file to create a new queries< INSERT INTO google.apigee.queries ( environmentsId, organizationsId, -dimensions, +name, +metrics, +filter, +envgroupHostname, +timeRange, limit, csvDelimiter, -envgroupHostname, -filter, +reportDefinitionId, +dimensions, outputFormat, -name, -timeRange, -metrics, -groupByTimeUnit, -reportDefinitionId +groupByTimeUnit ) SELECT '{{ environmentsId }}', '{{ organizationsId }}', -'{{ dimensions }}', +'{{ name }}', +'{{ metrics }}', +'{{ filter }}', +'{{ envgroupHostname }}', +'{{ timeRange }}', '{{ limit }}', '{{ csvDelimiter }}', -'{{ envgroupHostname }}', -'{{ filter }}', +'{{ reportDefinitionId }}', +'{{ dimensions }}', '{{ outputFormat }}', -'{{ name }}', -'{{ timeRange }}', -'{{ metrics }}', -'{{ groupByTimeUnit }}', -'{{ reportDefinitionId }}' +'{{ groupByTimeUnit }}' ; ``` ```yaml -dimensions: - - type: string -limit: integer -csvDelimiter: string -envgroupHostname: string -filter: string -outputFormat: string name: string -timeRange: any metrics: - - name: string - function: string - alias: string + - function: string + name: string value: string operator: string -groupByTimeUnit: string + alias: string +filter: string +envgroupHostname: string +timeRange: any +limit: integer +csvDelimiter: string reportDefinitionId: string +dimensions: + - type: string +outputFormat: string +groupByTimeUnit: string ``` diff --git a/docs/google-docs/providers/google/apigee/rateplans/index.md b/docs/google-docs/providers/google/apigee/rateplans/index.md index 3cda16c17a..9a7b9557f2 100644 --- a/docs/google-docs/providers/google/apigee/rateplans/index.md +++ b/docs/google-docs/providers/google/apigee/rateplans/index.md @@ -108,74 +108,74 @@ Use the following StackQL query and manifest file to create a new rateplan INSERT INTO google.apigee.rateplans ( apiproductsId, organizationsId, +fixedFeeFrequency, +description, consumptionPricingRates, -billingPeriod, -revenueShareRates, -fixedRecurringFee, -state, revenueShareType, +apiproduct, +state, consumptionPricingType, -currencyCode, +billingPeriod, +revenueShareRates, startTime, -setupFee, -displayName, -apiproduct, -description, +currencyCode, +paymentFundingModel, endTime, -fixedFeeFrequency, -paymentFundingModel +setupFee, +fixedRecurringFee, +displayName ) SELECT '{{ apiproductsId }}', '{{ organizationsId }}', +'{{ fixedFeeFrequency }}', +'{{ description }}', '{{ consumptionPricingRates }}', -'{{ billingPeriod }}', -'{{ revenueShareRates }}', -'{{ fixedRecurringFee }}', -'{{ state }}', '{{ revenueShareType }}', +'{{ apiproduct }}', +'{{ state }}', '{{ consumptionPricingType }}', -'{{ currencyCode }}', +'{{ billingPeriod }}', +'{{ revenueShareRates }}', '{{ startTime }}', -'{{ setupFee }}', -'{{ displayName }}', -'{{ apiproduct }}', -'{{ description }}', +'{{ currencyCode }}', +'{{ paymentFundingModel }}', '{{ endTime }}', -'{{ fixedFeeFrequency }}', -'{{ paymentFundingModel }}' +'{{ setupFee }}', +'{{ fixedRecurringFee }}', +'{{ displayName }}' ; ``` ```yaml +fixedFeeFrequency: integer +name: string +description: string consumptionPricingRates: - - end: string - fee: - nanos: integer - currencyCode: string + - fee: units: string + currencyCode: string + nanos: integer + end: string start: string +revenueShareType: string +apiproduct: string +state: string +consumptionPricingType: string billingPeriod: string revenueShareRates: - - start: string + - end: string + start: string sharePercentage: number - end: string -state: string -revenueShareType: string -consumptionPricingType: string -currencyCode: string startTime: string -name: string +currencyCode: string +paymentFundingModel: string +endTime: string lastModifiedAt: string createdAt: string displayName: string -apiproduct: string -description: string -endTime: string -fixedFeeFrequency: integer -paymentFundingModel: string ``` @@ -189,22 +189,22 @@ Replaces all fields in the specified rateplans resource. /*+ update */ REPLACE google.apigee.rateplans SET +fixedFeeFrequency = '{{ fixedFeeFrequency }}', +description = '{{ description }}', consumptionPricingRates = '{{ consumptionPricingRates }}', -billingPeriod = '{{ billingPeriod }}', -revenueShareRates = '{{ revenueShareRates }}', -fixedRecurringFee = '{{ fixedRecurringFee }}', -state = '{{ state }}', revenueShareType = '{{ revenueShareType }}', +apiproduct = '{{ apiproduct }}', +state = '{{ state }}', consumptionPricingType = '{{ consumptionPricingType }}', -currencyCode = '{{ currencyCode }}', +billingPeriod = '{{ billingPeriod }}', +revenueShareRates = '{{ revenueShareRates }}', startTime = '{{ startTime }}', -setupFee = '{{ setupFee }}', -displayName = '{{ displayName }}', -apiproduct = '{{ apiproduct }}', -description = '{{ description }}', +currencyCode = '{{ currencyCode }}', +paymentFundingModel = '{{ paymentFundingModel }}', endTime = '{{ endTime }}', -fixedFeeFrequency = '{{ fixedFeeFrequency }}', -paymentFundingModel = '{{ paymentFundingModel }}' +setupFee = '{{ setupFee }}', +fixedRecurringFee = '{{ fixedRecurringFee }}', +displayName = '{{ displayName }}' WHERE apiproductsId = '{{ apiproductsId }}' AND organizationsId = '{{ organizationsId }}' diff --git a/docs/google-docs/providers/google/apigee/references/index.md b/docs/google-docs/providers/google/apigee/references/index.md index 6040f0bfc3..843b14ee52 100644 --- a/docs/google-docs/providers/google/apigee/references/index.md +++ b/docs/google-docs/providers/google/apigee/references/index.md @@ -78,17 +78,17 @@ Use the following StackQL query and manifest file to create a new referenc INSERT INTO google.apigee.references ( environmentsId, organizationsId, +description, name, resourceType, -description, refers ) SELECT '{{ environmentsId }}', '{{ organizationsId }}', +'{{ description }}', '{{ name }}', '{{ resourceType }}', -'{{ description }}', '{{ refers }}' ; ``` @@ -96,9 +96,9 @@ SELECT ```yaml +description: string name: string resourceType: string -description: string refers: string ``` @@ -113,9 +113,9 @@ Replaces all fields in the specified references resource. /*+ update */ REPLACE google.apigee.references SET +description = '{{ description }}', name = '{{ name }}', resourceType = '{{ resourceType }}', -description = '{{ description }}', refers = '{{ refers }}' WHERE environmentsId = '{{ environmentsId }}' diff --git a/docs/google-docs/providers/google/apigee/reports/index.md b/docs/google-docs/providers/google/apigee/reports/index.md index 2032d303bc..17fa3fbd1b 100644 --- a/docs/google-docs/providers/google/apigee/reports/index.md +++ b/docs/google-docs/providers/google/apigee/reports/index.md @@ -112,42 +112,42 @@ Use the following StackQL query and manifest file to create a new reports< /*+ create */ INSERT INTO google.apigee.reports ( organizationsId, -fromTime, -sortByCols, -offset, +dimensions, +displayName, sortOrder, -topk, -name, -timeUnit, +filter, chartType, metrics, -filter, -properties, +timeUnit, +name, toTime, -displayName, -comments, +sortByCols, +properties, +offset, tags, -dimensions, +topk, +fromTime, +comments, limit ) SELECT '{{ organizationsId }}', -'{{ fromTime }}', -'{{ sortByCols }}', -'{{ offset }}', +'{{ dimensions }}', +'{{ displayName }}', '{{ sortOrder }}', -'{{ topk }}', -'{{ name }}', -'{{ timeUnit }}', +'{{ filter }}', '{{ chartType }}', '{{ metrics }}', -'{{ filter }}', -'{{ properties }}', +'{{ timeUnit }}', +'{{ name }}', '{{ toTime }}', -'{{ displayName }}', -'{{ comments }}', +'{{ sortByCols }}', +'{{ properties }}', +'{{ offset }}', '{{ tags }}', -'{{ dimensions }}', +'{{ topk }}', +'{{ fromTime }}', +'{{ comments }}', '{{ limit }}' ; ``` @@ -155,38 +155,38 @@ SELECT ```yaml -fromTime: string -sortByCols: +dimensions: - type: string -offset: string environment: string +displayName: string +organization: string sortOrder: string -topk: string -name: string -timeUnit: string +filter: string chartType: string -lastModifiedAt: string metrics: - - function: string - name: string -filter: string -createdAt: string + - name: string + function: string +timeUnit: string +name: string +toTime: string +sortByCols: + - type: string properties: - value: - - value: string - name: string + - name: string + value: string property: string -toTime: string -displayName: string -organization: string -comments: - - type: string +offset: string +createdAt: string tags: - type: string -lastViewedAt: string -dimensions: +topk: string +lastModifiedAt: string +fromTime: string +comments: - type: string limit: string +lastViewedAt: string ``` @@ -200,22 +200,22 @@ Replaces all fields in the specified reports resource. /*+ update */ REPLACE google.apigee.reports SET -fromTime = '{{ fromTime }}', -sortByCols = '{{ sortByCols }}', -offset = '{{ offset }}', +dimensions = '{{ dimensions }}', +displayName = '{{ displayName }}', sortOrder = '{{ sortOrder }}', -topk = '{{ topk }}', -name = '{{ name }}', -timeUnit = '{{ timeUnit }}', +filter = '{{ filter }}', chartType = '{{ chartType }}', metrics = '{{ metrics }}', -filter = '{{ filter }}', -properties = '{{ properties }}', +timeUnit = '{{ timeUnit }}', +name = '{{ name }}', toTime = '{{ toTime }}', -displayName = '{{ displayName }}', -comments = '{{ comments }}', +sortByCols = '{{ sortByCols }}', +properties = '{{ properties }}', +offset = '{{ offset }}', tags = '{{ tags }}', -dimensions = '{{ dimensions }}', +topk = '{{ topk }}', +fromTime = '{{ fromTime }}', +comments = '{{ comments }}', limit = '{{ limit }}' WHERE organizationsId = '{{ organizationsId }}' diff --git a/docs/google-docs/providers/google/apigee/resourcefiles/index.md b/docs/google-docs/providers/google/apigee/resourcefiles/index.md index f8acf74e06..e1ed9f8a6c 100644 --- a/docs/google-docs/providers/google/apigee/resourcefiles/index.md +++ b/docs/google-docs/providers/google/apigee/resourcefiles/index.md @@ -77,15 +77,15 @@ INSERT INTO google.apigee.resourcefiles ( environmentsId, organizationsId, contentType, -extensions, -data +data, +extensions ) SELECT '{{ environmentsId }}', '{{ organizationsId }}', '{{ contentType }}', -'{{ extensions }}', -'{{ data }}' +'{{ data }}', +'{{ extensions }}' ; ``` @@ -93,10 +93,10 @@ SELECT ```yaml contentType: string +data: string extensions: - additionalProperties: any type: string -data: string ``` @@ -111,8 +111,8 @@ Replaces all fields in the specified resourcefiles resource. REPLACE google.apigee.resourcefiles SET contentType = '{{ contentType }}', -extensions = '{{ extensions }}', -data = '{{ data }}' +data = '{{ data }}', +extensions = '{{ extensions }}' WHERE environmentsId = '{{ environmentsId }}' AND name = '{{ name }}' diff --git a/docs/google-docs/providers/google/apigee/revisions_api_proxy_revision/index.md b/docs/google-docs/providers/google/apigee/revisions_api_proxy_revision/index.md index 34ccec7b48..75bef8bac3 100644 --- a/docs/google-docs/providers/google/apigee/revisions_api_proxy_revision/index.md +++ b/docs/google-docs/providers/google/apigee/revisions_api_proxy_revision/index.md @@ -46,8 +46,8 @@ Updates a revisions_api_proxy_revision resource. UPDATE google.apigee.revisions_api_proxy_revision SET contentType = '{{ contentType }}', -extensions = '{{ extensions }}', -data = '{{ data }}' +data = '{{ data }}', +extensions = '{{ extensions }}' WHERE apisId = '{{ apisId }}' AND organizationsId = '{{ organizationsId }}' diff --git a/docs/google-docs/providers/google/apigee/revisions_shared_flow_revision/index.md b/docs/google-docs/providers/google/apigee/revisions_shared_flow_revision/index.md index faa95f1f97..30a732b37d 100644 --- a/docs/google-docs/providers/google/apigee/revisions_shared_flow_revision/index.md +++ b/docs/google-docs/providers/google/apigee/revisions_shared_flow_revision/index.md @@ -46,8 +46,8 @@ Updates a revisions_shared_flow_revision resource. UPDATE google.apigee.revisions_shared_flow_revision SET contentType = '{{ contentType }}', -extensions = '{{ extensions }}', -data = '{{ data }}' +data = '{{ data }}', +extensions = '{{ extensions }}' WHERE organizationsId = '{{ organizationsId }}' AND revisionsId = '{{ revisionsId }}' diff --git a/docs/google-docs/providers/google/apigee/security_actions/index.md b/docs/google-docs/providers/google/apigee/security_actions/index.md index 9fc1bacfc1..04caa1f2b6 100644 --- a/docs/google-docs/providers/google/apigee/security_actions/index.md +++ b/docs/google-docs/providers/google/apigee/security_actions/index.md @@ -94,76 +94,76 @@ Use the following StackQL query and manifest file to create a new security INSERT INTO google.apigee.security_actions ( environmentsId, organizationsId, -apiProxies, +state, +conditionConfig, +allow, name, description, -conditionConfig, deny, -state, ttl, -allow, flag, -expireTime +expireTime, +apiProxies ) SELECT '{{ environmentsId }}', '{{ organizationsId }}', -'{{ apiProxies }}', +'{{ state }}', +'{{ conditionConfig }}', +'{{ allow }}', '{{ name }}', '{{ description }}', -'{{ conditionConfig }}', '{{ deny }}', -'{{ state }}', '{{ ttl }}', -'{{ allow }}', '{{ flag }}', -'{{ expireTime }}' +'{{ expireTime }}', +'{{ apiProxies }}' ; ``` ```yaml -apiProxies: - - type: string -createTime: string -updateTime: string -name: string -description: string +state: string conditionConfig: - asns: - - type: string - format: string - ipAddressRanges: - - type: string - botReasons: - - type: string apiKeys: - type: string httpMethods: - type: string - accessTokens: - - type: string developers: - type: string - regionCodes: - - type: string apiProducts: - type: string + ipAddressRanges: + - type: string + botReasons: + - type: string + asns: + - format: string + type: string developerApps: - type: string + regionCodes: + - type: string + accessTokens: + - type: string userAgents: - type: string +allow: {} +name: string +description: string deny: responseCode: integer -state: string +createTime: string ttl: string -allow: {} +updateTime: string flag: headers: - value: string name: string expireTime: string +apiProxies: + - type: string ``` diff --git a/docs/google-docs/providers/google/apigee/security_profiles/index.md b/docs/google-docs/providers/google/apigee/security_profiles/index.md index 03de046177..d89c23cad7 100644 --- a/docs/google-docs/providers/google/apigee/security_profiles/index.md +++ b/docs/google-docs/providers/google/apigee/security_profiles/index.md @@ -92,50 +92,50 @@ Use the following StackQL query and manifest file to create a new security /*+ create */ INSERT INTO google.apigee.security_profiles ( organizationsId, -name, -displayName, +scoringConfigs, profileConfig, -environments, +displayName, +name, description, -scoringConfigs +environments ) SELECT '{{ organizationsId }}', -'{{ name }}', -'{{ displayName }}', +'{{ scoringConfigs }}', '{{ profileConfig }}', -'{{ environments }}', +'{{ displayName }}', +'{{ name }}', '{{ description }}', -'{{ scoringConfigs }}' +'{{ environments }}' ; ``` ```yaml -name: string -maxScore: integer -revisionCreateTime: string -displayName: string +scoringConfigs: + - description: string + title: string + scorePath: string profileConfig: categories: - - mtls: {} + - abuse: {} threat: {} - cors: {} mediation: {} + mtls: {} + cors: {} authorization: {} - abuse: {} -environments: - - attachTime: string - environment: string +displayName: string revisionPublishTime: string minScore: integer -description: string -scoringConfigs: - - description: string - scorePath: string - title: string revisionId: string +name: string +description: string +maxScore: integer +environments: + - environment: string + attachTime: string +revisionCreateTime: string revisionUpdateTime: string ``` @@ -150,12 +150,12 @@ Updates a security_profiles resource. /*+ update */ UPDATE google.apigee.security_profiles SET -name = '{{ name }}', -displayName = '{{ displayName }}', +scoringConfigs = '{{ scoringConfigs }}', profileConfig = '{{ profileConfig }}', -environments = '{{ environments }}', +displayName = '{{ displayName }}', +name = '{{ name }}', description = '{{ description }}', -scoringConfigs = '{{ scoringConfigs }}' +environments = '{{ environments }}' WHERE organizationsId = '{{ organizationsId }}' AND securityProfilesId = '{{ securityProfilesId }}'; diff --git a/docs/google-docs/providers/google/apigee/security_reports/index.md b/docs/google-docs/providers/google/apigee/security_reports/index.md index 3b6d47e273..979b02b692 100644 --- a/docs/google-docs/providers/google/apigee/security_reports/index.md +++ b/docs/google-docs/providers/google/apigee/security_reports/index.md @@ -94,55 +94,55 @@ Use the following StackQL query and manifest file to create a new security INSERT INTO google.apigee.security_reports ( environmentsId, organizationsId, -reportDefinitionId, envgroupHostname, -limit, -metrics, -dimensions, +displayName, groupByTimeUnit, -mimeType, +limit, timeRange, -csvDelimiter, +reportDefinitionId, filter, -displayName +csvDelimiter, +metrics, +dimensions, +mimeType ) SELECT '{{ environmentsId }}', '{{ organizationsId }}', -'{{ reportDefinitionId }}', '{{ envgroupHostname }}', -'{{ limit }}', -'{{ metrics }}', -'{{ dimensions }}', +'{{ displayName }}', '{{ groupByTimeUnit }}', -'{{ mimeType }}', +'{{ limit }}', '{{ timeRange }}', -'{{ csvDelimiter }}', +'{{ reportDefinitionId }}', '{{ filter }}', -'{{ displayName }}' +'{{ csvDelimiter }}', +'{{ metrics }}', +'{{ dimensions }}', +'{{ mimeType }}' ; ``` ```yaml -reportDefinitionId: string envgroupHostname: string +displayName: string +groupByTimeUnit: string limit: integer +timeRange: any +reportDefinitionId: string +filter: string +csvDelimiter: string metrics: - - operator: string - alias: string + - alias: string name: string aggregationFunction: string value: string + operator: string dimensions: - type: string -groupByTimeUnit: string mimeType: string -timeRange: any -csvDelimiter: string -filter: string -displayName: string ``` diff --git a/docs/google-docs/providers/google/apigee/security_settings/index.md b/docs/google-docs/providers/google/apigee/security_settings/index.md index c590af37b2..84e932fe1b 100644 --- a/docs/google-docs/providers/google/apigee/security_settings/index.md +++ b/docs/google-docs/providers/google/apigee/security_settings/index.md @@ -60,8 +60,8 @@ Updates a security_settings resource. /*+ update */ UPDATE google.apigee.security_settings SET -mlRetrainingFeedbackEnabled = true|false, -name = '{{ name }}' +name = '{{ name }}', +mlRetrainingFeedbackEnabled = true|false WHERE organizationsId = '{{ organizationsId }}'; ``` diff --git a/docs/google-docs/providers/google/apigee/sharedflows/index.md b/docs/google-docs/providers/google/apigee/sharedflows/index.md index 98ffdadf5a..776847887a 100644 --- a/docs/google-docs/providers/google/apigee/sharedflows/index.md +++ b/docs/google-docs/providers/google/apigee/sharedflows/index.md @@ -76,14 +76,14 @@ Use the following StackQL query and manifest file to create a new sharedfl INSERT INTO google.apigee.sharedflows ( organizationsId, contentType, -extensions, -data +data, +extensions ) SELECT '{{ organizationsId }}', '{{ contentType }}', -'{{ extensions }}', -'{{ data }}' +'{{ data }}', +'{{ extensions }}' ; ``` @@ -91,10 +91,10 @@ SELECT ```yaml contentType: string +data: string extensions: - additionalProperties: any type: string -data: string ``` diff --git a/docs/google-docs/providers/google/apigee/subscriptions/index.md b/docs/google-docs/providers/google/apigee/subscriptions/index.md index 0a92b89377..027aad2579 100644 --- a/docs/google-docs/providers/google/apigee/subscriptions/index.md +++ b/docs/google-docs/providers/google/apigee/subscriptions/index.md @@ -81,28 +81,28 @@ Use the following StackQL query and manifest file to create a new subscrip INSERT INTO google.apigee.subscriptions ( developersId, organizationsId, -apiproduct, +endTime, startTime, -endTime +apiproduct ) SELECT '{{ developersId }}', '{{ organizationsId }}', -'{{ apiproduct }}', +'{{ endTime }}', '{{ startTime }}', -'{{ endTime }}' +'{{ apiproduct }}' ; ``` ```yaml -apiproduct: string -lastModifiedAt: string createdAt: string +lastModifiedAt: string +endTime: string startTime: string name: string -endTime: string +apiproduct: string ``` diff --git a/docs/google-docs/providers/google/apigee/targetservers/index.md b/docs/google-docs/providers/google/apigee/targetservers/index.md index 31c43e305a..7a558908ed 100644 --- a/docs/google-docs/providers/google/apigee/targetservers/index.md +++ b/docs/google-docs/providers/google/apigee/targetservers/index.md @@ -84,51 +84,51 @@ Use the following StackQL query and manifest file to create a new targetse INSERT INTO google.apigee.targetservers ( environmentsId, organizationsId, -sSLInfo, -host, -name, isEnabled, port, description, -protocol +sSLInfo, +host, +protocol, +name ) SELECT '{{ environmentsId }}', '{{ organizationsId }}', -'{{ sSLInfo }}', -'{{ host }}', -'{{ name }}', true|false, '{{ port }}', '{{ description }}', -'{{ protocol }}' +'{{ sSLInfo }}', +'{{ host }}', +'{{ protocol }}', +'{{ name }}' ; ``` ```yaml +isEnabled: boolean +port: integer +description: string sSLInfo: + trustStore: string commonName: value: string wildcardMatch: boolean + keyAlias: string + ignoreValidationErrors: boolean ciphers: - type: string - clientAuthEnabled: boolean - ignoreValidationErrors: boolean + protocols: + - type: string enforce: boolean - trustStore: string + clientAuthEnabled: boolean enabled: boolean - keyAlias: string keyStore: string - protocols: - - type: string host: string -name: string -isEnabled: boolean -port: integer -description: string protocol: string +name: string ``` @@ -142,13 +142,13 @@ Replaces all fields in the specified targetservers resource. /*+ update */ REPLACE google.apigee.targetservers SET -sSLInfo = '{{ sSLInfo }}', -host = '{{ host }}', -name = '{{ name }}', isEnabled = true|false, port = '{{ port }}', description = '{{ description }}', -protocol = '{{ protocol }}' +sSLInfo = '{{ sSLInfo }}', +host = '{{ host }}', +protocol = '{{ protocol }}', +name = '{{ name }}' WHERE environmentsId = '{{ environmentsId }}' AND organizationsId = '{{ organizationsId }}' diff --git a/docs/google-docs/providers/google/apikeys/keys/index.md b/docs/google-docs/providers/google/apikeys/keys/index.md index f5f9f8aafa..c8e9b6da80 100644 --- a/docs/google-docs/providers/google/apikeys/keys/index.md +++ b/docs/google-docs/providers/google/apikeys/keys/index.md @@ -92,49 +92,49 @@ Use the following StackQL query and manifest file to create a new keys ```yaml -name: string -etag: string -createTime: string -annotations: object -uid: string -keyString: string restrictions: serverKeyRestrictions: allowedIps: - type: string - apiTargets: - - service: string - methods: - - type: string - iosKeyRestrictions: - allowedBundleIds: + browserKeyRestrictions: + allowedReferrers: - type: string androidKeyRestrictions: allowedApplications: - - packageName: string - sha1Fingerprint: string - browserKeyRestrictions: - allowedReferrers: + - sha1Fingerprint: string + packageName: string + iosKeyRestrictions: + allowedBundleIds: - type: string + apiTargets: + - methods: + - type: string + service: string +deleteTime: string +createTime: string displayName: string updateTime: string -deleteTime: string +annotations: object +name: string +uid: string +keyString: string +etag: string ``` @@ -148,9 +148,9 @@ Updates a keys resource. /*+ update */ UPDATE google.apikeys.keys SET -annotations = '{{ annotations }}', restrictions = '{{ restrictions }}', -displayName = '{{ displayName }}' +displayName = '{{ displayName }}', +annotations = '{{ annotations }}' WHERE keysId = '{{ keysId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/assuredworkloads/workloads/index.md b/docs/google-docs/providers/google/assuredworkloads/workloads/index.md index 8953af096f..1617e3f12f 100644 --- a/docs/google-docs/providers/google/assuredworkloads/workloads/index.md +++ b/docs/google-docs/providers/google/assuredworkloads/workloads/index.md @@ -118,90 +118,90 @@ Use the following StackQL query and manifest file to create a new workload INSERT INTO google.assuredworkloads.workloads ( locationsId, organizationsId, -resourceSettings, -partner, -displayName, -kmsSettings, -partnerServicesBillingAccount, -violationNotificationsEnabled, -enableSovereignControls, billingAccount, -etag, -complianceRegime, partnerPermissions, +violationNotificationsEnabled, +partnerServicesBillingAccount, +kmsSettings, +complianceRegime, +etag, provisionedResourcesParent, +displayName, +enableSovereignControls, labels, -name +partner, +name, +resourceSettings ) SELECT '{{ locationsId }}', '{{ organizationsId }}', -'{{ resourceSettings }}', -'{{ partner }}', -'{{ displayName }}', -'{{ kmsSettings }}', -'{{ partnerServicesBillingAccount }}', -true|false, -true|false, '{{ billingAccount }}', -'{{ etag }}', -'{{ complianceRegime }}', '{{ partnerPermissions }}', +true|false, +'{{ partnerServicesBillingAccount }}', +'{{ kmsSettings }}', +'{{ complianceRegime }}', +'{{ etag }}', '{{ provisionedResourcesParent }}', +'{{ displayName }}', +true|false, '{{ labels }}', -'{{ name }}' +'{{ partner }}', +'{{ name }}', +'{{ resourceSettings }}' ; ``` ```yaml +resources: + - resourceId: string + resourceType: string +billingAccount: string +partnerPermissions: + accessTransparencyLogsSupportCaseViewer: boolean + dataLogsViewer: boolean + serviceAccessApprover: boolean + assuredWorkloadsMonitoring: boolean +violationNotificationsEnabled: boolean +partnerServicesBillingAccount: string +kajEnrollmentState: string saaEnrollmentResponse: setupStatus: string setupErrors: - type: string - enum: string enumDescriptions: string -resourceSettings: - - resourceId: string - displayName: string - resourceType: string -partner: string -createTime: string -resources: - - resourceId: string - resourceType: string -displayName: string + enum: string kmsSettings: - nextRotationTime: string rotationPeriod: string -partnerServicesBillingAccount: string + nextRotationTime: string +complianceRegime: string +etag: string +ekmProvisioningResponse: + ekmProvisioningErrorDomain: string + ekmProvisioningState: string + ekmProvisioningErrorMapping: string +provisionedResourcesParent: string +displayName: string +enableSovereignControls: boolean +labels: object complianceStatus: - activeResourceViolationCount: integer + acknowledgedResourceViolationCount: integer acknowledgedViolationCount: integer activeViolationCount: integer - acknowledgedResourceViolationCount: integer + activeResourceViolationCount: integer resourceMonitoringEnabled: boolean -kajEnrollmentState: string -violationNotificationsEnabled: boolean -enableSovereignControls: boolean -billingAccount: string -etag: string -complianceRegime: string -partnerPermissions: - assuredWorkloadsMonitoring: boolean - serviceAccessApprover: boolean - dataLogsViewer: boolean - accessTransparencyLogsSupportCaseViewer: boolean +partner: string +name: string +resourceSettings: + - displayName: string + resourceId: string + resourceType: string compliantButDisallowedServices: - type: string -provisionedResourcesParent: string -labels: object -ekmProvisioningResponse: - ekmProvisioningErrorMapping: string - ekmProvisioningState: string - ekmProvisioningErrorDomain: string -name: string +createTime: string ``` @@ -215,20 +215,20 @@ Updates a workloads resource. /*+ update */ UPDATE google.assuredworkloads.workloads SET -resourceSettings = '{{ resourceSettings }}', -partner = '{{ partner }}', -displayName = '{{ displayName }}', -kmsSettings = '{{ kmsSettings }}', -partnerServicesBillingAccount = '{{ partnerServicesBillingAccount }}', -violationNotificationsEnabled = true|false, -enableSovereignControls = true|false, billingAccount = '{{ billingAccount }}', -etag = '{{ etag }}', -complianceRegime = '{{ complianceRegime }}', partnerPermissions = '{{ partnerPermissions }}', +violationNotificationsEnabled = true|false, +partnerServicesBillingAccount = '{{ partnerServicesBillingAccount }}', +kmsSettings = '{{ kmsSettings }}', +complianceRegime = '{{ complianceRegime }}', +etag = '{{ etag }}', provisionedResourcesParent = '{{ provisionedResourcesParent }}', +displayName = '{{ displayName }}', +enableSovereignControls = true|false, labels = '{{ labels }}', -name = '{{ name }}' +partner = '{{ partner }}', +name = '{{ name }}', +resourceSettings = '{{ resourceSettings }}' WHERE locationsId = '{{ locationsId }}' AND organizationsId = '{{ organizationsId }}' diff --git a/docs/google-docs/providers/google/beyondcorp/app_connectors/index.md b/docs/google-docs/providers/google/beyondcorp/app_connectors/index.md index 09b03a2c84..16c6be1e7d 100644 --- a/docs/google-docs/providers/google/beyondcorp/app_connectors/index.md +++ b/docs/google-docs/providers/google/beyondcorp/app_connectors/index.md @@ -71,7 +71,112 @@ FROM google.beyondcorp.app_connectors WHERE locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}'; ``` -undefined + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new app_connectors resource. + + + + +```sql +/*+ create */ +INSERT INTO google.beyondcorp.app_connectors ( +locationsId, +projectsId, +name, +labels, +displayName, +principalInfo, +resourceInfo +) +SELECT +'{{ locationsId }}', +'{{ projectsId }}', +'{{ name }}', +'{{ labels }}', +'{{ displayName }}', +'{{ principalInfo }}', +'{{ resourceInfo }}' +; +``` + + + +```yaml +name: string +createTime: string +updateTime: string +labels: object +displayName: string +uid: string +state: string +principalInfo: + serviceAccount: + email: string +resourceInfo: + id: string + status: string + resource: object + time: string + sub: + - id: string + status: string + resource: object + time: string + sub: + - id: string + status: string + resource: object + time: string + sub: + - id: string + status: string + resource: object + time: string + sub: + - id: string + status: string + resource: object + time: string + sub: + - id: string + status: string + resource: object + time: string + sub: + - id: string + status: string + resource: object + time: string + sub: + - id: string + status: string + resource: object + time: string + sub: + - id: string + status: string + resource: object + time: string + sub: + - id: string + status: string + resource: object + time: string + sub: + - {} + +``` + + + ## `UPDATE` example Updates a app_connectors resource. diff --git a/docs/google-docs/providers/google/bigquery/datasets/index.md b/docs/google-docs/providers/google/bigquery/datasets/index.md index 6790f54fed..ec8536c2de 100644 --- a/docs/google-docs/providers/google/bigquery/datasets/index.md +++ b/docs/google-docs/providers/google/bigquery/datasets/index.md @@ -53,7 +53,7 @@ Creates, updates, deletes, gets or lists a datasets resource. | | `object` | A dataset source type which refers to another BigQuery dataset. | | | `string` | The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. | | | `string` | Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. | -| | `object` | 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. | +| | `object` | Optional. The [tags](https://cloud.google.com/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](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. | | | `object` | | | | `boolean` | Output only. Reserved for future use. | | | `boolean` | Output only. Reserved for future use. | diff --git a/docs/google-docs/providers/google/bigquery/jobs/index.md b/docs/google-docs/providers/google/bigquery/jobs/index.md index d7f0abd8c5..eed8acb8c0 100644 --- a/docs/google-docs/providers/google/bigquery/jobs/index.md +++ b/docs/google-docs/providers/google/bigquery/jobs/index.md @@ -34,7 +34,7 @@ Creates, updates, deletes, gets or lists a jobs resource. | | `string` | Output only. Opaque ID field of the job. | | | `object` | | | | `string` | Output only. A hash of this resource. | -| | `object` | Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. This feature is not yet available. Jobs will always be created. | +| | `object` | Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. [Preview](https://cloud.google.com/products/#product-launch-stages) | | | `object` | A job reference is a fully qualified identifier for referring to a job. | | | `string` | Output only. The type of the resource. | | | `string` | Output only. [Full-projection-only] String representation of identity of requesting party. Populated for both first- and third-party identities. Only present for APIs that support third-party identities. | @@ -73,7 +73,856 @@ user_email FROM google.bigquery.jobs WHERE projectId = '{{ projectId }}'; ``` -undefined + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new jobs resource. + + + + +```sql +/*+ create */ +INSERT INTO google.bigquery.jobs ( +projectId, +configuration, +jobReference +) +SELECT +'{{ projectId }}', +'{{ configuration }}', +'{{ jobReference }}' +; +``` + + + +```yaml +configuration: + copy: + createDisposition: string + destinationEncryptionConfiguration: + kmsKeyName: string + destinationExpirationTime: string + destinationTable: + datasetId: string + projectId: string + tableId: string + operationType: string + sourceTables: + - datasetId: string + projectId: string + tableId: string + writeDisposition: string + dryRun: boolean + extract: + compression: string + destinationFormat: string + destinationUri: string + destinationUris: + - type: string + fieldDelimiter: string + modelExtractOptions: + trialId: string + printHeader: boolean + sourceModel: + datasetId: string + modelId: string + projectId: string + useAvroLogicalTypes: boolean + jobTimeoutMs: string + jobType: string + labels: object + load: + allowJaggedRows: boolean + allowQuotedNewlines: boolean + autodetect: boolean + clustering: + fields: + - type: string + columnNameCharacterMap: string + connectionProperties: + - key: string + value: string + copyFilesOnly: boolean + createDisposition: string + createSession: boolean + decimalTargetTypes: + - enum: string + enumDescriptions: string + type: string + destinationTableProperties: + description: string + expirationTime: string + friendlyName: string + labels: object + encoding: string + fieldDelimiter: string + fileSetSpecType: string + hivePartitioningOptions: + fields: + - type: string + mode: string + requirePartitionFilter: boolean + sourceUriPrefix: string + ignoreUnknownValues: boolean + jsonExtension: string + maxBadRecords: integer + nullMarker: string + parquetOptions: + enableListInference: boolean + enumAsString: boolean + mapTargetType: string + preserveAsciiControlCharacters: boolean + projectionFields: + - type: string + quote: string + rangePartitioning: + field: string + range: + end: string + interval: string + start: string + referenceFileSchemaUri: string + schema: + fields: + - categories: + names: + - type: string + collation: string + dataPolicies: + - name: string + defaultValueExpression: string + description: string + fields: + - categories: + names: + - type: string + collation: string + dataPolicies: + - name: string + defaultValueExpression: string + description: string + fields: + - categories: + names: + - type: string + collation: string + dataPolicies: + - name: string + defaultValueExpression: string + description: string + fields: + - categories: + names: + - type: string + collation: string + dataPolicies: + - name: string + defaultValueExpression: string + description: string + fields: + - categories: + names: + - type: string + collation: string + dataPolicies: + - name: string + defaultValueExpression: string + description: string + fields: + - categories: + names: + - {} + collation: string + dataPolicies: + - name: string + defaultValueExpression: string + description: string + fields: + - categories: {} + collation: string + dataPolicies: + - {} + defaultValueExpression: string + description: string + fields: + - {} + foreignTypeDefinition: string + maxLength: string + mode: string + name: string + policyTags: {} + precision: string + rangeElementType: {} + roundingMode: string + scale: string + type: string + foreignTypeDefinition: string + maxLength: string + mode: string + name: string + policyTags: + names: + - {} + precision: string + rangeElementType: + type: string + roundingMode: string + scale: string + type: string + foreignTypeDefinition: string + maxLength: string + mode: string + name: string + policyTags: + names: + - type: string + precision: string + rangeElementType: + type: string + roundingMode: string + scale: string + type: string + foreignTypeDefinition: string + maxLength: string + mode: string + name: string + policyTags: + names: + - type: string + precision: string + rangeElementType: + type: string + roundingMode: string + scale: string + type: string + foreignTypeDefinition: string + maxLength: string + mode: string + name: string + policyTags: + names: + - type: string + precision: string + rangeElementType: + type: string + roundingMode: string + scale: string + type: string + foreignTypeDefinition: string + maxLength: string + mode: string + name: string + policyTags: + names: + - type: string + precision: string + rangeElementType: + type: string + roundingMode: string + scale: string + type: string + foreignTypeDefinition: string + maxLength: string + mode: string + name: string + policyTags: + names: + - type: string + precision: string + rangeElementType: + type: string + roundingMode: string + scale: string + type: string + foreignTypeInfo: + typeSystem: string + schemaInline: string + schemaInlineFormat: string + schemaUpdateOptions: + - type: string + skipLeadingRows: integer + sourceFormat: string + sourceUris: + - type: string + timePartitioning: + expirationMs: string + field: string + requirePartitionFilter: boolean + type: string + useAvroLogicalTypes: boolean + writeDisposition: string + query: + allowLargeResults: boolean + connectionProperties: + - key: string + value: string + continuous: boolean + createDisposition: string + createSession: boolean + defaultDataset: + datasetId: string + projectId: string + flattenResults: boolean + maximumBillingTier: integer + maximumBytesBilled: string + parameterMode: string + preserveNulls: boolean + priority: string + query: string + queryParameters: + - name: string + parameterType: + structTypes: + - description: string + name: string + type: string + parameterValue: + arrayValues: + - arrayValues: + - arrayValues: + - arrayValues: + - arrayValues: + - arrayValues: + - arrayValues: + - {} + rangeValue: {} + structValues: object + value: string + structValues: object + value: string + structValues: object + value: string + structValues: object + value: string + structValues: object + value: string + structValues: object + value: string + structValues: object + value: string + schemaUpdateOptions: + - type: string + scriptOptions: + keyResultStatement: string + statementByteBudget: string + statementTimeoutMs: string + systemVariables: + types: object + values: object + tableDefinitions: object + useLegacySql: boolean + useQueryCache: boolean + userDefinedFunctionResources: + - inlineCode: string + resourceUri: string + writeDisposition: string +etag: string +id: string +jobCreationReason: + code: string +jobReference: + jobId: string + location: string + projectId: string +kind: string +principal_subject: string +selfLink: string +statistics: + completionRatio: number + copy: + copiedLogicalBytes: string + copiedRows: string + creationTime: string + dataMaskingStatistics: + dataMaskingApplied: boolean + edition: string + endTime: string + extract: + destinationUriFileCounts: + - format: string + type: string + inputBytes: string + timeline: + - activeUnits: string + completedUnits: string + elapsedMs: string + estimatedRunnableUnits: string + pendingUnits: string + totalSlotMs: string + finalExecutionDurationMs: string + load: + badRecords: string + inputFileBytes: string + inputFiles: string + outputBytes: string + outputRows: string + timeline: + - activeUnits: string + completedUnits: string + elapsedMs: string + estimatedRunnableUnits: string + pendingUnits: string + totalSlotMs: string + numChildJobs: string + parentJobId: string + query: + biEngineStatistics: + accelerationMode: string + biEngineMode: string + biEngineReasons: + - code: string + message: string + billingTier: integer + cacheHit: boolean + ddlAffectedRowAccessPolicyCount: string + ddlOperationPerformed: string + ddlTargetRoutine: + datasetId: string + projectId: string + routineId: string + ddlTargetRowAccessPolicy: + datasetId: string + policyId: string + projectId: string + tableId: string + dmlStats: + deletedRowCount: string + insertedRowCount: string + updatedRowCount: string + estimatedBytesProcessed: string + exportDataStatistics: + fileCount: string + rowCount: string + externalServiceCosts: + - bytesBilled: string + bytesProcessed: string + externalService: string + reservedSlotCount: string + slotMs: string + loadQueryStatistics: + badRecords: string + bytesTransferred: string + inputFileBytes: string + inputFiles: string + outputBytes: string + outputRows: string + materializedViewStatistics: + materializedView: + - chosen: boolean + estimatedBytesSaved: string + rejectedReason: string + metadataCacheStatistics: + tableMetadataCacheUsage: + - explanation: string + staleness: string + tableType: string + unusedReason: string + mlStatistics: + hparamTrials: + - endTimeMs: string + errorMessage: string + evalLoss: number + evaluationMetrics: + arimaForecastingMetrics: + arimaFittingMetrics: + - aic: number + logLikelihood: number + variance: number + arimaSingleModelForecastingMetrics: + - arimaFittingMetrics: + aic: number + logLikelihood: number + variance: number + hasDrift: boolean + hasHolidayEffect: boolean + hasSpikesAndDips: boolean + hasStepChanges: boolean + nonSeasonalOrder: + d: string + p: string + q: string + seasonalPeriods: + - enum: string + enumDescriptions: string + type: string + timeSeriesId: string + timeSeriesIds: + - type: string + hasDrift: + - type: string + nonSeasonalOrder: + - d: string + p: string + q: string + seasonalPeriods: + - enum: string + enumDescriptions: string + type: string + timeSeriesId: + - type: string + binaryClassificationMetrics: + aggregateClassificationMetrics: + accuracy: number + f1Score: number + logLoss: number + precision: number + recall: number + rocAuc: number + threshold: number + binaryConfusionMatrixList: + - accuracy: number + f1Score: number + falseNegatives: string + falsePositives: string + positiveClassThreshold: number + precision: number + recall: number + trueNegatives: string + truePositives: string + negativeLabel: string + positiveLabel: string + clusteringMetrics: + clusters: + - centroidId: string + count: string + featureValues: + - categoricalValue: + categoryCounts: + - category: string + count: string + featureColumn: string + numericalValue: number + daviesBouldinIndex: number + meanSquaredDistance: number + dimensionalityReductionMetrics: + totalExplainedVarianceRatio: number + multiClassClassificationMetrics: + confusionMatrixList: + - confidenceThreshold: number + rows: + - actualLabel: string + entries: + - itemCount: string + predictedLabel: string + rankingMetrics: + averageRank: number + meanAveragePrecision: number + meanSquaredError: number + normalizedDiscountedCumulativeGain: number + regressionMetrics: + meanAbsoluteError: number + meanSquaredError: number + meanSquaredLogError: number + medianAbsoluteError: number + rSquared: number + hparams: + activationFn: string + adjustStepChanges: boolean + approxGlobalFeatureContrib: boolean + autoArima: boolean + autoArimaMaxOrder: string + autoArimaMinOrder: string + autoClassWeights: boolean + batchSize: string + boosterType: string + budgetHours: number + calculatePValues: boolean + categoryEncodingMethod: string + cleanSpikesAndDips: boolean + colorSpace: string + colsampleBylevel: number + colsampleBynode: number + colsampleBytree: number + dartNormalizeType: string + dataFrequency: string + dataSplitColumn: string + dataSplitEvalFraction: number + dataSplitMethod: string + decomposeTimeSeries: boolean + distanceType: string + dropout: number + earlyStop: boolean + enableGlobalExplain: boolean + feedbackType: string + fitIntercept: boolean + hiddenUnits: + - format: string + type: string + holidayRegion: string + holidayRegions: + - enum: string + enumDescriptions: string + type: string + horizon: string + hparamTuningObjectives: + - enum: string + enumDescriptions: string + type: string + includeDrift: boolean + initialLearnRate: number + inputLabelColumns: + - type: string + instanceWeightColumn: string + integratedGradientsNumSteps: string + itemColumn: string + kmeansInitializationColumn: string + kmeansInitializationMethod: string + l1RegActivation: number + l1Regularization: number + l2Regularization: number + labelClassWeights: object + learnRate: number + learnRateStrategy: string + lossType: string + maxIterations: string + maxParallelTrials: string + maxTimeSeriesLength: string + maxTreeDepth: string + minRelativeProgress: number + minSplitLoss: number + minTimeSeriesLength: string + minTreeChildWeight: string + modelRegistry: string + modelUri: string + numClusters: string + numFactors: string + numParallelTree: string + numPrincipalComponents: string + numTrials: string + optimizationStrategy: string + optimizer: string + pcaExplainedVarianceRatio: number + pcaSolver: string + sampledShapleyNumPaths: string + scaleFeatures: boolean + standardizeFeatures: boolean + subsample: number + tfVersion: string + timeSeriesDataColumn: string + timeSeriesIdColumn: string + timeSeriesIdColumns: + - type: string + timeSeriesLengthFraction: number + timeSeriesTimestampColumn: string + treeMethod: string + trendSmoothingWindowSize: string + userColumn: string + vertexAiModelVersionAliases: + - type: string + walsAlpha: number + warmStart: boolean + xgboostVersion: string + startTimeMs: string + status: string + trainingLoss: number + trialId: string + iterationResults: + - arimaResult: + arimaModelInfo: + - arimaCoefficients: + autoRegressiveCoefficients: + - format: string + type: string + interceptCoefficient: number + movingAverageCoefficients: + - format: string + type: string + hasDrift: boolean + hasHolidayEffect: boolean + hasSpikesAndDips: boolean + hasStepChanges: boolean + seasonalPeriods: + - enum: string + enumDescriptions: string + type: string + timeSeriesId: string + timeSeriesIds: + - type: string + seasonalPeriods: + - enum: string + enumDescriptions: string + type: string + clusterInfos: + - centroidId: string + clusterRadius: number + clusterSize: string + durationMs: string + evalLoss: number + index: integer + learnRate: number + principalComponentInfos: + - cumulativeExplainedVarianceRatio: number + explainedVariance: number + explainedVarianceRatio: number + principalComponentId: string + trainingLoss: number + maxIterations: string + modelType: string + trainingType: string + modelTraining: + currentIteration: integer + expectedTotalIterations: string + modelTrainingCurrentIteration: integer + modelTrainingExpectedTotalIteration: string + numDmlAffectedRows: string + performanceInsights: + avgPreviousExecutionMs: string + stagePerformanceChangeInsights: + - inputDataChange: + recordsReadDiffPercentage: number + stageId: string + stagePerformanceStandaloneInsights: + - biEngineReasons: + - code: string + message: string + highCardinalityJoins: + - leftRows: string + outputRows: string + rightRows: string + stepIndex: integer + insufficientShuffleQuota: boolean + partitionSkew: + skewSources: + - stageId: string + slotContention: boolean + stageId: string + queryInfo: + optimizationDetails: object + queryPlan: + - completedParallelInputs: string + computeMode: string + computeMsAvg: string + computeMsMax: string + computeRatioAvg: number + computeRatioMax: number + endMs: string + id: string + inputStages: + - format: string + type: string + name: string + parallelInputs: string + readMsAvg: string + readMsMax: string + readRatioAvg: number + readRatioMax: number + recordsRead: string + recordsWritten: string + shuffleOutputBytes: string + shuffleOutputBytesSpilled: string + slotMs: string + startMs: string + status: string + steps: + - kind: string + substeps: + - type: string + waitMsAvg: string + waitMsMax: string + waitRatioAvg: number + waitRatioMax: number + writeMsAvg: string + writeMsMax: string + writeRatioAvg: number + writeRatioMax: number + referencedRoutines: + - datasetId: string + projectId: string + routineId: string + referencedTables: + - datasetId: string + projectId: string + tableId: string + reservationUsage: + - name: string + slotMs: string + searchStatistics: + indexUnusedReasons: + - code: string + indexName: string + message: string + indexUsageMode: string + sparkStatistics: + endpoints: object + gcsStagingBucket: string + kmsKeyName: string + loggingInfo: + projectId: string + resourceType: string + sparkJobId: string + sparkJobLocation: string + statementType: string + timeline: + - activeUnits: string + completedUnits: string + elapsedMs: string + estimatedRunnableUnits: string + pendingUnits: string + totalSlotMs: string + totalBytesBilled: string + totalBytesProcessed: string + totalBytesProcessedAccuracy: string + totalPartitionsProcessed: string + totalSlotMs: string + transferredBytes: string + undeclaredQueryParameters: + - name: string + vectorSearchStatistics: + indexUnusedReasons: + - code: string + indexName: string + message: string + indexUsageMode: string + quotaDeferments: + - type: string + reservationUsage: + - name: string + slotMs: string + reservation_id: string + rowLevelSecurityStatistics: + rowLevelSecurityApplied: boolean + scriptStatistics: + evaluationKind: string + stackFrames: + - endColumn: integer + endLine: integer + procedureId: string + startColumn: integer + startLine: integer + text: string + sessionInfo: + sessionId: string + startTime: string + totalBytesProcessed: string + totalSlotMs: string + transactionInfo: + transactionId: string +status: + errorResult: + debugInfo: string + location: string + message: string + reason: string + errors: + - debugInfo: string + location: string + message: string + reason: string + state: string +user_email: string + +``` + + + ## `DELETE` example Deletes the specified jobs resource. diff --git a/docs/google-docs/providers/google/bigquery/models/index.md b/docs/google-docs/providers/google/bigquery/models/index.md index 7796cc9687..553bc35ac6 100644 --- a/docs/google-docs/providers/google/bigquery/models/index.md +++ b/docs/google-docs/providers/google/bigquery/models/index.md @@ -34,21 +34,21 @@ Creates, updates, deletes, gets or lists a models resource. | | `string` | Optional. A user-friendly description of this model. | | | `string` | The best trial_id across all training runs. | | | `string` | Output only. The time when this model was created, in millisecs since the epoch. | -| | `string` | Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the best trial ID. For multi-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the smallest trial ID among all Pareto optimal trials. | +| | `string` | Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the best trial ID. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the smallest trial ID among all Pareto optimal trials. | | | `object` | Configuration for Cloud KMS encryption settings. | | | `string` | Output only. A hash of this resource. | | | `string` | Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models. | | | `array` | Output only. Input feature columns for the model inference. If the model is trained with TRANSFORM clause, these are the input of the TRANSFORM clause. | | | `string` | Optional. A descriptive name for this model. | | | `object` | Hyperparameter search spaces. These should be a subset of training_options. | -| | `array` | Output only. Trials of a [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) model sorted by trial_id. | +| | `array` | Output only. Trials of a [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) model sorted by trial_id. | | | `array` | Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns. | | | `object` | The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, 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 and each label in the list must have a different key. | | | `string` | Output only. The time when this model was last modified, in millisecs since the epoch. | | | `string` | Output only. The geographic location where the model resides. This value is inherited from the dataset. | | | `object` | Id path of a model. | | | `string` | Output only. Type of the model resource. | -| | `array` | Output only. For single-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it only contains the best trial. For multi-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it contains all Pareto optimal trials sorted by trial_id. | +| | `array` | Output only. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it only contains the best trial. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it contains all Pareto optimal trials sorted by trial_id. | | | `object` | Remote Model Info | | | `array` | Information for all training runs in increasing order of start_time. | | | `array` | Output only. This field will be populated if a TRANSFORM clause was used to train a model. TRANSFORM clause (if used) takes feature_columns as input and outputs transform_columns. transform_columns then are used to train the model. | diff --git a/docs/google-docs/providers/google/bigquery/routines/index.md b/docs/google-docs/providers/google/bigquery/routines/index.md index b552910ebc..8e0044d96d 100644 --- a/docs/google-docs/providers/google/bigquery/routines/index.md +++ b/docs/google-docs/providers/google/bigquery/routines/index.md @@ -43,7 +43,7 @@ Creates, updates, deletes, gets or lists a routines resource. | | `string` | Output only. The time when this routine was last modified, in milliseconds since the epoch. | | | `object` | Options for a remote user-defined function. | | | `object` | A table type | -| | `object` | The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } | +| | `object` | The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } | | | `object` | Id path of a routine. | | | `string` | Required. The type of routine. | | | `string` | Optional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine's configuration. | diff --git a/docs/google-docs/providers/google/bigquery/tables/index.md b/docs/google-docs/providers/google/bigquery/tables/index.md index 9b3b52bda5..afbd41ba3e 100644 --- a/docs/google-docs/providers/google/bigquery/tables/index.md +++ b/docs/google-docs/providers/google/bigquery/tables/index.md @@ -80,7 +80,7 @@ Creates, updates, deletes, gets or lists a tables resource. | | `object` | | | | `object` | Replication info of a table created using `AS REPLICA` DDL like: `CREATE MATERIALIZED VIEW mv1 AS REPLICA OF src_mv` | | | `object` | | -| | `string` | Output only. Describes the table type. The following values are supported: * `TABLE`: A normal BigQuery table. * `VIEW`: A virtual table defined by a SQL query. * `EXTERNAL`: A table that references data stored in an external storage system, such as Google Cloud Storage. * `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table snapshots](/bigquery/docs/table-snapshots-intro). The default value is `TABLE`. | +| | `string` | Output only. Describes the table type. The following values are supported: * `TABLE`: A normal BigQuery table. * `VIEW`: A virtual table defined by a SQL query. * `EXTERNAL`: A table that references data stored in an external storage system, such as Google Cloud Storage. * `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table snapshots](https://cloud.google.com/bigquery/docs/table-snapshots-intro). The default value is `TABLE`. | | | `object` | Describes the definition of a logical view. | ## Methods @@ -154,7 +154,491 @@ FROM google.bigquery.tables WHERE +datasetId = '{{ +datasetId }}' AND projectId = '{{ projectId }}'; ``` -undefined + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new tables resource. + + + + +```sql +/*+ create */ +INSERT INTO google.bigquery.tables ( ++datasetId, +projectId, +biglakeConfiguration, +clustering, +defaultCollation, +defaultRoundingMode, +description, +encryptionConfiguration, +expirationTime, +externalCatalogTableOptions, +externalDataConfiguration, +friendlyName, +labels, +materializedView, +maxStaleness, +model, +partitionDefinition, +rangePartitioning, +requirePartitionFilter, +resourceTags, +schema, +tableConstraints, +tableReference, +tableReplicationInfo, +timePartitioning, +view +) +SELECT +'{{ +datasetId }}', +'{{ projectId }}', +'{{ biglakeConfiguration }}', +'{{ clustering }}', +'{{ defaultCollation }}', +'{{ defaultRoundingMode }}', +'{{ description }}', +'{{ encryptionConfiguration }}', +'{{ expirationTime }}', +'{{ externalCatalogTableOptions }}', +'{{ externalDataConfiguration }}', +'{{ friendlyName }}', +'{{ labels }}', +'{{ materializedView }}', +'{{ maxStaleness }}', +'{{ model }}', +'{{ partitionDefinition }}', +'{{ rangePartitioning }}', +true|false, +'{{ resourceTags }}', +'{{ schema }}', +'{{ tableConstraints }}', +'{{ tableReference }}', +'{{ tableReplicationInfo }}', +'{{ timePartitioning }}', +'{{ view }}' +; +``` + + + +```yaml +biglakeConfiguration: + connectionId: string + fileFormat: string + storageUri: string + tableFormat: string +cloneDefinition: + baseTableReference: + datasetId: string + projectId: string + tableId: string + cloneTime: string +clustering: + fields: + - type: string +creationTime: string +defaultCollation: string +defaultRoundingMode: string +description: string +encryptionConfiguration: + kmsKeyName: string +etag: string +expirationTime: string +externalCatalogTableOptions: + connectionId: string + parameters: object + storageDescriptor: + inputFormat: string + locationUri: string + outputFormat: string + serdeInfo: + name: string + parameters: object + serializationLibrary: string +externalDataConfiguration: + autodetect: boolean + avroOptions: + useAvroLogicalTypes: boolean + bigtableOptions: + columnFamilies: + - columns: + - encoding: string + fieldName: string + onlyReadLatest: boolean + qualifierEncoded: string + qualifierString: string + type: string + encoding: string + familyId: string + onlyReadLatest: boolean + type: string + ignoreUnspecifiedColumnFamilies: boolean + outputColumnFamiliesAsJson: boolean + readRowkeyAsString: boolean + compression: string + connectionId: string + csvOptions: + allowJaggedRows: boolean + allowQuotedNewlines: boolean + encoding: string + fieldDelimiter: string + nullMarker: string + preserveAsciiControlCharacters: boolean + quote: string + skipLeadingRows: string + decimalTargetTypes: + - enum: string + enumDescriptions: string + type: string + fileSetSpecType: string + googleSheetsOptions: + range: string + skipLeadingRows: string + hivePartitioningOptions: + fields: + - type: string + mode: string + requirePartitionFilter: boolean + sourceUriPrefix: string + ignoreUnknownValues: boolean + jsonExtension: string + jsonOptions: + encoding: string + maxBadRecords: integer + metadataCacheMode: string + objectMetadata: string + parquetOptions: + enableListInference: boolean + enumAsString: boolean + mapTargetType: string + referenceFileSchemaUri: string + schema: + fields: + - categories: + names: + - type: string + collation: string + dataPolicies: + - name: string + defaultValueExpression: string + description: string + fields: + - categories: + names: + - type: string + collation: string + dataPolicies: + - name: string + defaultValueExpression: string + description: string + fields: + - categories: + names: + - type: string + collation: string + dataPolicies: + - name: string + defaultValueExpression: string + description: string + fields: + - categories: + names: + - type: string + collation: string + dataPolicies: + - name: string + defaultValueExpression: string + description: string + fields: + - categories: + names: + - type: string + collation: string + dataPolicies: + - name: string + defaultValueExpression: string + description: string + fields: + - categories: + names: + - type: string + collation: string + dataPolicies: + - name: string + defaultValueExpression: string + description: string + fields: + - categories: + names: + - {} + collation: string + dataPolicies: + - name: string + defaultValueExpression: string + description: string + fields: + - categories: {} + collation: string + dataPolicies: + - {} + defaultValueExpression: string + description: string + fields: + - {} + foreignTypeDefinition: string + maxLength: string + mode: string + name: string + policyTags: {} + precision: string + rangeElementType: {} + roundingMode: string + scale: string + type: string + foreignTypeDefinition: string + maxLength: string + mode: string + name: string + policyTags: + names: + - {} + precision: string + rangeElementType: + type: string + roundingMode: string + scale: string + type: string + foreignTypeDefinition: string + maxLength: string + mode: string + name: string + policyTags: + names: + - type: string + precision: string + rangeElementType: + type: string + roundingMode: string + scale: string + type: string + foreignTypeDefinition: string + maxLength: string + mode: string + name: string + policyTags: + names: + - type: string + precision: string + rangeElementType: + type: string + roundingMode: string + scale: string + type: string + foreignTypeDefinition: string + maxLength: string + mode: string + name: string + policyTags: + names: + - type: string + precision: string + rangeElementType: + type: string + roundingMode: string + scale: string + type: string + foreignTypeDefinition: string + maxLength: string + mode: string + name: string + policyTags: + names: + - type: string + precision: string + rangeElementType: + type: string + roundingMode: string + scale: string + type: string + foreignTypeDefinition: string + maxLength: string + mode: string + name: string + policyTags: + names: + - type: string + precision: string + rangeElementType: + type: string + roundingMode: string + scale: string + type: string + foreignTypeDefinition: string + maxLength: string + mode: string + name: string + policyTags: + names: + - type: string + precision: string + rangeElementType: + type: string + roundingMode: string + scale: string + type: string + foreignTypeInfo: + typeSystem: string + sourceFormat: string + sourceUris: + - type: string +friendlyName: string +id: string +kind: string +labels: object +lastModifiedTime: string +location: string +materializedView: + allowNonIncrementalDefinition: boolean + enableRefresh: boolean + lastRefreshTime: string + maxStaleness: string + query: string + refreshIntervalMs: string +materializedViewStatus: + lastRefreshStatus: + debugInfo: string + location: string + message: string + reason: string + refreshWatermark: string +maxStaleness: string +model: + modelOptions: + labels: + - type: string + lossType: string + modelType: string + trainingRuns: + - iterationResults: + - durationMs: string + evalLoss: number + index: integer + learnRate: number + trainingLoss: number + startTime: string + state: string + trainingOptions: + earlyStop: boolean + l1Reg: number + l2Reg: number + learnRate: number + learnRateStrategy: string + lineSearchInitLearnRate: number + maxIteration: string + minRelProgress: number + warmStart: boolean +numActiveLogicalBytes: string +numActivePhysicalBytes: string +numBytes: string +numCurrentPhysicalBytes: string +numLongTermBytes: string +numLongTermLogicalBytes: string +numLongTermPhysicalBytes: string +numPartitions: string +numPhysicalBytes: string +numRows: string +numTimeTravelPhysicalBytes: string +numTotalLogicalBytes: string +numTotalPhysicalBytes: string +partitionDefinition: + partitionedColumn: + - field: string +rangePartitioning: + field: string + range: + end: string + interval: string + start: string +replicas: + - datasetId: string + projectId: string + tableId: string +requirePartitionFilter: boolean +resourceTags: object +restrictions: + type: string +selfLink: string +snapshotDefinition: + snapshotTime: string +streamingBuffer: + estimatedBytes: string + estimatedRows: string + oldestEntryTime: string +tableConstraints: + foreignKeys: + - columnReferences: + - referencedColumn: string + referencingColumn: string + name: string + referencedTable: + datasetId: string + projectId: string + tableId: string + primaryKey: + columns: + - type: string +tableReplicationInfo: + replicatedSourceLastRefreshTime: string + replicationIntervalMs: string + replicationStatus: string +timePartitioning: + expirationMs: string + field: string + requirePartitionFilter: boolean + type: string +type: string +view: + foreignDefinitions: + - dialect: string + query: string + privacyPolicy: + aggregationThresholdPolicy: + privacyUnitColumns: + - type: string + threshold: string + differentialPrivacyPolicy: + deltaBudget: number + deltaBudgetRemaining: number + deltaPerQuery: number + epsilonBudget: number + epsilonBudgetRemaining: number + maxEpsilonPerQuery: number + maxGroupsContributed: string + privacyUnitColumn: string + joinRestrictionPolicy: + joinAllowedColumns: + - type: string + joinCondition: string + query: string + useExplicitColumnNames: boolean + useLegacySql: boolean + userDefinedFunctionResources: + - inlineCode: string + resourceUri: string + +``` + + + ## `UPDATE` example Updates a tables resource. diff --git a/docs/google-docs/providers/google/bigtableadmin/app_profiles/index.md b/docs/google-docs/providers/google/bigtableadmin/app_profiles/index.md index c46e32f5e1..2b6227533a 100644 --- a/docs/google-docs/providers/google/bigtableadmin/app_profiles/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/app_profiles/index.md @@ -118,6 +118,7 @@ description: string multiClusterRoutingUseAny: clusterIds: - type: string + rowAffinity: {} singleClusterRouting: clusterId: string allowTransactionalWrites: boolean diff --git a/docs/google-docs/providers/google/bigtableadmin/backups/index.md b/docs/google-docs/providers/google/bigtableadmin/backups/index.md index 92d2da3178..cb1088882e 100644 --- a/docs/google-docs/providers/google/bigtableadmin/backups/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/backups/index.md @@ -32,9 +32,11 @@ Creates, updates, deletes, gets or lists a backups resource. | Name | Datatype | Description | |:-----|:---------|:------------| | | `string` | A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. | +| | `string` | Indicates the backup type of the backup. | | | `object` | Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status. | | | `string` | Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp. | | | `string` | 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. | +| | `string` | The time at which the hot backup will be converted to a standard backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request. | | | `string` | Output only. Size of the backup in bytes. | | | `string` | Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/ | | | `string` | Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects/{project}/instances/{instance}/tables/{source_table}`. | @@ -58,9 +60,11 @@ Lists Cloud Bigtable backups. Returns both completed and pending backups. ```sql SELECT name, +backupType, encryptionInfo, endTime, expireTime, +hotToStandardTime, sizeBytes, sourceBackup, sourceTable, @@ -93,7 +97,9 @@ instancesId, projectsId, name, sourceTable, -expireTime +expireTime, +backupType, +hotToStandardTime ) SELECT '{{ clustersId }}', @@ -101,7 +107,9 @@ SELECT '{{ projectsId }}', '{{ name }}', '{{ sourceTable }}', -'{{ expireTime }}' +'{{ expireTime }}', +'{{ backupType }}', +'{{ hotToStandardTime }}' ; ``` @@ -125,6 +133,8 @@ encryptionInfo: - type: string additionalProperties: any kmsKeyVersion: string +backupType: string +hotToStandardTime: string ``` @@ -140,7 +150,9 @@ UPDATE google.bigtableadmin.backups SET name = '{{ name }}', sourceTable = '{{ sourceTable }}', -expireTime = '{{ expireTime }}' +expireTime = '{{ expireTime }}', +backupType = '{{ backupType }}', +hotToStandardTime = '{{ hotToStandardTime }}' WHERE backupsId = '{{ backupsId }}' AND clustersId = '{{ clustersId }}' diff --git a/docs/google-docs/providers/google/billingbudgets/budgets/index.md b/docs/google-docs/providers/google/billingbudgets/budgets/index.md index 8d6b51c6c8..8e56159d6d 100644 --- a/docs/google-docs/providers/google/billingbudgets/budgets/index.md +++ b/docs/google-docs/providers/google/billingbudgets/budgets/index.md @@ -84,68 +84,68 @@ Use the following StackQL query and manifest file to create a new budgets< /*+ create */ INSERT INTO google.billingbudgets.budgets ( billingAccountsId, -ownershipScope, -thresholdRules, +amount, +etag, +budgetFilter, notificationsRule, +thresholdRules, displayName, -budgetFilter, -amount, -etag +ownershipScope ) SELECT '{{ billingAccountsId }}', -'{{ ownershipScope }}', -'{{ thresholdRules }}', +'{{ amount }}', +'{{ etag }}', +'{{ budgetFilter }}', '{{ notificationsRule }}', +'{{ thresholdRules }}', '{{ displayName }}', -'{{ budgetFilter }}', -'{{ amount }}', -'{{ etag }}' +'{{ ownershipScope }}' ; ``` ```yaml -ownershipScope: string -thresholdRules: - - thresholdPercent: number - spendBasis: string -notificationsRule: - pubsubTopic: string - disableDefaultIamRecipients: boolean - enableProjectLevelRecipients: boolean - schemaVersion: string - monitoringNotificationChannels: - - type: string -name: string -displayName: string +amount: + specifiedAmount: + nanos: integer + currencyCode: string + units: string + lastPeriodAmount: {} +etag: string budgetFilter: - calendarPeriod: string projects: - type: string - labels: object - creditTypesTreatment: string - creditTypes: + services: - type: string resourceAncestors: - type: string + calendarPeriod: string subaccounts: - type: string - services: - - type: string + labels: object customPeriod: endDate: year: integer month: integer day: integer -amount: - specifiedAmount: - currencyCode: string - nanos: integer - units: string - lastPeriodAmount: {} -etag: string + creditTypes: + - type: string + creditTypesTreatment: string +notificationsRule: + schemaVersion: string + enableProjectLevelRecipients: boolean + pubsubTopic: string + disableDefaultIamRecipients: boolean + monitoringNotificationChannels: + - type: string +thresholdRules: + - thresholdPercent: number + spendBasis: string +displayName: string +ownershipScope: string +name: string ``` @@ -159,13 +159,13 @@ Updates a budgets resource. /*+ update */ UPDATE google.billingbudgets.budgets SET -ownershipScope = '{{ ownershipScope }}', -thresholdRules = '{{ thresholdRules }}', +amount = '{{ amount }}', +etag = '{{ etag }}', +budgetFilter = '{{ budgetFilter }}', notificationsRule = '{{ notificationsRule }}', +thresholdRules = '{{ thresholdRules }}', displayName = '{{ displayName }}', -budgetFilter = '{{ budgetFilter }}', -amount = '{{ amount }}', -etag = '{{ etag }}' +ownershipScope = '{{ ownershipScope }}' WHERE billingAccountsId = '{{ billingAccountsId }}' AND budgetsId = '{{ budgetsId }}'; diff --git a/docs/google-docs/providers/google/cloudbuild/connections/index.md b/docs/google-docs/providers/google/cloudbuild/connections/index.md index 2bff38fca0..2f7d5665e9 100644 --- a/docs/google-docs/providers/google/cloudbuild/connections/index.md +++ b/docs/google-docs/providers/google/cloudbuild/connections/index.md @@ -97,78 +97,78 @@ Use the following StackQL query and manifest file to create a new connecti INSERT INTO google.cloudbuild.connections ( locationsId, projectsId, -githubConfig, -etag, +githubEnterpriseConfig, bitbucketDataCenterConfig, -gitlabConfig, +bitbucketCloudConfig, annotations, +etag, +githubConfig, +disabled, name, -githubEnterpriseConfig, -bitbucketCloudConfig, -disabled +gitlabConfig ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ githubConfig }}', -'{{ etag }}', +'{{ githubEnterpriseConfig }}', '{{ bitbucketDataCenterConfig }}', -'{{ gitlabConfig }}', +'{{ bitbucketCloudConfig }}', '{{ annotations }}', +'{{ etag }}', +'{{ githubConfig }}', +true|false, '{{ name }}', -'{{ githubEnterpriseConfig }}', -'{{ bitbucketCloudConfig }}', -true|false +'{{ gitlabConfig }}' ; ``` ```yaml -updateTime: string -githubConfig: - authorizerCredential: - username: string - oauthTokenSecretVersion: string +githubEnterpriseConfig: + hostUri: string + appId: string + privateKeySecretVersion: string + webhookSecretSecretVersion: string appInstallationId: string -etag: string -bitbucketDataCenterConfig: + appSlug: string + serverVersion: string + apiKey: string serviceDirectoryConfig: service: string - authorizerCredential: - username: string + sslCa: string +updateTime: string +bitbucketDataCenterConfig: + readAuthorizerCredential: userTokenSecretVersion: string + username: string hostUri: string - sslCa: string webhookSecretSecretVersion: string serverVersion: string -gitlabConfig: - webhookSecretSecretVersion: string sslCa: string - serverVersion: string - hostUri: string -annotations: object -name: string -reconciling: boolean -githubEnterpriseConfig: - appSlug: string - sslCa: string - apiKey: string - webhookSecretSecretVersion: string - appId: string - serverVersion: string - privateKeySecretVersion: string - appInstallationId: string - hostUri: string bitbucketCloudConfig: webhookSecretSecretVersion: string workspace: string -createTime: string +annotations: object +etag: string +githubConfig: + appInstallationId: string + authorizerCredential: + oauthTokenSecretVersion: string + username: string +disabled: boolean installationState: + stage: string actionUri: string message: string - stage: string -disabled: boolean +name: string +reconciling: boolean +createTime: string +gitlabConfig: + serverVersion: string + webhookSecretSecretVersion: string + sslCa: string + hostUri: string ``` @@ -182,15 +182,15 @@ Updates a connections resource. /*+ update */ UPDATE google.cloudbuild.connections SET -githubConfig = '{{ githubConfig }}', -etag = '{{ etag }}', +githubEnterpriseConfig = '{{ githubEnterpriseConfig }}', bitbucketDataCenterConfig = '{{ bitbucketDataCenterConfig }}', -gitlabConfig = '{{ gitlabConfig }}', +bitbucketCloudConfig = '{{ bitbucketCloudConfig }}', annotations = '{{ annotations }}', +etag = '{{ etag }}', +githubConfig = '{{ githubConfig }}', +disabled = true|false, name = '{{ name }}', -githubEnterpriseConfig = '{{ githubEnterpriseConfig }}', -bitbucketCloudConfig = '{{ bitbucketCloudConfig }}', -disabled = true|false +gitlabConfig = '{{ gitlabConfig }}' WHERE connectionsId = '{{ connectionsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/cloudbuild/connections_iam_policies/index.md b/docs/google-docs/providers/google/cloudbuild/connections_iam_policies/index.md index 94be4d6d45..a2d6f781c9 100644 --- a/docs/google-docs/providers/google/cloudbuild/connections_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudbuild/connections_iam_policies/index.md @@ -65,8 +65,8 @@ Replaces all fields in the specified connections_iam_policies resou /*+ update */ REPLACE google.cloudbuild.connections_iam_policies SET -policy = '{{ policy }}', -updateMask = '{{ updateMask }}' +updateMask = '{{ updateMask }}', +policy = '{{ policy }}' WHERE connectionsId = '{{ connectionsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/cloudbuild/repositories/index.md b/docs/google-docs/providers/google/cloudbuild/repositories/index.md index 55049dff97..c747607f70 100644 --- a/docs/google-docs/providers/google/cloudbuild/repositories/index.md +++ b/docs/google-docs/providers/google/cloudbuild/repositories/index.md @@ -105,12 +105,12 @@ requests: - repositoryId: string repository: updateTime: string - annotations: object name: string + annotations: object etag: string webhookId: string - remoteUri: string createTime: string + remoteUri: string parent: string ``` diff --git a/docs/google-docs/providers/google/cloudcommerceprocurement/entitlements/index.md b/docs/google-docs/providers/google/cloudcommerceprocurement/entitlements/index.md index 1490ef3031..abb1aa3a05 100644 --- a/docs/google-docs/providers/google/cloudcommerceprocurement/entitlements/index.md +++ b/docs/google-docs/providers/google/cloudcommerceprocurement/entitlements/index.md @@ -115,16 +115,16 @@ Updates a entitlements resource. UPDATE google.cloudcommerceprocurement.entitlements SET provider = '{{ provider }}', -inputProperties = '{{ inputProperties }}', -product = '{{ product }}', -messageToUser = '{{ messageToUser }}', +newPendingPlan = '{{ newPendingPlan }}', consumers = '{{ consumers }}', -plan = '{{ plan }}', -account = '{{ account }}', -usageReportingId = '{{ usageReportingId }}', -state = '{{ state }}', name = '{{ name }}', -newPendingPlan = '{{ newPendingPlan }}' +state = '{{ state }}', +usageReportingId = '{{ usageReportingId }}', +product = '{{ product }}', +inputProperties = '{{ inputProperties }}', +account = '{{ account }}', +messageToUser = '{{ messageToUser }}', +plan = '{{ plan }}' WHERE entitlementsId = '{{ entitlementsId }}' AND providersId = '{{ providersId }}'; diff --git a/docs/google-docs/providers/google/cloudsupport/cases/index.md b/docs/google-docs/providers/google/cloudsupport/cases/index.md index bbc034c7c6..b056dee3bf 100644 --- a/docs/google-docs/providers/google/cloudsupport/cases/index.md +++ b/docs/google-docs/providers/google/cloudsupport/cases/index.md @@ -50,6 +50,7 @@ Creates, updates, deletes, gets or lists a cases resource. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Retrieve a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case" ``` 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().get( name="projects/some-project/cases/43595344", ) print(request.execute()) ``` | | | `SELECT` | | Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` 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().list(parent="projects/some-project") print(request.execute()) ``` | | | `INSERT` | | Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the API and don't want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "display_name": "Test case created by me.", "description": "a random test case, feel free to close", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", "bar@domain.com" ], "testCase": true, "priority": "P3" }' \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` 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().create( parent="projects/some-project", body={ "displayName": "A Test Case", "description": "This is a test case.", "testCase": True, "priority": "P2", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, }, ) print(request.execute()) ``` | | | `UPDATE` | | 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().patch( name="projects/some-project/cases/43112854", body={ "displayName": "This is Now a New Title", "priority": "P2", }, ) print(request.execute()) ``` | @@ -57,7 +58,7 @@ Creates, updates, deletes, gets or lists a cases resource. ## `SELECT` examples -Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` 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().list(parent="projects/some-project") print(request.execute()) ``` +Retrieve a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case" ``` 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().get( name="projects/some-project/cases/43595344", ) print(request.execute()) ``` ```sql SELECT @@ -77,8 +78,7 @@ testCase, timeZone, updateTime FROM google.cloudsupport.cases -WHERE parent = '{{ parent }}' -AND parentType = '{{ parentType }}'; +WHERE name = '{{ name }}'; ``` ## `INSERT` example @@ -99,62 +99,62 @@ Use the following StackQL query and manifest file to create a new cases ```yaml -timeZone: string -subscriberEmailAddresses: - - type: string -creator: - email: string - googleSupport: boolean - username: string - displayName: string -createTime: string -name: string languageCode: string -testCase: boolean classification: id: string displayName: string +contactEmail: string +escalated: boolean description: string +updateTime: string priority: string +name: string +testCase: boolean +timeZone: string state: string -escalated: boolean +createTime: string +creator: + displayName: string + email: string + googleSupport: boolean + username: string +subscriberEmailAddresses: + - type: string displayName: string -updateTime: string -contactEmail: string ``` @@ -168,18 +168,18 @@ Updates a cases resource. /*+ update */ UPDATE google.cloudsupport.cases SET -timeZone = '{{ timeZone }}', -subscriberEmailAddresses = '{{ subscriberEmailAddresses }}', -creator = '{{ creator }}', -name = '{{ name }}', languageCode = '{{ languageCode }}', -testCase = true|false, classification = '{{ classification }}', +contactEmail = '{{ contactEmail }}', +escalated = true|false, description = '{{ description }}', priority = '{{ priority }}', -escalated = true|false, -displayName = '{{ displayName }}', -contactEmail = '{{ contactEmail }}' +name = '{{ name }}', +testCase = true|false, +timeZone = '{{ timeZone }}', +creator = '{{ creator }}', +subscriberEmailAddresses = '{{ subscriberEmailAddresses }}', +displayName = '{{ displayName }}' WHERE name = '{{ name }}'; ``` diff --git a/docs/google-docs/providers/google/cloudsupport/comments/index.md b/docs/google-docs/providers/google/cloudsupport/comments/index.md index ec66736e13..a07a9e6ccf 100644 --- a/docs/google-docs/providers/google/cloudsupport/comments/index.md +++ b/docs/google-docs/providers/google/cloudsupport/comments/index.md @@ -89,15 +89,15 @@ SELECT ```yaml +name: string plainTextBody: string body: string createTime: string -name: string creator: + displayName: string email: string googleSupport: boolean username: string - displayName: string ``` diff --git a/docs/google-docs/providers/google/cloudsupport/media/index.md b/docs/google-docs/providers/google/cloudsupport/media/index.md index 16de1b9e37..eef95a1e0d 100644 --- a/docs/google-docs/providers/google/cloudsupport/media/index.md +++ b/docs/google-docs/providers/google/cloudsupport/media/index.md @@ -35,5 +35,4 @@ Creates, updates, deletes, gets or lists a media resource. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `EXEC` | | 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.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ``` | | | `EXEC` | | 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( 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()) ``` | diff --git a/docs/google-docs/providers/google/contactcenterinsights/analyses/index.md b/docs/google-docs/providers/google/contactcenterinsights/analyses/index.md index da3174895b..0a10888be0 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/analyses/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/analyses/index.md @@ -96,66 +96,66 @@ SELECT ```yaml -requestTime: string -name: string analysisResult: endTime: string callAnalysisMetadata: - issueModelResult: - issueModel: string - issues: - - displayName: string - score: number - issue: string - silence: - silenceDuration: string - silencePercentage: number sentiments: - channelTag: integer sentimentData: score: number magnitude: number + silence: + silenceDuration: string + silencePercentage: number + intents: object + entities: object + issueModelResult: + issues: + - score: number + displayName: string + issue: string + issueModel: string + phraseMatchers: object annotations: - - issueMatchData: - issueAssignment: - displayName: string - score: number - issue: string - silenceData: {} + - silenceData: {} + entityMentionData: + entityUniqueId: string + type: string channelTag: integer + interruptionData: {} phraseMatchData: - displayName: string phraseMatcher: string + displayName: string annotationEndBoundary: wordIndex: integer transcriptIndex: integer - entityMentionData: - type: string - entityUniqueId: string + issueMatchData: + issueAssignment: + score: number + displayName: string + issue: string holdData: {} - interruptionData: {} intentMatchData: intentUniqueId: string - phraseMatchers: object - entities: object - intents: object +name: string createTime: string +requestTime: string annotatorSelector: - runEntityAnnotator: boolean + runSummarizationAnnotator: boolean + runSentimentAnnotator: boolean issueModels: - type: string + runIntentAnnotator: boolean + runEntityAnnotator: boolean + runPhraseMatcherAnnotator: boolean + runInterruptionAnnotator: boolean + runSilenceAnnotator: boolean runIssueModelAnnotator: boolean - runSummarizationAnnotator: boolean summarizationConfig: summarizationModel: string conversationProfile: string - runSentimentAnnotator: boolean - runInterruptionAnnotator: boolean - runPhraseMatcherAnnotator: boolean - runIntentAnnotator: boolean phraseMatchers: - type: string - runSilenceAnnotator: boolean ``` diff --git a/docs/google-docs/providers/google/contactcenterinsights/conversations/index.md b/docs/google-docs/providers/google/contactcenterinsights/conversations/index.md index 8aa4e62773..57d251d3eb 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/conversations/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/conversations/index.md @@ -119,202 +119,202 @@ Use the following StackQL query and manifest file to create a new conversa INSERT INTO google.contactcenterinsights.conversations ( locationsId, projectsId, +agentId, +name, expireTime, +languageCode, +ttl, +obfuscatedUserId, +metadataJson, +medium, +callMetadata, startTime, qualityMetadata, -dataSource, -metadataJson, -name, labels, -callMetadata, -obfuscatedUserId, -medium, -languageCode, -ttl, -agentId +dataSource ) SELECT '{{ locationsId }}', '{{ projectsId }}', +'{{ agentId }}', +'{{ name }}', '{{ expireTime }}', +'{{ languageCode }}', +'{{ ttl }}', +'{{ obfuscatedUserId }}', +'{{ metadataJson }}', +'{{ medium }}', +'{{ callMetadata }}', '{{ startTime }}', '{{ qualityMetadata }}', -'{{ dataSource }}', -'{{ metadataJson }}', -'{{ name }}', '{{ labels }}', -'{{ callMetadata }}', -'{{ obfuscatedUserId }}', -'{{ medium }}', -'{{ languageCode }}', -'{{ ttl }}', -'{{ agentId }}' +'{{ dataSource }}' ; ``` ```yaml +latestSummary: + textSections: object + metadata: object + conversationModel: string + confidence: number + answerRecord: string + text: string +dialogflowIntents: object +agentId: string +name: string +expireTime: string +languageCode: string +ttl: string +obfuscatedUserId: string +createTime: string transcript: transcriptSegments: - - words: - - confidence: number - word: string - endOffset: string - startOffset: string - confidence: number - languageCode: string - messageTime: string + - sentiment: + score: number + magnitude: number + channelTag: integer dialogflowSegmentMetadata: smartReplyAllowlistCovered: boolean - channelTag: integer + text: string segmentParticipant: obfuscatedExternalUserId: string - role: string - userId: string dialogflowParticipant: string + userId: string + role: string dialogflowParticipantName: string - text: string - sentiment: - score: number - magnitude: number -latestSummary: - answerRecord: string - textSections: object - text: string - confidence: number - metadata: object - conversationModel: string -expireTime: string -startTime: string -updateTime: string + languageCode: string + words: + - endOffset: string + startOffset: string + confidence: number + word: string + confidence: number + messageTime: string +metadataJson: string +medium: string +callMetadata: + agentChannel: integer + customerChannel: integer runtimeAnnotations: - - smartReply: + - smartComposeSuggestion: + suggestion: string queryRecord: string - reply: string - confidenceScore: number metadata: object - userInput: - generatorName: string - querySource: string - query: string - createTime: string - answerFeedback: - correctnessLevel: string - clicked: boolean - displayed: boolean - articleSuggestion: + confidenceScore: number + faqAnswer: source: string confidenceScore: number - queryRecord: string - title: string metadata: object - uri: string + queryRecord: string + question: string + answer: string dialogflowInteraction: confidence: number dialogflowIntentId: string - faqAnswer: + articleSuggestion: + source: string metadata: object + uri: string + title: string queryRecord: string confidenceScore: number - answer: string - source: string - question: string - annotationId: string endBoundary: wordIndex: integer transcriptIndex: integer - smartComposeSuggestion: - suggestion: string - queryRecord: string - confidenceScore: number + annotationId: string + createTime: string + smartReply: metadata: object -turnCount: integer + reply: string + confidenceScore: number + queryRecord: string + answerFeedback: + correctnessLevel: string + clicked: boolean + displayed: boolean + userInput: + querySource: string + query: string + generatorName: string +startTime: string qualityMetadata: - waitDuration: string agentInfo: - - displayName: string - agentId: string + - agentId: string + displayName: string team: string dispositionCode: string + waitDuration: string menuPath: string customerSatisfactionRating: integer -duration: string +updateTime: string +turnCount: integer +labels: object dataSource: dialogflowSource: audioUri: string dialogflowConversation: string gcsSource: - audioUri: string transcriptUri: string + audioUri: string +duration: string latestAnalysis: - requestTime: string - name: string analysisResult: endTime: string callAnalysisMetadata: - issueModelResult: - issueModel: string - issues: - - displayName: string - score: number - issue: string + sentiments: + - channelTag: integer silence: silenceDuration: string silencePercentage: number - sentiments: - - channelTag: integer + intents: object + entities: object + issueModelResult: + issues: + - score: number + displayName: string + issue: string + issueModel: string + phraseMatchers: object annotations: - - issueMatchData: - issueAssignment: - displayName: string - score: number - issue: string - silenceData: {} + - silenceData: {} + entityMentionData: + entityUniqueId: string + type: string channelTag: integer + interruptionData: {} phraseMatchData: - displayName: string phraseMatcher: string - entityMentionData: - type: string - entityUniqueId: string + displayName: string + issueMatchData: + issueAssignment: + score: number + displayName: string + issue: string holdData: {} - interruptionData: {} intentMatchData: intentUniqueId: string - phraseMatchers: object - entities: object - intents: object + name: string createTime: string + requestTime: string annotatorSelector: - runEntityAnnotator: boolean + runSummarizationAnnotator: boolean + runSentimentAnnotator: boolean issueModels: - type: string + runIntentAnnotator: boolean + runEntityAnnotator: boolean + runPhraseMatcherAnnotator: boolean + runInterruptionAnnotator: boolean + runSilenceAnnotator: boolean runIssueModelAnnotator: boolean - runSummarizationAnnotator: boolean summarizationConfig: summarizationModel: string conversationProfile: string - runSentimentAnnotator: boolean - runInterruptionAnnotator: boolean - runPhraseMatcherAnnotator: boolean - runIntentAnnotator: boolean phraseMatchers: - type: string - runSilenceAnnotator: boolean -metadataJson: string -name: string -labels: object -createTime: string -callMetadata: - agentChannel: integer - customerChannel: integer -obfuscatedUserId: string -medium: string -dialogflowIntents: object -languageCode: string -ttl: string -agentId: string ``` @@ -328,19 +328,19 @@ Updates a conversations resource. /*+ update */ UPDATE google.contactcenterinsights.conversations SET +agentId = '{{ agentId }}', +name = '{{ name }}', expireTime = '{{ expireTime }}', +languageCode = '{{ languageCode }}', +ttl = '{{ ttl }}', +obfuscatedUserId = '{{ obfuscatedUserId }}', +metadataJson = '{{ metadataJson }}', +medium = '{{ medium }}', +callMetadata = '{{ callMetadata }}', startTime = '{{ startTime }}', qualityMetadata = '{{ qualityMetadata }}', -dataSource = '{{ dataSource }}', -metadataJson = '{{ metadataJson }}', -name = '{{ name }}', labels = '{{ labels }}', -callMetadata = '{{ callMetadata }}', -obfuscatedUserId = '{{ obfuscatedUserId }}', -medium = '{{ medium }}', -languageCode = '{{ languageCode }}', -ttl = '{{ ttl }}', -agentId = '{{ agentId }}' +dataSource = '{{ dataSource }}' WHERE conversationsId = '{{ conversationsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/contactcenterinsights/issue_models/index.md b/docs/google-docs/providers/google/contactcenterinsights/issue_models/index.md index eac67e4687..e09a50e7b2 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/issue_models/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/issue_models/index.md @@ -96,19 +96,19 @@ INSERT INTO google.contactcenterinsights.issue_models ( locationsId, projectsId, languageCode, +displayName, inputDataConfig, name, -modelType, -displayName +modelType ) SELECT '{{ locationsId }}', '{{ projectsId }}', '{{ languageCode }}', +'{{ displayName }}', '{{ inputDataConfig }}', '{{ name }}', -'{{ modelType }}', -'{{ displayName }}' +'{{ modelType }}' ; ``` @@ -116,21 +116,21 @@ SELECT ```yaml languageCode: string +displayName: string +issueCount: string createTime: string -updateTime: string inputDataConfig: + medium: string trainingConversationsCount: string filter: string - medium: string name: string -issueCount: string -state: string +updateTime: string trainingStats: analyzedConversationsCount: string unclassifiedConversationsCount: string issueStats: object modelType: string -displayName: string +state: string ``` @@ -145,10 +145,10 @@ Updates a issue_models resource. UPDATE google.contactcenterinsights.issue_models SET languageCode = '{{ languageCode }}', +displayName = '{{ displayName }}', inputDataConfig = '{{ inputDataConfig }}', name = '{{ name }}', -modelType = '{{ modelType }}', -displayName = '{{ displayName }}' +modelType = '{{ modelType }}' WHERE issueModelsId = '{{ issueModelsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/contactcenterinsights/issues/index.md b/docs/google-docs/providers/google/contactcenterinsights/issues/index.md index cc12f7932b..d91caf3eaf 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/issues/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/issues/index.md @@ -72,8 +72,8 @@ Updates a issues resource. /*+ update */ UPDATE google.contactcenterinsights.issues SET -displayDescription = '{{ displayDescription }}', name = '{{ name }}', +displayDescription = '{{ displayDescription }}', displayName = '{{ displayName }}' WHERE issueModelsId = '{{ issueModelsId }}' diff --git a/docs/google-docs/providers/google/contactcenterinsights/phrase_matchers/index.md b/docs/google-docs/providers/google/contactcenterinsights/phrase_matchers/index.md index 797561c51e..d976267788 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/phrase_matchers/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/phrase_matchers/index.md @@ -92,48 +92,48 @@ Use the following StackQL query and manifest file to create a new phrase_m INSERT INTO google.contactcenterinsights.phrase_matchers ( locationsId, projectsId, -name, -displayName, -roleMatch, phraseMatchRuleGroups, +name, active, +displayName, type, -versionTag +versionTag, +roleMatch ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ name }}', -'{{ displayName }}', -'{{ roleMatch }}', '{{ phraseMatchRuleGroups }}', +'{{ name }}', true|false, +'{{ displayName }}', '{{ type }}', -'{{ versionTag }}' +'{{ versionTag }}', +'{{ roleMatch }}' ; ``` ```yaml -activationUpdateTime: string -name: string -displayName: string -revisionCreateTime: string -roleMatch: string -updateTime: string phraseMatchRuleGroups: - - type: string - phraseMatchRules: - - query: string - negated: boolean + - phraseMatchRules: + - negated: boolean config: exactMatchConfig: caseSensitive: boolean -revisionId: string + query: string + type: string +name: string active: boolean +displayName: string type: string +revisionCreateTime: string +updateTime: string +revisionId: string versionTag: string +activationUpdateTime: string +roleMatch: string ``` @@ -147,13 +147,13 @@ Updates a phrase_matchers resource. /*+ update */ UPDATE google.contactcenterinsights.phrase_matchers SET -name = '{{ name }}', -displayName = '{{ displayName }}', -roleMatch = '{{ roleMatch }}', phraseMatchRuleGroups = '{{ phraseMatchRuleGroups }}', +name = '{{ name }}', active = true|false, +displayName = '{{ displayName }}', type = '{{ type }}', -versionTag = '{{ versionTag }}' +versionTag = '{{ versionTag }}', +roleMatch = '{{ roleMatch }}' WHERE locationsId = '{{ locationsId }}' AND phraseMatchersId = '{{ phraseMatchersId }}' diff --git a/docs/google-docs/providers/google/contactcenterinsights/settings/index.md b/docs/google-docs/providers/google/contactcenterinsights/settings/index.md index cfb2330e5d..966f2a53e5 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/settings/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/settings/index.md @@ -75,13 +75,13 @@ Updates a settings resource. /*+ update */ UPDATE google.contactcenterinsights.settings SET +name = '{{ name }}', analysisConfig = '{{ analysisConfig }}', -conversationTtl = '{{ conversationTtl }}', +languageCode = '{{ languageCode }}', redactionConfig = '{{ redactionConfig }}', speechConfig = '{{ speechConfig }}', -pubsubNotificationSettings = '{{ pubsubNotificationSettings }}', -languageCode = '{{ languageCode }}', -name = '{{ name }}' +conversationTtl = '{{ conversationTtl }}', +pubsubNotificationSettings = '{{ pubsubNotificationSettings }}' WHERE locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}'; diff --git a/docs/google-docs/providers/google/contactcenterinsights/views/index.md b/docs/google-docs/providers/google/contactcenterinsights/views/index.md index e631a13d8f..97bc14b8cf 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/views/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/views/index.md @@ -80,27 +80,27 @@ Use the following StackQL query and manifest file to create a new views ```yaml -value: string +updateTime: string name: string displayName: string createTime: string -updateTime: string +value: string ``` @@ -114,9 +114,9 @@ Updates a views resource. /*+ update */ UPDATE google.contactcenterinsights.views SET -value = '{{ value }}', name = '{{ name }}', -displayName = '{{ displayName }}' +displayName = '{{ displayName }}', +value = '{{ value }}' WHERE locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}' diff --git a/docs/google-docs/providers/google/containeranalysis/notes/index.md b/docs/google-docs/providers/google/containeranalysis/notes/index.md index b171ab8f0a..d344096016 100644 --- a/docs/google-docs/providers/google/containeranalysis/notes/index.md +++ b/docs/google-docs/providers/google/containeranalysis/notes/index.md @@ -142,24 +142,24 @@ Updates a notes resource. /*+ update */ UPDATE google.containeranalysis.notes SET -longDescription = '{{ longDescription }}', -vulnerability = '{{ vulnerability }}', -vulnerabilityAssessment = '{{ vulnerabilityAssessment }}', -discovery = '{{ discovery }}', +image = '{{ image }}', +relatedNoteNames = '{{ relatedNoteNames }}', +deployment = '{{ deployment }}', +name = '{{ name }}', dsseAttestation = '{{ dsseAttestation }}', -shortDescription = '{{ shortDescription }}', build = '{{ build }}', -name = '{{ name }}', -relatedNoteNames = '{{ relatedNoteNames }}', -compliance = '{{ compliance }}', +expirationTime = '{{ expirationTime }}', sbomReference = '{{ sbomReference }}', package = '{{ package }}', +discovery = '{{ discovery }}', +vulnerability = '{{ vulnerability }}', +compliance = '{{ compliance }}', +longDescription = '{{ longDescription }}', upgrade = '{{ upgrade }}', -image = '{{ image }}', +vulnerabilityAssessment = '{{ vulnerabilityAssessment }}', +shortDescription = '{{ shortDescription }}', attestation = '{{ attestation }}', -deployment = '{{ deployment }}', -relatedUrl = '{{ relatedUrl }}', -expirationTime = '{{ expirationTime }}' +relatedUrl = '{{ relatedUrl }}' WHERE notesId = '{{ notesId }}' AND projectsId = '{{ projectsId }}'; diff --git a/docs/google-docs/providers/google/containeranalysis/occurrences/index.md b/docs/google-docs/providers/google/containeranalysis/occurrences/index.md index 91f594be3a..e7a2179630 100644 --- a/docs/google-docs/providers/google/containeranalysis/occurrences/index.md +++ b/docs/google-docs/providers/google/containeranalysis/occurrences/index.md @@ -127,361 +127,361 @@ SELECT ```yaml occurrences: - - resourceUri: string + - noteName: string + kind: string + sbomReference: + signatures: + - keyid: string + sig: string + payloadType: string + payload: + subject: + - digest: object + name: string + _type: string + predicateType: string + predicate: + digest: object + referrerId: string + mimeType: string + location: string discovery: - sbomStatus: - error: string - sbomState: string continuousAnalysis: string - cpe: string - analysisCompleted: - analysisType: - - type: string + analysisStatus: string analysisStatusError: details: - - additionalProperties: any - type: string - code: integer + - type: string + additionalProperties: any message: string + code: integer + sbomStatus: + sbomState: string + error: string + archiveTime: string + lastScanTime: string analysisError: - details: - - additionalProperties: any - type: string - code: integer + - type: string + additionalProperties: any message: string - archiveTime: string - analysisStatus: string - lastScanTime: string - image: - distance: integer - fingerprint: - v2Name: string - v1Name: string - v2Blob: + code: integer + analysisCompleted: + analysisType: - type: string - baseResourceUrl: string - layerInfo: - - directive: string - arguments: string + cpe: string + attestation: + serializedPayload: string + jwts: + - compactJwt: string + signatures: + - publicKeyId: string + signature: string + dsseAttestation: + statement: + predicateType: string + slsaProvenanceZeroTwo: + metadata: + buildInvocationId: string + reproducible: boolean + completeness: + parameters: boolean + environment: boolean + materials: boolean + buildFinishedOn: string + buildStartedOn: string + buildConfig: object + invocation: + parameters: object + configSource: + entryPoint: string + uri: string + digest: object + environment: object + materials: + - digest: object + uri: string + builder: + id: string + buildType: string + _type: string + subject: + - digest: object + name: string + provenance: + builderConfig: + id: string + recipe: + environment: + - additionalProperties: any + type: string + type: string + arguments: + - additionalProperties: any + type: string + definedInMaterial: string + entryPoint: string + metadata: + buildStartedOn: string + reproducible: boolean + buildInvocationId: string + completeness: + arguments: boolean + environment: boolean + materials: boolean + buildFinishedOn: string + materials: + - type: string + slsaProvenance: + builder: + id: string + materials: + - digest: object + uri: string + recipe: + arguments: object + definedInMaterial: string + environment: object + type: string + entryPoint: string + metadata: + completeness: + arguments: boolean + materials: boolean + environment: boolean + reproducible: boolean + buildFinishedOn: string + buildStartedOn: string + buildInvocationId: string + envelope: + payloadType: string + signatures: + - keyid: string + sig: string + payload: string vulnerability: + cvssVersion: string + severity: string + shortDescription: string + relatedUrls: + - label: string + url: string vexAssessment: - state: string - cve: string - relatedUris: - - url: string - label: string - justification: - justificationType: string - details: string impacts: - type: string + relatedUris: + - label: string + url: string remediations: - - remediationType: string - details: string - remediationUri: - url: string + - remediationUri: label: string + url: string + remediationType: string + details: string noteName: string + justification: + justificationType: string + details: string vulnerabilityId: string - effectiveSeverity: string + cve: string + state: string + type: string packageIssue: - - fixedVersion: - kind: string - fullName: string - revision: string - name: string + - fileLocation: + - filePath: string + affectedCpeUri: string + packageType: string + fixedVersion: inclusive: boolean + revision: string + fullName: string epoch: integer - fileLocation: - - filePath: string - fixedCpeUri: string + name: string + kind: string fixAvailable: boolean + fixedCpeUri: string effectiveSeverity: string - fixedPackage: string - affectedCpeUri: string - packageType: string affectedPackage: string - fixAvailable: boolean - cvssScore: number - type: string - relatedUrls: - - url: string - label: string - cvssVersion: string - severity: string - shortDescription: string - longDescription: string + fixedPackage: string + extraDetails: string cvssV2: - baseScore: number - authentication: string attackComplexity: string - scope: string - attackVector: string + exploitabilityScore: number impactScore: number availabilityImpact: string + baseScore: number + attackVector: string + scope: string + integrityImpact: string + confidentialityImpact: string privilegesRequired: string + authentication: string userInteraction: string - exploitabilityScore: number - confidentialityImpact: string - integrityImpact: string - extraDetails: string - package: - location: - - cpeUri: string + effectiveSeverity: string + longDescription: string + fixAvailable: boolean + cvssScore: number + image: + baseResourceUrl: string + fingerprint: + v2Blob: + - type: string + v2Name: string + v1Name: string + layerInfo: + - arguments: string + directive: string + distance: integer + name: string + createTime: string + compliance: + version: + cpeUri: string + benchmarkDocument: string + version: string + nonComplianceReason: string + nonCompliantFiles: + - reason: string path: string - packageType: string + displayCommand: string + upgrade: + package: string + windowsUpdate: + description: string + categories: + - categoryId: string + name: string + title: string + identity: + updateId: string + revision: integer + supportUrl: string + lastPublishedTimestamp: string + kbArticleIds: + - type: string + distribution: + cpeUri: string + classification: string + severity: string + cve: + - type: string + package: architecture: string - cpeUri: string - name: string + packageType: string license: comments: string expression: string - attestation: - jwts: - - compactJwt: string - serializedPayload: string - signatures: - - signature: string - publicKeyId: string + name: string + cpeUri: string + location: + - path: string + cpeUri: string + deployment: + undeployTime: string + config: string + address: string + userEmail: string + platform: string + resourceUri: + - type: string + deployTime: string + updateTime: string build: inTotoSlsaProvenanceV1: - _type: string + subject: + - digest: object + name: string predicate: - buildDefinition: - buildType: string - internalParameters: object - externalParameters: object - resolvedDependencies: - - annotations: object - mediaType: string - content: string - downloadLocation: string - digest: object - name: string - uri: string runDetails: - byproducts: - - annotations: object - mediaType: string - content: string - downloadLocation: string - digest: object - name: string - uri: string builder: - version: object - id: string builderDependencies: - - annotations: object - mediaType: string - content: string + - uri: string downloadLocation: string - digest: object + content: string + mediaType: string name: string - uri: string + digest: object + annotations: object + version: object + id: string metadata: - invocationId: string finishedOn: string startedOn: string - predicateType: string - subject: - - digest: object - name: string - intotoStatement: - predicateType: string - subject: - - digest: object - name: string + invocationId: string + byproducts: + - uri: string + downloadLocation: string + content: string + mediaType: string + name: string + digest: object + annotations: object + buildDefinition: + buildType: string + externalParameters: object + resolvedDependencies: + - uri: string + downloadLocation: string + content: string + mediaType: string + name: string + digest: object + annotations: object + internalParameters: object _type: string - slsaProvenanceZeroTwo: - builder: - id: string - buildType: string - invocation: - environment: object - configSource: - uri: string - entryPoint: string - digest: object - parameters: object - buildConfig: object - materials: - - uri: string - digest: object - metadata: - buildInvocationId: string - reproducible: boolean - buildFinishedOn: string - buildStartedOn: string - completeness: - parameters: boolean - materials: boolean - environment: boolean - slsaProvenance: - metadata: - buildInvocationId: string - completeness: - arguments: boolean - materials: boolean - environment: boolean - reproducible: boolean - buildFinishedOn: string - buildStartedOn: string - materials: - - uri: string - digest: object - recipe: - type: string - arguments: object - definedInMaterial: string - entryPoint: string - environment: object - builder: - id: string - provenance: - materials: - - type: string - metadata: - completeness: - arguments: boolean - materials: boolean - environment: boolean - buildStartedOn: string - buildInvocationId: string - buildFinishedOn: string - reproducible: boolean - builderConfig: - id: string - recipe: - entryPoint: string - definedInMaterial: string - environment: - - type: string - additionalProperties: any - type: string - arguments: - - type: string - additionalProperties: any + predicateType: string provenance: createTime: string - endTime: string - creator: string - id: string projectId: string commands: - - id: string + - dir: string + id: string + env: + - type: string args: - type: string - env: + waitFor: - type: string - dir: string name: string - waitFor: + buildOptions: object + builtArtifacts: + - checksum: string + id: string + names: - type: string + id: string startTime: string - builderVersion: string + endTime: string + creator: string logsUri: string + builderVersion: string triggerId: string - buildOptions: object - builtArtifacts: - - names: - - type: string - id: string - checksum: string sourceProvenance: additionalContexts: - - gerrit: - gerritProject: string - aliasContext: - name: string - kind: string - hostUri: string - revisionId: string + - labels: object cloudRepo: + revisionId: string repoId: + uid: string projectRepoId: repoName: string projectId: string - uid: string - revisionId: string - labels: object + aliasContext: + kind: string + name: string git: revisionId: string url: string + gerrit: + gerritProject: string + revisionId: string + hostUri: string + artifactStorageSourceUri: string + fileHashes: object context: labels: object - fileHashes: object - artifactStorageSourceUri: string provenanceBytes: string - kind: string - updateTime: string - createTime: string - compliance: - nonComplianceReason: string - version: - cpeUri: string - benchmarkDocument: string - version: string - nonCompliantFiles: - - reason: string - path: string - displayCommand: string + resourceUri: string remediation: string - sbomReference: - payloadType: string - payload: - predicate: - mimeType: string - digest: object - referrerId: string - location: string - subject: - - digest: object - name: string - predicateType: string - _type: string - signatures: - - keyid: string - sig: string - name: string - envelope: - signatures: - - keyid: string - sig: string - payload: string - payloadType: string - upgrade: - windowsUpdate: - title: string - categories: - - name: string - categoryId: string - identity: - revision: integer - updateId: string - description: string - kbArticleIds: - - type: string - lastPublishedTimestamp: string - supportUrl: string - package: string - distribution: - cpeUri: string - classification: string - cve: - - type: string - severity: string - dsseAttestation: {} - deployment: - config: string - platform: string - deployTime: string - undeployTime: string - address: string - resourceUri: - - type: string - userEmail: string - noteName: string ``` @@ -495,22 +495,22 @@ Updates a occurrences resource. /*+ update */ UPDATE google.containeranalysis.occurrences SET -resourceUri = '{{ resourceUri }}', +noteName = '{{ noteName }}', +sbomReference = '{{ sbomReference }}', discovery = '{{ discovery }}', -image = '{{ image }}', -vulnerability = '{{ vulnerability }}', -package = '{{ package }}', attestation = '{{ attestation }}', -build = '{{ build }}', -compliance = '{{ compliance }}', -remediation = '{{ remediation }}', -sbomReference = '{{ sbomReference }}', -name = '{{ name }}', +dsseAttestation = '{{ dsseAttestation }}', +vulnerability = '{{ vulnerability }}', +image = '{{ image }}', envelope = '{{ envelope }}', +name = '{{ name }}', +compliance = '{{ compliance }}', upgrade = '{{ upgrade }}', -dsseAttestation = '{{ dsseAttestation }}', +package = '{{ package }}', deployment = '{{ deployment }}', -noteName = '{{ noteName }}' +build = '{{ build }}', +resourceUri = '{{ resourceUri }}', +remediation = '{{ remediation }}' WHERE occurrencesId = '{{ occurrencesId }}' AND projectsId = '{{ projectsId }}'; diff --git a/docs/google-docs/providers/google/contentwarehouse/document_links/index.md b/docs/google-docs/providers/google/contentwarehouse/document_links/index.md index 693a86b76e..8cb82a2c76 100644 --- a/docs/google-docs/providers/google/contentwarehouse/document_links/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/document_links/index.md @@ -57,42 +57,42 @@ INSERT INTO google.contentwarehouse.document_links ( documentsId, locationsId, projectsId, -documentLink, -requestMetadata +requestMetadata, +documentLink ) SELECT '{{ documentsId }}', '{{ locationsId }}', '{{ projectsId }}', -'{{ documentLink }}', -'{{ requestMetadata }}' +'{{ requestMetadata }}', +'{{ documentLink }}' ; ``` ```yaml +requestMetadata: + userInfo: + groupIds: + - type: string + id: string documentLink: + updateTime: string name: string - sourceDocumentReference: - documentIsFolder: boolean - deleteTime: string - updateTime: string + createTime: string + state: string + description: string + targetDocumentReference: + createTime: string documentIsLegalHoldFolder: boolean + documentIsRetentionFolder: boolean + documentIsFolder: boolean documentName: string + updateTime: string snippet: string - createTime: string - documentIsRetentionFolder: boolean displayName: string - updateTime: string - createTime: string - state: string - description: string -requestMetadata: - userInfo: - groupIds: - - type: string - id: string + deleteTime: string ``` diff --git a/docs/google-docs/providers/google/contentwarehouse/document_schemas/index.md b/docs/google-docs/providers/google/contentwarehouse/document_schemas/index.md index 50064f4ad5..d94622776c 100644 --- a/docs/google-docs/providers/google/contentwarehouse/document_schemas/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/document_schemas/index.md @@ -84,67 +84,67 @@ Use the following StackQL query and manifest file to create a new document INSERT INTO google.contentwarehouse.document_schemas ( locationsId, projectsId, -name, -description, propertyDefinitions, +documentIsFolder, +description, displayName, -documentIsFolder +name ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ name }}', -'{{ description }}', '{{ propertyDefinitions }}', +true|false, +'{{ description }}', '{{ displayName }}', -true|false +'{{ name }}' ; ``` ```yaml -name: string -updateTime: string -description: string -createTime: string propertyDefinitions: - - isSearchable: boolean + - mapTypeOptions: {} + isSearchable: boolean + isRequired: boolean + isRepeatable: boolean + isMetadata: boolean + dateTimeTypeOptions: {} + name: string + displayName: string + timestampTypeOptions: {} + floatTypeOptions: {} + retrievalImportance: string + integerTypeOptions: {} + textTypeOptions: {} propertyTypeOptions: propertyDefinitions: - isSearchable: boolean - schemaSources: - - name: string - processorType: string - floatTypeOptions: {} + isRequired: boolean isRepeatable: boolean - isFilterable: boolean - retrievalImportance: string isMetadata: boolean + name: string + displayName: string + retrievalImportance: string + schemaSources: + - processorType: string + name: string enumTypeOptions: possibleValues: - type: string validationCheckDisabled: boolean - displayName: string - mapTypeOptions: {} - textTypeOptions: {} - name: string - timestampTypeOptions: {} - dateTimeTypeOptions: {} - isRequired: boolean - integerTypeOptions: {} + isFilterable: boolean schemaSources: - - name: string - processorType: string - isRepeatable: boolean + - processorType: string + name: string isFilterable: boolean - retrievalImportance: string - isMetadata: boolean - displayName: string - name: string - isRequired: boolean -displayName: string documentIsFolder: boolean +description: string +displayName: string +name: string +createTime: string +updateTime: string ``` diff --git a/docs/google-docs/providers/google/contentwarehouse/documents/index.md b/docs/google-docs/providers/google/contentwarehouse/documents/index.md index 6fba8927bc..fc7bcb9ada 100644 --- a/docs/google-docs/providers/google/contentwarehouse/documents/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/documents/index.md @@ -98,7 +98,449 @@ WHERE documentsId = '{{ documentsId }}' AND locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}'; ``` -undefined + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new documents resource. + + + + +```sql +/*+ create */ +INSERT INTO google.contentwarehouse.documents ( +locationsId, +projectsId, +cloudAiDocumentOption, +requestMetadata, +policy, +createMask, +document +) +SELECT +'{{ locationsId }}', +'{{ projectsId }}', +'{{ cloudAiDocumentOption }}', +'{{ requestMetadata }}', +'{{ policy }}', +'{{ createMask }}', +'{{ document }}' +; +``` + + + +```yaml +cloudAiDocumentOption: + customizedEntitiesPropertiesConversions: object + enableEntitiesConversions: boolean +requestMetadata: + userInfo: + groupIds: + - type: string + id: string +policy: + etag: string + bindings: + - members: + - type: string + role: string + condition: + location: string + expression: string + title: string + description: string + auditConfigs: + - service: string + auditLogConfigs: + - exemptedMembers: + - type: string + logType: string + version: integer +createMask: string +document: + referenceId: string + title: string + updater: string + creator: string + rawDocumentFileType: string + inlineRawDocument: string + legalHold: boolean + createTime: string + contentCategory: string + cloudAiDocument: + revisions: + - parent: + - format: string + type: string + humanReview: + state: string + stateMessage: string + id: string + createTime: string + processor: string + parentIds: + - type: string + agent: string + pages: + - imageQualityScores: + detectedDefects: + - type: string + confidence: number + qualityScore: number + tables: + - layout: + boundingPoly: + normalizedVertices: + - 'y': number + x: number + vertices: + - 'y': integer + x: integer + orientation: string + textAnchor: + textSegments: + - startIndex: string + endIndex: string + content: string + confidence: number + detectedLanguages: + - languageCode: string + confidence: number + headerRows: + - cells: + - colSpan: integer + detectedLanguages: + - languageCode: string + confidence: number + rowSpan: integer + bodyRows: + - cells: + - colSpan: integer + detectedLanguages: + - languageCode: string + confidence: number + rowSpan: integer + provenance: + id: integer + revision: integer + parents: + - revision: integer + id: integer + index: integer + type: string + image: + content: string + width: integer + mimeType: string + height: integer + formFields: + - correctedKeyText: string + valueDetectedLanguages: + - languageCode: string + confidence: number + valueType: string + nameDetectedLanguages: + - languageCode: string + confidence: number + correctedValueText: string + pageNumber: integer + detectedBarcodes: + - barcode: + rawValue: string + format: string + valueFormat: string + tokens: + - detectedLanguages: + - languageCode: string + confidence: number + detectedBreak: + type: string + styleInfo: + textColor: + green: number + red: number + alpha: number + blue: number + strikeout: boolean + fontSize: integer + underlined: boolean + handwritten: boolean + letterSpacing: number + bold: boolean + fontType: string + fontWeight: integer + smallcaps: boolean + subscript: boolean + pixelFontSize: number + italic: boolean + superscript: boolean + detectedLanguages: + - languageCode: string + confidence: number + symbols: + - detectedLanguages: + - languageCode: string + confidence: number + lines: + - detectedLanguages: + - languageCode: string + confidence: number + transforms: + - type: integer + data: string + rows: integer + cols: integer + visualElements: + - detectedLanguages: + - languageCode: string + confidence: number + type: string + paragraphs: + - detectedLanguages: + - languageCode: string + confidence: number + dimension: + unit: string + height: number + width: number + blocks: + - detectedLanguages: + - languageCode: string + confidence: number + entityRelations: + - objectId: string + relation: string + subjectId: string + content: string + shardInfo: + shardIndex: string + shardCount: string + textOffset: string + chunkedDocument: + chunks: + - sourceBlockIds: + - type: string + pageFooters: + - pageSpan: + pageEnd: integer + pageStart: integer + text: string + content: string + chunkId: string + pageHeaders: + - text: string + entities: + - type: string + normalizedValue: + datetimeValue: + day: integer + hours: integer + month: integer + timeZone: + version: string + id: string + year: integer + utcOffset: string + minutes: integer + nanos: integer + seconds: integer + text: string + moneyValue: + nanos: integer + currencyCode: string + units: string + booleanValue: boolean + dateValue: + year: integer + day: integer + month: integer + integerValue: integer + floatValue: number + addressValue: + revision: integer + regionCode: string + administrativeArea: string + organization: string + locality: string + sortingCode: string + sublocality: string + addressLines: + - type: string + recipients: + - type: string + languageCode: string + postalCode: string + properties: + - type: string + properties: + - type: string + properties: + - type: string + properties: + - type: string + properties: + - type: string + properties: + - type: string + properties: + - type: string + properties: + - {} + id: string + confidence: number + redacted: boolean + mentionText: string + mentionId: string + pageAnchor: {} + id: string + confidence: number + redacted: boolean + mentionText: string + mentionId: string + id: string + confidence: number + redacted: boolean + mentionText: string + mentionId: string + id: string + confidence: number + redacted: boolean + mentionText: string + mentionId: string + id: string + confidence: number + redacted: boolean + mentionText: string + mentionId: string + id: string + confidence: number + redacted: boolean + mentionText: string + mentionId: string + id: string + confidence: number + redacted: boolean + mentionText: string + mentionId: string + id: string + confidence: number + redacted: boolean + mentionText: string + mentionId: string + text: string + textStyles: + - fontWeight: string + textStyle: string + fontSize: + unit: string + size: number + textDecoration: string + fontFamily: string + mimeType: string + documentLayout: + blocks: + - pageSpan: + pageStart: integer + pageEnd: integer + tableBlock: + bodyRows: + - cells: + - colSpan: integer + rowSpan: integer + blocks: + - listBlock: + listEntries: + - blocks: + - {} + type: string + blockId: string + textBlock: + text: string + type: string + blocks: + - blockId: string + headerRows: + - cells: + - colSpan: integer + rowSpan: integer + blocks: + - blockId: string + caption: string + blockId: string + uri: string + textChanges: + - changedText: string + provenance: + - id: integer + revision: integer + parents: + - revision: integer + id: integer + index: integer + type: string + error: + details: + - additionalProperties: any + type: string + message: string + code: integer + displayName: string + name: string + textExtractionDisabled: boolean + properties: + - textValues: + values: + - type: string + enumValues: + values: + - type: string + propertyValues: + properties: + - timestampValues: + values: + - textValue: string + timestampValue: string + floatValues: + values: + - format: string + type: string + mapProperty: + fields: object + integerValues: + values: + - format: string + type: string + dateTimeValues: + values: + - day: integer + hours: integer + month: integer + year: integer + utcOffset: string + minutes: integer + nanos: integer + seconds: integer + name: string + name: string + textExtractionEnabled: boolean + plainText: string + updateTime: string + rawDocumentPath: string + displayUri: string + dispositionTime: string + documentSchemaName: string + +``` + + + ## `UPDATE` example Updates a documents resource. @@ -107,10 +549,10 @@ Updates a documents resource. /*+ update */ UPDATE google.contentwarehouse.documents SET -updateOptions = '{{ updateOptions }}', cloudAiDocumentOption = '{{ cloudAiDocumentOption }}', requestMetadata = '{{ requestMetadata }}', -document = '{{ document }}' +document = '{{ document }}', +updateOptions = '{{ updateOptions }}' WHERE documentsId = '{{ documentsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/contentwarehouse/reference_id/index.md b/docs/google-docs/providers/google/contentwarehouse/reference_id/index.md index dc03ca9f06..b57860c939 100644 --- a/docs/google-docs/providers/google/contentwarehouse/reference_id/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/reference_id/index.md @@ -101,10 +101,10 @@ Updates a reference_id resource. /*+ update */ UPDATE google.contentwarehouse.reference_id SET -updateOptions = '{{ updateOptions }}', cloudAiDocumentOption = '{{ cloudAiDocumentOption }}', requestMetadata = '{{ requestMetadata }}', -document = '{{ document }}' +document = '{{ document }}', +updateOptions = '{{ updateOptions }}' WHERE locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}' diff --git a/docs/google-docs/providers/google/contentwarehouse/rule_sets/index.md b/docs/google-docs/providers/google/contentwarehouse/rule_sets/index.md index ec034c1328..400cae8099 100644 --- a/docs/google-docs/providers/google/contentwarehouse/rule_sets/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/rule_sets/index.md @@ -78,70 +78,70 @@ Use the following StackQL query and manifest file to create a new rule_set INSERT INTO google.contentwarehouse.rule_sets ( locationsId, projectsId, -rules, +source, description, name, -source +rules ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ rules }}', +'{{ source }}', '{{ description }}', '{{ name }}', -'{{ source }}' +'{{ rules }}' ; ``` ```yaml +source: string +description: string +name: string rules: - - triggerType: string + - description: string + ruleId: string + triggerType: string + condition: string actions: - - dataValidation: - conditions: object - actionId: string - dataUpdate: - entries: object - removeFromFolderAction: - condition: string - folder: string - deleteDocumentAction: - enableHardDelete: boolean + - actionId: string + publishToPubSub: + messages: + - type: string + topicId: string accessControl: policy: etag: string - auditConfigs: - - service: string - auditLogConfigs: - - exemptedMembers: - - type: string - logType: string - version: integer bindings: - members: - type: string role: string condition: - title: string + location: string expression: string + title: string description: string - location: string + auditConfigs: + - service: string + auditLogConfigs: + - exemptedMembers: + - type: string + logType: string + version: integer operationType: string + deleteDocumentAction: + enableHardDelete: boolean + removeFromFolderAction: + condition: string + folder: string + dataValidation: + conditions: object + dataUpdate: + entries: object addToFolder: folders: - type: string - publishToPubSub: - messages: - - type: string - topicId: string - description: string - condition: string - ruleId: string -description: string -name: string -source: string ``` diff --git a/docs/google-docs/providers/google/contentwarehouse/synonym_sets/index.md b/docs/google-docs/providers/google/contentwarehouse/synonym_sets/index.md index 15bcb31567..925b47ff85 100644 --- a/docs/google-docs/providers/google/contentwarehouse/synonym_sets/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/synonym_sets/index.md @@ -76,27 +76,27 @@ Use the following StackQL query and manifest file to create a new synonym_ INSERT INTO google.contentwarehouse.synonym_sets ( locationsId, projectsId, -name, synonyms, -context +context, +name ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ name }}', '{{ synonyms }}', -'{{ context }}' +'{{ context }}', +'{{ name }}' ; ``` ```yaml -name: string synonyms: - words: - type: string context: string +name: string ``` @@ -110,9 +110,9 @@ Updates a synonym_sets resource. /*+ update */ UPDATE google.contentwarehouse.synonym_sets SET -name = '{{ name }}', synonyms = '{{ synonyms }}', -context = '{{ context }}' +context = '{{ context }}', +name = '{{ name }}' WHERE locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}' diff --git a/docs/google-docs/providers/google/datacatalog/entries/index.md b/docs/google-docs/providers/google/datacatalog/entries/index.md index 3b5e6c7042..ab63140955 100644 --- a/docs/google-docs/providers/google/datacatalog/entries/index.md +++ b/docs/google-docs/providers/google/datacatalog/entries/index.md @@ -118,7 +118,315 @@ WHERE entryGroupsId = '{{ entryGroupsId }}' AND locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}'; ``` -undefined + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new entries resource. + + + + +```sql +/*+ create */ +INSERT INTO google.datacatalog.entries ( +entryGroupsId, +locationsId, +projectsId, +linkedResource, +fullyQualifiedName, +type, +userSpecifiedType, +userSpecifiedSystem, +sqlDatabaseSystemSpec, +lookerSystemSpec, +cloudBigtableSystemSpec, +gcsFilesetSpec, +databaseTableSpec, +dataSourceConnectionSpec, +routineSpec, +datasetSpec, +filesetSpec, +serviceSpec, +modelSpec, +featureOnlineStoreSpec, +displayName, +description, +businessContext, +schema, +sourceSystemTimestamps, +usageSignal, +labels +) +SELECT +'{{ entryGroupsId }}', +'{{ locationsId }}', +'{{ projectsId }}', +'{{ linkedResource }}', +'{{ fullyQualifiedName }}', +'{{ type }}', +'{{ userSpecifiedType }}', +'{{ userSpecifiedSystem }}', +'{{ sqlDatabaseSystemSpec }}', +'{{ lookerSystemSpec }}', +'{{ cloudBigtableSystemSpec }}', +'{{ gcsFilesetSpec }}', +'{{ databaseTableSpec }}', +'{{ dataSourceConnectionSpec }}', +'{{ routineSpec }}', +'{{ datasetSpec }}', +'{{ filesetSpec }}', +'{{ serviceSpec }}', +'{{ modelSpec }}', +'{{ featureOnlineStoreSpec }}', +'{{ displayName }}', +'{{ description }}', +'{{ businessContext }}', +'{{ schema }}', +'{{ sourceSystemTimestamps }}', +'{{ usageSignal }}', +'{{ labels }}' +; +``` + + + +```yaml +name: string +linkedResource: string +fullyQualifiedName: string +type: string +userSpecifiedType: string +integratedSystem: string +userSpecifiedSystem: string +sqlDatabaseSystemSpec: + sqlEngine: string + databaseVersion: string + instanceHost: string +lookerSystemSpec: + parentInstanceId: string + parentInstanceDisplayName: string + parentModelId: string + parentModelDisplayName: string + parentViewId: string + parentViewDisplayName: string +cloudBigtableSystemSpec: + instanceDisplayName: string +gcsFilesetSpec: + filePatterns: + - type: string + sampleGcsFileSpecs: + - filePath: string + gcsTimestamps: + createTime: string + updateTime: string + expireTime: string + sizeBytes: string +bigqueryTableSpec: + tableSourceType: string + viewSpec: + viewQuery: string + tableSpec: + groupedEntry: string +bigqueryDateShardedSpec: + dataset: string + tablePrefix: string + shardCount: string + latestShardResource: string +databaseTableSpec: + type: string + dataplexTable: + externalTables: + - system: string + fullyQualifiedName: string + googleCloudResource: string + dataCatalogEntry: string + dataplexSpec: + asset: string + dataFormat: + avro: + text: string + thrift: + text: string + protobuf: + text: string + parquet: {} + orc: {} + csv: {} + compressionFormat: string + projectId: string + userManaged: boolean + databaseViewSpec: + viewType: string + baseTable: string + sqlQuery: string +dataSourceConnectionSpec: + bigqueryConnectionSpec: + connectionType: string + cloudSql: + instanceId: string + database: string + type: string + hasCredential: boolean +routineSpec: + routineType: string + language: string + routineArguments: + - name: string + mode: string + type: string + returnType: string + definitionBody: string + bigqueryRoutineSpec: + importedLibraries: + - type: string +datasetSpec: + vertexDatasetSpec: + dataItemCount: string + dataType: string +filesetSpec: + dataplexFileset: {} +serviceSpec: + cloudBigtableInstanceSpec: + cloudBigtableClusterSpecs: + - displayName: string + location: string + type: string + linkedResource: string +modelSpec: + vertexModelSpec: + versionId: string + versionAliases: + - type: string + versionDescription: string + vertexModelSourceInfo: + sourceType: string + copy: boolean + containerImageUri: string +featureOnlineStoreSpec: + storageType: string +displayName: string +description: string +businessContext: + entryOverview: + overview: string + contacts: + people: + - designation: string + email: string +schema: + columns: + - column: string + type: string + description: string + mode: string + defaultValue: string + ordinalPosition: integer + highestIndexingType: string + subcolumns: + - column: string + type: string + description: string + mode: string + defaultValue: string + ordinalPosition: integer + highestIndexingType: string + subcolumns: + - column: string + type: string + description: string + mode: string + defaultValue: string + ordinalPosition: integer + highestIndexingType: string + subcolumns: + - column: string + type: string + description: string + mode: string + defaultValue: string + ordinalPosition: integer + highestIndexingType: string + subcolumns: + - column: string + type: string + description: string + mode: string + defaultValue: string + ordinalPosition: integer + highestIndexingType: string + subcolumns: + - column: string + type: string + description: string + mode: string + defaultValue: string + ordinalPosition: integer + highestIndexingType: string + subcolumns: + - column: string + type: string + description: string + mode: string + defaultValue: string + ordinalPosition: integer + highestIndexingType: string + subcolumns: + - column: string + type: string + description: string + mode: string + defaultValue: string + ordinalPosition: integer + highestIndexingType: string + subcolumns: + - column: string + type: string + description: string + mode: string + defaultValue: string + ordinalPosition: integer + highestIndexingType: string + subcolumns: + - {} + lookerColumnSpec: {} + rangeElementType: {} + gcRule: string + gcRule: string + gcRule: string + gcRule: string + gcRule: string + gcRule: string + gcRule: string + gcRule: string + gcRule: string +usageSignal: + updateTime: string + usageWithinTimeRange: object + commonUsageWithinTimeRange: object + favoriteCount: string +labels: object +dataSource: + service: string + resource: string + sourceEntry: string + storageProperties: + filePattern: + - type: string + fileType: string +personalDetails: + starred: boolean + starTime: string + +``` + + + ## `UPDATE` example Updates a entries resource. diff --git a/docs/google-docs/providers/google/datalineage/lineage_events/index.md b/docs/google-docs/providers/google/datalineage/lineage_events/index.md index 34171c4347..059df1778c 100644 --- a/docs/google-docs/providers/google/datalineage/lineage_events/index.md +++ b/docs/google-docs/providers/google/datalineage/lineage_events/index.md @@ -82,9 +82,9 @@ processesId, projectsId, runsId, startTime, -links, name, -endTime +endTime, +links ) SELECT '{{ locationsId }}', @@ -92,9 +92,9 @@ SELECT '{{ projectsId }}', '{{ runsId }}', '{{ startTime }}', -'{{ links }}', '{{ name }}', -'{{ endTime }}' +'{{ endTime }}', +'{{ links }}' ; ``` @@ -102,11 +102,11 @@ SELECT ```yaml startTime: string -links: - - source: - fullyQualifiedName: string name: string endTime: string +links: + - target: + fullyQualifiedName: string ``` diff --git a/docs/google-docs/providers/google/datalineage/processes/index.md b/docs/google-docs/providers/google/datalineage/processes/index.md index c7d65671ce..aa303d8746 100644 --- a/docs/google-docs/providers/google/datalineage/processes/index.md +++ b/docs/google-docs/providers/google/datalineage/processes/index.md @@ -79,17 +79,17 @@ INSERT INTO google.datalineage.processes ( locationsId, projectsId, name, +attributes, displayName, -origin, -attributes +origin ) SELECT '{{ locationsId }}', '{{ projectsId }}', '{{ name }}', +'{{ attributes }}', '{{ displayName }}', -'{{ origin }}', -'{{ attributes }}' +'{{ origin }}' ; ``` @@ -97,11 +97,11 @@ SELECT ```yaml name: string +attributes: object displayName: string origin: sourceType: string name: string -attributes: object ``` @@ -116,9 +116,9 @@ Updates a processes resource. UPDATE google.datalineage.processes SET name = '{{ name }}', +attributes = '{{ attributes }}', displayName = '{{ displayName }}', -origin = '{{ origin }}', -attributes = '{{ attributes }}' +origin = '{{ origin }}' WHERE locationsId = '{{ locationsId }}' AND processesId = '{{ processesId }}' diff --git a/docs/google-docs/providers/google/datalineage/runs/index.md b/docs/google-docs/providers/google/datalineage/runs/index.md index 0c40df1000..8cd5492d11 100644 --- a/docs/google-docs/providers/google/datalineage/runs/index.md +++ b/docs/google-docs/providers/google/datalineage/runs/index.md @@ -84,35 +84,35 @@ INSERT INTO google.datalineage.runs ( locationsId, processesId, projectsId, -attributes, +displayName, startTime, -endTime, name, +attributes, state, -displayName +endTime ) SELECT '{{ locationsId }}', '{{ processesId }}', '{{ projectsId }}', -'{{ attributes }}', +'{{ displayName }}', '{{ startTime }}', -'{{ endTime }}', '{{ name }}', +'{{ attributes }}', '{{ state }}', -'{{ displayName }}' +'{{ endTime }}' ; ``` ```yaml -attributes: object +displayName: string startTime: string -endTime: string name: string +attributes: object state: string -displayName: string +endTime: string ``` @@ -126,12 +126,12 @@ Updates a runs resource. /*+ update */ UPDATE google.datalineage.runs SET -attributes = '{{ attributes }}', +displayName = '{{ displayName }}', startTime = '{{ startTime }}', -endTime = '{{ endTime }}', name = '{{ name }}', +attributes = '{{ attributes }}', state = '{{ state }}', -displayName = '{{ displayName }}' +endTime = '{{ endTime }}' WHERE locationsId = '{{ locationsId }}' AND processesId = '{{ processesId }}' diff --git a/docs/google-docs/providers/google/datapipelines/pipelines/index.md b/docs/google-docs/providers/google/datapipelines/pipelines/index.md index 022461644f..aed7c9d2ae 100644 --- a/docs/google-docs/providers/google/datapipelines/pipelines/index.md +++ b/docs/google-docs/providers/google/datapipelines/pipelines/index.md @@ -94,103 +94,103 @@ Use the following StackQL query and manifest file to create a new pipeline INSERT INTO google.datapipelines.pipelines ( locationsId, projectsId, -pipelineSources, displayName, -workload, +name, type, +pipelineSources, scheduleInfo, -schedulerServiceAccountEmail, +workload, state, -name +schedulerServiceAccountEmail ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ pipelineSources }}', '{{ displayName }}', -'{{ workload }}', +'{{ name }}', '{{ type }}', +'{{ pipelineSources }}', '{{ scheduleInfo }}', -'{{ schedulerServiceAccountEmail }}', +'{{ workload }}', '{{ state }}', -'{{ name }}' +'{{ schedulerServiceAccountEmail }}' ; ``` ```yaml -pipelineSources: object -createTime: string displayName: string -lastUpdateTime: string +name: string jobCount: integer +type: string +pipelineSources: object +scheduleInfo: + timeZone: string + schedule: string + nextJobTime: string workload: - dataflowFlexTemplateRequest: + dataflowLaunchTemplateRequest: + gcsPath: string + validateOnly: boolean projectId: string location: string - launchParameter: - transformNameMappings: object + launchParameters: + update: boolean environment: - kmsKeyName: string - network: string + workerZone: string + maxWorkers: integer + enableStreamingEngine: boolean machineType: string + additionalExperiments: + - type: string + zone: string + bypassTempDirValidation: boolean + kmsKeyName: string + additionalUserLabels: object ipConfiguration: string - subnetwork: string tempLocation: string numWorkers: integer - workerZone: string - additionalUserLabels: object - flexrsGoal: string - additionalExperiments: - - type: string serviceAccountEmail: string - maxWorkers: integer + network: string + subnetwork: string workerRegion: string - enableStreamingEngine: boolean - zone: string parameters: object jobName: string - launchOptions: object - update: boolean - containerSpecGcsPath: string - validateOnly: boolean - dataflowLaunchTemplateRequest: - gcsPath: string + transformNameMapping: object + dataflowFlexTemplateRequest: validateOnly: boolean - location: string - projectId: string - launchParameters: - parameters: object + launchParameter: update: boolean + transformNameMappings: object + parameters: object environment: - numWorkers: integer + enableStreamingEngine: boolean + subnetwork: string serviceAccountEmail: string + numWorkers: integer + tempLocation: string + zone: string + additionalUserLabels: object + network: string + maxWorkers: integer kmsKeyName: string - subnetwork: string + flexrsGoal: string + machineType: string workerZone: string + workerRegion: string additionalExperiments: - type: string ipConfiguration: string - enableStreamingEngine: boolean - workerRegion: string - machineType: string - zone: string - maxWorkers: integer - tempLocation: string - network: string - additionalUserLabels: object - bypassTempDirValidation: boolean - transformNameMapping: object + containerSpecGcsPath: string + launchOptions: object jobName: string -type: string -scheduleInfo: - timeZone: string - nextJobTime: string - schedule: string -schedulerServiceAccountEmail: string + projectId: string + location: string state: string -name: string +lastUpdateTime: string +createTime: string +schedulerServiceAccountEmail: string ``` @@ -204,14 +204,14 @@ Updates a pipelines resource. /*+ update */ UPDATE google.datapipelines.pipelines SET -pipelineSources = '{{ pipelineSources }}', displayName = '{{ displayName }}', -workload = '{{ workload }}', +name = '{{ name }}', type = '{{ type }}', +pipelineSources = '{{ pipelineSources }}', scheduleInfo = '{{ scheduleInfo }}', -schedulerServiceAccountEmail = '{{ schedulerServiceAccountEmail }}', +workload = '{{ workload }}', state = '{{ state }}', -name = '{{ name }}' +schedulerServiceAccountEmail = '{{ schedulerServiceAccountEmail }}' WHERE locationsId = '{{ locationsId }}' AND pipelinesId = '{{ pipelinesId }}' diff --git a/docs/google-docs/providers/google/dataplex/aspect_types/index.md b/docs/google-docs/providers/google/dataplex/aspect_types/index.md index 30e7579927..0ab0d17079 100644 --- a/docs/google-docs/providers/google/dataplex/aspect_types/index.md +++ b/docs/google-docs/providers/google/dataplex/aspect_types/index.md @@ -71,7 +71,164 @@ FROM google.dataplex.aspect_types WHERE locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}'; ``` -undefined + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new aspect_types resource. + + + + +```sql +/*+ create */ +INSERT INTO google.dataplex.aspect_types ( +locationsId, +projectsId, +description, +displayName, +labels, +etag, +authorization, +metadataTemplate +) +SELECT +'{{ locationsId }}', +'{{ projectsId }}', +'{{ description }}', +'{{ displayName }}', +'{{ labels }}', +'{{ etag }}', +'{{ authorization }}', +'{{ metadataTemplate }}' +; +``` + + + +```yaml +name: string +uid: string +createTime: string +updateTime: string +description: string +displayName: string +labels: object +etag: string +authorization: + alternateUsePermission: string +metadataTemplate: + index: integer + name: string + type: string + recordFields: + - index: integer + name: string + type: string + recordFields: + - index: integer + name: string + type: string + recordFields: + - index: integer + name: string + type: string + recordFields: + - index: integer + name: string + type: string + recordFields: + - index: integer + name: string + type: string + recordFields: + - index: integer + name: string + type: string + recordFields: + - index: integer + name: string + type: string + recordFields: + - index: integer + name: string + type: string + recordFields: + - index: integer + name: string + type: string + recordFields: + - {} + enumValues: + - {} + typeId: string + typeRef: string + constraints: {} + annotations: {} + enumValues: + - index: integer + name: string + deprecated: string + typeId: string + typeRef: string + enumValues: + - index: integer + name: string + deprecated: string + typeId: string + typeRef: string + enumValues: + - index: integer + name: string + deprecated: string + typeId: string + typeRef: string + enumValues: + - index: integer + name: string + deprecated: string + typeId: string + typeRef: string + enumValues: + - index: integer + name: string + deprecated: string + typeId: string + typeRef: string + enumValues: + - index: integer + name: string + deprecated: string + typeId: string + typeRef: string + enumValues: + - index: integer + name: string + deprecated: string + typeId: string + typeRef: string + enumValues: + - index: integer + name: string + deprecated: string + typeId: string + typeRef: string + enumValues: + - index: integer + name: string + deprecated: string + typeId: string + typeRef: string + +``` + + + ## `UPDATE` example Updates a aspect_types resource. diff --git a/docs/google-docs/providers/google/dataplex/entities/index.md b/docs/google-docs/providers/google/dataplex/entities/index.md index 124fa1220b..726c695d72 100644 --- a/docs/google-docs/providers/google/dataplex/entities/index.md +++ b/docs/google-docs/providers/google/dataplex/entities/index.md @@ -89,7 +89,150 @@ AND locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}' AND zonesId = '{{ zonesId }}'; ``` -undefined + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new entities resource. + + + + +```sql +/*+ create */ +INSERT INTO google.dataplex.entities ( +lakesId, +locationsId, +projectsId, +zonesId, +displayName, +description, +etag, +type, +asset, +dataPath, +dataPathPattern, +system, +format, +schema +) +SELECT +'{{ lakesId }}', +'{{ locationsId }}', +'{{ projectsId }}', +'{{ zonesId }}', +'{{ displayName }}', +'{{ description }}', +'{{ etag }}', +'{{ type }}', +'{{ asset }}', +'{{ dataPath }}', +'{{ dataPathPattern }}', +'{{ system }}', +'{{ format }}', +'{{ schema }}' +; +``` + + + +```yaml +name: string +displayName: string +description: string +createTime: string +updateTime: string +id: string +etag: string +type: string +asset: string +dataPath: string +dataPathPattern: string +catalogEntry: string +system: string +format: + format: string + compressionFormat: string + mimeType: string + csv: + encoding: string + headerRows: integer + delimiter: string + quote: string + json: + encoding: string + iceberg: + metadataLocation: string +compatibility: + hiveMetastore: + compatible: boolean + reason: string +access: + read: string +uid: string +schema: + userManaged: boolean + fields: + - name: string + description: string + type: string + mode: string + fields: + - name: string + description: string + type: string + mode: string + fields: + - name: string + description: string + type: string + mode: string + fields: + - name: string + description: string + type: string + mode: string + fields: + - name: string + description: string + type: string + mode: string + fields: + - name: string + description: string + type: string + mode: string + fields: + - name: string + description: string + type: string + mode: string + fields: + - name: string + description: string + type: string + mode: string + fields: + - name: string + description: string + type: string + mode: string + fields: + - {} + partitionFields: + - name: string + type: string + partitionStyle: string + +``` + + + ## `REPLACE` example Replaces all fields in the specified entities resource. diff --git a/docs/google-docs/providers/google/dlp/connections/index.md b/docs/google-docs/providers/google/dlp/connections/index.md index 894479ae2f..cc0f6cf49c 100644 --- a/docs/google-docs/providers/google/dlp/connections/index.md +++ b/docs/google-docs/providers/google/dlp/connections/index.md @@ -98,27 +98,27 @@ SELECT ```yaml connection: - state: string cloudSql: + cloudSqlIam: {} + databaseEngine: string connectionName: string + maxConnections: integer usernamePassword: passwordSecretVersionName: string username: string - cloudSqlIam: {} - maxConnections: integer - databaseEngine: string + state: string + name: string errors: - details: - message: string - code: integer details: - additionalProperties: any type: string + code: integer + message: string timestamps: - - format: string - type: string + - type: string + format: string extraInfo: string - name: string ``` @@ -132,8 +132,8 @@ Updates a connections resource. /*+ update */ UPDATE google.dlp.connections SET -updateMask = '{{ updateMask }}', -connection = '{{ connection }}' +connection = '{{ connection }}', +updateMask = '{{ updateMask }}' WHERE connectionsId = '{{ connectionsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/dlp/deidentify_templates/index.md b/docs/google-docs/providers/google/dlp/deidentify_templates/index.md index 8ff170f5ac..8920bd4d25 100644 --- a/docs/google-docs/providers/google/dlp/deidentify_templates/index.md +++ b/docs/google-docs/providers/google/dlp/deidentify_templates/index.md @@ -95,124 +95,124 @@ Use the following StackQL query and manifest file to create a new deidenti /*+ create */ INSERT INTO google.dlp.deidentify_templates ( projectsId, -locationId, deidentifyTemplate, -templateId +templateId, +locationId ) SELECT '{{ projectsId }}', -'{{ locationId }}', '{{ deidentifyTemplate }}', -'{{ templateId }}' +'{{ templateId }}', +'{{ locationId }}' ; ``` ```yaml -locationId: string deidentifyTemplate: - name: string deidentifyConfig: - imageTransformations: - transforms: - - allInfoTypes: {} - selectedInfoTypes: - infoTypes: - - version: string - name: string - sensitivityScore: - score: string - redactionColor: - blue: number - red: number - green: number - allText: {} + transformationErrorHandling: + leaveUntransformed: {} + throwError: {} recordTransformations: fieldTransformations: - - condition: - expressions: - logicalOperator: string - conditions: - conditions: - - operator: string - value: + - infoTypeTransformations: + transformations: + - primitiveTransformation: + fixedSizeBucketingConfig: + bucketSize: number + lowerBound: + integerValue: string + dayOfWeekValue: string + floatValue: number + stringValue: string timestampValue: string dateValue: - month: integer - year: integer day: integer - dayOfWeekValue: string - stringValue: string + year: integer + month: integer booleanValue: boolean timeValue: - nanos: integer + hours: integer minutes: integer seconds: integer - hours: integer - floatValue: number - integerValue: string - field: + nanos: integer + dateShiftConfig: + cryptoKey: + transient: + name: string + unwrapped: + key: string + kmsWrapped: + cryptoKeyName: string + wrappedKey: string + context: name: string - primitiveTransformation: - replaceDictionaryConfig: - wordList: - words: - - type: string - cryptoDeterministicConfig: - cryptoKey: - unwrapped: - key: string - transient: - name: string - kmsWrapped: - cryptoKeyName: string - wrappedKey: string - surrogateInfoType: - version: string - name: string - bucketingConfig: - buckets: - - {} - replaceWithInfoTypeConfig: {} - characterMaskConfig: - numberToMask: integer - charactersToIgnore: - - commonCharactersToIgnore: string - charactersToSkip: string - reverseOrder: boolean - maskingCharacter: string - timePartConfig: - partToExtract: string - cryptoHashConfig: {} - redactConfig: {} - dateShiftConfig: - lowerBoundDays: integer - upperBoundDays: integer - fixedSizeBucketingConfig: - bucketSize: number - replaceConfig: {} - cryptoReplaceFfxFpeConfig: - commonAlphabet: string - customAlphabet: string - radix: integer - infoTypeTransformations: - transformations: - - infoTypes: + upperBoundDays: integer + lowerBoundDays: integer + redactConfig: {} + cryptoDeterministicConfig: + surrogateInfoType: + sensitivityScore: + score: string + version: string + name: string + replaceDictionaryConfig: + wordList: + words: + - type: string + characterMaskConfig: + numberToMask: integer + reverseOrder: boolean + charactersToIgnore: + - commonCharactersToIgnore: string + charactersToSkip: string + maskingCharacter: string + cryptoHashConfig: {} + bucketingConfig: + buckets: + - {} + replaceConfig: {} + cryptoReplaceFfxFpeConfig: + customAlphabet: string + commonAlphabet: string + radix: integer + timePartConfig: + partToExtract: string + replaceWithInfoTypeConfig: {} + infoTypes: - version: string name: string + condition: + expressions: + conditions: + conditions: + - operator: string + logicalOperator: string fields: - name: string recordSuppressions: - {} - transformationErrorHandling: - leaveUntransformed: {} - throwError: {} - createTime: string + imageTransformations: + transforms: + - allInfoTypes: {} + selectedInfoTypes: + infoTypes: + - version: string + name: string + allText: {} + redactionColor: + blue: number + red: number + green: number + displayName: string description: string + createTime: string updateTime: string - displayName: string + name: string templateId: string +locationId: string ``` diff --git a/docs/google-docs/providers/google/dlp/discovery_configs/index.md b/docs/google-docs/providers/google/dlp/discovery_configs/index.md index 9bbd4fd2fb..e54c2a6436 100644 --- a/docs/google-docs/providers/google/dlp/discovery_configs/index.md +++ b/docs/google-docs/providers/google/dlp/discovery_configs/index.md @@ -113,159 +113,159 @@ SELECT ```yaml configId: string discoveryConfig: + displayName: string + name: string + status: string + actions: + - publishToScc: {} + pubSubNotification: + topic: string + pubsubCondition: + expressions: + conditions: + - minimumSensitivityScore: string + minimumRiskScore: string + logicalOperator: string + detailOfMessage: string + event: string + publishToChronicle: {} + exportData: + profileTable: + projectId: string + datasetId: string + tableId: string + tagResources: + lowerDataRiskToLow: boolean + tagConditions: + - sensitivityScore: + score: string + tag: + namespacedValue: string + profileGenerationsToTag: + - type: string + enumDescriptions: string + enum: string + createTime: string targets: - - secretsTarget: {} - cloudStorageTarget: + - cloudSqlTarget: conditions: - createdAfter: string - cloudStorageConditions: - includedObjectAttributes: - - type: string - enum: string - enumDescriptions: string - includedBucketAttributes: - - enum: string - enumDescriptions: string - type: string - minAge: string - disabled: {} - filter: - others: {} - collection: - includeRegexes: - patterns: - - cloudStorageRegex: - bucketNameRegex: string - projectIdRegex: string - cloudStorageResourceReference: - projectId: string - bucketName: string + types: + - enum: string + type: string + enumDescriptions: string + databaseEngines: + - enum: string + enumDescriptions: string + type: string generationCadence: refreshFrequency: string inspectTemplateModifiedCadence: frequency: string - cloudSqlTarget: + schemaModifiedCadence: + types: + - enumDescriptions: string + type: string + enum: string + frequency: string filter: + databaseResourceReference: + instance: string + projectId: string + database: string + databaseResource: string collection: includeRegexes: patterns: - - instanceRegex: string - databaseRegex: string + - databaseRegex: string + instanceRegex: string projectIdRegex: string databaseResourceNameRegex: string - databaseResourceReference: - databaseResource: string - projectId: string - database: string - instance: string others: {} - generationCadence: - schemaModifiedCadence: - types: - - enum: string - enumDescriptions: string - type: string - frequency: string - refreshFrequency: string - conditions: - types: - - type: string - enum: string - enumDescriptions: string - databaseEngines: - - type: string - enum: string - enumDescriptions: string + disabled: {} + secretsTarget: {} bigQueryTarget: filter: otherTables: {} tableReference: - tableId: string datasetId: string + tableId: string tables: includeRegexes: patterns: - tableIdRegex: string - projectIdRegex: string datasetIdRegex: string - conditions: - createdAfter: string - orConditions: - minRowCount: integer - minAge: string - typeCollection: string - types: + projectIdRegex: string + cadence: + tableModifiedCadence: + frequency: string types: - - enum: string - enumDescriptions: string + - enumDescriptions: string + enum: string type: string - cadence: + refreshFrequency: string schemaModifiedCadence: types: - enum: string type: string enumDescriptions: string frequency: string - tableModifiedCadence: + conditions: + types: types: - enum: string enumDescriptions: string type: string - frequency: string + orConditions: + minRowCount: integer + minAge: string + typeCollection: string + createdAfter: string + cloudStorageTarget: + generationCadence: refreshFrequency: string - status: string - displayName: string - updateTime: string + conditions: + cloudStorageConditions: + includedBucketAttributes: + - enumDescriptions: string + enum: string + type: string + includedObjectAttributes: + - type: string + enum: string + enumDescriptions: string + minAge: string + createdAfter: string + filter: + collection: + includeRegexes: + patterns: + - cloudStorageRegex: + projectIdRegex: string + bucketNameRegex: string + cloudStorageResourceReference: + projectId: string + bucketName: string + others: {} + orgConfig: + projectId: string + location: + organizationId: string + folderId: string lastRunTime: string inspectTemplates: - type: string - createTime: string errors: - details: - message: string - code: integer details: - additionalProperties: any type: string + code: integer + message: string timestamps: - - format: string - type: string + - type: string + format: string extraInfo: string - name: string - actions: - - tagResources: - lowerDataRiskToLow: boolean - tagConditions: - - sensitivityScore: - score: string - tag: - namespacedValue: string - profileGenerationsToTag: - - enumDescriptions: string - type: string - enum: string - pubSubNotification: - detailOfMessage: string - event: string - pubsubCondition: - expressions: - conditions: - - minimumSensitivityScore: string - minimumRiskScore: string - logicalOperator: string - topic: string - exportData: - profileTable: - tableId: string - projectId: string - datasetId: string - publishToScc: {} - publishToChronicle: {} - orgConfig: - projectId: string - location: - folderId: string - organizationId: string + updateTime: string ``` diff --git a/docs/google-docs/providers/google/dlp/dlp_jobs/index.md b/docs/google-docs/providers/google/dlp/dlp_jobs/index.md index 13256ee34d..a0a10f183a 100644 --- a/docs/google-docs/providers/google/dlp/dlp_jobs/index.md +++ b/docs/google-docs/providers/google/dlp/dlp_jobs/index.md @@ -119,145 +119,149 @@ SELECT ```yaml jobId: string inspectJob: - storageConfig: - hybridOptions: - requiredFindingLabelKeys: - - type: string - labels: object - description: string - tableOptions: - identifyingFields: - - name: string - timespanConfig: - startTime: string - timestampField: - name: string - endTime: string - enableAutoPopulationOfTimespanConfig: boolean - datastoreOptions: - kind: - name: string - partitionId: - namespaceId: string - projectId: string - cloudStorageOptions: - bytesLimitPerFilePercent: integer - filesLimitPercent: integer - fileSet: - regexFileSet: - excludeRegex: - - type: string - includeRegex: - - type: string - bucketName: string - url: string - bytesLimitPerFile: string - fileTypes: - - enumDescriptions: string - enum: string - type: string - sampleMethod: string - bigQueryOptions: - includedFields: - - name: string - identifyingFields: - - name: string - tableReference: - tableId: string - projectId: string - datasetId: string - excludedFields: - - name: string - rowsLimitPercent: integer - rowsLimit: string - sampleMethod: string - inspectTemplateName: string - actions: - - publishSummaryToCscc: {} - saveFindings: - outputConfig: - outputSchema: string - jobNotificationEmails: {} - publishFindingsToCloudDataCatalog: {} - pubSub: - topic: string - deidentify: - cloudStorageOutput: string - transformationConfig: - structuredDeidentifyTemplate: string - imageRedactTemplate: string - deidentifyTemplate: string - transformationDetailsStorageConfig: {} - fileTypesToTransform: - - enumDescriptions: string - type: string - enum: string - publishToStackdriver: {} inspectConfig: + contentOptions: + - type: string + enum: string + enumDescriptions: string + infoTypes: + - sensitivityScore: + score: string + version: string + name: string + minLikelihood: string + includeQuote: boolean + minLikelihoodPerInfoType: + - minLikelihood: string + infoType: + version: string + name: string limits: - maxFindingsPerItem: integer maxFindingsPerRequest: integer + maxFindingsPerItem: integer maxFindingsPerInfoType: - maxFindings: integer - infoType: - version: string - name: string - sensitivityScore: - score: string - contentOptions: - - enum: string - type: string - enumDescriptions: string - includeQuote: boolean customInfoTypes: - - regex: - pattern: string - groupIndexes: - - type: string - format: string - exclusionType: string - likelihood: string - dictionary: - cloudStoragePath: - path: string - wordList: - words: - - type: string + - exclusionType: string + storedType: + createTime: string + name: string surrogateType: {} + regex: + groupIndexes: + - format: string + type: string + pattern: string detectionRules: - hotwordRule: proximity: - windowAfter: integer windowBefore: integer + windowAfter: integer likelihoodAdjustment: relativeLikelihood: integer fixedLikelihood: string - storedType: - createTime: string - name: string - minLikelihoodPerInfoType: - - minLikelihood: string - infoTypes: - - version: string - name: string - minLikelihood: string + dictionary: + wordList: + words: + - type: string + cloudStoragePath: + path: string + likelihood: string excludeInfoTypes: boolean ruleSet: - - infoTypes: - - version: string - name: string - rules: + - rules: - exclusionRule: + matchingType: string excludeInfoTypes: infoTypes: - version: string name: string - matchingType: string excludeByHotword: {} + infoTypes: + - version: string + name: string + actions: + - pubSub: + topic: string + jobNotificationEmails: {} + deidentify: + fileTypesToTransform: + - enumDescriptions: string + enum: string + type: string + transformationDetailsStorageConfig: + table: + projectId: string + datasetId: string + tableId: string + transformationConfig: + deidentifyTemplate: string + structuredDeidentifyTemplate: string + imageRedactTemplate: string + cloudStorageOutput: string + publishFindingsToCloudDataCatalog: {} + publishToStackdriver: {} + publishSummaryToCscc: {} + saveFindings: + outputConfig: + outputSchema: string + storageConfig: + cloudStorageOptions: + fileTypes: + - enum: string + enumDescriptions: string + type: string + bytesLimitPerFile: string + filesLimitPercent: integer + bytesLimitPerFilePercent: integer + fileSet: + regexFileSet: + excludeRegex: + - type: string + bucketName: string + includeRegex: + - type: string + url: string + sampleMethod: string + hybridOptions: + description: string + labels: object + tableOptions: + identifyingFields: + - name: string + requiredFindingLabelKeys: + - type: string + datastoreOptions: + partitionId: + namespaceId: string + projectId: string + kind: + name: string + bigQueryOptions: + rowsLimit: string + includedFields: + - name: string + sampleMethod: string + identifyingFields: + - name: string + excludedFields: + - name: string + rowsLimitPercent: integer + timespanConfig: + startTime: string + timestampField: + name: string + endTime: string + enableAutoPopulationOfTimespanConfig: boolean + inspectTemplateName: string locationId: string riskJob: + actions: + - {} privacyMetric: - kMapEstimationConfig: + categoricalStatsConfig: {} + numericalStatsConfig: {} + deltaPresenceEstimationConfig: auxiliaryTables: - quasiIds: - customTag: string @@ -268,11 +272,10 @@ riskJob: lDiversityConfig: quasiIds: - name: string - numericalStatsConfig: {} - deltaPresenceEstimationConfig: - regionCode: string + kMapEstimationConfig: quasiIds: - customTag: string + regionCode: string auxiliaryTables: - quasiIds: - customTag: string @@ -280,9 +283,6 @@ riskJob: entityId: {} quasiIds: - name: string - categoricalStatsConfig: {} - actions: - - {} ``` diff --git a/docs/google-docs/providers/google/dlp/inspect_templates/index.md b/docs/google-docs/providers/google/dlp/inspect_templates/index.md index aee7147bda..54c6c6d5d7 100644 --- a/docs/google-docs/providers/google/dlp/inspect_templates/index.md +++ b/docs/google-docs/providers/google/dlp/inspect_templates/index.md @@ -95,90 +95,90 @@ Use the following StackQL query and manifest file to create a new inspect_ /*+ create */ INSERT INTO google.dlp.inspect_templates ( projectsId, +inspectTemplate, templateId, -locationId, -inspectTemplate +locationId ) SELECT '{{ projectsId }}', +'{{ inspectTemplate }}', '{{ templateId }}', -'{{ locationId }}', -'{{ inspectTemplate }}' +'{{ locationId }}' ; ``` ```yaml -templateId: string -locationId: string inspectTemplate: - displayName: string - createTime: string - description: string + updateTime: string inspectConfig: + contentOptions: + - type: string + enum: string + enumDescriptions: string + infoTypes: + - sensitivityScore: + score: string + version: string + name: string + minLikelihood: string + includeQuote: boolean + minLikelihoodPerInfoType: + - minLikelihood: string + infoType: + version: string + name: string limits: - maxFindingsPerItem: integer maxFindingsPerRequest: integer + maxFindingsPerItem: integer maxFindingsPerInfoType: - maxFindings: integer - infoType: - version: string - name: string - sensitivityScore: - score: string - contentOptions: - - enum: string - type: string - enumDescriptions: string - includeQuote: boolean customInfoTypes: - - regex: - pattern: string - groupIndexes: - - type: string - format: string - exclusionType: string - likelihood: string - dictionary: - cloudStoragePath: - path: string - wordList: - words: - - type: string + - exclusionType: string + storedType: + createTime: string + name: string surrogateType: {} + regex: + groupIndexes: + - format: string + type: string + pattern: string detectionRules: - hotwordRule: proximity: - windowAfter: integer windowBefore: integer + windowAfter: integer likelihoodAdjustment: relativeLikelihood: integer fixedLikelihood: string - storedType: - createTime: string - name: string - minLikelihoodPerInfoType: - - minLikelihood: string - infoTypes: - - version: string - name: string - minLikelihood: string + dictionary: + wordList: + words: + - type: string + cloudStoragePath: + path: string + likelihood: string excludeInfoTypes: boolean ruleSet: - - infoTypes: - - version: string - name: string - rules: + - rules: - exclusionRule: + matchingType: string excludeInfoTypes: infoTypes: - version: string name: string - matchingType: string excludeByHotword: {} - updateTime: string + infoTypes: + - version: string + name: string + displayName: string name: string + description: string + createTime: string +templateId: string +locationId: string ``` @@ -192,8 +192,8 @@ Updates a inspect_templates resource. /*+ update */ UPDATE google.dlp.inspect_templates SET -inspectTemplate = '{{ inspectTemplate }}', -updateMask = '{{ updateMask }}' +updateMask = '{{ updateMask }}', +inspectTemplate = '{{ inspectTemplate }}' WHERE inspectTemplatesId = '{{ inspectTemplatesId }}' AND projectsId = '{{ projectsId }}'; diff --git a/docs/google-docs/providers/google/dlp/job_triggers/index.md b/docs/google-docs/providers/google/dlp/job_triggers/index.md index f075dd43b0..11ba2529f1 100644 --- a/docs/google-docs/providers/google/dlp/job_triggers/index.md +++ b/docs/google-docs/providers/google/dlp/job_triggers/index.md @@ -101,182 +101,182 @@ Use the following StackQL query and manifest file to create a new job_trig /*+ create */ INSERT INTO google.dlp.job_triggers ( projectsId, -jobTrigger, triggerId, -locationId +locationId, +jobTrigger ) SELECT '{{ projectsId }}', -'{{ jobTrigger }}', '{{ triggerId }}', -'{{ locationId }}' +'{{ locationId }}', +'{{ jobTrigger }}' ; ``` ```yaml +triggerId: string +locationId: string jobTrigger: - createTime: string - name: string errors: - details: - message: string - code: integer details: - additionalProperties: any type: string + code: integer + message: string timestamps: - - format: string - type: string + - type: string + format: string extraInfo: string + status: string + lastRunTime: string + name: string + createTime: string + updateTime: string triggers: - - schedule: + - manual: {} + schedule: recurrencePeriodDuration: string - manual: {} - lastRunTime: string - status: string - displayName: string description: string + displayName: string inspectJob: - storageConfig: - hybridOptions: - requiredFindingLabelKeys: - - type: string - labels: object - description: string - tableOptions: - identifyingFields: - - name: string - timespanConfig: - startTime: string - timestampField: - name: string - endTime: string - enableAutoPopulationOfTimespanConfig: boolean - datastoreOptions: - kind: - name: string - partitionId: - namespaceId: string - projectId: string - cloudStorageOptions: - bytesLimitPerFilePercent: integer - filesLimitPercent: integer - fileSet: - regexFileSet: - excludeRegex: - - type: string - includeRegex: - - type: string - bucketName: string - url: string - bytesLimitPerFile: string - fileTypes: - - enumDescriptions: string - enum: string - type: string - sampleMethod: string - bigQueryOptions: - includedFields: - - name: string - identifyingFields: - - name: string - tableReference: - tableId: string - projectId: string - datasetId: string - excludedFields: - - name: string - rowsLimitPercent: integer - rowsLimit: string - sampleMethod: string - inspectTemplateName: string - actions: - - publishSummaryToCscc: {} - saveFindings: - outputConfig: - outputSchema: string - jobNotificationEmails: {} - publishFindingsToCloudDataCatalog: {} - pubSub: - topic: string - deidentify: - cloudStorageOutput: string - transformationConfig: - structuredDeidentifyTemplate: string - imageRedactTemplate: string - deidentifyTemplate: string - transformationDetailsStorageConfig: {} - fileTypesToTransform: - - enumDescriptions: string - type: string - enum: string - publishToStackdriver: {} inspectConfig: + contentOptions: + - type: string + enum: string + enumDescriptions: string + infoTypes: + - sensitivityScore: + score: string + version: string + name: string + minLikelihood: string + includeQuote: boolean + minLikelihoodPerInfoType: + - minLikelihood: string + infoType: + version: string + name: string limits: - maxFindingsPerItem: integer maxFindingsPerRequest: integer + maxFindingsPerItem: integer maxFindingsPerInfoType: - maxFindings: integer - infoType: - version: string - name: string - sensitivityScore: - score: string - contentOptions: - - enum: string - type: string - enumDescriptions: string - includeQuote: boolean customInfoTypes: - - regex: - pattern: string - groupIndexes: - - type: string - format: string - exclusionType: string - likelihood: string - dictionary: - cloudStoragePath: - path: string - wordList: - words: - - type: string + - exclusionType: string + storedType: + createTime: string + name: string surrogateType: {} + regex: + groupIndexes: + - format: string + type: string + pattern: string detectionRules: - hotwordRule: proximity: - windowAfter: integer windowBefore: integer + windowAfter: integer likelihoodAdjustment: relativeLikelihood: integer fixedLikelihood: string - storedType: - createTime: string - name: string - minLikelihoodPerInfoType: - - minLikelihood: string - infoTypes: - - version: string - name: string - minLikelihood: string + dictionary: + wordList: + words: + - type: string + cloudStoragePath: + path: string + likelihood: string excludeInfoTypes: boolean ruleSet: - - infoTypes: - - version: string - name: string - rules: + - rules: - exclusionRule: + matchingType: string excludeInfoTypes: infoTypes: - version: string name: string - matchingType: string excludeByHotword: {} - updateTime: string -triggerId: string -locationId: string + infoTypes: + - version: string + name: string + actions: + - pubSub: + topic: string + jobNotificationEmails: {} + deidentify: + fileTypesToTransform: + - enumDescriptions: string + enum: string + type: string + transformationDetailsStorageConfig: + table: + projectId: string + datasetId: string + tableId: string + transformationConfig: + deidentifyTemplate: string + structuredDeidentifyTemplate: string + imageRedactTemplate: string + cloudStorageOutput: string + publishFindingsToCloudDataCatalog: {} + publishToStackdriver: {} + publishSummaryToCscc: {} + saveFindings: + outputConfig: + outputSchema: string + storageConfig: + cloudStorageOptions: + fileTypes: + - enum: string + enumDescriptions: string + type: string + bytesLimitPerFile: string + filesLimitPercent: integer + bytesLimitPerFilePercent: integer + fileSet: + regexFileSet: + excludeRegex: + - type: string + bucketName: string + includeRegex: + - type: string + url: string + sampleMethod: string + hybridOptions: + description: string + labels: object + tableOptions: + identifyingFields: + - name: string + requiredFindingLabelKeys: + - type: string + datastoreOptions: + partitionId: + namespaceId: string + projectId: string + kind: + name: string + bigQueryOptions: + rowsLimit: string + includedFields: + - name: string + sampleMethod: string + identifyingFields: + - name: string + excludedFields: + - name: string + rowsLimitPercent: integer + timespanConfig: + startTime: string + timestampField: + name: string + endTime: string + enableAutoPopulationOfTimespanConfig: boolean + inspectTemplateName: string ``` @@ -290,8 +290,8 @@ Updates a job_triggers resource. /*+ update */ UPDATE google.dlp.job_triggers SET -updateMask = '{{ updateMask }}', -jobTrigger = '{{ jobTrigger }}' +jobTrigger = '{{ jobTrigger }}', +updateMask = '{{ updateMask }}' WHERE jobTriggersId = '{{ jobTriggersId }}' AND projectsId = '{{ projectsId }}'; diff --git a/docs/google-docs/providers/google/dlp/stored_info_types/index.md b/docs/google-docs/providers/google/dlp/stored_info_types/index.md index 8ebcfad677..00d3d0c554 100644 --- a/docs/google-docs/providers/google/dlp/stored_info_types/index.md +++ b/docs/google-docs/providers/google/dlp/stored_info_types/index.md @@ -107,29 +107,29 @@ SELECT storedInfoTypeId: string locationId: string config: + regex: + groupIndexes: + - format: string + type: string + pattern: string dictionary: - cloudStoragePath: - path: string wordList: words: - type: string + cloudStoragePath: + path: string description: string - regex: - pattern: string - groupIndexes: - - type: string - format: string - displayName: string largeCustomDictionary: cloudStorageFileSet: url: string bigQueryField: - field: - name: string table: - tableId: string projectId: string datasetId: string + tableId: string + field: + name: string + displayName: string ``` @@ -143,8 +143,8 @@ Updates a stored_info_types resource. /*+ update */ UPDATE google.dlp.stored_info_types SET -updateMask = '{{ updateMask }}', -config = '{{ config }}' +config = '{{ config }}', +updateMask = '{{ updateMask }}' WHERE projectsId = '{{ projectsId }}' AND storedInfoTypesId = '{{ storedInfoTypesId }}'; diff --git a/docs/google-docs/providers/google/documentai/processors/index.md b/docs/google-docs/providers/google/documentai/processors/index.md index 295864113e..469466348b 100644 --- a/docs/google-docs/providers/google/documentai/processors/index.md +++ b/docs/google-docs/providers/google/documentai/processors/index.md @@ -97,36 +97,36 @@ INSERT INTO google.documentai.processors ( locationsId, projectsId, defaultProcessorVersion, -displayName, kmsKeyName, -type +type, +displayName ) SELECT '{{ locationsId }}', '{{ projectsId }}', '{{ defaultProcessorVersion }}', -'{{ displayName }}', '{{ kmsKeyName }}', -'{{ type }}' +'{{ type }}', +'{{ displayName }}' ; ``` ```yaml +satisfiesPzi: boolean +processEndpoint: string +satisfiesPzs: boolean +defaultProcessorVersion: string state: string createTime: string -defaultProcessorVersion: string processorVersionAliases: - processorVersion: string alias: string -satisfiesPzs: boolean -displayName: string -processEndpoint: string kmsKeyName: string -satisfiesPzi: boolean name: string type: string +displayName: string ``` diff --git a/docs/google-docs/providers/google/essentialcontacts/contacts/index.md b/docs/google-docs/providers/google/essentialcontacts/contacts/index.md index d3c5173e63..ef7a0a3569 100644 --- a/docs/google-docs/providers/google/essentialcontacts/contacts/index.md +++ b/docs/google-docs/providers/google/essentialcontacts/contacts/index.md @@ -96,31 +96,31 @@ Use the following StackQL query and manifest file to create a new contacts /*+ create */ INSERT INTO google.essentialcontacts.contacts ( foldersId, -validateTime, -languageTag, +email, notificationCategorySubscriptions, -email +validateTime, +languageTag ) SELECT '{{ foldersId }}', -'{{ validateTime }}', -'{{ languageTag }}', +'{{ email }}', '{{ notificationCategorySubscriptions }}', -'{{ email }}' +'{{ validateTime }}', +'{{ languageTag }}' ; ``` ```yaml -validateTime: string -languageTag: string +validationState: string +email: string notificationCategorySubscriptions: - - type: string - enumDescriptions: string + - enumDescriptions: string enum: string -email: string -validationState: string + type: string +validateTime: string +languageTag: string name: string ``` @@ -135,10 +135,10 @@ Updates a contacts resource. /*+ update */ UPDATE google.essentialcontacts.contacts SET -validateTime = '{{ validateTime }}', -languageTag = '{{ languageTag }}', +email = '{{ email }}', notificationCategorySubscriptions = '{{ notificationCategorySubscriptions }}', -email = '{{ email }}' +validateTime = '{{ validateTime }}', +languageTag = '{{ languageTag }}' WHERE contactsId = '{{ contactsId }}' AND foldersId = '{{ foldersId }}'; diff --git a/docs/google-docs/providers/google/iam/index.md b/docs/google-docs/providers/google/iam/index.md index 59d61e8759..04d68467ea 100644 --- a/docs/google-docs/providers/google/iam/index.md +++ b/docs/google-docs/providers/google/iam/index.md @@ -20,7 +20,7 @@ The iam service documentation.
-total resources: 14
+total resources: 17
@@ -29,21 +29,24 @@ The iam service documentation. ## Resources
-credentials
iam_policies
-keys
+oauth_client_credentials
oauth_clients
operations
permissions
-providers -
-
roles
+service_account_keys
service_accounts
-service_accounts_iam_policies
-subjects
+service_accounts_iam_policies +
+
+workforce_pool_provider_keys
+workforce_pool_providers
+workforce_pool_subjects
workforce_pools
workforce_pools_iam_policies
+workload_identity_pool_provider_keys
+workload_identity_pool_providers
workload_identity_pools
\ No newline at end of file diff --git a/docs/google-docs/providers/google/iam/credentials/index.md b/docs/google-docs/providers/google/iam/oauth_client_credentials/index.md similarity index 85% rename from docs/google-docs/providers/google/iam/credentials/index.md rename to docs/google-docs/providers/google/iam/oauth_client_credentials/index.md index 1b1188cf5b..7a086759a6 100644 --- a/docs/google-docs/providers/google/iam/credentials/index.md +++ b/docs/google-docs/providers/google/iam/oauth_client_credentials/index.md @@ -1,9 +1,9 @@ --- -title: credentials +title: oauth_client_credentials hide_title: false hide_table_of_contents: false keywords: - - credentials + - oauth_client_credentials - iam - google - stackql @@ -19,13 +19,13 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a credentials resource. +Creates, updates, deletes, gets or lists a oauth_client_credentials resource. ## Overview - + - +
Namecredentials
Nameoauth_client_credentials
TypeResource
Id
Id
## Fields @@ -55,7 +55,7 @@ name, clientSecret, disabled, displayName -FROM google.iam.credentials +FROM google.iam.oauth_client_credentials WHERE locationsId = '{{ locationsId }}' AND oauthClientsId = '{{ oauthClientsId }}' AND projectsId = '{{ projectsId }}'; @@ -63,7 +63,7 @@ AND projectsId = '{{ projectsId }}'; ## `INSERT` example -Use the following StackQL query and manifest file to create a new credentials resource. +Use the following StackQL query and manifest file to create a new oauth_client_credentials resource. credenti ```sql /*+ create */ -INSERT INTO google.iam.credentials ( +INSERT INTO google.iam.oauth_client_credentials ( locationsId, oauthClientsId, projectsId, @@ -108,11 +108,11 @@ displayName: string ## `UPDATE` example -Updates a credentials resource. +Updates a oauth_client_credentials resource. ```sql /*+ update */ -UPDATE google.iam.credentials +UPDATE google.iam.oauth_client_credentials SET name = '{{ name }}', disabled = true|false, @@ -126,11 +126,11 @@ AND projectsId = '{{ projectsId }}'; ## `DELETE` example -Deletes the specified credentials resource. +Deletes the specified oauth_client_credentials resource. ```sql /*+ delete */ -DELETE FROM google.iam.credentials +DELETE FROM google.iam.oauth_client_credentials WHERE credentialsId = '{{ credentialsId }}' AND locationsId = '{{ locationsId }}' AND oauthClientsId = '{{ oauthClientsId }}' diff --git a/docs/google-docs/providers/google/iam/operations/index.md b/docs/google-docs/providers/google/iam/operations/index.md index e5fa15a195..1faa8188dc 100644 --- a/docs/google-docs/providers/google/iam/operations/index.md +++ b/docs/google-docs/providers/google/iam/operations/index.md @@ -40,7 +40,16 @@ Creates, updates, deletes, gets or lists a operations resource. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | 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. | +| | `SELECT` | | 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. | +| | `SELECT` | | 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. | +| | `SELECT` | | 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. | +| | `SELECT` | | 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. | +| | `SELECT` | | 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. | +| | `SELECT` | | 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. | +| | `SELECT` | | 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. | +| | `SELECT` | | 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. | +| | `SELECT` | | 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. | +| | `SELECT` | | 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. | ## `SELECT` examples @@ -56,6 +65,5 @@ response FROM google.iam.operations WHERE locationsId = '{{ locationsId }}' AND operationsId = '{{ operationsId }}' -AND subjectsId = '{{ subjectsId }}' AND workforcePoolsId = '{{ workforcePoolsId }}'; ``` diff --git a/docs/google-docs/providers/google/iam/roles/index.md b/docs/google-docs/providers/google/iam/roles/index.md index b166526855..c7d24e8d9b 100644 --- a/docs/google-docs/providers/google/iam/roles/index.md +++ b/docs/google-docs/providers/google/iam/roles/index.md @@ -42,13 +42,21 @@ Creates, updates, deletes, gets or lists a roles resource. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets the definition of a Role. | -| | `SELECT` | | Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project. | -| | `INSERT` | | Creates a new custom Role. | -| | `DELETE` | | 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. | -| | `UPDATE` | | Updates the definition of a custom Role. | +| | `SELECT` | | Gets the definition of a Role. | +| | `SELECT` | | Gets the definition of a Role. | +| | `SELECT` | | Gets the definition of a Role. | +| | `SELECT` | | Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project. | +| | `SELECT` | | Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project. | +| | `SELECT` | | Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project. | +| | `INSERT` | | Creates a new custom Role. | +| | `INSERT` | | Creates a new custom Role. | +| | `DELETE` | | 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. | +| | `DELETE` | | 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. | +| | `UPDATE` | | Updates the definition of a custom Role. | +| | `UPDATE` | | Updates the definition of a custom Role. | | | `EXEC` | | 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. | -| | `EXEC` | | Undeletes a custom Role. | +| | `EXEC` | | Undeletes a custom Role. | +| | `EXEC` | | Undeletes a custom Role. | ## `SELECT` examples @@ -64,7 +72,7 @@ includedPermissions, stage, title FROM google.iam.roles -WHERE organizationsId = '{{ organizationsId }}'; +WHERE = '{{ }}'; ``` ## `INSERT` example @@ -83,12 +91,12 @@ Use the following StackQL query and manifest file to create a new rolesroles resource. ```sql /*+ delete */ DELETE FROM google.iam.roles -WHERE organizationsId = '{{ organizationsId }}' +WHERE projectsId = '{{ projectsId }}' AND rolesId = '{{ rolesId }}'; ``` diff --git a/docs/google-docs/providers/google/iam/service_account_keys/index.md b/docs/google-docs/providers/google/iam/service_account_keys/index.md new file mode 100644 index 0000000000..0705d5d9c2 --- /dev/null +++ b/docs/google-docs/providers/google/iam/service_account_keys/index.md @@ -0,0 +1,130 @@ +--- +title: service_account_keys +hide_title: false +hide_table_of_contents: false +keywords: + - service_account_keys + - iam + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a service_account_keys resource. + +## Overview + + + + +
Nameservice_account_keys
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. | +| | `string` | Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. | +| | `boolean` | The key status. | +| | `array` | 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. | +| | `string` | Specifies the algorithm (and possibly key size) for the key. | +| | `string` | The key origin. | +| | `string` | The key type. | +| | `string` | 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. | +| | `string` | 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. | +| | `string` | The public key data. Only provided in `GetServiceAccountKey` responses. | +| | `string` | The key can be used after this timestamp. | +| | `string` | 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. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets a ServiceAccountKey. | +| | `SELECT` | | Lists every ServiceAccountKey for a service account. | +| | `INSERT` | | Creates a ServiceAccountKey. | +| | `DELETE` | | Deletes a ServiceAccountKey. Deleting a service account key does not revoke short-lived credentials that have been issued based on the service account key. | +| | `EXEC` | | Disable a ServiceAccountKey. A disabled service account key can be re-enabled with EnableServiceAccountKey. | +| | `EXEC` | | Enable a ServiceAccountKey. | +| | `EXEC` | | 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. | + +## `SELECT` examples + +Lists every ServiceAccountKey for a service account. + +```sql +SELECT +name, +disableReason, +disabled, +extendedStatus, +keyAlgorithm, +keyOrigin, +keyType, +privateKeyData, +privateKeyType, +publicKeyData, +validAfterTime, +validBeforeTime +FROM google.iam.service_account_keys +WHERE projectsId = '{{ projectsId }}' +AND serviceAccountsId = '{{ serviceAccountsId }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new service_account_keys resource. + + + + +```sql +/*+ create */ +INSERT INTO google.iam.service_account_keys ( +projectsId, +serviceAccountsId, +privateKeyType, +keyAlgorithm +) +SELECT +'{{ projectsId }}', +'{{ serviceAccountsId }}', +'{{ privateKeyType }}', +'{{ keyAlgorithm }}' +; +``` + + + +```yaml +privateKeyType: string +keyAlgorithm: string + +``` + + + +## `DELETE` example + +Deletes the specified service_account_keys resource. + +```sql +/*+ delete */ +DELETE FROM google.iam.service_account_keys +WHERE keysId = '{{ keysId }}' +AND projectsId = '{{ projectsId }}' +AND serviceAccountsId = '{{ serviceAccountsId }}'; +``` diff --git a/docs/google-docs/providers/google/iam/keys/index.md b/docs/google-docs/providers/google/iam/workforce_pool_provider_keys/index.md similarity index 77% rename from docs/google-docs/providers/google/iam/keys/index.md rename to docs/google-docs/providers/google/iam/workforce_pool_provider_keys/index.md index 0d5496932e..6806a1e89e 100644 --- a/docs/google-docs/providers/google/iam/keys/index.md +++ b/docs/google-docs/providers/google/iam/workforce_pool_provider_keys/index.md @@ -1,9 +1,9 @@ --- -title: keys +title: workforce_pool_provider_keys hide_title: false hide_table_of_contents: false keywords: - - keys + - workforce_pool_provider_keys - iam - google - stackql @@ -19,13 +19,13 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a keys resource. +Creates, updates, deletes, gets or lists a workforce_pool_provider_keys resource. ## Overview - + - +
Namekeys
Nameworkforce_pool_provider_keys
TypeResource
Id
Id
## Fields @@ -44,10 +44,7 @@ Creates, updates, deletes, gets or lists a keys resource. | | `SELECT` | | Lists all non-deleted WorkforcePoolProviderKeys in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted keys are also listed. | | | `INSERT` | | Creates a new WorkforcePoolProviderKey in a WorkforcePoolProvider. | | | `DELETE` | | Deletes a WorkforcePoolProviderKey. You can undelete a key for 30 days. After 30 days, deletion is permanent. | -| | `EXEC` | | Disable a ServiceAccountKey. A disabled service account key can be re-enabled with EnableServiceAccountKey. | -| | `EXEC` | | Enable a ServiceAccountKey. | | | `EXEC` | | Undeletes a WorkforcePoolProviderKey, as long as it was deleted fewer than 30 days ago. | -| | `EXEC` | | 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. | ## `SELECT` examples @@ -60,7 +57,7 @@ expireTime, keyData, state, use -FROM google.iam.keys +FROM google.iam.workforce_pool_provider_keys WHERE locationsId = '{{ locationsId }}' AND providersId = '{{ providersId }}' AND workforcePoolsId = '{{ workforcePoolsId }}'; @@ -68,7 +65,7 @@ AND workforcePoolsId = '{{ workforcePoolsId }}'; ## `INSERT` example -Use the following StackQL query and manifest file to create a new keys resource. +Use the following StackQL query and manifest file to create a new workforce_pool_provider_keys resource. keyskeys resource. +Deletes the specified workforce_pool_provider_keys resource. ```sql /*+ delete */ -DELETE FROM google.iam.keys +DELETE FROM google.iam.workforce_pool_provider_keys WHERE keysId = '{{ keysId }}' AND locationsId = '{{ locationsId }}' AND providersId = '{{ providersId }}' diff --git a/docs/google-docs/providers/google/iam/providers/index.md b/docs/google-docs/providers/google/iam/workforce_pool_providers/index.md similarity index 93% rename from docs/google-docs/providers/google/iam/providers/index.md rename to docs/google-docs/providers/google/iam/workforce_pool_providers/index.md index afdc3f9f0b..4e1b614689 100644 --- a/docs/google-docs/providers/google/iam/providers/index.md +++ b/docs/google-docs/providers/google/iam/workforce_pool_providers/index.md @@ -1,9 +1,9 @@ --- -title: providers +title: workforce_pool_providers hide_title: false hide_table_of_contents: false keywords: - - providers + - workforce_pool_providers - iam - google - stackql @@ -19,13 +19,13 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a providers resource. +Creates, updates, deletes, gets or lists a workforce_pool_providers resource. ## Overview - + - +
Nameproviders
Nameworkforce_pool_providers
TypeResource
Id
Id
## Fields @@ -70,14 +70,14 @@ extraAttributesOauth2Client, oidc, saml, state -FROM google.iam.providers +FROM google.iam.workforce_pool_providers WHERE locationsId = '{{ locationsId }}' AND workforcePoolsId = '{{ workforcePoolsId }}'; ``` ## `INSERT` example -Use the following StackQL query and manifest file to create a new providers resource. +Use the following StackQL query and manifest file to create a new workforce_pool_providers resource. provider ```sql /*+ create */ -INSERT INTO google.iam.providers ( +INSERT INTO google.iam.workforce_pool_providers ( locationsId, workforcePoolsId, displayName, @@ -155,11 +155,11 @@ extraAttributesOauth2Client: ## `UPDATE` example -Updates a providers resource. +Updates a workforce_pool_providers resource. ```sql /*+ update */ -UPDATE google.iam.providers +UPDATE google.iam.workforce_pool_providers SET displayName = '{{ displayName }}', description = '{{ description }}', @@ -177,11 +177,11 @@ AND workforcePoolsId = '{{ workforcePoolsId }}'; ## `DELETE` example -Deletes the specified providers resource. +Deletes the specified workforce_pool_providers resource. ```sql /*+ delete */ -DELETE FROM google.iam.providers +DELETE FROM google.iam.workforce_pool_providers WHERE locationsId = '{{ locationsId }}' AND providersId = '{{ providersId }}' AND workforcePoolsId = '{{ workforcePoolsId }}'; diff --git a/docs/google-docs/providers/google/iam/subjects/index.md b/docs/google-docs/providers/google/iam/workforce_pool_subjects/index.md similarity index 83% rename from docs/google-docs/providers/google/iam/subjects/index.md rename to docs/google-docs/providers/google/iam/workforce_pool_subjects/index.md index dd8900cdc3..30cdf6706e 100644 --- a/docs/google-docs/providers/google/iam/subjects/index.md +++ b/docs/google-docs/providers/google/iam/workforce_pool_subjects/index.md @@ -1,9 +1,9 @@ --- -title: subjects +title: workforce_pool_subjects hide_title: false hide_table_of_contents: false keywords: - - subjects + - workforce_pool_subjects - iam - google - stackql @@ -19,13 +19,13 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Creates, updates, deletes, gets or lists a subjects resource. +Creates, updates, deletes, gets or lists a workforce_pool_subjects resource. ## Overview - + - +
Namesubjects
Nameworkforce_pool_subjects
TypeResource
Id
Id
## Fields @@ -40,11 +40,11 @@ Creates, updates, deletes, gets or lists a subjects resource. ## `DELETE` example -Deletes the specified subjects resource. +Deletes the specified workforce_pool_subjects resource. ```sql /*+ delete */ -DELETE FROM google.iam.subjects +DELETE FROM google.iam.workforce_pool_subjects WHERE locationsId = '{{ locationsId }}' AND subjectsId = '{{ subjectsId }}' AND workforcePoolsId = '{{ workforcePoolsId }}'; diff --git a/docs/google-docs/providers/google/iam/workload_identity_pool_provider_keys/index.md b/docs/google-docs/providers/google/iam/workload_identity_pool_provider_keys/index.md new file mode 100644 index 0000000000..40852f33bf --- /dev/null +++ b/docs/google-docs/providers/google/iam/workload_identity_pool_provider_keys/index.md @@ -0,0 +1,130 @@ +--- +title: workload_identity_pool_provider_keys +hide_title: false +hide_table_of_contents: false +keywords: + - workload_identity_pool_provider_keys + - iam + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a workload_identity_pool_provider_keys resource. + +## Overview + + + + +
Nameworkload_identity_pool_provider_keys
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Output only. The resource name of the key. | +| | `string` | 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. | +| | `object` | Represents a public key data along with its format. | +| | `string` | Output only. The state of the key. | +| | `string` | Required. The purpose of the key. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets an individual WorkloadIdentityPoolProviderKey. | +| | `SELECT` | | Lists all non-deleted WorkloadIdentityPoolProviderKeys in a project. If show_deleted is set to `true`, then deleted pools are also listed. | +| | `INSERT` | | Create a new WorkloadIdentityPoolProviderKey in a WorkloadIdentityPoolProvider. | +| | `DELETE` | | Deletes an WorkloadIdentityPoolProviderKey. You can undelete a key for 30 days. After 30 days, deletion is permanent. | +| | `EXEC` | | Undeletes an WorkloadIdentityPoolProviderKey, as long as it was deleted fewer than 30 days ago. | + +## `SELECT` examples + +Lists all non-deleted WorkloadIdentityPoolProviderKeys in a project. If show_deleted is set to `true`, then deleted pools are also listed. + +```sql +SELECT +name, +expireTime, +keyData, +state, +use +FROM google.iam.workload_identity_pool_provider_keys +WHERE locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}' +AND providersId = '{{ providersId }}' +AND workloadIdentityPoolsId = '{{ workloadIdentityPoolsId }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new workload_identity_pool_provider_keys resource. + + + + +```sql +/*+ create */ +INSERT INTO google.iam.workload_identity_pool_provider_keys ( +locationsId, +projectsId, +providersId, +workloadIdentityPoolsId, +keyData, +use +) +SELECT +'{{ locationsId }}', +'{{ projectsId }}', +'{{ providersId }}', +'{{ workloadIdentityPoolsId }}', +'{{ keyData }}', +'{{ use }}' +; +``` + + + +```yaml +name: string +keyData: + format: string + notBeforeTime: string + notAfterTime: string + key: string + keySpec: string +state: string +use: string +expireTime: string + +``` + + + +## `DELETE` example + +Deletes the specified workload_identity_pool_provider_keys resource. + +```sql +/*+ delete */ +DELETE FROM google.iam.workload_identity_pool_provider_keys +WHERE keysId = '{{ keysId }}' +AND locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}' +AND providersId = '{{ providersId }}' +AND workloadIdentityPoolsId = '{{ workloadIdentityPoolsId }}'; +``` diff --git a/docs/google-docs/providers/google/iam/workload_identity_pool_providers/index.md b/docs/google-docs/providers/google/iam/workload_identity_pool_providers/index.md new file mode 100644 index 0000000000..2b6a961c0c --- /dev/null +++ b/docs/google-docs/providers/google/iam/workload_identity_pool_providers/index.md @@ -0,0 +1,181 @@ +--- +title: workload_identity_pool_providers +hide_title: false +hide_table_of_contents: false +keywords: + - workload_identity_pool_providers + - iam + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a workload_identity_pool_providers resource. + +## Overview + + + + +
Nameworkload_identity_pool_providers
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Output only. The resource name of the provider. | +| | `string` | A description for the provider. Cannot exceed 256 characters. | +| | `string` | [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" ``` | +| | `object` | 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"} ``` | +| | `object` | Represents an Amazon Web Services identity provider. | +| | `boolean` | Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access. | +| | `string` | A display name for the provider. Cannot exceed 32 characters. | +| | `string` | Output only. Time after which the workload identity pool provider will be permanently purged and cannot be recovered. | +| | `object` | Represents an OpenId Connect 1.0 identity provider. | +| | `object` | Represents an SAML 2.0 identity provider. | +| | `string` | Output only. The state of the provider. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets an individual WorkloadIdentityPoolProvider. | +| | `SELECT` | | Lists all non-deleted WorkloadIdentityPoolProviders in a WorkloadIdentityPool. If `show_deleted` is set to `true`, then deleted providers are also listed. | +| | `INSERT` | | Creates a new WorkloadIdentityPoolProvider in a WorkloadIdentityPool. You cannot reuse the name of a deleted provider until 30 days after deletion. | +| | `DELETE` | | 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. | +| | `UPDATE` | | Updates an existing WorkloadIdentityPoolProvider. | +| | `EXEC` | | Undeletes a WorkloadIdentityPoolProvider, as long as it was deleted fewer than 30 days ago. | + +## `SELECT` examples + +Lists all non-deleted WorkloadIdentityPoolProviders in a WorkloadIdentityPool. If `show_deleted` is set to `true`, then deleted providers are also listed. + +```sql +SELECT +name, +description, +attributeCondition, +attributeMapping, +aws, +disabled, +displayName, +expireTime, +oidc, +saml, +state +FROM google.iam.workload_identity_pool_providers +WHERE locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}' +AND workloadIdentityPoolsId = '{{ workloadIdentityPoolsId }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new workload_identity_pool_providers resource. + + + + +```sql +/*+ create */ +INSERT INTO google.iam.workload_identity_pool_providers ( +locationsId, +projectsId, +workloadIdentityPoolsId, +displayName, +description, +disabled, +attributeMapping, +attributeCondition, +aws, +oidc, +saml +) +SELECT +'{{ locationsId }}', +'{{ projectsId }}', +'{{ workloadIdentityPoolsId }}', +'{{ displayName }}', +'{{ description }}', +true|false, +'{{ attributeMapping }}', +'{{ attributeCondition }}', +'{{ aws }}', +'{{ oidc }}', +'{{ saml }}' +; +``` + + + +```yaml +name: string +displayName: string +description: string +state: string +disabled: boolean +attributeMapping: object +attributeCondition: string +aws: + accountId: string +oidc: + issuerUri: string + allowedAudiences: + - type: string + jwksJson: string +saml: + idpMetadataXml: string +expireTime: string + +``` + + + +## `UPDATE` example + +Updates a workload_identity_pool_providers resource. + +```sql +/*+ update */ +UPDATE google.iam.workload_identity_pool_providers +SET +displayName = '{{ displayName }}', +description = '{{ description }}', +disabled = true|false, +attributeMapping = '{{ attributeMapping }}', +attributeCondition = '{{ attributeCondition }}', +aws = '{{ aws }}', +oidc = '{{ oidc }}', +saml = '{{ saml }}' +WHERE +locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}' +AND providersId = '{{ providersId }}' +AND workloadIdentityPoolsId = '{{ workloadIdentityPoolsId }}'; +``` + +## `DELETE` example + +Deletes the specified workload_identity_pool_providers resource. + +```sql +/*+ delete */ +DELETE FROM google.iam.workload_identity_pool_providers +WHERE locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}' +AND providersId = '{{ providersId }}' +AND workloadIdentityPoolsId = '{{ workloadIdentityPoolsId }}'; +``` diff --git a/docs/google-docs/providers/google/iamv2/index.md b/docs/google-docs/providers/google/iamv2/index.md index 70088c9474..e4fb781a30 100644 --- a/docs/google-docs/providers/google/iamv2/index.md +++ b/docs/google-docs/providers/google/iamv2/index.md @@ -20,7 +20,7 @@ The iamv2 service documentation.
-total resources: 4
+total resources: 2
@@ -29,11 +29,9 @@ The iamv2 service documentation. ## Resources
-operations
-policies +operations
-policies_policies
-policies_policy +policies
\ No newline at end of file diff --git a/docs/google-docs/providers/google/iamv2/policies/index.md b/docs/google-docs/providers/google/iamv2/policies/index.md index 3ec4b90415..7da41ea57c 100644 --- a/docs/google-docs/providers/google/iamv2/policies/index.md +++ b/docs/google-docs/providers/google/iamv2/policies/index.md @@ -46,12 +46,14 @@ Creates, updates, deletes, gets or lists a policies resource. | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | | `SELECT` | | Gets a policy. | +| | `SELECT` | | 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. | +| | `INSERT` | | Creates a policy. | | | `DELETE` | | Deletes a policy. This action is permanent. | | | `REPLACE` | | 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. | ## `SELECT` examples -Gets a policy. +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. ```sql SELECT @@ -67,9 +69,78 @@ uid, updateTime FROM google.iamv2.policies WHERE policiesId = '{{ policiesId }}' -AND policiesId1 = '{{ policiesId1 }}' -AND policiesId2 = '{{ policiesId2 }}'; +AND policiesId1 = '{{ policiesId1 }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new policies resource. + + + + +```sql +/*+ create */ +INSERT INTO google.iamv2.policies ( +policiesId, +policiesId1, +name, +uid, +displayName, +annotations, +etag, +rules +) +SELECT +'{{ policiesId }}', +'{{ policiesId1 }}', +'{{ name }}', +'{{ uid }}', +'{{ displayName }}', +'{{ annotations }}', +'{{ etag }}', +'{{ rules }}' +; +``` + + + +```yaml +name: string +uid: string +kind: string +displayName: string +annotations: object +etag: string +createTime: string +updateTime: string +deleteTime: string +rules: + - denyRule: + deniedPrincipals: + - type: string + exceptionPrincipals: + - type: string + deniedPermissions: + - type: string + exceptionPermissions: + - type: string + denialCondition: + expression: string + title: string + description: string + location: string + description: string + ``` + + ## `REPLACE` example diff --git a/docs/google-docs/providers/google/iamv2/policies_policies/index.md b/docs/google-docs/providers/google/iamv2/policies_policies/index.md deleted file mode 100644 index 587fc21bf1..0000000000 --- a/docs/google-docs/providers/google/iamv2/policies_policies/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: policies_policies -hide_title: false -hide_table_of_contents: false -keywords: - - policies_policies - - iamv2 - - google - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL -custom_edit_url: null -image: /img/providers/google/stackql-google-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a policies_policies resource. - -## Overview - - - - -
Namepolicies_policies
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | 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. | -| | `object` | 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. | -| | `string` | Output only. The time when the `Policy` was created. | -| | `string` | Output only. The time when the `Policy` was deleted. Empty if the policy is not deleted. | -| | `string` | A user-specified description of the `Policy`. This value can be up to 63 characters. | -| | `string` | 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. | -| | `string` | Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`. | -| | `array` | A list of rules that specify the behavior of the `Policy`. All of the rules should be of the `kind` specified in the `Policy`. | -| | `string` | Immutable. The globally unique ID of the `Policy`. Assigned automatically when the `Policy` is created. | -| | `string` | Output only. The time when the `Policy` was last updated. | - -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | 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. | - -## `SELECT` examples - -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. - -```sql -SELECT -name, -annotations, -createTime, -deleteTime, -displayName, -etag, -kind, -rules, -uid, -updateTime -FROM google.iamv2.policies_policies -WHERE policiesId = '{{ policiesId }}' -AND policiesId1 = '{{ policiesId1 }}'; -``` diff --git a/docs/google-docs/providers/google/iamv2/policies_policy/index.md b/docs/google-docs/providers/google/iamv2/policies_policy/index.md deleted file mode 100644 index eff3216390..0000000000 --- a/docs/google-docs/providers/google/iamv2/policies_policy/index.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: policies_policy -hide_title: false -hide_table_of_contents: false -keywords: - - policies_policy - - iamv2 - - google - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL -custom_edit_url: null -image: /img/providers/google/stackql-google-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Creates, updates, deletes, gets or lists a policies_policy resource. - -## Overview - - - - -
Namepolicies_policy
TypeResource
Id
- -## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. - - -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `INSERT` | | Creates a policy. | - -## `INSERT` example - -Use the following StackQL query and manifest file to create a new policies_policy resource. - - - - -```sql -/*+ create */ -INSERT INTO google.iamv2.policies_policy ( -policiesId, -policiesId1, -name, -uid, -displayName, -annotations, -etag, -rules -) -SELECT -'{{ policiesId }}', -'{{ policiesId1 }}', -'{{ name }}', -'{{ uid }}', -'{{ displayName }}', -'{{ annotations }}', -'{{ etag }}', -'{{ rules }}' -; -``` - - - -```yaml -name: string -uid: string -kind: string -displayName: string -annotations: object -etag: string -createTime: string -updateTime: string -deleteTime: string -rules: - - denyRule: - deniedPrincipals: - - type: string - exceptionPrincipals: - - type: string - deniedPermissions: - - type: string - exceptionPermissions: - - type: string - denialCondition: - expression: string - title: string - description: string - location: string - description: string - -``` - - diff --git a/docs/google-docs/providers/google/integrations/apps_script_projects/index.md b/docs/google-docs/providers/google/integrations/apps_script_projects/index.md index d0a751c84e..211a0f93cc 100644 --- a/docs/google-docs/providers/google/integrations/apps_script_projects/index.md +++ b/docs/google-docs/providers/google/integrations/apps_script_projects/index.md @@ -56,22 +56,22 @@ Use the following StackQL query and manifest file to create a new apps_scr INSERT INTO google.integrations.apps_script_projects ( locationsId, projectsId, -authConfigId, -appsScriptProject +appsScriptProject, +authConfigId ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ authConfigId }}', -'{{ appsScriptProject }}' +'{{ appsScriptProject }}', +'{{ authConfigId }}' ; ``` ```yaml -authConfigId: string appsScriptProject: string +authConfigId: string ``` diff --git a/docs/google-docs/providers/google/integrations/auth_configs/index.md b/docs/google-docs/providers/google/integrations/auth_configs/index.md index ff9304efc9..afb9ca96ab 100644 --- a/docs/google-docs/providers/google/integrations/auth_configs/index.md +++ b/docs/google-docs/providers/google/integrations/auth_configs/index.md @@ -109,140 +109,140 @@ Use the following StackQL query and manifest file to create a new auth_con INSERT INTO google.integrations.auth_configs ( locationsId, projectsId, -reason, +description, +certificateId, +name, +decryptedCredential, visibility, -displayName, encryptedCredential, -name, -description, creatorEmail, -credentialType, +lastModifierEmail, +reason, validTime, +credentialType, state, -lastModifierEmail, -overrideValidTime, +displayName, expiryNotificationDuration, -certificateId, -decryptedCredential +overrideValidTime ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ reason }}', +'{{ description }}', +'{{ certificateId }}', +'{{ name }}', +'{{ decryptedCredential }}', '{{ visibility }}', -'{{ displayName }}', '{{ encryptedCredential }}', -'{{ name }}', -'{{ description }}', '{{ creatorEmail }}', -'{{ credentialType }}', +'{{ lastModifierEmail }}', +'{{ reason }}', '{{ validTime }}', +'{{ credentialType }}', '{{ state }}', -'{{ lastModifierEmail }}', -'{{ overrideValidTime }}', +'{{ displayName }}', '{{ expiryNotificationDuration }}', -'{{ certificateId }}', -'{{ decryptedCredential }}' +'{{ overrideValidTime }}' ; ``` ```yaml -reason: string -visibility: string -displayName: string -encryptedCredential: string -name: string description: string -creatorEmail: string -credentialType: string -validTime: string -state: string -lastModifierEmail: string -overrideValidTime: string -expiryNotificationDuration: - - type: string - format: string -createTime: string -updateTime: string certificateId: string +name: string decryptedCredential: - credentialType: string - serviceAccountCredentials: - serviceAccount: string - scope: string - authToken: + usernameAndPassword: + password: string + username: string + oidcToken: + tokenExpireTime: string token: string - type: string + audience: string + serviceAccountEmail: string oauth2ClientCredentials: - accessToken: - accessToken: string - refreshTokenExpireTime: string - tokenType: string - refreshToken: string - accessTokenExpireTime: string - tokenEndpoint: string - clientId: string + scope: string clientSecret: string tokenParams: entries: - - value: + - key: + referenceKey: string literalValue: - stringValue: string - doubleValue: number - jsonValue: string - booleanArray: - booleanValues: - - type: string - booleanValue: boolean - intValue: string - stringArray: - stringValues: - - type: string intArray: intValues: - - type: string - format: string + - format: string + type: string doubleArray: doubleValues: - format: string type: string - referenceKey: string + intValue: string + stringArray: + stringValues: + - type: string + doubleValue: number + stringValue: string + jsonValue: string + booleanArray: + booleanValues: + - type: string + booleanValue: boolean keyType: string valueType: string + clientId: string + tokenEndpoint: string + accessToken: + accessTokenExpireTime: string + refreshToken: string + tokenType: string + accessToken: string + refreshTokenExpireTime: string requestType: string + oauth2ResourceOwnerCredentials: scope: string + clientId: string + username: string + clientSecret: string + password: string + tokenEndpoint: string + requestType: string + credentialType: string oauth2AuthorizationCode: + clientSecret: string + requestType: string authCode: string - clientId: string scope: string - clientSecret: string - applyReauthPolicy: boolean authEndpoint: string tokenEndpoint: string - requestType: string + applyReauthPolicy: boolean + clientId: string + serviceAccountCredentials: + scope: string + serviceAccount: string jwt: - jwtHeader: string - secret: string jwt: string + secret: string jwtPayload: string - oidcToken: - tokenExpireTime: string - audience: string - serviceAccountEmail: string + jwtHeader: string + authToken: + type: string token: string - oauth2ResourceOwnerCredentials: - scope: string - requestType: string - clientId: string - username: string - password: string - clientSecret: string - tokenEndpoint: string - usernameAndPassword: - username: string - password: string +visibility: string +encryptedCredential: string +creatorEmail: string +lastModifierEmail: string +reason: string +validTime: string +createTime: string +credentialType: string +state: string +displayName: string +expiryNotificationDuration: + - type: string + format: string +overrideValidTime: string +updateTime: string ``` @@ -256,21 +256,21 @@ Updates a auth_configs resource. /*+ update */ UPDATE google.integrations.auth_configs SET -reason = '{{ reason }}', +description = '{{ description }}', +certificateId = '{{ certificateId }}', +name = '{{ name }}', +decryptedCredential = '{{ decryptedCredential }}', visibility = '{{ visibility }}', -displayName = '{{ displayName }}', encryptedCredential = '{{ encryptedCredential }}', -name = '{{ name }}', -description = '{{ description }}', creatorEmail = '{{ creatorEmail }}', -credentialType = '{{ credentialType }}', +lastModifierEmail = '{{ lastModifierEmail }}', +reason = '{{ reason }}', validTime = '{{ validTime }}', +credentialType = '{{ credentialType }}', state = '{{ state }}', -lastModifierEmail = '{{ lastModifierEmail }}', -overrideValidTime = '{{ overrideValidTime }}', +displayName = '{{ displayName }}', expiryNotificationDuration = '{{ expiryNotificationDuration }}', -certificateId = '{{ certificateId }}', -decryptedCredential = '{{ decryptedCredential }}' +overrideValidTime = '{{ overrideValidTime }}' WHERE authConfigsId = '{{ authConfigsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/integrations/certificates/index.md b/docs/google-docs/providers/google/integrations/certificates/index.md index a3e12e878a..c9a8ad9f0d 100644 --- a/docs/google-docs/providers/google/integrations/certificates/index.md +++ b/docs/google-docs/providers/google/integrations/certificates/index.md @@ -93,40 +93,40 @@ Use the following StackQL query and manifest file to create a new certific INSERT INTO google.integrations.certificates ( locationsId, projectsId, -requestorId, -certificateStatus, credentialId, rawCertificate, description, -displayName +requestorId, +displayName, +certificateStatus ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ requestorId }}', -'{{ certificateStatus }}', '{{ credentialId }}', '{{ rawCertificate }}', '{{ description }}', -'{{ displayName }}' +'{{ requestorId }}', +'{{ displayName }}', +'{{ certificateStatus }}' ; ``` ```yaml -name: string -validEndTime: string -requestorId: string -certificateStatus: string credentialId: string rawCertificate: passphrase: string - sslCertificate: string encryptedPrivateKey: string + sslCertificate: string +validEndTime: string validStartTime: string description: string +requestorId: string displayName: string +name: string +certificateStatus: string ``` @@ -140,12 +140,12 @@ Updates a certificates resource. /*+ update */ UPDATE google.integrations.certificates SET -requestorId = '{{ requestorId }}', -certificateStatus = '{{ certificateStatus }}', credentialId = '{{ credentialId }}', rawCertificate = '{{ rawCertificate }}', description = '{{ description }}', -displayName = '{{ displayName }}' +requestorId = '{{ requestorId }}', +displayName = '{{ displayName }}', +certificateStatus = '{{ certificateStatus }}' WHERE certificatesId = '{{ certificatesId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/integrations/cloud_functions/index.md b/docs/google-docs/providers/google/integrations/cloud_functions/index.md index 6d90481741..2685591ff7 100644 --- a/docs/google-docs/providers/google/integrations/cloud_functions/index.md +++ b/docs/google-docs/providers/google/integrations/cloud_functions/index.md @@ -56,25 +56,25 @@ Use the following StackQL query and manifest file to create a new cloud_fu INSERT INTO google.integrations.cloud_functions ( locationsId, projectsId, -projectId, +functionName, functionRegion, -functionName +projectId ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ projectId }}', +'{{ functionName }}', '{{ functionRegion }}', -'{{ functionName }}' +'{{ projectId }}' ; ``` ```yaml -projectId: string -functionRegion: string functionName: string +functionRegion: string +projectId: string ``` diff --git a/docs/google-docs/providers/google/integrations/sfdc_channels/index.md b/docs/google-docs/providers/google/integrations/sfdc_channels/index.md index b0a67cb226..fbd3b3baed 100644 --- a/docs/google-docs/providers/google/integrations/sfdc_channels/index.md +++ b/docs/google-docs/providers/google/integrations/sfdc_channels/index.md @@ -95,38 +95,38 @@ INSERT INTO google.integrations.sfdc_channels ( locationsId, projectsId, sfdcInstancesId, -name, description, +name, +isActive, displayName, lastReplayId, -channelTopic, -isActive +channelTopic ) SELECT '{{ locationsId }}', '{{ projectsId }}', '{{ sfdcInstancesId }}', -'{{ name }}', '{{ description }}', +'{{ name }}', +true|false, '{{ displayName }}', '{{ lastReplayId }}', -'{{ channelTopic }}', -true|false +'{{ channelTopic }}' ; ``` ```yaml +description: string name: string updateTime: string -description: string -deleteTime: string +isActive: boolean displayName: string -createTime: string lastReplayId: string channelTopic: string -isActive: boolean +deleteTime: string +createTime: string ``` @@ -140,12 +140,12 @@ Updates a sfdc_channels resource. /*+ update */ UPDATE google.integrations.sfdc_channels SET -name = '{{ name }}', description = '{{ description }}', +name = '{{ name }}', +isActive = true|false, displayName = '{{ displayName }}', lastReplayId = '{{ lastReplayId }}', -channelTopic = '{{ channelTopic }}', -isActive = true|false +channelTopic = '{{ channelTopic }}' WHERE locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}' diff --git a/docs/google-docs/providers/google/integrations/sfdc_instances/index.md b/docs/google-docs/providers/google/integrations/sfdc_instances/index.md index f575a3c430..ebfe424ea6 100644 --- a/docs/google-docs/providers/google/integrations/sfdc_instances/index.md +++ b/docs/google-docs/providers/google/integrations/sfdc_instances/index.md @@ -93,38 +93,38 @@ Use the following StackQL query and manifest file to create a new sfdc_ins INSERT INTO google.integrations.sfdc_instances ( locationsId, projectsId, -authConfigId, -description, +sfdcOrgId, serviceAuthority, +authConfigId, displayName, -sfdcOrgId, -name +name, +description ) SELECT '{{ locationsId }}', '{{ projectsId }}', -'{{ authConfigId }}', -'{{ description }}', +'{{ sfdcOrgId }}', '{{ serviceAuthority }}', +'{{ authConfigId }}', '{{ displayName }}', -'{{ sfdcOrgId }}', -'{{ name }}' +'{{ name }}', +'{{ description }}' ; ``` ```yaml +sfdcOrgId: string +serviceAuthority: string authConfigId: - type: string -description: string -serviceAuthority: string -displayName: string -sfdcOrgId: string deleteTime: string -name: string -createTime: string updateTime: string +displayName: string +createTime: string +name: string +description: string ``` @@ -138,12 +138,12 @@ Updates a sfdc_instances resource. /*+ update */ UPDATE google.integrations.sfdc_instances SET -authConfigId = '{{ authConfigId }}', -description = '{{ description }}', +sfdcOrgId = '{{ sfdcOrgId }}', serviceAuthority = '{{ serviceAuthority }}', +authConfigId = '{{ authConfigId }}', displayName = '{{ displayName }}', -sfdcOrgId = '{{ sfdcOrgId }}', -name = '{{ name }}' +name = '{{ name }}', +description = '{{ description }}' WHERE locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}' diff --git a/docs/google-docs/providers/google/integrations/templates/index.md b/docs/google-docs/providers/google/integrations/templates/index.md index 61005b2763..dccb336092 100644 --- a/docs/google-docs/providers/google/integrations/templates/index.md +++ b/docs/google-docs/providers/google/integrations/templates/index.md @@ -90,7 +90,616 @@ FROM google.integrations.templates WHERE locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}'; ``` -undefined + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new templates resource. + + + + +```sql +/*+ create */ +INSERT INTO google.integrations.templates ( +locationsId, +projectsId, +tags, +sharedWith, +components, +lastUsedTime, +docLink, +displayName, +description, +usageInfo, +categories, +templateBundle, +visibility, +author, +usageCount, +name +) +SELECT +'{{ locationsId }}', +'{{ projectsId }}', +'{{ tags }}', +'{{ sharedWith }}', +'{{ components }}', +'{{ lastUsedTime }}', +'{{ docLink }}', +'{{ displayName }}', +'{{ description }}', +'{{ usageInfo }}', +'{{ categories }}', +'{{ templateBundle }}', +'{{ visibility }}', +'{{ author }}', +'{{ usageCount }}', +'{{ name }}' +; +``` + + + +```yaml +tags: + - type: string +sharedWith: + - type: string +components: + - type: string + name: string +lastUsedTime: string +createTime: string +docLink: string +updateTime: string +displayName: string +description: string +usageInfo: string +categories: + - type: string + enumDescriptions: string + enum: string +templateBundle: + subIntegrationVersionTemplates: + - integrationVersion: + origin: string + userLabel: string + triggerConfigs: + - startTasks: + - displayName: string + taskId: string + taskConfigId: string + description: string + condition: string + alertConfig: + - alertThreshold: integer + thresholdType: string + durationThreshold: string + thresholdValue: + absolute: string + percentage: integer + metricType: string + aggregationPeriod: string + disableAlert: boolean + displayName: string + onlyFinalAttempt: boolean + properties: object + triggerId: string + nextTasksExecutionPolicy: string + label: string + position: + x: integer + 'y': integer + cloudSchedulerConfig: + cronTab: string + location: string + serviceAccountEmail: string + errorMessage: string + description: string + trigger: string + triggerNumber: string + errorCatcherId: string + triggerType: string + taskConfigs: + - taskTemplate: string + failurePolicy: + condition: string + intervalTime: string + maxRetries: integer + retryStrategy: string + taskId: string + nextTasksExecutionPolicy: string + description: string + conditionalFailurePolicies: + failurePolicies: + - condition: string + intervalTime: string + maxRetries: integer + retryStrategy: string + successPolicy: + finalState: string + parameters: object + taskExecutionStrategy: string + errorCatcherId: string + nextTasks: + - displayName: string + taskId: string + taskConfigId: string + description: string + condition: string + externalTaskType: string + displayName: string + jsonValidationOption: string + task: string + triggerConfigsInternal: + - nextTasksExecutionPolicy: string + position: + 'y': integer + x: integer + triggerName: string + startTasks: + - combinedConditions: + - conditions: + - value: + stringValue: string + intValue: string + stringArray: + values: + - type: string + intArray: + values: + - type: string + format: string + doubleValue: number + booleanValue: boolean + doubleArray: + values: + - type: string + format: string + protoValue: object + eventPropertyKey: string + operator: string + condition: string + taskNumber: string + taskConfigId: string + label: string + description: string + triggerNumber: string + triggerCriteria: + triggerCriteriaTaskImplementationClassName: string + parameters: + parameters: + - value: + protoArray: + protoValues: + - type: string + additionalProperties: any + doubleArray: + doubleValues: + - type: string + format: string + stringValue: string + intValue: string + doubleValue: number + booleanValue: boolean + serializedObjectValue: + objectValue: string + intArray: + intValues: + - format: string + type: string + booleanArray: + booleanValues: + - type: string + stringArray: + stringValues: + - type: string + protoValue: object + key: string + masked: boolean + condition: string + description: string + properties: object + pauseWorkflowExecutions: boolean + triggerType: string + alertConfig: + - alertName: string + durationThresholdMs: string + playbookUrl: string + warningEnumList: + filterType: string + enumStrings: + - type: string + onlyFinalAttempt: boolean + aggregationPeriod: string + metricType: string + numAggregationPeriods: integer + thresholdType: string + clientId: string + thresholdValue: + percentage: integer + absolute: string + alertDisabled: boolean + triggerId: string + enabledClients: + - type: string + errorCatcherId: string + cloudSchedulerConfig: + errorMessage: string + cronTab: string + location: string + serviceAccountEmail: string + label: string + createTime: string + createdFromTemplate: string + description: string + teardown: + teardownTaskConfigs: + - teardownTaskImplementationClassName: string + name: string + properties: + properties: + - key: string + creatorEmail: string + nextTeardownTask: + name: string + enableVariableMasking: boolean + snapshotNumber: string + parentTemplateId: string + lastModifierEmail: string + state: string + cloudLoggingDetails: + enableCloudLogging: boolean + cloudLoggingSeverity: string + updateTime: string + runAsServiceAccount: string + integrationConfigParameters: + - value: + intArray: + intValues: + - format: string + type: string + doubleArray: + doubleValues: + - format: string + type: string + intValue: string + stringArray: + stringValues: + - type: string + doubleValue: number + stringValue: string + jsonValue: string + booleanArray: + booleanValues: + - type: string + booleanValue: boolean + parameter: + description: string + inputOutputType: string + isTransient: boolean + producer: string + dataType: string + jsonSchema: string + searchable: boolean + containsLargeData: boolean + masked: boolean + key: string + displayName: string + errorCatcherConfigs: + - description: string + startErrorTasks: + - displayName: string + taskId: string + taskConfigId: string + description: string + condition: string + label: string + errorCatcherNumber: string + errorCatcherId: string + status: string + name: string + databasePersistencePolicy: string + lockHolder: string + taskConfigsInternal: + - taskNumber: string + lastModifiedTime: string + taskType: string + nextTasks: + - combinedConditions: + - conditions: + - eventPropertyKey: string + operator: string + condition: string + taskNumber: string + taskConfigId: string + label: string + description: string + disableStrictTypeValidation: boolean + taskExecutionStrategy: string + errorCatcherId: string + failurePolicy: + retryStrategy: string + retryCondition: string + maxNumRetries: integer + intervalInSeconds: string + taskEntity: + taskType: string + stats: + dimensions: + triggerId: string + taskName: string + warningEnumString: string + clientId: string + errorEnumString: string + retryAttempt: string + workflowName: string + enumFilterType: string + taskNumber: string + workflowId: string + warningRate: number + qps: number + durationInSeconds: number + errorRate: number + paramSpecs: + parameters: + - config: + helpText: string + isHidden: boolean + label: string + uiPlaceholderText: string + subSectionLabel: string + parameterNameOption: string + inputDisplayOption: string + descriptivePhrase: string + hideDefaultValue: boolean + validationRule: + doubleRange: + max: number + min: number + intRange: + min: string + max: string + stringRegex: + regex: string + exclusive: boolean + protoDef: + fullName: string + path: string + isOutput: boolean + jsonSchema: string + key: string + dataType: string + collectionElementClassName: string + required: boolean + className: string + isDeprecated: boolean + defaultValue: + stringValue: string + doubleValue: number + protoValue: object + stringArray: + stringValues: + - type: string + booleanValue: boolean + intArray: + intValues: + - type: string + format: string + jsonValue: string + serializedObjectValue: + objectValue: string + doubleArray: + doubleValues: + - format: string + type: string + booleanArray: + booleanValues: + - type: string + protoArray: + protoValues: + - type: string + additionalProperties: any + intValue: string + uiConfig: + taskUiModuleConfigs: + - moduleId: string + metadata: + activeTaskName: string + externalDocHtml: string + isDeprecated: boolean + externalDocMarkdown: string + tags: + - type: string + externalDocLink: string + admins: + - googleGroupEmail: string + userEmail: string + externalCategorySequence: integer + iconLink: string + docMarkdown: string + descriptiveName: string + system: string + standaloneExternalDocHtml: string + defaultSpec: string + name: string + g3DocLink: string + category: string + externalCategory: string + codeSearchLink: string + defaultJsonValidationOption: string + status: string + description: string + disabledForVpcSc: boolean + jsonValidationOption: string + taskName: string + externalTaskType: string + alertConfigs: + - numAggregationPeriods: integer + alertName: string + thresholdType: string + alertDisabled: boolean + playbookUrl: string + aggregationPeriod: string + clientId: string + onlyFinalAttempt: boolean + metricType: string + durationThresholdMs: string + preconditionLabel: string + label: string + parameters: object + precondition: string + createTime: string + creatorEmail: string + conditionalFailurePolicies: + failurePolicies: + - retryStrategy: string + retryCondition: string + maxNumRetries: integer + intervalInSeconds: string + description: string + incomingEdgeCount: integer + successPolicy: + finalState: string + nextTasksExecutionPolicy: string + rollbackStrategy: + rollbackTaskImplementationClassName: string + parameters: + parameters: + - key: string + dataType: string + masked: boolean + taskNumbersToRollback: + - type: string + taskTemplateName: string + taskSpec: string + integrationParametersInternal: + parameters: + - producer: string + producedBy: + elementIdentifier: string + elementType: string + containsLargeData: boolean + inOutType: string + required: boolean + key: string + dataType: string + attributes: + readOnly: boolean + dataType: string + searchable: string + isRequired: boolean + masked: boolean + isSearchable: boolean + logSettings: + seedPeriod: string + seedScope: string + logFieldName: string + taskVisibility: + - type: string + protoDefName: string + jsonSchema: string + protoDefPath: string + name: string + description: string + children: + - producer: string + containsLargeData: boolean + inOutType: string + required: boolean + key: string + dataType: string + protoDefName: string + jsonSchema: string + protoDefPath: string + name: string + description: string + children: + - producer: string + containsLargeData: boolean + inOutType: string + required: boolean + key: string + dataType: string + protoDefName: string + jsonSchema: string + protoDefPath: string + name: string + description: string + children: + - producer: string + containsLargeData: boolean + inOutType: string + required: boolean + key: string + dataType: string + protoDefName: string + jsonSchema: string + protoDefPath: string + name: string + description: string + children: + - producer: string + containsLargeData: boolean + inOutType: string + required: boolean + key: string + dataType: string + protoDefName: string + jsonSchema: string + protoDefPath: string + name: string + description: string + children: + - producer: string + containsLargeData: boolean + inOutType: string + required: boolean + key: string + dataType: string + protoDefName: string + jsonSchema: string + protoDefPath: string + name: string + description: string + children: + - {} + isTransient: boolean + isTransient: boolean + isTransient: boolean + isTransient: boolean + isTransient: boolean + isTransient: boolean + integrationParameters: + - description: string + inputOutputType: string + isTransient: boolean + producer: string + dataType: string + jsonSchema: string + searchable: boolean + containsLargeData: boolean + masked: boolean + key: string + displayName: string + key: string + integrationVersionTemplate: + key: string +visibility: string +author: string +usageCount: string +name: string + +``` + + + ## `UPDATE` example Updates a templates resource. @@ -99,20 +708,20 @@ Updates a templates resource. /*+ update */ UPDATE google.integrations.templates SET -usageInfo = '{{ usageInfo }}', -templateBundle = '{{ templateBundle }}', -docLink = '{{ docLink }}', -name = '{{ name }}', -lastUsedTime = '{{ lastUsedTime }}', -components = '{{ components }}', +tags = '{{ tags }}', sharedWith = '{{ sharedWith }}', -author = '{{ author }}', -categories = '{{ categories }}', +components = '{{ components }}', +lastUsedTime = '{{ lastUsedTime }}', +docLink = '{{ docLink }}', +displayName = '{{ displayName }}', description = '{{ description }}', +usageInfo = '{{ usageInfo }}', +categories = '{{ categories }}', +templateBundle = '{{ templateBundle }}', visibility = '{{ visibility }}', -displayName = '{{ displayName }}', -tags = '{{ tags }}', -usageCount = '{{ usageCount }}' +author = '{{ author }}', +usageCount = '{{ usageCount }}', +name = '{{ name }}' WHERE locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}' diff --git a/docs/google-docs/providers/google/integrations/versions/index.md b/docs/google-docs/providers/google/integrations/versions/index.md index f9ab6cbd4b..f2397c106d 100644 --- a/docs/google-docs/providers/google/integrations/versions/index.md +++ b/docs/google-docs/providers/google/integrations/versions/index.md @@ -119,7 +119,643 @@ WHERE integrationsId = '{{ integrationsId }}' AND locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}'; ``` -undefined + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new versions resource. + + + + +```sql +/*+ create */ +INSERT INTO google.integrations.versions ( +integrationsId, +locationsId, +projectsId, +origin, +userLabel, +triggerConfigs, +taskConfigs, +triggerConfigsInternal, +createdFromTemplate, +description, +teardown, +enableVariableMasking, +snapshotNumber, +parentTemplateId, +lastModifierEmail, +cloudLoggingDetails, +runAsServiceAccount, +integrationConfigParameters, +errorCatcherConfigs, +databasePersistencePolicy, +lockHolder, +taskConfigsInternal, +integrationParametersInternal, +integrationParameters +) +SELECT +'{{ integrationsId }}', +'{{ locationsId }}', +'{{ projectsId }}', +'{{ origin }}', +'{{ userLabel }}', +'{{ triggerConfigs }}', +'{{ taskConfigs }}', +'{{ triggerConfigsInternal }}', +'{{ createdFromTemplate }}', +'{{ description }}', +'{{ teardown }}', +true|false, +'{{ snapshotNumber }}', +'{{ parentTemplateId }}', +'{{ lastModifierEmail }}', +'{{ cloudLoggingDetails }}', +'{{ runAsServiceAccount }}', +'{{ integrationConfigParameters }}', +'{{ errorCatcherConfigs }}', +'{{ databasePersistencePolicy }}', +'{{ lockHolder }}', +'{{ taskConfigsInternal }}', +'{{ integrationParametersInternal }}', +'{{ integrationParameters }}' +; +``` + + + +```yaml +origin: string +userLabel: string +triggerConfigs: + - startTasks: + - displayName: string + taskId: string + taskConfigId: string + description: string + condition: string + alertConfig: + - alertThreshold: integer + thresholdType: string + durationThreshold: string + thresholdValue: + absolute: string + percentage: integer + metricType: string + aggregationPeriod: string + disableAlert: boolean + displayName: string + onlyFinalAttempt: boolean + properties: object + triggerId: string + nextTasksExecutionPolicy: string + label: string + position: + x: integer + 'y': integer + cloudSchedulerConfig: + cronTab: string + location: string + serviceAccountEmail: string + errorMessage: string + description: string + trigger: string + triggerNumber: string + errorCatcherId: string + triggerType: string +taskConfigs: + - taskTemplate: string + failurePolicy: + condition: string + intervalTime: string + maxRetries: integer + retryStrategy: string + taskId: string + nextTasksExecutionPolicy: string + description: string + conditionalFailurePolicies: + failurePolicies: + - condition: string + intervalTime: string + maxRetries: integer + retryStrategy: string + successPolicy: + finalState: string + parameters: object + taskExecutionStrategy: string + errorCatcherId: string + nextTasks: + - displayName: string + taskId: string + taskConfigId: string + description: string + condition: string + externalTaskType: string + displayName: string + jsonValidationOption: string + task: string +triggerConfigsInternal: + - nextTasksExecutionPolicy: string + position: + 'y': integer + x: integer + triggerName: string + startTasks: + - combinedConditions: + - conditions: + - value: + stringValue: string + intValue: string + stringArray: + values: + - type: string + intArray: + values: + - type: string + format: string + doubleValue: number + booleanValue: boolean + doubleArray: + values: + - type: string + format: string + protoValue: object + eventPropertyKey: string + operator: string + condition: string + taskNumber: string + taskConfigId: string + label: string + description: string + triggerNumber: string + triggerCriteria: + triggerCriteriaTaskImplementationClassName: string + parameters: + parameters: + - value: + protoArray: + protoValues: + - type: string + additionalProperties: any + doubleArray: + doubleValues: + - type: string + format: string + stringValue: string + intValue: string + doubleValue: number + booleanValue: boolean + serializedObjectValue: + objectValue: string + intArray: + intValues: + - format: string + type: string + booleanArray: + booleanValues: + - type: string + stringArray: + stringValues: + - type: string + protoValue: object + key: string + masked: boolean + condition: string + description: string + properties: object + pauseWorkflowExecutions: boolean + triggerType: string + alertConfig: + - alertName: string + durationThresholdMs: string + playbookUrl: string + warningEnumList: + filterType: string + enumStrings: + - type: string + onlyFinalAttempt: boolean + aggregationPeriod: string + metricType: string + numAggregationPeriods: integer + thresholdType: string + clientId: string + thresholdValue: + percentage: integer + absolute: string + alertDisabled: boolean + triggerId: string + enabledClients: + - type: string + errorCatcherId: string + cloudSchedulerConfig: + errorMessage: string + cronTab: string + location: string + serviceAccountEmail: string + label: string +createTime: string +createdFromTemplate: string +description: string +teardown: + teardownTaskConfigs: + - teardownTaskImplementationClassName: string + name: string + properties: + properties: + - key: string + creatorEmail: string + nextTeardownTask: + name: string +enableVariableMasking: boolean +snapshotNumber: string +parentTemplateId: string +lastModifierEmail: string +state: string +cloudLoggingDetails: + enableCloudLogging: boolean + cloudLoggingSeverity: string +updateTime: string +runAsServiceAccount: string +integrationConfigParameters: + - value: + intArray: + intValues: + - format: string + type: string + doubleArray: + doubleValues: + - format: string + type: string + intValue: string + stringArray: + stringValues: + - type: string + doubleValue: number + stringValue: string + jsonValue: string + booleanArray: + booleanValues: + - type: string + booleanValue: boolean + parameter: + description: string + inputOutputType: string + isTransient: boolean + producer: string + dataType: string + jsonSchema: string + searchable: boolean + containsLargeData: boolean + masked: boolean + key: string + displayName: string +errorCatcherConfigs: + - description: string + startErrorTasks: + - displayName: string + taskId: string + taskConfigId: string + description: string + condition: string + label: string + errorCatcherNumber: string + errorCatcherId: string +status: string +name: string +databasePersistencePolicy: string +lockHolder: string +taskConfigsInternal: + - taskNumber: string + lastModifiedTime: string + taskType: string + nextTasks: + - combinedConditions: + - conditions: + - eventPropertyKey: string + operator: string + condition: string + taskNumber: string + taskConfigId: string + label: string + description: string + disableStrictTypeValidation: boolean + taskExecutionStrategy: string + errorCatcherId: string + failurePolicy: + retryStrategy: string + retryCondition: string + maxNumRetries: integer + intervalInSeconds: string + taskEntity: + taskType: string + stats: + dimensions: + triggerId: string + taskName: string + warningEnumString: string + clientId: string + errorEnumString: string + retryAttempt: string + workflowName: string + enumFilterType: string + taskNumber: string + workflowId: string + warningRate: number + qps: number + durationInSeconds: number + errorRate: number + paramSpecs: + parameters: + - config: + helpText: string + isHidden: boolean + label: string + uiPlaceholderText: string + subSectionLabel: string + parameterNameOption: string + inputDisplayOption: string + descriptivePhrase: string + hideDefaultValue: boolean + validationRule: + doubleRange: + max: number + min: number + intRange: + min: string + max: string + stringRegex: + regex: string + exclusive: boolean + protoDef: + fullName: string + path: string + isOutput: boolean + jsonSchema: string + key: string + dataType: string + collectionElementClassName: string + required: boolean + className: string + isDeprecated: boolean + defaultValue: + stringValue: string + doubleValue: number + protoValue: object + stringArray: + stringValues: + - type: string + booleanValue: boolean + intArray: + intValues: + - type: string + format: string + jsonValue: string + serializedObjectValue: + objectValue: string + doubleArray: + doubleValues: + - format: string + type: string + booleanArray: + booleanValues: + - type: string + protoArray: + protoValues: + - type: string + additionalProperties: any + intValue: string + uiConfig: + taskUiModuleConfigs: + - moduleId: string + metadata: + activeTaskName: string + externalDocHtml: string + isDeprecated: boolean + externalDocMarkdown: string + tags: + - type: string + externalDocLink: string + admins: + - googleGroupEmail: string + userEmail: string + externalCategorySequence: integer + iconLink: string + docMarkdown: string + descriptiveName: string + system: string + standaloneExternalDocHtml: string + defaultSpec: string + name: string + g3DocLink: string + category: string + externalCategory: string + codeSearchLink: string + defaultJsonValidationOption: string + status: string + description: string + disabledForVpcSc: boolean + jsonValidationOption: string + taskName: string + externalTaskType: string + alertConfigs: + - numAggregationPeriods: integer + alertName: string + thresholdType: string + alertDisabled: boolean + playbookUrl: string + aggregationPeriod: string + clientId: string + onlyFinalAttempt: boolean + metricType: string + durationThresholdMs: string + preconditionLabel: string + label: string + parameters: object + precondition: string + createTime: string + creatorEmail: string + conditionalFailurePolicies: + failurePolicies: + - retryStrategy: string + retryCondition: string + maxNumRetries: integer + intervalInSeconds: string + description: string + incomingEdgeCount: integer + successPolicy: + finalState: string + nextTasksExecutionPolicy: string + rollbackStrategy: + rollbackTaskImplementationClassName: string + parameters: + parameters: + - key: string + dataType: string + masked: boolean + taskNumbersToRollback: + - type: string + taskTemplateName: string + taskSpec: string +integrationParametersInternal: + parameters: + - producer: string + producedBy: + elementIdentifier: string + elementType: string + containsLargeData: boolean + inOutType: string + required: boolean + key: string + dataType: string + attributes: + readOnly: boolean + dataType: string + searchable: string + isRequired: boolean + masked: boolean + isSearchable: boolean + logSettings: + seedPeriod: string + seedScope: string + logFieldName: string + taskVisibility: + - type: string + protoDefName: string + jsonSchema: string + protoDefPath: string + name: string + description: string + children: + - producer: string + containsLargeData: boolean + inOutType: string + required: boolean + key: string + dataType: string + protoDefName: string + jsonSchema: string + protoDefPath: string + name: string + description: string + children: + - producer: string + containsLargeData: boolean + inOutType: string + required: boolean + key: string + dataType: string + protoDefName: string + jsonSchema: string + protoDefPath: string + name: string + description: string + children: + - producer: string + containsLargeData: boolean + inOutType: string + required: boolean + key: string + dataType: string + protoDefName: string + jsonSchema: string + protoDefPath: string + name: string + description: string + children: + - producer: string + containsLargeData: boolean + inOutType: string + required: boolean + key: string + dataType: string + protoDefName: string + jsonSchema: string + protoDefPath: string + name: string + description: string + children: + - producer: string + containsLargeData: boolean + inOutType: string + required: boolean + key: string + dataType: string + protoDefName: string + jsonSchema: string + protoDefPath: string + name: string + description: string + children: + - producer: string + containsLargeData: boolean + inOutType: string + required: boolean + key: string + dataType: string + protoDefName: string + jsonSchema: string + protoDefPath: string + name: string + description: string + children: + - producer: string + containsLargeData: boolean + inOutType: string + required: boolean + key: string + dataType: string + protoDefName: string + jsonSchema: string + protoDefPath: string + name: string + description: string + children: + - producer: string + containsLargeData: boolean + inOutType: string + required: boolean + key: string + dataType: string + protoDefName: string + jsonSchema: string + protoDefPath: string + name: string + description: string + children: + - {} + isTransient: boolean + isTransient: boolean + isTransient: boolean + isTransient: boolean + isTransient: boolean + isTransient: boolean + isTransient: boolean + isTransient: boolean + isTransient: boolean +integrationParameters: + - description: string + inputOutputType: string + isTransient: boolean + producer: string + dataType: string + jsonSchema: string + searchable: boolean + containsLargeData: boolean + masked: boolean + key: string + displayName: string + +``` + + + ## `UPDATE` example Updates a versions resource. @@ -128,27 +764,27 @@ Updates a versions resource. /*+ update */ UPDATE google.integrations.versions SET -integrationParametersInternal = '{{ integrationParametersInternal }}', -runAsServiceAccount = '{{ runAsServiceAccount }}', +origin = '{{ origin }}', userLabel = '{{ userLabel }}', -cloudLoggingDetails = '{{ cloudLoggingDetails }}', -integrationParameters = '{{ integrationParameters }}', -integrationConfigParameters = '{{ integrationConfigParameters }}', -teardown = '{{ teardown }}', -taskConfigsInternal = '{{ taskConfigsInternal }}', -triggerConfigsInternal = '{{ triggerConfigsInternal }}', triggerConfigs = '{{ triggerConfigs }}', -lockHolder = '{{ lockHolder }}', -createdFromTemplate = '{{ createdFromTemplate }}', -errorCatcherConfigs = '{{ errorCatcherConfigs }}', -lastModifierEmail = '{{ lastModifierEmail }}', -enableVariableMasking = true|false, taskConfigs = '{{ taskConfigs }}', -origin = '{{ origin }}', +triggerConfigsInternal = '{{ triggerConfigsInternal }}', +createdFromTemplate = '{{ createdFromTemplate }}', description = '{{ description }}', -databasePersistencePolicy = '{{ databasePersistencePolicy }}', +teardown = '{{ teardown }}', +enableVariableMasking = true|false, +snapshotNumber = '{{ snapshotNumber }}', parentTemplateId = '{{ parentTemplateId }}', -snapshotNumber = '{{ snapshotNumber }}' +lastModifierEmail = '{{ lastModifierEmail }}', +cloudLoggingDetails = '{{ cloudLoggingDetails }}', +runAsServiceAccount = '{{ runAsServiceAccount }}', +integrationConfigParameters = '{{ integrationConfigParameters }}', +errorCatcherConfigs = '{{ errorCatcherConfigs }}', +databasePersistencePolicy = '{{ databasePersistencePolicy }}', +lockHolder = '{{ lockHolder }}', +taskConfigsInternal = '{{ taskConfigsInternal }}', +integrationParametersInternal = '{{ integrationParametersInternal }}', +integrationParameters = '{{ integrationParameters }}' WHERE integrationsId = '{{ integrationsId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/logging/buckets/index.md b/docs/google-docs/providers/google/logging/buckets/index.md index 126a2c7350..337ae07cc1 100644 --- a/docs/google-docs/providers/google/logging/buckets/index.md +++ b/docs/google-docs/providers/google/logging/buckets/index.md @@ -33,7 +33,7 @@ Creates, updates, deletes, gets or lists a buckets resource. |:-----|:---------|:------------| | | `string` | Output only. The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed. | | | `string` | Optional. Describes this bucket. | -| | `boolean` | Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled. | +| | `boolean` | Optional. Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled. | | | `object` | Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | | | `string` | Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. | | | `array` | Optional. A list of indexed fields and related configuration data. | diff --git a/docs/google-docs/providers/google/looker/instances/index.md b/docs/google-docs/providers/google/looker/instances/index.md index a706c0298b..73852f15a9 100644 --- a/docs/google-docs/providers/google/looker/instances/index.md +++ b/docs/google-docs/providers/google/looker/instances/index.md @@ -39,6 +39,8 @@ Creates, updates, deletes, gets or lists a instances resource. | | `object` | Specifies the maintenance denial period. | | | `string` | Output only. Public Egress IP (IPv4). | | | `object` | Encryption configuration (i.e. CMEK). | +| | `boolean` | Optional. Whether FIPS is enabled on the Looker instance. | +| | `boolean` | Optional. Whether Gemini feature is enabled on the Looker instance or not. | | | `string` | Output only. Private Ingress IP (IPv4). | | | `string` | Output only. Public Ingress IP (IPv4). | | | `object` | Specifies the maintenance denial period. | @@ -84,6 +86,8 @@ customDomain, denyMaintenancePeriod, egressPublicIp, encryptionConfig, +fipsEnabled, +geminiEnabled, ingressPrivateIp, ingressPublicIp, lastDenyMaintenancePeriod, @@ -140,7 +144,9 @@ customDomain, encryptionConfig, adminSettings, oauthConfig, -linkedLspProjectNumber +linkedLspProjectNumber, +fipsEnabled, +geminiEnabled ) SELECT '{{ locationsId }}', @@ -160,7 +166,9 @@ true|false, '{{ encryptionConfig }}', '{{ adminSettings }}', '{{ oauthConfig }}', -'{{ linkedLspProjectNumber }}' +'{{ linkedLspProjectNumber }}', +true|false, +true|false ; ``` @@ -223,6 +231,8 @@ oauthConfig: clientId: string clientSecret: string linkedLspProjectNumber: string +fipsEnabled: boolean +geminiEnabled: boolean ``` @@ -251,7 +261,9 @@ customDomain = '{{ customDomain }}', encryptionConfig = '{{ encryptionConfig }}', adminSettings = '{{ adminSettings }}', oauthConfig = '{{ oauthConfig }}', -linkedLspProjectNumber = '{{ linkedLspProjectNumber }}' +linkedLspProjectNumber = '{{ linkedLspProjectNumber }}', +fipsEnabled = true|false, +geminiEnabled = true|false WHERE instancesId = '{{ instancesId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/ml/studies/index.md b/docs/google-docs/providers/google/ml/studies/index.md index 80bbed2286..2b5eefd362 100644 --- a/docs/google-docs/providers/google/ml/studies/index.md +++ b/docs/google-docs/providers/google/ml/studies/index.md @@ -60,7 +60,118 @@ FROM google.ml.studies WHERE locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}'; ``` -undefined + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new studies resource. + + + + +```sql +/*+ create */ +INSERT INTO google.ml.studies ( +locationsId, +projectsId, +studyConfig +) +SELECT +'{{ locationsId }}', +'{{ projectsId }}', +'{{ studyConfig }}' +; +``` + + + +```yaml +name: string +studyConfig: + metrics: + - goal: string + metric: string + parameters: + - parameter: string + type: string + doubleValueSpec: + minValue: number + maxValue: number + integerValueSpec: + minValue: string + maxValue: string + categoricalValueSpec: + values: + - type: string + discreteValueSpec: + values: + - type: string + format: string + scaleType: string + parentDiscreteValues: + values: + - type: string + format: string + parentIntValues: + values: + - type: string + format: string + parentCategoricalValues: + values: + - type: string + childParameterSpecs: + - parameter: string + type: string + scaleType: string + childParameterSpecs: + - parameter: string + type: string + scaleType: string + childParameterSpecs: + - parameter: string + type: string + scaleType: string + childParameterSpecs: + - parameter: string + type: string + scaleType: string + childParameterSpecs: + - parameter: string + type: string + scaleType: string + childParameterSpecs: + - parameter: string + type: string + scaleType: string + childParameterSpecs: + - parameter: string + type: string + scaleType: string + childParameterSpecs: + - parameter: string + type: string + scaleType: string + childParameterSpecs: + - {} + algorithm: string + automatedStoppingConfig: + decayCurveStoppingConfig: + useElapsedTime: boolean + medianAutomatedStoppingConfig: + useElapsedTime: boolean +state: string +createTime: string +inactiveReason: string + +``` + + + ## `DELETE` example Deletes the specified studies resource. diff --git a/docs/google-docs/providers/google/oracledatabase/autonomous_database_backups/index.md b/docs/google-docs/providers/google/oracledatabase/autonomous_database_backups/index.md new file mode 100644 index 0000000000..b47d42340b --- /dev/null +++ b/docs/google-docs/providers/google/oracledatabase/autonomous_database_backups/index.md @@ -0,0 +1,59 @@ +--- +title: autonomous_database_backups +hide_title: false +hide_table_of_contents: false +keywords: + - autonomous_database_backups + - oracledatabase + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a autonomous_database_backups resource. + +## Overview + + + + +
Nameautonomous_database_backups
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Identifier. The name of the Autonomous Database Backup resource with the format: projects/{project}/locations/{region}/autonomousDatabaseBackups/{autonomous_database_backup} | +| | `string` | Required. The name of the Autonomous Database resource for which the backup is being created. Format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database} | +| | `string` | Optional. User friendly name for the Backup. The name does not have to be unique. | +| | `object` | Optional. labels or tags associated with the resource. | +| | `object` | Properties of the Autonomous Database Backup resource. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Lists the long term and automatic backups of an Autonomous Database. | + +## `SELECT` examples + +Lists the long term and automatic backups of an Autonomous Database. + +```sql +SELECT +name, +autonomousDatabase, +displayName, +labels, +properties +FROM google.oracledatabase.autonomous_database_backups +WHERE locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; +``` diff --git a/docs/google-docs/providers/google/oracledatabase/autonomous_database_character_sets/index.md b/docs/google-docs/providers/google/oracledatabase/autonomous_database_character_sets/index.md new file mode 100644 index 0000000000..283a6b04bf --- /dev/null +++ b/docs/google-docs/providers/google/oracledatabase/autonomous_database_character_sets/index.md @@ -0,0 +1,55 @@ +--- +title: autonomous_database_character_sets +hide_title: false +hide_table_of_contents: false +keywords: + - autonomous_database_character_sets + - oracledatabase + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a autonomous_database_character_sets resource. + +## Overview + + + + +
Nameautonomous_database_character_sets
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Identifier. The name of the Autonomous Database Character Set resource in the following format: projects/{project}/locations/{region}/autonomousDatabaseCharacterSets/{autonomous_database_character_set} | +| | `string` | Output only. The character set name for the Autonomous Database which is the ID in the resource name. | +| | `string` | Output only. The character set type for the Autonomous Database. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Lists Autonomous Database Character Sets in a given project and location. | + +## `SELECT` examples + +Lists Autonomous Database Character Sets in a given project and location. + +```sql +SELECT +name, +characterSet, +characterSetType +FROM google.oracledatabase.autonomous_database_character_sets +WHERE locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; +``` diff --git a/docs/google-docs/providers/google/oracledatabase/autonomous_databases/index.md b/docs/google-docs/providers/google/oracledatabase/autonomous_databases/index.md new file mode 100644 index 0000000000..e66c991a4c --- /dev/null +++ b/docs/google-docs/providers/google/oracledatabase/autonomous_databases/index.md @@ -0,0 +1,245 @@ +--- +title: autonomous_databases +hide_title: false +hide_table_of_contents: false +keywords: + - autonomous_databases + - oracledatabase + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a autonomous_databases resource. + +## Overview + + + + +
Nameautonomous_databases
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database} | +| | `string` | Optional. The password for the default ADMIN user. | +| | `string` | Required. The subnet CIDR range for the Autonmous Database. | +| | `string` | Output only. The date and time that the Autonomous Database was created. | +| | `string` | Optional. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters. | +| | `string` | Optional. The display name for the Autonomous Database. The name does not have to be unique within your project. | +| | `string` | Output only. The ID of the subscription entitlement associated with the Autonomous Database. | +| | `object` | Optional. The labels or tags associated with the Autonomous Database. | +| | `string` | Required. The name of the VPC network used by the Autonomous Database. Format: projects/{project}/global/networks/{network} | +| | `object` | The properties of an Autonomous Database. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets the details of a single Autonomous Database. | +| | `SELECT` | | Lists the Autonomous Databases in a given project and location. | +| | `INSERT` | | Creates a new Autonomous Database in a given project and location. | +| | `DELETE` | | Deletes a single Autonomous Database. | +| | `EXEC` | | Generates a wallet for a single Autonomous Database. | +| | `EXEC` | | Restores a single Autonomous Database. | + +## `SELECT` examples + +Lists the Autonomous Databases in a given project and location. + +```sql +SELECT +name, +adminPassword, +cidr, +createTime, +database, +displayName, +entitlementId, +labels, +network, +properties +FROM google.oracledatabase.autonomous_databases +WHERE locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new autonomous_databases resource. + + + + +```sql +/*+ create */ +INSERT INTO google.oracledatabase.autonomous_databases ( +locationsId, +projectsId, +name, +database, +displayName, +adminPassword, +properties, +labels, +network, +cidr +) +SELECT +'{{ locationsId }}', +'{{ projectsId }}', +'{{ name }}', +'{{ database }}', +'{{ displayName }}', +'{{ adminPassword }}', +'{{ properties }}', +'{{ labels }}', +'{{ network }}', +'{{ cidr }}' +; +``` + + + +```yaml +name: string +database: string +displayName: string +entitlementId: string +adminPassword: string +properties: + ocid: string + computeCount: number + cpuCoreCount: integer + dataStorageSizeTb: integer + dataStorageSizeGb: integer + dbWorkload: string + dbEdition: string + characterSet: string + nCharacterSet: string + privateEndpointIp: string + privateEndpointLabel: string + dbVersion: string + isAutoScalingEnabled: boolean + isStorageAutoScalingEnabled: boolean + licenseType: string + customerContacts: + - email: string + secretId: string + vaultId: string + maintenanceScheduleType: string + mtlsConnectionRequired: boolean + backupRetentionPeriodDays: integer + actualUsedDataStorageSizeTb: number + allocatedStorageSizeTb: number + apexDetails: + apexVersion: string + ordsVersion: string + arePrimaryAllowlistedIpsUsed: boolean + lifecycleDetails: string + state: string + autonomousContainerDatabaseId: string + availableUpgradeVersions: + - type: string + connectionStrings: + allConnectionStrings: + high: string + low: string + medium: string + dedicated: string + high: string + low: string + medium: string + profiles: + - consumerGroup: string + displayName: string + hostFormat: string + isRegional: boolean + protocol: string + sessionMode: string + syntaxFormat: string + tlsAuthentication: string + value: string + connectionUrls: + apexUri: string + databaseTransformsUri: string + graphStudioUri: string + machineLearningNotebookUri: string + machineLearningUserManagementUri: string + mongoDbUri: string + ordsUri: string + sqlDevWebUri: string + failedDataRecoveryDuration: string + memoryTableGbs: integer + isLocalDataGuardEnabled: boolean + localAdgAutoFailoverMaxDataLossLimit: integer + localStandbyDb: + lagTimeDuration: string + lifecycleDetails: string + state: string + dataGuardRoleChangedTime: string + disasterRecoveryRoleChangedTime: string + memoryPerOracleComputeUnitGbs: integer + localDisasterRecoveryType: string + dataSafeState: string + databaseManagementState: string + openMode: string + operationsInsightsState: string + peerDbIds: + - type: string + permissionLevel: string + privateEndpoint: string + refreshableMode: string + refreshableState: string + role: string + scheduledOperationDetails: + - dayOfWeek: string + startTime: + hours: integer + minutes: integer + seconds: integer + nanos: integer + sqlWebDeveloperUrl: string + supportedCloneRegions: + - type: string + usedDataStorageSizeTbs: integer + ociUrl: string + totalAutoBackupStorageSizeGbs: number + nextLongTermBackupTime: string + maintenanceBeginTime: string + maintenanceEndTime: string +labels: object +network: string +cidr: string +createTime: string + +``` + + + +## `DELETE` example + +Deletes the specified autonomous_databases resource. + +```sql +/*+ delete */ +DELETE FROM google.oracledatabase.autonomous_databases +WHERE autonomousDatabasesId = '{{ autonomousDatabasesId }}' +AND locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; +``` diff --git a/docs/google-docs/providers/google/oracledatabase/autonomous_db_versions/index.md b/docs/google-docs/providers/google/oracledatabase/autonomous_db_versions/index.md new file mode 100644 index 0000000000..eea891bd4d --- /dev/null +++ b/docs/google-docs/providers/google/oracledatabase/autonomous_db_versions/index.md @@ -0,0 +1,57 @@ +--- +title: autonomous_db_versions +hide_title: false +hide_table_of_contents: false +keywords: + - autonomous_db_versions + - oracledatabase + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a autonomous_db_versions resource. + +## Overview + + + + +
Nameautonomous_db_versions
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Identifier. The name of the Autonomous Database Version resource with the format: projects/{project}/locations/{region}/autonomousDbVersions/{autonomous_db_version} | +| | `string` | Output only. The Autonomous Database workload type. | +| | `string` | Output only. An Oracle Database version for Autonomous Database. | +| | `string` | Output only. A URL that points to a detailed description of the Autonomous Database version. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Lists all the available Autonomous Database versions for a project and location. | + +## `SELECT` examples + +Lists all the available Autonomous Database versions for a project and location. + +```sql +SELECT +name, +dbWorkload, +version, +workloadUri +FROM google.oracledatabase.autonomous_db_versions +WHERE locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; +``` diff --git a/docs/google-docs/providers/google/oracledatabase/cloud_exadata_infrastructures/index.md b/docs/google-docs/providers/google/oracledatabase/cloud_exadata_infrastructures/index.md new file mode 100644 index 0000000000..1508d9ad54 --- /dev/null +++ b/docs/google-docs/providers/google/oracledatabase/cloud_exadata_infrastructures/index.md @@ -0,0 +1,175 @@ +--- +title: cloud_exadata_infrastructures +hide_title: false +hide_table_of_contents: false +keywords: + - cloud_exadata_infrastructures + - oracledatabase + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a cloud_exadata_infrastructures resource. + +## Overview + + + + +
Namecloud_exadata_infrastructures
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure} | +| | `string` | Output only. The date and time that the Exadata Infrastructure was created. | +| | `string` | Optional. User friendly name for this resource. | +| | `string` | Output only. Entitlement ID of the private offer against which this infrastructure resource is provisioned. | +| | `string` | Optional. GCP location where Oracle Exadata is hosted. | +| | `object` | Optional. Labels or tags associated with the resource. | +| | `object` | Various properties of Exadata Infrastructure. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets details of a single Exadata Infrastructure. | +| | `SELECT` | | Lists Exadata Infrastructures in a given project and location. | +| | `INSERT` | | Creates a new Exadata Infrastructure in a given project and location. | +| | `DELETE` | | Deletes a single Exadata Infrastructure. | + +## `SELECT` examples + +Lists Exadata Infrastructures in a given project and location. + +```sql +SELECT +name, +createTime, +displayName, +entitlementId, +gcpOracleZone, +labels, +properties +FROM google.oracledatabase.cloud_exadata_infrastructures +WHERE locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cloud_exadata_infrastructures resource. + + + + +```sql +/*+ create */ +INSERT INTO google.oracledatabase.cloud_exadata_infrastructures ( +locationsId, +projectsId, +name, +displayName, +gcpOracleZone, +properties, +labels +) +SELECT +'{{ locationsId }}', +'{{ projectsId }}', +'{{ name }}', +'{{ displayName }}', +'{{ gcpOracleZone }}', +'{{ properties }}', +'{{ labels }}' +; +``` + + + +```yaml +name: string +displayName: string +gcpOracleZone: string +entitlementId: string +properties: + ocid: string + computeCount: integer + storageCount: integer + totalStorageSizeGb: integer + availableStorageSizeGb: integer + maintenanceWindow: + preference: string + months: + - type: string + enumDescriptions: string + enum: string + weeksOfMonth: + - type: string + format: string + daysOfWeek: + - type: string + enumDescriptions: string + enum: string + hoursOfDay: + - type: string + format: string + leadTimeWeek: integer + patchingMode: string + customActionTimeoutMins: integer + isCustomActionTimeoutEnabled: boolean + state: string + shape: string + ociUrl: string + cpuCount: integer + maxCpuCount: integer + memorySizeGb: integer + maxMemoryGb: integer + dbNodeStorageSizeGb: integer + maxDbNodeStorageSizeGb: integer + dataStorageSizeTb: number + maxDataStorageTb: number + activatedStorageCount: integer + additionalStorageCount: integer + dbServerVersion: string + storageServerVersion: string + nextMaintenanceRunId: string + nextMaintenanceRunTime: string + nextSecurityMaintenanceRunTime: string + customerContacts: + - email: string + monthlyStorageServerVersion: string + monthlyDbServerVersion: string +labels: object +createTime: string + +``` + + + +## `DELETE` example + +Deletes the specified cloud_exadata_infrastructures resource. + +```sql +/*+ delete */ +DELETE FROM google.oracledatabase.cloud_exadata_infrastructures +WHERE cloudExadataInfrastructuresId = '{{ cloudExadataInfrastructuresId }}' +AND locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; +``` diff --git a/docs/google-docs/providers/google/oracledatabase/cloud_vm_clusters/index.md b/docs/google-docs/providers/google/oracledatabase/cloud_vm_clusters/index.md new file mode 100644 index 0000000000..9759b368ce --- /dev/null +++ b/docs/google-docs/providers/google/oracledatabase/cloud_vm_clusters/index.md @@ -0,0 +1,183 @@ +--- +title: cloud_vm_clusters +hide_title: false +hide_table_of_contents: false +keywords: + - cloud_vm_clusters + - oracledatabase + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a cloud_vm_clusters resource. + +## Overview + + + + +
Namecloud_vm_clusters
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster} | +| | `string` | Required. CIDR range of the backup subnet. | +| | `string` | Required. Network settings. CIDR to use for cluster IP allocation. | +| | `string` | Output only. The date and time that the VM cluster was created. | +| | `string` | Optional. User friendly name for this resource. | +| | `string` | Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure} | +| | `string` | Output only. GCP location where Oracle Exadata is hosted. It is same as GCP Oracle zone of Exadata infrastructure. | +| | `object` | Optional. Labels or tags associated with the VM Cluster. | +| | `string` | Required. The name of the VPC network. Format: projects/{project}/global/networks/{network} | +| | `object` | Various properties and settings associated with Exadata VM cluster. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets details of a single VM Cluster. | +| | `SELECT` | | Lists the VM Clusters in a given project and location. | +| | `INSERT` | | Creates a new VM Cluster in a given project and location. | +| | `DELETE` | | Deletes a single VM Cluster. | + +## `SELECT` examples + +Lists the VM Clusters in a given project and location. + +```sql +SELECT +name, +backupSubnetCidr, +cidr, +createTime, +displayName, +exadataInfrastructure, +gcpOracleZone, +labels, +network, +properties +FROM google.oracledatabase.cloud_vm_clusters +WHERE locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; +``` + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new cloud_vm_clusters resource. + + + + +```sql +/*+ create */ +INSERT INTO google.oracledatabase.cloud_vm_clusters ( +locationsId, +projectsId, +name, +exadataInfrastructure, +displayName, +properties, +labels, +cidr, +backupSubnetCidr, +network +) +SELECT +'{{ locationsId }}', +'{{ projectsId }}', +'{{ name }}', +'{{ exadataInfrastructure }}', +'{{ displayName }}', +'{{ properties }}', +'{{ labels }}', +'{{ cidr }}', +'{{ backupSubnetCidr }}', +'{{ network }}' +; +``` + + + +```yaml +name: string +exadataInfrastructure: string +displayName: string +gcpOracleZone: string +properties: + ocid: string + licenseType: string + giVersion: string + timeZone: + id: string + version: string + sshPublicKeys: + - type: string + nodeCount: integer + shape: string + ocpuCount: number + memorySizeGb: integer + dbNodeStorageSizeGb: integer + storageSizeGb: integer + dataStorageSizeTb: number + diskRedundancy: string + sparseDiskgroupEnabled: boolean + localBackupEnabled: boolean + hostnamePrefix: string + diagnosticsDataCollectionOptions: + diagnosticsEventsEnabled: boolean + healthMonitoringEnabled: boolean + incidentLogsEnabled: boolean + state: string + scanListenerPortTcp: integer + scanListenerPortTcpSsl: integer + domain: string + scanDns: string + hostname: string + cpuCoreCount: integer + systemVersion: string + scanIpIds: + - type: string + scanDnsRecordId: string + ociUrl: string + dbServerOcids: + - type: string + compartmentId: string + dnsListenerIp: string + clusterName: string +labels: object +createTime: string +cidr: string +backupSubnetCidr: string +network: string + +``` + + + +## `DELETE` example + +Deletes the specified cloud_vm_clusters resource. + +```sql +/*+ delete */ +DELETE FROM google.oracledatabase.cloud_vm_clusters +WHERE cloudVmClustersId = '{{ cloudVmClustersId }}' +AND locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; +``` diff --git a/docs/google-docs/providers/google/oracledatabase/db_nodes/index.md b/docs/google-docs/providers/google/oracledatabase/db_nodes/index.md new file mode 100644 index 0000000000..85d0101bf6 --- /dev/null +++ b/docs/google-docs/providers/google/oracledatabase/db_nodes/index.md @@ -0,0 +1,54 @@ +--- +title: db_nodes +hide_title: false +hide_table_of_contents: false +keywords: + - db_nodes + - oracledatabase + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a db_nodes resource. + +## Overview + + + + +
Namedb_nodes
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Identifier. The name of the database node resource in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node} | +| | `object` | Various properties and settings associated with Db node. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Lists the database nodes of a VM Cluster. | + +## `SELECT` examples + +Lists the database nodes of a VM Cluster. + +```sql +SELECT +name, +properties +FROM google.oracledatabase.db_nodes +WHERE cloudVmClustersId = '{{ cloudVmClustersId }}' +AND locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; +``` diff --git a/docs/google-docs/providers/google/oracledatabase/db_servers/index.md b/docs/google-docs/providers/google/oracledatabase/db_servers/index.md new file mode 100644 index 0000000000..8854dc04e9 --- /dev/null +++ b/docs/google-docs/providers/google/oracledatabase/db_servers/index.md @@ -0,0 +1,56 @@ +--- +title: db_servers +hide_title: false +hide_table_of_contents: false +keywords: + - db_servers + - oracledatabase + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a db_servers resource. + +## Overview + + + + +
Namedb_servers
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Identifier. The name of the database server resource with the format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server} | +| | `string` | Optional. User friendly name for this resource. | +| | `object` | Various properties and settings associated with Exadata database server. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Lists the database servers of an Exadata Infrastructure instance. | + +## `SELECT` examples + +Lists the database servers of an Exadata Infrastructure instance. + +```sql +SELECT +name, +displayName, +properties +FROM google.oracledatabase.db_servers +WHERE cloudExadataInfrastructuresId = '{{ cloudExadataInfrastructuresId }}' +AND locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; +``` diff --git a/docs/google-docs/providers/google/oracledatabase/db_system_shapes/index.md b/docs/google-docs/providers/google/oracledatabase/db_system_shapes/index.md new file mode 100644 index 0000000000..0e3f01e7ff --- /dev/null +++ b/docs/google-docs/providers/google/oracledatabase/db_system_shapes/index.md @@ -0,0 +1,73 @@ +--- +title: db_system_shapes +hide_title: false +hide_table_of_contents: false +keywords: + - db_system_shapes + - oracledatabase + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a db_system_shapes resource. + +## Overview + + + + +
Namedb_system_shapes
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Identifier. The name of the Database System Shape resource with the format: projects/{project}/locations/{region}/dbSystemShapes/{db_system_shape} | +| | `integer` | Optional. Number of cores per node. | +| | `integer` | Optional. Storage per storage server in terabytes. | +| | `integer` | Optional. Memory per database server node in gigabytes. | +| | `integer` | Optional. Maximum number of database servers. | +| | `integer` | Optional. Maximum number of storage servers. | +| | `integer` | Optional. Minimum core count per node. | +| | `integer` | Optional. Minimum node storage per database server in gigabytes. | +| | `integer` | Optional. Minimum memory per node in gigabytes. | +| | `integer` | Optional. Minimum number of database servers. | +| | `integer` | Optional. Minimum number of storage servers. | +| | `string` | Optional. shape | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Lists the database system shapes available for the project and location. | + +## `SELECT` examples + +Lists the database system shapes available for the project and location. + +```sql +SELECT +name, +availableCoreCountPerNode, +availableDataStorageTb, +availableMemoryPerNodeGb, +maxNodeCount, +maxStorageCount, +minCoreCountPerNode, +minDbNodeStoragePerNodeGb, +minMemoryPerNodeGb, +minNodeCount, +minStorageCount, +shape +FROM google.oracledatabase.db_system_shapes +WHERE locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; +``` diff --git a/docs/google-docs/providers/google/oracledatabase/entitlements/index.md b/docs/google-docs/providers/google/oracledatabase/entitlements/index.md new file mode 100644 index 0000000000..3d0a615e65 --- /dev/null +++ b/docs/google-docs/providers/google/oracledatabase/entitlements/index.md @@ -0,0 +1,57 @@ +--- +title: entitlements +hide_title: false +hide_table_of_contents: false +keywords: + - entitlements + - oracledatabase + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a entitlements resource. + +## Overview + + + + +
Nameentitlements
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Identifier. The name of the Entitlement resource with the format: projects/{project}/locations/{region}/entitlements/{entitlement} | +| | `object` | Details of the OCI Cloud Account. | +| | `string` | Output only. Google Cloud Marketplace order ID (aka entitlement ID) | +| | `string` | Output only. Entitlement State. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Lists the entitlements in a given project. | + +## `SELECT` examples + +Lists the entitlements in a given project. + +```sql +SELECT +name, +cloudAccountDetails, +entitlementId, +state +FROM google.oracledatabase.entitlements +WHERE locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; +``` diff --git a/docs/google-docs/providers/google/oracledatabase/gi_versions/index.md b/docs/google-docs/providers/google/oracledatabase/gi_versions/index.md new file mode 100644 index 0000000000..2dadc9361f --- /dev/null +++ b/docs/google-docs/providers/google/oracledatabase/gi_versions/index.md @@ -0,0 +1,53 @@ +--- +title: gi_versions +hide_title: false +hide_table_of_contents: false +keywords: + - gi_versions + - oracledatabase + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a gi_versions resource. + +## Overview + + + + +
Namegi_versions
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Identifier. The name of the Oracle Grid Infrastructure (GI) version resource with the format: projects/{project}/locations/{region}/giVersions/{gi_versions} | +| | `string` | Optional. version | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location. | + +## `SELECT` examples + +Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location. + +```sql +SELECT +name, +version +FROM google.oracledatabase.gi_versions +WHERE locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; +``` diff --git a/docs/google-docs/providers/google/oracledatabase/index.md b/docs/google-docs/providers/google/oracledatabase/index.md new file mode 100644 index 0000000000..122153d368 --- /dev/null +++ b/docs/google-docs/providers/google/oracledatabase/index.md @@ -0,0 +1,48 @@ +--- +title: oracledatabase +hide_title: false +hide_table_of_contents: false +keywords: + - oracledatabase + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage google resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +The oracledatabase service documentation. + +:::info Service Summary + +
+
+total resources: 13
+
+
+ +::: + +## Resources +
+
+autonomous_database_backups
+autonomous_database_character_sets
+autonomous_databases
+autonomous_db_versions
+cloud_exadata_infrastructures
+cloud_vm_clusters
+db_nodes +
+
+db_servers
+db_system_shapes
+entitlements
+gi_versions
+locations
+operations +
+
\ No newline at end of file diff --git a/docs/google-docs/providers/google/oracledatabase/locations/index.md b/docs/google-docs/providers/google/oracledatabase/locations/index.md new file mode 100644 index 0000000000..bdcfd96e9f --- /dev/null +++ b/docs/google-docs/providers/google/oracledatabase/locations/index.md @@ -0,0 +1,59 @@ +--- +title: locations +hide_title: false +hide_table_of_contents: false +keywords: + - locations + - oracledatabase + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a locations resource. + +## Overview + + + + +
Namelocations
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| | `string` | The canonical id for this location. For example: `"us-east1"`. | +| | `object` | Service-specific metadata. For example the available capacity at the given location. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Gets information about a location. | +| | `SELECT` | | Lists information about the supported locations for this service. | + +## `SELECT` examples + +Lists information about the supported locations for this service. + +```sql +SELECT +name, +displayName, +labels, +locationId, +metadata +FROM google.oracledatabase.locations +WHERE projectsId = '{{ projectsId }}'; +``` diff --git a/docs/google-docs/providers/google/oracledatabase/operations/index.md b/docs/google-docs/providers/google/oracledatabase/operations/index.md new file mode 100644 index 0000000000..f02b595384 --- /dev/null +++ b/docs/google-docs/providers/google/oracledatabase/operations/index.md @@ -0,0 +1,74 @@ +--- +title: operations +hide_title: false +hide_table_of_contents: false +keywords: + - operations + - oracledatabase + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage Google Cloud Platform (GCP) infrastructure and resources using SQL +custom_edit_url: null +image: /img/providers/google/stackql-google-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a operations resource. + +## Overview + + + + +
Nameoperations
TypeResource
Id
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| | `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}`. | +| | `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. | +| | `object` | 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). | +| | `object` | 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. | +| | `object` | 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`. | + +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| | `SELECT` | | 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. | +| | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| | `DELETE` | | 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`. | +| | `EXEC` | | 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`. | + +## `SELECT` examples + +Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + +```sql +SELECT +name, +done, +error, +metadata, +response +FROM google.oracledatabase.operations +WHERE locationsId = '{{ locationsId }}' +AND projectsId = '{{ projectsId }}'; +``` + +## `DELETE` example + +Deletes the specified operations resource. + +```sql +/*+ delete */ +DELETE FROM google.oracledatabase.operations +WHERE locationsId = '{{ locationsId }}' +AND operationsId = '{{ operationsId }}' +AND projectsId = '{{ projectsId }}'; +``` diff --git a/docs/google-docs/providers/google/orgpolicy/custom_constraints/index.md b/docs/google-docs/providers/google/orgpolicy/custom_constraints/index.md index e6bdab67e0..9547898c1f 100644 --- a/docs/google-docs/providers/google/orgpolicy/custom_constraints/index.md +++ b/docs/google-docs/providers/google/orgpolicy/custom_constraints/index.md @@ -84,41 +84,41 @@ Use the following StackQL query and manifest file to create a new custom_c /*+ create */ INSERT INTO google.orgpolicy.custom_constraints ( organizationsId, -name, -methodTypes, description, -resourceTypes, +condition, displayName, actionType, -condition +name, +resourceTypes, +methodTypes ) SELECT '{{ organizationsId }}', -'{{ name }}', -'{{ methodTypes }}', '{{ description }}', -'{{ resourceTypes }}', +'{{ condition }}', '{{ displayName }}', '{{ actionType }}', -'{{ condition }}' +'{{ name }}', +'{{ resourceTypes }}', +'{{ methodTypes }}' ; ``` ```yaml +description: string +condition: string +displayName: string +actionType: string name: string +resourceTypes: + - type: string +updateTime: string methodTypes: - enum: string type: string enumDescriptions: string -description: string -resourceTypes: - - type: string -displayName: string -updateTime: string -actionType: string -condition: string ``` @@ -132,13 +132,13 @@ Updates a custom_constraints resource. /*+ update */ UPDATE google.orgpolicy.custom_constraints SET -name = '{{ name }}', -methodTypes = '{{ methodTypes }}', description = '{{ description }}', -resourceTypes = '{{ resourceTypes }}', +condition = '{{ condition }}', displayName = '{{ displayName }}', actionType = '{{ actionType }}', -condition = '{{ condition }}' +name = '{{ name }}', +resourceTypes = '{{ resourceTypes }}', +methodTypes = '{{ methodTypes }}' WHERE customConstraintsId = '{{ customConstraintsId }}' AND organizationsId = '{{ organizationsId }}'; diff --git a/docs/google-docs/providers/google/orgpolicy/policies/index.md b/docs/google-docs/providers/google/orgpolicy/policies/index.md index cdc8994be6..a5daa46781 100644 --- a/docs/google-docs/providers/google/orgpolicy/policies/index.md +++ b/docs/google-docs/providers/google/orgpolicy/policies/index.md @@ -89,16 +89,16 @@ Use the following StackQL query and manifest file to create a new policies INSERT INTO google.orgpolicy.policies ( foldersId, dryRunSpec, -etag, name, +etag, spec, alternate ) SELECT '{{ foldersId }}', '{{ dryRunSpec }}', -'{{ etag }}', '{{ name }}', +'{{ etag }}', '{{ spec }}', '{{ alternate }}' ; @@ -108,26 +108,26 @@ SELECT ```yaml dryRunSpec: - inheritFromParent: boolean - etag: string reset: boolean + inheritFromParent: boolean updateTime: string + etag: string rules: - - enforce: boolean + - values: + allowedValues: + - type: string + deniedValues: + - type: string condition: - location: string - title: string description: string + location: string expression: string - denyAll: boolean - values: - deniedValues: - - type: string - allowedValues: - - type: string + title: string allowAll: boolean -etag: string + enforce: boolean + denyAll: boolean name: string +etag: string alternate: launch: string @@ -144,8 +144,8 @@ Updates a policies resource. UPDATE google.orgpolicy.policies SET dryRunSpec = '{{ dryRunSpec }}', -etag = '{{ etag }}', name = '{{ name }}', +etag = '{{ etag }}', spec = '{{ spec }}', alternate = '{{ alternate }}' WHERE diff --git a/docs/google-docs/providers/google/policyanalyzer/activities/index.md b/docs/google-docs/providers/google/policyanalyzer/activities/index.md index bf7b02dc20..6478921623 100644 --- a/docs/google-docs/providers/google/policyanalyzer/activities/index.md +++ b/docs/google-docs/providers/google/policyanalyzer/activities/index.md @@ -37,7 +37,7 @@ Creates, updates, deletes, gets or lists a activities resource. ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Queries policy activities on Google Cloud resources. | +| | `SELECT` | | Queries policy activities on Google Cloud resources. | ## `SELECT` examples @@ -50,5 +50,5 @@ nextPageToken FROM google.policyanalyzer.activities WHERE activityTypesId = '{{ activityTypesId }}' AND locationsId = '{{ locationsId }}' -AND projectsId = '{{ projectsId }}'; +AND organizationsId = '{{ organizationsId }}'; ``` diff --git a/docs/google-docs/providers/google/policysimulator/replays/index.md b/docs/google-docs/providers/google/policysimulator/replays/index.md index 8aca5552e6..6c5e7f83fb 100644 --- a/docs/google-docs/providers/google/policysimulator/replays/index.md +++ b/docs/google-docs/providers/google/policysimulator/replays/index.md @@ -93,19 +93,19 @@ SELECT ```yaml name: string +state: string config: policyOverlay: object logSource: string -state: string resultsSummary: + errorCount: integer unchangedCount: integer - newestDate: - day: integer - year: integer + logCount: integer + oldestDate: month: integer + year: integer + day: integer differenceCount: integer - logCount: integer - errorCount: integer ``` diff --git a/docs/google-docs/providers/google/prod_tt_sasportal/customer_nodes/index.md b/docs/google-docs/providers/google/prod_tt_sasportal/customer_nodes/index.md index cd887f3e60..f33bc584b8 100644 --- a/docs/google-docs/providers/google/prod_tt_sasportal/customer_nodes/index.md +++ b/docs/google-docs/providers/google/prod_tt_sasportal/customer_nodes/index.md @@ -74,14 +74,14 @@ Use the following StackQL query and manifest file to create a new customer /*+ create */ INSERT INTO google.prod_tt_sasportal.customer_nodes ( customersId, -name, sasUserIds, +name, displayName ) SELECT '{{ customersId }}', -'{{ name }}', '{{ sasUserIds }}', +'{{ name }}', '{{ displayName }}' ; ``` @@ -89,9 +89,9 @@ SELECT ```yaml -name: string sasUserIds: - type: string +name: string displayName: string ``` diff --git a/docs/google-docs/providers/google/prod_tt_sasportal/deployments/index.md b/docs/google-docs/providers/google/prod_tt_sasportal/deployments/index.md index ca01e599bc..9c01db05c0 100644 --- a/docs/google-docs/providers/google/prod_tt_sasportal/deployments/index.md +++ b/docs/google-docs/providers/google/prod_tt_sasportal/deployments/index.md @@ -87,25 +87,25 @@ Use the following StackQL query and manifest file to create a new deployme /*+ create */ INSERT INTO google.prod_tt_sasportal.deployments ( customersId, -sasUserIds, -displayName +displayName, +sasUserIds ) SELECT '{{ customersId }}', -'{{ sasUserIds }}', -'{{ displayName }}' +'{{ displayName }}', +'{{ sasUserIds }}' ; ``` ```yaml -sasUserIds: - - type: string displayName: string +name: string frns: - type: string -name: string +sasUserIds: + - type: string ``` @@ -119,8 +119,8 @@ Updates a deployments resource. /*+ update */ UPDATE google.prod_tt_sasportal.deployments SET -sasUserIds = '{{ sasUserIds }}', -displayName = '{{ displayName }}' +displayName = '{{ displayName }}', +sasUserIds = '{{ sasUserIds }}' WHERE deploymentsId = '{{ deploymentsId }}' AND nodesId = '{{ nodesId }}'; diff --git a/docs/google-docs/providers/google/prod_tt_sasportal/devices/index.md b/docs/google-docs/providers/google/prod_tt_sasportal/devices/index.md index b1ed421b58..53f118ec72 100644 --- a/docs/google-docs/providers/google/prod_tt_sasportal/devices/index.md +++ b/docs/google-docs/providers/google/prod_tt_sasportal/devices/index.md @@ -112,105 +112,105 @@ Use the following StackQL query and manifest file to create a new devices< /*+ create */ INSERT INTO google.prod_tt_sasportal.devices ( nodesId, -displayName, activeConfig, +displayName, deviceMetadata, -preloadedConfig, -state, name, +serialNumber, fccId, +grantRangeAllowlists, +state, grants, -serialNumber, -grantRangeAllowlists +preloadedConfig ) SELECT '{{ nodesId }}', -'{{ displayName }}', '{{ activeConfig }}', +'{{ displayName }}', '{{ deviceMetadata }}', -'{{ preloadedConfig }}', -'{{ state }}', '{{ name }}', +'{{ serialNumber }}', '{{ fccId }}', +'{{ grantRangeAllowlists }}', +'{{ state }}', '{{ grants }}', -'{{ serialNumber }}', -'{{ grantRangeAllowlists }}' +'{{ preloadedConfig }}' ; ``` ```yaml -displayName: string -currentChannels: - - score: number - frequencyRange: - highFrequencyMhz: number - lowFrequencyMhz: number activeConfig: + model: + firmwareVersion: string + softwareVersion: string + name: string + vendor: string + hardwareVersion: string + userId: string + measurementCapabilities: + - enum: string + type: string + enumDescriptions: string + airInterface: + supportedSpec: string + radioTechnology: string + isSigned: boolean state: string + category: string + callSign: string + updateTime: string installationParams: - verticalAccuracy: number + heightType: string + longitude: number antennaAzimuth: integer - antennaModel: string horizontalAccuracy: number - height: number - latitude: number indoorDeployment: boolean - longitude: number - heightType: string - cpeCbsdIndication: boolean - antennaDowntilt: integer eirpCapability: integer antennaGain: number + antennaModel: string + height: number + cpeCbsdIndication: boolean antennaBeamwidth: integer - updateTime: string - model: - name: string - hardwareVersion: string - vendor: string - firmwareVersion: string - softwareVersion: string - isSigned: boolean - airInterface: - radioTechnology: string - supportedSpec: string - measurementCapabilities: - - type: string - enum: string - enumDescriptions: string - userId: string - callSign: string - category: string + verticalAccuracy: number + antennaDowntilt: integer + latitude: number +displayName: string +currentChannels: + - frequencyRange: + lowFrequencyMhz: number + highFrequencyMhz: number + score: number deviceMetadata: - antennaModel: string + interferenceCoordinationGroup: string nrqzValidation: - state: string latitude: number + state: string + cpiId: string caseId: string longitude: number - cpiId: string commonChannelGroup: string - interferenceCoordinationGroup: string nrqzValidated: boolean -state: string + antennaModel: string name: string +serialNumber: string fccId: string +grantRangeAllowlists: + - lowFrequencyMhz: number + highFrequencyMhz: number +state: string grants: - - grantId: string + - channelType: string + maxEirp: number + expireTime: string lastHeartbeatTransmitExpireTime: string - suspensionReason: - - type: string - channelType: string state: string - expireTime: string - maxEirp: number + grantId: string moveList: - dpaId: string -serialNumber: string -grantRangeAllowlists: - - highFrequencyMhz: number - lowFrequencyMhz: number + suspensionReason: + - type: string ``` @@ -224,16 +224,16 @@ Updates a devices resource. /*+ update */ UPDATE google.prod_tt_sasportal.devices SET -displayName = '{{ displayName }}', activeConfig = '{{ activeConfig }}', +displayName = '{{ displayName }}', deviceMetadata = '{{ deviceMetadata }}', -preloadedConfig = '{{ preloadedConfig }}', -state = '{{ state }}', name = '{{ name }}', +serialNumber = '{{ serialNumber }}', fccId = '{{ fccId }}', +grantRangeAllowlists = '{{ grantRangeAllowlists }}', +state = '{{ state }}', grants = '{{ grants }}', -serialNumber = '{{ serialNumber }}', -grantRangeAllowlists = '{{ grantRangeAllowlists }}' +preloadedConfig = '{{ preloadedConfig }}' WHERE devicesId = '{{ devicesId }}' AND nodesId = '{{ nodesId }}'; diff --git a/docs/google-docs/providers/google/prod_tt_sasportal/devices_signed/index.md b/docs/google-docs/providers/google/prod_tt_sasportal/devices_signed/index.md index 93d10be838..a2951bd4f9 100644 --- a/docs/google-docs/providers/google/prod_tt_sasportal/devices_signed/index.md +++ b/docs/google-docs/providers/google/prod_tt_sasportal/devices_signed/index.md @@ -90,8 +90,8 @@ Updates a devices_signed resource. /*+ update */ UPDATE google.prod_tt_sasportal.devices_signed SET -encodedDevice = '{{ encodedDevice }}', -installerId = '{{ installerId }}' +installerId = '{{ installerId }}', +encodedDevice = '{{ encodedDevice }}' WHERE devicesId = '{{ devicesId }}' AND nodesId = '{{ nodesId }}'; diff --git a/docs/google-docs/providers/google/prod_tt_sasportal/nodes/index.md b/docs/google-docs/providers/google/prod_tt_sasportal/nodes/index.md index f494072329..df3e6570fc 100644 --- a/docs/google-docs/providers/google/prod_tt_sasportal/nodes/index.md +++ b/docs/google-docs/providers/google/prod_tt_sasportal/nodes/index.md @@ -78,14 +78,14 @@ Use the following StackQL query and manifest file to create a new nodes ```yaml -name: string sasUserIds: - type: string +name: string displayName: string ``` @@ -110,8 +110,8 @@ Updates a nodes resource. /*+ update */ UPDATE google.prod_tt_sasportal.nodes SET -name = '{{ name }}', sasUserIds = '{{ sasUserIds }}', +name = '{{ name }}', displayName = '{{ displayName }}' WHERE nodesId = '{{ nodesId }}' diff --git a/docs/google-docs/providers/google/recaptchaenterprise/assessments/index.md b/docs/google-docs/providers/google/recaptchaenterprise/assessments/index.md index fe8e58662e..6f417ef341 100644 --- a/docs/google-docs/providers/google/recaptchaenterprise/assessments/index.md +++ b/docs/google-docs/providers/google/recaptchaenterprise/assessments/index.md @@ -55,16 +55,16 @@ Use the following StackQL query and manifest file to create a new assessme /*+ create */ INSERT INTO google.recaptchaenterprise.assessments ( projectsId, +assessmentEnvironment, accountVerification, event, -assessmentEnvironment, privatePasswordLeakVerification ) SELECT '{{ projectsId }}', +'{{ assessmentEnvironment }}', '{{ accountVerification }}', '{{ event }}', -'{{ assessmentEnvironment }}', '{{ privatePasswordLeakVerification }}' ; ``` @@ -72,155 +72,155 @@ SELECT ```yaml +phoneFraudAssessment: + smsTollFraudVerdict: + reasons: + - enum: string + enumDescriptions: string + type: string + risk: number +name: string +assessmentEnvironment: + version: string + client: string accountVerification: - username: string + latestVerificationResult: string languageCode: string endpoints: - - phoneNumber: string - emailAddress: string - lastVerificationTime: string + - emailAddress: string requestToken: string - latestVerificationResult: string + phoneNumber: string + lastVerificationTime: string + username: string +tokenProperties: + hostname: string + valid: boolean + invalidReason: string + androidPackageName: string + createTime: string + action: string + iosBundleId: string event: - ja3: string - expectedAction: string - hashedAccountId: string + userIpAddress: string fraudPrevention: string wafTokenAssessment: boolean - express: boolean - firewallPolicyEvaluation: boolean + requestedUri: string userAgent: string + expectedAction: string + token: string + hashedAccountId: string + firewallPolicyEvaluation: boolean + express: boolean + headers: + - type: string + ja3: string + siteKey: string transactionData: - value: number - currencyCode: string - merchants: - - emailVerified: boolean - phoneNumber: string - email: string - creationMs: string - accountId: string - phoneVerified: boolean - transactionId: string - cardBin: string billingAddress: + recipient: string address: - type: string - administrativeArea: string - recipient: string postalCode: string - locality: string regionCode: string + administrativeArea: string + locality: string user: - emailVerified: boolean phoneNumber: string + emailVerified: boolean email: string - creationMs: string accountId: string + creationMs: string phoneVerified: boolean paymentMethod: string - cardLastFour: string + cardBin: string items: - - name: string - merchantAccountId: string + - value: number quantity: string - value: number - shippingValue: number + merchantAccountId: string + name: string + currencyCode: string gatewayInfo: - name: string - cvvResponseCode: string avsResponseCode: string + name: string gatewayResponseCode: string + cvvResponseCode: string + transactionId: string + shippingValue: number + cardLastFour: string + value: number + merchants: + - phoneNumber: string + emailVerified: boolean + email: string + accountId: string + creationMs: string + phoneVerified: boolean userInfo: userIds: - email: string username: string phoneNumber: string - accountId: string createAccountTime: string - userIpAddress: string - siteKey: string - token: string - headers: - - type: string - requestedUri: string -fraudSignals: - cardSignals: - cardLabels: - - type: string - enum: string - enumDescriptions: string - userSignals: - activeDaysLowerBound: integer - syntheticRisk: number -fraudPreventionAssessment: - behavioralTrustVerdict: - trust: number - stolenInstrumentVerdict: - risk: number - transactionRisk: number - cardTestingVerdict: - risk: number -assessmentEnvironment: - version: string - client: string -privatePasswordLeakVerification: - encryptedLeakMatchPrefixes: - - type: string - format: string - lookupHashPrefix: string - reencryptedUserCredentialsHash: string - encryptedUserCredentialsHash: string -accountDefenderAssessment: - labels: - - type: string - enumDescriptions: string - enum: string + accountId: string firewallPolicyAssessment: error: + message: string + code: integer details: - additionalProperties: any type: string - code: integer - message: string firewallPolicy: - name: string - condition: string description: string actions: - - redirect: {} - allow: {} + - allow: {} substitute: path: string - includeRecaptchaScript: {} - block: {} setHeader: value: string key: string + includeRecaptchaScript: {} + block: {} + redirect: {} path: string -tokenProperties: - invalidReason: string - hostname: string - createTime: string - valid: boolean - iosBundleId: string - androidPackageName: string - action: string -phoneFraudAssessment: - smsTollFraudVerdict: - reasons: + condition: string + name: string +privatePasswordLeakVerification: + encryptedLeakMatchPrefixes: + - type: string + format: string + reencryptedUserCredentialsHash: string + lookupHashPrefix: string + encryptedUserCredentialsHash: string +fraudSignals: + cardSignals: + cardLabels: - type: string - enumDescriptions: string enum: string - risk: number + enumDescriptions: string + userSignals: + activeDaysLowerBound: integer + syntheticRisk: number riskAnalysis: - score: number - extendedVerdictReasons: - - type: string reasons: + - enum: string + enumDescriptions: string + type: string + extendedVerdictReasons: - type: string + score: number +accountDefenderAssessment: + labels: + - enumDescriptions: string + type: string enum: string - enumDescriptions: string -name: string +fraudPreventionAssessment: + stolenInstrumentVerdict: + risk: number + transactionRisk: number + cardTestingVerdict: + risk: number + behavioralTrustVerdict: + trust: number ``` diff --git a/docs/google-docs/providers/google/recaptchaenterprise/firewallpolicies/index.md b/docs/google-docs/providers/google/recaptchaenterprise/firewallpolicies/index.md index add6bcae14..afee172770 100644 --- a/docs/google-docs/providers/google/recaptchaenterprise/firewallpolicies/index.md +++ b/docs/google-docs/providers/google/recaptchaenterprise/firewallpolicies/index.md @@ -79,39 +79,39 @@ Use the following StackQL query and manifest file to create a new firewall /*+ create */ INSERT INTO google.recaptchaenterprise.firewallpolicies ( projectsId, -name, -condition, description, actions, -path +path, +condition, +name ) SELECT '{{ projectsId }}', -'{{ name }}', -'{{ condition }}', '{{ description }}', '{{ actions }}', -'{{ path }}' +'{{ path }}', +'{{ condition }}', +'{{ name }}' ; ``` ```yaml -name: string -condition: string description: string actions: - - redirect: {} - allow: {} + - allow: {} substitute: path: string - includeRecaptchaScript: {} - block: {} setHeader: value: string key: string + includeRecaptchaScript: {} + block: {} + redirect: {} path: string +condition: string +name: string ``` @@ -125,11 +125,11 @@ Updates a firewallpolicies resource. /*+ update */ UPDATE google.recaptchaenterprise.firewallpolicies SET -name = '{{ name }}', -condition = '{{ condition }}', description = '{{ description }}', actions = '{{ actions }}', -path = '{{ path }}' +path = '{{ path }}', +condition = '{{ condition }}', +name = '{{ name }}' WHERE firewallpoliciesId = '{{ firewallpoliciesId }}' AND projectsId = '{{ projectsId }}'; diff --git a/docs/google-docs/providers/google/recaptchaenterprise/keys/index.md b/docs/google-docs/providers/google/recaptchaenterprise/keys/index.md index 50a0dbd1db..84fc69b9ee 100644 --- a/docs/google-docs/providers/google/recaptchaenterprise/keys/index.md +++ b/docs/google-docs/providers/google/recaptchaenterprise/keys/index.md @@ -89,64 +89,64 @@ Use the following StackQL query and manifest file to create a new keys ```yaml -displayName: string +wafSettings: + wafFeature: string + wafService: string name: string +iosSettings: + appleDeveloperId: + keyId: string + teamId: string + privateKey: string + allowedBundleIds: + - type: string + allowAllBundleIds: boolean +createTime: string +testingOptions: + testingChallenge: string + testingScore: number webSettings: challengeSecurityPreference: string + allowedDomains: + - type: string allowAllDomains: boolean allowAmpTraffic: boolean integrationType: string - allowedDomains: - - type: string -wafSettings: - wafFeature: string - wafService: string -testingOptions: - testingScore: number - testingChallenge: string -labels: object androidSettings: supportNonGoogleAppStoreDistribution: boolean allowedPackageNames: - type: string allowAllPackageNames: boolean +labels: object +displayName: string expressSettings: {} -iosSettings: - allowedBundleIds: - - type: string - allowAllBundleIds: boolean - appleDeveloperId: - keyId: string - privateKey: string - teamId: string -createTime: string ``` @@ -160,15 +160,15 @@ Updates a keys resource. /*+ update */ UPDATE google.recaptchaenterprise.keys SET -displayName = '{{ displayName }}', -name = '{{ name }}', -webSettings = '{{ webSettings }}', wafSettings = '{{ wafSettings }}', +name = '{{ name }}', +iosSettings = '{{ iosSettings }}', testingOptions = '{{ testingOptions }}', -labels = '{{ labels }}', +webSettings = '{{ webSettings }}', androidSettings = '{{ androidSettings }}', -expressSettings = '{{ expressSettings }}', -iosSettings = '{{ iosSettings }}' +labels = '{{ labels }}', +displayName = '{{ displayName }}', +expressSettings = '{{ expressSettings }}' WHERE keysId = '{{ keysId }}' AND projectsId = '{{ projectsId }}'; diff --git a/docs/google-docs/providers/google/recaptchaenterprise/keys_ip_override/index.md b/docs/google-docs/providers/google/recaptchaenterprise/keys_ip_override/index.md index d3b84bb554..d88ebe803f 100644 --- a/docs/google-docs/providers/google/recaptchaenterprise/keys_ip_override/index.md +++ b/docs/google-docs/providers/google/recaptchaenterprise/keys_ip_override/index.md @@ -69,8 +69,8 @@ SELECT ```yaml ipOverrideData: - ip: string overrideType: string + ip: string ``` diff --git a/docs/google-docs/providers/google/recommender/insight_types_config/index.md b/docs/google-docs/providers/google/recommender/insight_types_config/index.md index b999101f31..000c54ca40 100644 --- a/docs/google-docs/providers/google/recommender/insight_types_config/index.md +++ b/docs/google-docs/providers/google/recommender/insight_types_config/index.md @@ -76,11 +76,11 @@ Updates a insight_types_config resource. /*+ update */ UPDATE google.recommender.insight_types_config SET -name = '{{ name }}', annotations = '{{ annotations }}', -etag = '{{ etag }}', displayName = '{{ displayName }}', -insightTypeGenerationConfig = '{{ insightTypeGenerationConfig }}' +etag = '{{ etag }}', +insightTypeGenerationConfig = '{{ insightTypeGenerationConfig }}', +name = '{{ name }}' WHERE insightTypesId = '{{ insightTypesId }}' AND locationsId = '{{ locationsId }}' diff --git a/docs/google-docs/providers/google/recommender/recommenders_config/index.md b/docs/google-docs/providers/google/recommender/recommenders_config/index.md index c4f22c719d..e2a31a236c 100644 --- a/docs/google-docs/providers/google/recommender/recommenders_config/index.md +++ b/docs/google-docs/providers/google/recommender/recommenders_config/index.md @@ -76,11 +76,11 @@ Updates a recommenders_config resource. /*+ update */ UPDATE google.recommender.recommenders_config SET +displayName = '{{ displayName }}', name = '{{ name }}', -annotations = '{{ annotations }}', +etag = '{{ etag }}', recommenderGenerationConfig = '{{ recommenderGenerationConfig }}', -displayName = '{{ displayName }}', -etag = '{{ etag }}' +annotations = '{{ annotations }}' WHERE locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}' diff --git a/docs/google-docs/providers/google/retail/products/index.md b/docs/google-docs/providers/google/retail/products/index.md index 58953bb447..cb15b29039 100644 --- a/docs/google-docs/providers/google/retail/products/index.md +++ b/docs/google-docs/providers/google/retail/products/index.md @@ -124,7 +124,668 @@ AND catalogsId = '{{ catalogsId }}' AND locationsId = '{{ locationsId }}' AND projectsId = '{{ projectsId }}'; ``` -undefined + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new products resource. + + + + +```sql +/*+ create */ +INSERT INTO google.retail.products ( +branchesId, +catalogsId, +locationsId, +projectsId, +expireTime, +ttl, +name, +type, +primaryProductId, +collectionMemberIds, +gtin, +categories, +title, +brands, +description, +languageCode, +attributes, +tags, +priceInfo, +rating, +availableTime, +availability, +availableQuantity, +fulfillmentInfo, +uri, +images, +audience, +colorInfo, +sizes, +materials, +patterns, +conditions, +promotions, +publishTime, +retrievableFields +) +SELECT +'{{ branchesId }}', +'{{ catalogsId }}', +'{{ locationsId }}', +'{{ projectsId }}', +'{{ expireTime }}', +'{{ ttl }}', +'{{ name }}', +'{{ type }}', +'{{ primaryProductId }}', +'{{ collectionMemberIds }}', +'{{ gtin }}', +'{{ categories }}', +'{{ title }}', +'{{ brands }}', +'{{ description }}', +'{{ languageCode }}', +'{{ attributes }}', +'{{ tags }}', +'{{ priceInfo }}', +'{{ rating }}', +'{{ availableTime }}', +'{{ availability }}', +'{{ availableQuantity }}', +'{{ fulfillmentInfo }}', +'{{ uri }}', +'{{ images }}', +'{{ audience }}', +'{{ colorInfo }}', +'{{ sizes }}', +'{{ materials }}', +'{{ patterns }}', +'{{ conditions }}', +'{{ promotions }}', +'{{ publishTime }}', +'{{ retrievableFields }}' +; +``` + + + +```yaml +expireTime: string +ttl: string +name: string +id: string +type: string +primaryProductId: string +collectionMemberIds: + - type: string +gtin: string +categories: + - type: string +title: string +brands: + - type: string +description: string +languageCode: string +attributes: object +tags: + - type: string +priceInfo: + currencyCode: string + price: number + originalPrice: number + cost: number + priceEffectiveTime: string + priceExpireTime: string + priceRange: + price: + minimum: number + exclusiveMinimum: number + maximum: number + exclusiveMaximum: number +rating: + ratingCount: integer + averageRating: number + ratingHistogram: + - type: string + format: string +availableTime: string +availability: string +availableQuantity: integer +fulfillmentInfo: + - type: string + placeIds: + - type: string +uri: string +images: + - uri: string + height: integer + width: integer +audience: + genders: + - type: string + ageGroups: + - type: string +colorInfo: + colorFamilies: + - type: string + colors: + - type: string +sizes: + - type: string +materials: + - type: string +patterns: + - type: string +conditions: + - type: string +promotions: + - promotionId: string +publishTime: string +retrievableFields: string +variants: + - expireTime: string + ttl: string + name: string + id: string + type: string + primaryProductId: string + collectionMemberIds: + - type: string + gtin: string + categories: + - type: string + title: string + brands: + - type: string + description: string + languageCode: string + attributes: object + tags: + - type: string + availableTime: string + availability: string + availableQuantity: integer + fulfillmentInfo: + - type: string + placeIds: + - type: string + uri: string + images: + - uri: string + height: integer + width: integer + sizes: + - type: string + materials: + - type: string + patterns: + - type: string + conditions: + - type: string + promotions: + - promotionId: string + publishTime: string + retrievableFields: string + variants: + - expireTime: string + ttl: string + name: string + id: string + type: string + primaryProductId: string + collectionMemberIds: + - type: string + gtin: string + categories: + - type: string + title: string + brands: + - type: string + description: string + languageCode: string + attributes: object + tags: + - type: string + availableTime: string + availability: string + availableQuantity: integer + fulfillmentInfo: + - type: string + placeIds: + - type: string + uri: string + images: + - uri: string + height: integer + width: integer + sizes: + - type: string + materials: + - type: string + patterns: + - type: string + conditions: + - type: string + promotions: + - promotionId: string + publishTime: string + retrievableFields: string + variants: + - expireTime: string + ttl: string + name: string + id: string + type: string + primaryProductId: string + collectionMemberIds: + - type: string + gtin: string + categories: + - type: string + title: string + brands: + - type: string + description: string + languageCode: string + attributes: object + tags: + - type: string + availableTime: string + availability: string + availableQuantity: integer + fulfillmentInfo: + - type: string + placeIds: + - type: string + uri: string + images: + - uri: string + height: integer + width: integer + sizes: + - type: string + materials: + - type: string + patterns: + - type: string + conditions: + - type: string + promotions: + - promotionId: string + publishTime: string + retrievableFields: string + variants: + - expireTime: string + ttl: string + name: string + id: string + type: string + primaryProductId: string + collectionMemberIds: + - type: string + gtin: string + categories: + - type: string + title: string + brands: + - type: string + description: string + languageCode: string + attributes: object + tags: + - type: string + availableTime: string + availability: string + availableQuantity: integer + fulfillmentInfo: + - type: string + placeIds: + - type: string + uri: string + images: + - uri: string + height: integer + width: integer + sizes: + - type: string + materials: + - type: string + patterns: + - type: string + conditions: + - type: string + promotions: + - promotionId: string + publishTime: string + retrievableFields: string + variants: + - expireTime: string + ttl: string + name: string + id: string + type: string + primaryProductId: string + collectionMemberIds: + - type: string + gtin: string + categories: + - type: string + title: string + brands: + - type: string + description: string + languageCode: string + attributes: object + tags: + - type: string + availableTime: string + availability: string + availableQuantity: integer + fulfillmentInfo: + - type: string + placeIds: + - type: string + uri: string + images: + - uri: string + height: integer + width: integer + sizes: + - type: string + materials: + - type: string + patterns: + - type: string + conditions: + - type: string + promotions: + - promotionId: string + publishTime: string + retrievableFields: string + variants: + - expireTime: string + ttl: string + name: string + id: string + type: string + primaryProductId: string + collectionMemberIds: + - type: string + gtin: string + categories: + - type: string + title: string + brands: + - type: string + description: string + languageCode: string + attributes: object + tags: + - type: string + availableTime: string + availability: string + availableQuantity: integer + fulfillmentInfo: + - type: string + placeIds: + - type: string + uri: string + images: + - uri: string + height: integer + width: integer + sizes: + - type: string + materials: + - type: string + patterns: + - type: string + conditions: + - type: string + promotions: + - promotionId: string + publishTime: string + retrievableFields: string + variants: + - expireTime: string + ttl: string + name: string + id: string + type: string + primaryProductId: string + collectionMemberIds: + - type: string + gtin: string + categories: + - type: string + title: string + brands: + - type: string + description: string + languageCode: string + attributes: object + tags: + - type: string + availableTime: string + availability: string + availableQuantity: integer + fulfillmentInfo: + - type: string + placeIds: + - type: string + uri: string + images: + - uri: string + height: integer + width: integer + sizes: + - type: string + materials: + - type: string + patterns: + - type: string + conditions: + - type: string + promotions: + - promotionId: string + publishTime: string + retrievableFields: string + variants: + - expireTime: string + ttl: string + name: string + id: string + type: string + primaryProductId: string + collectionMemberIds: + - type: string + gtin: string + categories: + - type: string + title: string + brands: + - type: string + description: string + languageCode: string + attributes: object + tags: + - type: string + availableTime: string + availability: string + availableQuantity: integer + fulfillmentInfo: + - type: string + placeIds: + - type: string + uri: string + images: + - uri: string + height: integer + width: integer + sizes: + - type: string + materials: + - type: string + patterns: + - type: string + conditions: + - type: string + promotions: + - promotionId: string + publishTime: string + retrievableFields: string + variants: + - expireTime: string + ttl: string + name: string + id: string + type: string + primaryProductId: string + collectionMemberIds: + - type: string + gtin: string + categories: + - type: string + title: string + brands: + - type: string + description: string + languageCode: string + attributes: object + tags: + - type: string + availableTime: string + availability: string + availableQuantity: integer + fulfillmentInfo: + - type: string + placeIds: + - {} + uri: string + images: + - uri: string + height: integer + width: integer + sizes: + - type: string + materials: + - type: string + patterns: + - type: string + conditions: + - type: string + promotions: + - promotionId: string + publishTime: string + retrievableFields: string + variants: + - expireTime: string + ttl: string + name: string + id: string + type: string + primaryProductId: string + collectionMemberIds: + - {} + gtin: string + categories: + - {} + title: string + brands: + - {} + description: string + languageCode: string + attributes: object + tags: + - {} + availableTime: string + availability: string + availableQuantity: integer + fulfillmentInfo: + - {} + uri: string + images: + - {} + sizes: + - {} + materials: + - {} + patterns: + - {} + conditions: + - {} + promotions: + - {} + publishTime: string + retrievableFields: string + variants: + - {} + localInventories: + - {} + localInventories: + - placeId: string + attributes: object + fulfillmentTypes: + - {} + localInventories: + - placeId: string + attributes: object + fulfillmentTypes: + - type: string + localInventories: + - placeId: string + attributes: object + fulfillmentTypes: + - type: string + localInventories: + - placeId: string + attributes: object + fulfillmentTypes: + - type: string + localInventories: + - placeId: string + attributes: object + fulfillmentTypes: + - type: string + localInventories: + - placeId: string + attributes: object + fulfillmentTypes: + - type: string + localInventories: + - placeId: string + attributes: object + fulfillmentTypes: + - type: string + localInventories: + - placeId: string + attributes: object + fulfillmentTypes: + - type: string + localInventories: + - placeId: string + attributes: object + fulfillmentTypes: + - type: string +localInventories: + - placeId: string + attributes: object + fulfillmentTypes: + - type: string + +``` + + + ## `UPDATE` example Updates a products resource. diff --git a/docs/google-docs/providers/google/run/services/index.md b/docs/google-docs/providers/google/run/services/index.md index 14faa8c5dd..e3a4a437fa 100644 --- a/docs/google-docs/providers/google/run/services/index.md +++ b/docs/google-docs/providers/google/run/services/index.md @@ -292,6 +292,7 @@ traffic: tag: string scaling: minInstanceCount: integer + scalingMode: string defaultUriDisabled: boolean urls: - type: string diff --git a/docs/google-docs/providers/google/sasportal/customer_nodes/index.md b/docs/google-docs/providers/google/sasportal/customer_nodes/index.md index 2c65cdab03..814153d6ad 100644 --- a/docs/google-docs/providers/google/sasportal/customer_nodes/index.md +++ b/docs/google-docs/providers/google/sasportal/customer_nodes/index.md @@ -75,14 +75,14 @@ Use the following StackQL query and manifest file to create a new customer INSERT INTO google.sasportal.customer_nodes ( customersId, sasUserIds, -name, -displayName +displayName, +name ) SELECT '{{ customersId }}', '{{ sasUserIds }}', -'{{ name }}', -'{{ displayName }}' +'{{ displayName }}', +'{{ name }}' ; ``` @@ -91,8 +91,8 @@ SELECT ```yaml sasUserIds: - type: string -name: string displayName: string +name: string ``` diff --git a/docs/google-docs/providers/google/sasportal/customers/index.md b/docs/google-docs/providers/google/sasportal/customers/index.md index dcc58369a2..cb14eb06fd 100644 --- a/docs/google-docs/providers/google/sasportal/customers/index.md +++ b/docs/google-docs/providers/google/sasportal/customers/index.md @@ -66,9 +66,9 @@ Updates a customers resource. /*+ update */ UPDATE google.sasportal.customers SET -displayName = '{{ displayName }}', sasUserIds = '{{ sasUserIds }}', -name = '{{ name }}' +name = '{{ name }}', +displayName = '{{ displayName }}' WHERE customersId = '{{ customersId }}'; ``` diff --git a/docs/google-docs/providers/google/sasportal/deployments/index.md b/docs/google-docs/providers/google/sasportal/deployments/index.md index 54a05a7b5e..62c65f27d3 100644 --- a/docs/google-docs/providers/google/sasportal/deployments/index.md +++ b/docs/google-docs/providers/google/sasportal/deployments/index.md @@ -87,24 +87,24 @@ Use the following StackQL query and manifest file to create a new deployme /*+ create */ INSERT INTO google.sasportal.deployments ( customersId, -sasUserIds, -displayName +displayName, +sasUserIds ) SELECT '{{ customersId }}', -'{{ sasUserIds }}', -'{{ displayName }}' +'{{ displayName }}', +'{{ sasUserIds }}' ; ``` ```yaml -name: string -sasUserIds: +frns: - type: string +name: string displayName: string -frns: +sasUserIds: - type: string ``` @@ -119,8 +119,8 @@ Updates a deployments resource. /*+ update */ UPDATE google.sasportal.deployments SET -sasUserIds = '{{ sasUserIds }}', -displayName = '{{ displayName }}' +displayName = '{{ displayName }}', +sasUserIds = '{{ sasUserIds }}' WHERE deploymentsId = '{{ deploymentsId }}' AND nodesId = '{{ nodesId }}'; diff --git a/docs/google-docs/providers/google/sasportal/devices/index.md b/docs/google-docs/providers/google/sasportal/devices/index.md index de401a3b6f..7e6374701f 100644 --- a/docs/google-docs/providers/google/sasportal/devices/index.md +++ b/docs/google-docs/providers/google/sasportal/devices/index.md @@ -112,105 +112,105 @@ Use the following StackQL query and manifest file to create a new devices< /*+ create */ INSERT INTO google.sasportal.devices ( nodesId, +grants, displayName, preloadedConfig, -serialNumber, +fccId, +deviceMetadata, activeConfig, -grants, +name, grantRangeAllowlists, -deviceMetadata, -fccId, -state, -name +serialNumber, +state ) SELECT '{{ nodesId }}', +'{{ grants }}', '{{ displayName }}', '{{ preloadedConfig }}', -'{{ serialNumber }}', +'{{ fccId }}', +'{{ deviceMetadata }}', '{{ activeConfig }}', -'{{ grants }}', +'{{ name }}', '{{ grantRangeAllowlists }}', -'{{ deviceMetadata }}', -'{{ fccId }}', -'{{ state }}', -'{{ name }}' +'{{ serialNumber }}', +'{{ state }}' ; ``` ```yaml +grants: + - grantId: string + frequencyRange: + lowFrequencyMhz: number + highFrequencyMhz: number + state: string + channelType: string + maxEirp: number + suspensionReason: + - type: string + moveList: + - dpaId: string + expireTime: string + lastHeartbeatTransmitExpireTime: string displayName: string +currentChannels: + - score: number preloadedConfig: + updateTime: string + model: + firmwareVersion: string + hardwareVersion: string + name: string + softwareVersion: string + vendor: string + callSign: string + measurementCapabilities: + - enum: string + type: string + enumDescriptions: string + state: string + airInterface: + radioTechnology: string + supportedSpec: string installationParams: - antennaDowntilt: integer verticalAccuracy: number + horizontalAccuracy: number heightType: string + latitude: number antennaGain: number - antennaModel: string longitude: number - indoorDeployment: boolean + cpeCbsdIndication: boolean eirpCapability: integer + antennaBeamwidth: integer + antennaDowntilt: integer height: number - horizontalAccuracy: number antennaAzimuth: integer - antennaBeamwidth: integer - cpeCbsdIndication: boolean - latitude: number + antennaModel: string + indoorDeployment: boolean userId: string - airInterface: - radioTechnology: string - supportedSpec: string - category: string - measurementCapabilities: - - type: string - enum: string - enumDescriptions: string isSigned: boolean - state: string - callSign: string - model: - hardwareVersion: string - vendor: string - firmwareVersion: string - name: string - softwareVersion: string - updateTime: string -serialNumber: string -grants: - - channelType: string - expireTime: string - frequencyRange: - lowFrequencyMhz: number - highFrequencyMhz: number - state: string - moveList: - - dpaId: string - lastHeartbeatTransmitExpireTime: string - maxEirp: number - grantId: string - suspensionReason: - - type: string -grantRangeAllowlists: - - lowFrequencyMhz: number - highFrequencyMhz: number + category: string +fccId: string deviceMetadata: - nrqzValidated: boolean - commonChannelGroup: string - interferenceCoordinationGroup: string nrqzValidation: - longitude: number - state: string cpiId: string - caseId: string + state: string + longitude: number latitude: number + caseId: string antennaModel: string -currentChannels: - - score: number -fccId: string -state: string + nrqzValidated: boolean + commonChannelGroup: string + interferenceCoordinationGroup: string name: string +grantRangeAllowlists: + - lowFrequencyMhz: number + highFrequencyMhz: number +serialNumber: string +state: string ``` @@ -224,16 +224,16 @@ Updates a devices resource. /*+ update */ UPDATE google.sasportal.devices SET +grants = '{{ grants }}', displayName = '{{ displayName }}', preloadedConfig = '{{ preloadedConfig }}', -serialNumber = '{{ serialNumber }}', +fccId = '{{ fccId }}', +deviceMetadata = '{{ deviceMetadata }}', activeConfig = '{{ activeConfig }}', -grants = '{{ grants }}', +name = '{{ name }}', grantRangeAllowlists = '{{ grantRangeAllowlists }}', -deviceMetadata = '{{ deviceMetadata }}', -fccId = '{{ fccId }}', -state = '{{ state }}', -name = '{{ name }}' +serialNumber = '{{ serialNumber }}', +state = '{{ state }}' WHERE devicesId = '{{ devicesId }}' AND nodesId = '{{ nodesId }}'; diff --git a/docs/google-docs/providers/google/sasportal/devices_signed/index.md b/docs/google-docs/providers/google/sasportal/devices_signed/index.md index 897bbaa3af..538f82e02a 100644 --- a/docs/google-docs/providers/google/sasportal/devices_signed/index.md +++ b/docs/google-docs/providers/google/sasportal/devices_signed/index.md @@ -90,8 +90,8 @@ Updates a devices_signed resource. /*+ update */ UPDATE google.sasportal.devices_signed SET -encodedDevice = '{{ encodedDevice }}', -installerId = '{{ installerId }}' +installerId = '{{ installerId }}', +encodedDevice = '{{ encodedDevice }}' WHERE devicesId = '{{ devicesId }}' AND nodesId = '{{ nodesId }}'; diff --git a/docs/google-docs/providers/google/sasportal/nodes/index.md b/docs/google-docs/providers/google/sasportal/nodes/index.md index fdbf94b7d7..e9816ec9a0 100644 --- a/docs/google-docs/providers/google/sasportal/nodes/index.md +++ b/docs/google-docs/providers/google/sasportal/nodes/index.md @@ -79,14 +79,14 @@ Use the following StackQL query and manifest file to create a new nodes @@ -95,8 +95,8 @@ SELECT ```yaml sasUserIds: - type: string -name: string displayName: string +name: string ``` @@ -111,8 +111,8 @@ Updates a nodes resource. UPDATE google.sasportal.nodes SET sasUserIds = '{{ sasUserIds }}', -name = '{{ name }}', -displayName = '{{ displayName }}' +displayName = '{{ displayName }}', +name = '{{ name }}' WHERE nodesId = '{{ nodesId }}' AND nodesId1 = '{{ nodesId1 }}'; diff --git a/docs/google-docs/providers/google/serviceconsumermanagement/tenancy_units_project/index.md b/docs/google-docs/providers/google/serviceconsumermanagement/tenancy_units_project/index.md index 2f8c0cad50..6d0689a845 100644 --- a/docs/google-docs/providers/google/serviceconsumermanagement/tenancy_units_project/index.md +++ b/docs/google-docs/providers/google/serviceconsumermanagement/tenancy_units_project/index.md @@ -84,13 +84,13 @@ projectConfig: role: string billingConfig: billingAccount: string + folder: string serviceAccountConfig: accountId: string tenantProjectRoles: - type: string services: - type: string - folder: string tag: string ``` diff --git a/docs/google-docs/providers/google/servicemanagement/configs/index.md b/docs/google-docs/providers/google/servicemanagement/configs/index.md index 4c7b91a214..2955c8d146 100644 --- a/docs/google-docs/providers/google/servicemanagement/configs/index.md +++ b/docs/google-docs/providers/google/servicemanagement/configs/index.md @@ -105,4 +105,539 @@ usage FROM google.servicemanagement.configs WHERE serviceName = '{{ serviceName }}'; ``` -undefined \ No newline at end of file + +## `INSERT` example + +Use the following StackQL query and manifest file to create a new configs resource. + + + + +```sql +/*+ create */ +INSERT INTO google.servicemanagement.configs ( +serviceName, +name, +title, +producerProjectId, +apis, +types, +enums, +documentation, +backend, +http, +quota, +authentication, +context, +usage, +customError, +endpoints, +control, +logs, +metrics, +monitoredResources, +billing, +logging, +monitoring, +systemParameters, +sourceInfo, +publishing, +systemTypes, +configVersion +) +SELECT +'{{ serviceName }}', +'{{ name }}', +'{{ title }}', +'{{ producerProjectId }}', +'{{ apis }}', +'{{ types }}', +'{{ enums }}', +'{{ documentation }}', +'{{ backend }}', +'{{ http }}', +'{{ quota }}', +'{{ authentication }}', +'{{ context }}', +'{{ usage }}', +'{{ customError }}', +'{{ endpoints }}', +'{{ control }}', +'{{ logs }}', +'{{ metrics }}', +'{{ monitoredResources }}', +'{{ billing }}', +'{{ logging }}', +'{{ monitoring }}', +'{{ systemParameters }}', +'{{ sourceInfo }}', +'{{ publishing }}', +'{{ systemTypes }}', +'{{ configVersion }}' +; +``` + + + +```yaml +name: string +title: string +producerProjectId: string +id: string +apis: + - name: string + methods: + - name: string + requestTypeUrl: string + requestStreaming: boolean + responseTypeUrl: string + responseStreaming: boolean + options: + - name: string + value: object + syntax: string + options: + - name: string + value: object + version: string + sourceContext: + fileName: string + mixins: + - name: string + root: string + syntax: string +types: + - name: string + fields: + - kind: string + cardinality: string + number: integer + name: string + typeUrl: string + oneofIndex: integer + packed: boolean + options: + - name: string + value: object + jsonName: string + defaultValue: string + oneofs: + - type: string + options: + - name: string + value: object + syntax: string + edition: string +enums: + - name: string + enumvalue: + - name: string + number: integer + options: + - name: string + value: object + options: + - name: string + value: object + syntax: string + edition: string +documentation: + summary: string + pages: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - {} + rules: + - selector: string + description: string + deprecationDescription: string + disableReplacementWords: string + documentationRootUrl: string + serviceRootUrl: string + overview: string + sectionOverrides: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - name: string + content: string + subpages: + - {} +backend: + rules: + - selector: string + address: string + deadline: number + minDeadline: number + operationDeadline: number + pathTranslation: string + jwtAudience: string + disableAuth: boolean + protocol: string + overridesByRequestProtocol: object +http: + rules: + - selector: string + get: string + put: string + post: string + delete: string + patch: string + custom: + kind: string + path: string + body: string + responseBody: string + additionalBindings: + - selector: string + get: string + put: string + post: string + delete: string + patch: string + body: string + responseBody: string + additionalBindings: + - selector: string + get: string + put: string + post: string + delete: string + patch: string + body: string + responseBody: string + additionalBindings: + - selector: string + get: string + put: string + post: string + delete: string + patch: string + body: string + responseBody: string + additionalBindings: + - selector: string + get: string + put: string + post: string + delete: string + patch: string + body: string + responseBody: string + additionalBindings: + - selector: string + get: string + put: string + post: string + delete: string + patch: string + body: string + responseBody: string + additionalBindings: + - selector: string + get: string + put: string + post: string + delete: string + patch: string + body: string + responseBody: string + additionalBindings: + - selector: string + get: string + put: string + post: string + delete: string + patch: string + body: string + responseBody: string + additionalBindings: + - selector: string + get: string + put: string + post: string + delete: string + patch: string + body: string + responseBody: string + additionalBindings: + - {} + fullyDecodeReservedExpansion: boolean +quota: + limits: + - name: string + description: string + defaultLimit: string + maxLimit: string + freeTier: string + duration: string + metric: string + unit: string + values: object + displayName: string + metricRules: + - selector: string + metricCosts: object +authentication: + rules: + - selector: string + oauth: + canonicalScopes: string + allowWithoutCredential: boolean + requirements: + - providerId: string + audiences: string + providers: + - id: string + issuer: string + jwksUri: string + audiences: string + authorizationUrl: string + jwtLocations: + - header: string + query: string + cookie: string + valuePrefix: string +context: + rules: + - selector: string + requested: + - type: string + provided: + - type: string + allowedRequestExtensions: + - type: string + allowedResponseExtensions: + - type: string +usage: + requirements: + - type: string + rules: + - selector: string + allowUnregisteredCalls: boolean + skipServiceControl: boolean + producerNotificationChannel: string +customError: + rules: + - selector: string + isErrorType: boolean + types: + - type: string +endpoints: + - name: string + aliases: + - type: string + target: string + allowCors: boolean +control: + environment: string + methodPolicies: + - selector: string + requestPolicies: + - selector: string + resourcePermission: string + resourceType: string +logs: + - name: string + labels: + - key: string + valueType: string + description: string + description: string + displayName: string +metrics: + - name: string + type: string + labels: + - key: string + valueType: string + description: string + metricKind: string + valueType: string + unit: string + description: string + displayName: string + metadata: + launchStage: string + samplePeriod: string + ingestDelay: string + timeSeriesResourceHierarchyLevel: + - type: string + enumDescriptions: string + enum: string + launchStage: string + monitoredResourceTypes: + - type: string +monitoredResources: + - name: string + type: string + displayName: string + description: string + labels: + - key: string + valueType: string + description: string + launchStage: string +billing: + consumerDestinations: + - monitoredResource: string + metrics: + - type: string +logging: + producerDestinations: + - monitoredResource: string + logs: + - type: string + consumerDestinations: + - monitoredResource: string + logs: + - type: string +monitoring: + producerDestinations: + - monitoredResource: string + metrics: + - type: string + consumerDestinations: + - monitoredResource: string + metrics: + - type: string +systemParameters: + rules: + - selector: string + parameters: + - name: string + httpHeader: string + urlQueryParameter: string +sourceInfo: + sourceFiles: + - type: string + additionalProperties: any +publishing: + methodSettings: + - selector: string + longRunning: + initialPollDelay: string + pollDelayMultiplier: number + maxPollDelay: string + totalPollTimeout: string + autoPopulatedFields: + - type: string + newIssueUri: string + documentationUri: string + apiShortName: string + githubLabel: string + codeownerGithubTeams: + - type: string + docTagPrefix: string + organization: string + librarySettings: + - version: string + launchStage: string + restNumericEnums: boolean + javaSettings: + libraryPackage: string + serviceClassNames: object + common: + referenceDocsUri: string + destinations: + - type: string + enumDescriptions: string + enum: string + cppSettings: {} + phpSettings: {} + pythonSettings: + experimentalFeatures: + restAsyncIoEnabled: boolean + nodeSettings: {} + dotnetSettings: + renamedServices: object + renamedResources: object + ignoredResources: + - type: string + forcedNamespaceAliases: + - type: string + handwrittenSignatures: + - type: string + rubySettings: {} + goSettings: {} + protoReferenceDocumentationUri: string + restReferenceDocumentationUri: string +systemTypes: + - name: string + fields: + - kind: string + cardinality: string + number: integer + name: string + typeUrl: string + oneofIndex: integer + packed: boolean + options: + - name: string + value: object + jsonName: string + defaultValue: string + oneofs: + - type: string + options: + - name: string + value: object + syntax: string + edition: string +configVersion: integer + +``` + + diff --git a/docs/google-docs/providers/google/servicenetworking/connections/index.md b/docs/google-docs/providers/google/servicenetworking/connections/index.md index 3a6f92c93c..53e96e2aaa 100644 --- a/docs/google-docs/providers/google/servicenetworking/connections/index.md +++ b/docs/google-docs/providers/google/servicenetworking/connections/index.md @@ -68,24 +68,24 @@ Use the following StackQL query and manifest file to create a new connecti /*+ create */ INSERT INTO google.servicenetworking.connections ( servicesId, -reservedPeeringRanges, -network +network, +reservedPeeringRanges ) SELECT '{{ servicesId }}', -'{{ reservedPeeringRanges }}', -'{{ network }}' +'{{ network }}', +'{{ reservedPeeringRanges }}' ; ``` ```yaml +network: string peering: string reservedPeeringRanges: - type: string service: string -network: string ``` @@ -99,8 +99,8 @@ Updates a connections resource. /*+ update */ UPDATE google.servicenetworking.connections SET -reservedPeeringRanges = '{{ reservedPeeringRanges }}', -network = '{{ network }}' +network = '{{ network }}', +reservedPeeringRanges = '{{ reservedPeeringRanges }}' WHERE connectionsId = '{{ connectionsId }}' AND servicesId = '{{ servicesId }}'; diff --git a/docs/google-docs/providers/google/servicenetworking/dns_record_sets/index.md b/docs/google-docs/providers/google/servicenetworking/dns_record_sets/index.md index 2224b592af..3a220c8bfb 100644 --- a/docs/google-docs/providers/google/servicenetworking/dns_record_sets/index.md +++ b/docs/google-docs/providers/google/servicenetworking/dns_record_sets/index.md @@ -70,14 +70,14 @@ Use the following StackQL query and manifest file to create a new dns_reco INSERT INTO google.servicenetworking.dns_record_sets ( servicesId, zone, -dnsRecordSet, -consumerNetwork +consumerNetwork, +dnsRecordSet ) SELECT '{{ servicesId }}', '{{ zone }}', -'{{ dnsRecordSet }}', -'{{ consumerNetwork }}' +'{{ consumerNetwork }}', +'{{ dnsRecordSet }}' ; ``` @@ -85,13 +85,13 @@ SELECT ```yaml zone: string +consumerNetwork: string dnsRecordSet: - type: string ttl: string data: - type: string domain: string -consumerNetwork: string + type: string ``` @@ -105,10 +105,10 @@ Updates a dns_record_sets resource. /*+ update */ UPDATE google.servicenetworking.dns_record_sets SET -zone = '{{ zone }}', +newDnsRecordSet = '{{ newDnsRecordSet }}', existingDnsRecordSet = '{{ existingDnsRecordSet }}', -consumerNetwork = '{{ consumerNetwork }}', -newDnsRecordSet = '{{ newDnsRecordSet }}' +zone = '{{ zone }}', +consumerNetwork = '{{ consumerNetwork }}' WHERE servicesId = '{{ servicesId }}'; ``` diff --git a/docs/google-docs/providers/google/servicenetworking/peered_dns_domains/index.md b/docs/google-docs/providers/google/servicenetworking/peered_dns_domains/index.md index b385123c7b..8b470d229e 100644 --- a/docs/google-docs/providers/google/servicenetworking/peered_dns_domains/index.md +++ b/docs/google-docs/providers/google/servicenetworking/peered_dns_domains/index.md @@ -72,23 +72,23 @@ INSERT INTO google.servicenetworking.peered_dns_domains ( networksId, projectsId, servicesId, -name, -dnsSuffix +dnsSuffix, +name ) SELECT '{{ networksId }}', '{{ projectsId }}', '{{ servicesId }}', -'{{ name }}', -'{{ dnsSuffix }}' +'{{ dnsSuffix }}', +'{{ name }}' ; ``` ```yaml -name: string dnsSuffix: string +name: string ``` diff --git a/docs/google-docs/providers/google/servicenetworking/services_subnetwork/index.md b/docs/google-docs/providers/google/servicenetworking/services_subnetwork/index.md index 9d8f356f4f..93f5060d69 100644 --- a/docs/google-docs/providers/google/servicenetworking/services_subnetwork/index.md +++ b/docs/google-docs/providers/google/servicenetworking/services_subnetwork/index.md @@ -56,83 +56,83 @@ INSERT INTO google.servicenetworking.services_subnetwork ( servicesId, servicesId1, servicesId2, -useCustomComputeIdempotencyWindow, -subnetworkUsers, -outsideAllocationPublicIpRange, role, -purpose, -requestedAddress, -description, +ipPrefixLength, +skipRequestedAddressValidation, +consumerNetwork, +internalRange, secondaryIpRangeSpecs, +description, +useCustomComputeIdempotencyWindow, requestedRanges, -consumer, -skipRequestedAddressValidation, -region, allowSubnetCidrRoutesOverlap, -checkServiceNetworkingUsePermission, -subnetwork, computeIdempotencyWindow, -consumerNetwork, +subnetwork, +requestedAddress, +outsideAllocationPublicIpRange, privateIpv6GoogleAccess, -ipPrefixLength, -internalRange +consumer, +subnetworkUsers, +purpose, +region, +checkServiceNetworkingUsePermission ) SELECT '{{ servicesId }}', '{{ servicesId1 }}', '{{ servicesId2 }}', -true|false, -'{{ subnetworkUsers }}', -'{{ outsideAllocationPublicIpRange }}', '{{ role }}', -'{{ purpose }}', -'{{ requestedAddress }}', -'{{ description }}', -'{{ secondaryIpRangeSpecs }}', -'{{ requestedRanges }}', -'{{ consumer }}', +'{{ ipPrefixLength }}', true|false, -'{{ region }}', +'{{ consumerNetwork }}', +'{{ internalRange }}', +'{{ secondaryIpRangeSpecs }}', +'{{ description }}', true|false, +'{{ requestedRanges }}', true|false, -'{{ subnetwork }}', '{{ computeIdempotencyWindow }}', -'{{ consumerNetwork }}', +'{{ subnetwork }}', +'{{ requestedAddress }}', +'{{ outsideAllocationPublicIpRange }}', '{{ privateIpv6GoogleAccess }}', -'{{ ipPrefixLength }}', -'{{ internalRange }}' +'{{ consumer }}', +'{{ subnetworkUsers }}', +'{{ purpose }}', +'{{ region }}', +true|false ; ``` ```yaml -useCustomComputeIdempotencyWindow: boolean -subnetworkUsers: - - type: string -outsideAllocationPublicIpRange: string role: string -purpose: string -requestedAddress: string -description: string +ipPrefixLength: integer +skipRequestedAddressValidation: boolean +consumerNetwork: string +internalRange: string secondaryIpRangeSpecs: - - outsideAllocationPublicIpRange: string - rangeName: string - ipPrefixLength: integer + - ipPrefixLength: integer + outsideAllocationPublicIpRange: string requestedAddress: string + rangeName: string +description: string +useCustomComputeIdempotencyWindow: boolean requestedRanges: - type: string -consumer: string -skipRequestedAddressValidation: boolean -region: string allowSubnetCidrRoutesOverlap: boolean -checkServiceNetworkingUsePermission: boolean -subnetwork: string computeIdempotencyWindow: string -consumerNetwork: string +subnetwork: string +requestedAddress: string +outsideAllocationPublicIpRange: string privateIpv6GoogleAccess: string -ipPrefixLength: integer -internalRange: string +consumer: string +subnetworkUsers: + - type: string +purpose: string +region: string +checkServiceNetworkingUsePermission: boolean ``` diff --git a/docs/google-docs/providers/google/serviceusage/services/index.md b/docs/google-docs/providers/google/serviceusage/services/index.md index 904f53901e..40be2bd1e4 100644 --- a/docs/google-docs/providers/google/serviceusage/services/index.md +++ b/docs/google-docs/providers/google/serviceusage/services/index.md @@ -31,18 +31,15 @@ Creates, updates, deletes, gets or lists a services resource. ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| | `string` | The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com | -| | `object` | The configuration of the service. | -| | `string` | The resource name of the consumer. A valid name would be: - projects/123 | -| | `string` | Whether or not the service has been enabled for use by the consumer. | +| | `array` | The requested Service states. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| | `SELECT` | | Returns the service configurations and enabled states for a given list of services. | | | `SELECT` | | Returns the service configuration and enabled state for a given service. | -| | `SELECT` | | List all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the `servicemanagement.services.bind` permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project. WARNING: If you need to query enabled services frequently or across an organization, you should use [Cloud Asset Inventory API](https://cloud.google.com/asset-inventory/docs/apis), which provides higher throughput and richer filtering capability. | | | `EXEC` | | 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. | -| | `EXEC` | | Enable a service so that it can be used with a project. | +| | `EXEC` | | 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. | ## `SELECT` examples @@ -50,10 +47,7 @@ Returns the service configuration and enabled state for a given service. ```sql SELECT -name, -config, -parent, -state +services FROM google.serviceusage.services WHERE name = '{{ name }}'; ``` diff --git a/docs/google-docs/providers/google/websecurityscanner/scan_configs/index.md b/docs/google-docs/providers/google/websecurityscanner/scan_configs/index.md index de2bb9b42b..fa2a712665 100644 --- a/docs/google-docs/providers/google/websecurityscanner/scan_configs/index.md +++ b/docs/google-docs/providers/google/websecurityscanner/scan_configs/index.md @@ -95,68 +95,68 @@ Use the following StackQL query and manifest file to create a new scan_con /*+ create */ INSERT INTO google.websecurityscanner.scan_configs ( projectsId, -staticIpScan, -displayName, -userAgent, +startingUrls, +authentication, riskLevel, +displayName, blacklistPatterns, -exportToSecurityCommandCenter, -schedule, -startingUrls, -maxQps, -managedScan, ignoreHttpStatusErrors, +staticIpScan, +managedScan, name, -authentication +userAgent, +maxQps, +schedule, +exportToSecurityCommandCenter ) SELECT '{{ projectsId }}', -true|false, -'{{ displayName }}', -'{{ userAgent }}', +'{{ startingUrls }}', +'{{ authentication }}', '{{ riskLevel }}', +'{{ displayName }}', '{{ blacklistPatterns }}', -'{{ exportToSecurityCommandCenter }}', -'{{ schedule }}', -'{{ startingUrls }}', -'{{ maxQps }}', +true|false, true|false, true|false, '{{ name }}', -'{{ authentication }}' +'{{ userAgent }}', +'{{ maxQps }}', +'{{ schedule }}', +'{{ exportToSecurityCommandCenter }}' ; ``` ```yaml -staticIpScan: boolean -displayName: string -userAgent: string -riskLevel: string -blacklistPatterns: - - type: string -exportToSecurityCommandCenter: string -schedule: - scheduleTime: string - intervalDurationDays: integer startingUrls: - type: string -maxQps: integer -managedScan: boolean -ignoreHttpStatusErrors: boolean -name: string authentication: - customAccount: - username: string - password: string - loginUrl: string googleAccount: - password: string username: string + password: string iapCredential: iapTestServiceAccountInfo: targetAudienceClientId: string + customAccount: + username: string + password: string + loginUrl: string +riskLevel: string +displayName: string +blacklistPatterns: + - type: string +ignoreHttpStatusErrors: boolean +staticIpScan: boolean +managedScan: boolean +name: string +userAgent: string +maxQps: integer +schedule: + scheduleTime: string + intervalDurationDays: integer +exportToSecurityCommandCenter: string ``` @@ -170,19 +170,19 @@ Updates a scan_configs resource. /*+ update */ UPDATE google.websecurityscanner.scan_configs SET -staticIpScan = true|false, -displayName = '{{ displayName }}', -userAgent = '{{ userAgent }}', +startingUrls = '{{ startingUrls }}', +authentication = '{{ authentication }}', riskLevel = '{{ riskLevel }}', +displayName = '{{ displayName }}', blacklistPatterns = '{{ blacklistPatterns }}', -exportToSecurityCommandCenter = '{{ exportToSecurityCommandCenter }}', -schedule = '{{ schedule }}', -startingUrls = '{{ startingUrls }}', -maxQps = '{{ maxQps }}', -managedScan = true|false, ignoreHttpStatusErrors = true|false, +staticIpScan = true|false, +managedScan = true|false, name = '{{ name }}', -authentication = '{{ authentication }}' +userAgent = '{{ userAgent }}', +maxQps = '{{ maxQps }}', +schedule = '{{ schedule }}', +exportToSecurityCommandCenter = '{{ exportToSecurityCommandCenter }}' WHERE projectsId = '{{ projectsId }}' AND scanConfigsId = '{{ scanConfigsId }}'; diff --git a/docs/google-docs/providers/google/workstations/workstation_configs/index.md b/docs/google-docs/providers/google/workstations/workstation_configs/index.md index 85d5627c9c..e1539dcee6 100644 --- a/docs/google-docs/providers/google/workstations/workstation_configs/index.md +++ b/docs/google-docs/providers/google/workstations/workstation_configs/index.md @@ -41,7 +41,7 @@ Creates, updates, deletes, gets or lists a workstation_configs reso | | `string` | Output only. Time when this workstation configuration was soft-deleted. | | | `boolean` | Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. | | | `string` | Optional. Human-readable name for this workstation configuration. | -| | `boolean` | Optional. Whether to enable Linux `auditd` logging on the 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" | +| | `boolean` | Optional. Whether to enable Linux `auditd` logging on the 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](https://cloud.google.com/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" | | | `object` | A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). | | | `array` | Optional. Ephemeral directories which won't persist across workstation sessions. | | | `string` | Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. | @@ -49,7 +49,7 @@ Creates, updates, deletes, gets or lists a workstation_configs reso | | `object` | Runtime host for a workstation. | | | `string` | Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). | | | `object` | Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. | -| | `integer` | 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. | +| | `integer` | Optional. Maximum number of workstations under this configuration 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. | | | `array` | Optional. Directories to persist across workstation sessions. | | | `array` | Optional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes. | | | `boolean` | Output only. Indicates whether this workstation configuration is currently being updated to match its intended state. | diff --git a/docs/google-docs/providers/google/workstations/workstation_configs_usable/index.md b/docs/google-docs/providers/google/workstations/workstation_configs_usable/index.md index f968b05fd3..67e3235b87 100644 --- a/docs/google-docs/providers/google/workstations/workstation_configs_usable/index.md +++ b/docs/google-docs/providers/google/workstations/workstation_configs_usable/index.md @@ -41,7 +41,7 @@ Creates, updates, deletes, gets or lists a workstation_configs_usable | `string` | Output only. Time when this workstation configuration was soft-deleted. | | | `boolean` | Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. | | | `string` | Optional. Human-readable name for this workstation configuration. | -| | `boolean` | Optional. Whether to enable Linux `auditd` logging on the 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" | +| | `boolean` | Optional. Whether to enable Linux `auditd` logging on the 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](https://cloud.google.com/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" | | | `object` | A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). | | | `array` | Optional. Ephemeral directories which won't persist across workstation sessions. | | | `string` | Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. | @@ -49,7 +49,7 @@ Creates, updates, deletes, gets or lists a workstation_configs_usable | `object` | Runtime host for a workstation. | | | `string` | Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). | | | `object` | Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. | -| | `integer` | 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. | +| | `integer` | Optional. Maximum number of workstations under this configuration 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. | | | `array` | Optional. Directories to persist across workstation sessions. | | | `array` | Optional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes. | | | `boolean` | Output only. Indicates whether this workstation configuration is currently being updated to match its intended state. |