From 0c7bed6d47b7e3329ff8c2fc8675b5c64cbefda2 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Thu, 10 Aug 2023 15:08:33 +1000 Subject: [PATCH] google updates --- docs/google-docs/index.md | 15 +-- .../access_approval_settings/index.md | 8 +- .../accessapproval/approval_requests/index.md | 9 +- .../providers/google/accessapproval/index.md | 4 +- .../access_levels/index.md | 3 +- .../access_policies/index.md | 5 +- .../access_policies_iam_policies/index.md | 9 +- .../authorized_orgs_descs/index.md | 5 +- .../gcp_user_access_bindings/index.md | 3 +- .../google/accesscontextmanager/index.md | 6 +- .../accesscontextmanager/operations/index.md | 8 +- .../service_perimeters/index.md | 5 +- .../google/advisorynotifications/index.md | 4 +- .../notifications/index.md | 3 +- .../aiplatform/annotation_specs/index.md | 38 ++++++++ .../google/aiplatform/annotations/index.md | 42 ++++++++ .../google/aiplatform/artifacts/index.md | 52 ++++++++++ .../aiplatform/batch_prediction_jobs/index.md | 65 +++++++++++++ .../google/aiplatform/contexts/index.md | 51 ++++++++++ .../index.md | 32 +++++++ .../contexts_context_children/index.md | 33 +++++++ .../google/aiplatform/custom_jobs/index.md | 50 ++++++++++ .../google/aiplatform/data_items/index.md | 40 ++++++++ .../aiplatform/data_labeling_jobs/index.md | 56 +++++++++++ .../google/aiplatform/datasets/index.md | 54 +++++++++++ .../google/aiplatform/endpoints/index.md | 59 ++++++++++++ .../google/aiplatform/entity_types/index.md | 51 ++++++++++ .../entity_types_feature_values/index.md | 32 +++++++ .../entity_types_iam_policies/index.md | 38 ++++++++ .../google/aiplatform/evaluations/index.md | 47 +++++++++ .../google/aiplatform/executions/index.md | 51 ++++++++++ .../executions_execution_events/index.md | 32 +++++++ .../google/aiplatform/experiments/index.md | 47 +++++++++ .../google/aiplatform/features/index.md | 49 ++++++++++ .../google/aiplatform/featurestores/index.md | 49 ++++++++++ .../featurestores_iam_policies/index.md | 38 ++++++++ .../hyperparameter_tuning_jobs/index.md | 54 +++++++++++ .../providers/google/aiplatform/index.md | 96 +++++++++++++++++++ .../aiplatform/index_endpoints/index.md | 56 +++++++++++ .../google/aiplatform/indexes/index.md | 51 ++++++++++ .../aiplatform/indexes_datapoints/index.md | 32 +++++++ .../google/aiplatform/locations/index.md | 40 ++++++++ .../aiplatform/metadata_schemas/index.md | 42 ++++++++ .../aiplatform/metadata_stores/index.md | 43 +++++++++ .../aiplatform/migratable_resources/index.md | 33 +++++++ .../model_deployment_monitoring_jobs/index.md | 64 +++++++++++++ .../google/aiplatform/models/index.md | 73 ++++++++++++++ .../models_explanation_dataset/index.md | 32 +++++++ .../google/aiplatform/models_version/index.md | 32 +++++++ .../aiplatform/models_versions/index.md | 63 ++++++++++++ .../google/aiplatform/nas_jobs/index.md | 51 ++++++++++ .../aiplatform/nas_trial_details/index.md | 39 ++++++++ .../google/aiplatform/operations/index.md | 43 +++++++++ .../google/aiplatform/pipeline_jobs/index.md | 56 +++++++++++ .../providers/google/aiplatform/runs/index.md | 47 +++++++++ .../google/aiplatform/saved_queries/index.md | 45 +++++++++ .../google/aiplatform/schedules/index.md | 58 +++++++++++ .../google/aiplatform/slices/index.md | 42 ++++++++ .../aiplatform/specialist_pools/index.md | 44 +++++++++ .../google/aiplatform/studies/index.md | 44 +++++++++ .../google/aiplatform/tensorboards/index.md | 51 ++++++++++ .../google/aiplatform/time_series/index.md | 53 ++++++++++ .../aiplatform/training_pipelines/index.md | 55 +++++++++++ .../google/aiplatform/trials/index.md | 53 ++++++++++ .../aiplatform/trials_optimal_trials/index.md | 32 +++++++ .../trials_trial_measurement/index.md | 32 +++++++ .../analyticshub/data_exchanges/index.md | 13 ++- .../data_exchanges_iam_policies/index.md | 9 +- .../data_exchanges_subscriptions/index.md | 44 +++++++++ .../providers/google/analyticshub/index.md | 13 ++- .../google/analyticshub/listings/index.md | 16 +++- .../listings_iam_policies/index.md | 9 +- .../listings_subscriptions/index.md | 44 +++++++++ .../analyticshub/subscriptions/index.md | 48 ++++++++++ .../providers/google/apigateway/apis/index.md | 11 ++- .../apigateway/apis_iam_policies/index.md | 4 +- .../google/apigateway/configs/index.md | 15 ++- .../apigateway/configs_iam_policies/index.md | 2 +- .../google/apigateway/gateways/index.md | 12 ++- .../apigateway/gateways_iam_policies/index.md | 2 +- .../providers/google/apigateway/index.md | 4 +- .../google/apigateway/locations/index.md | 8 +- .../google/apigateway/operations/index.md | 8 +- .../google/apigee/admin_schemav2/index.md | 2 +- .../providers/google/apigee/aliases/index.md | 2 +- .../apigee/aliases_certificate/index.md | 2 +- .../google/apigee/apicategories/index.md | 4 +- .../google/apigee/apiproducts/index.md | 20 ++++ .../google/apigee/appgroups/index.md | 14 ++- .../providers/google/apigee/apps/index.md | 28 +++--- .../apigee/archive_deployments/index.md | 9 +- .../google/apigee/attachments/index.md | 4 +- .../google/apigee/attributes/index.md | 4 - .../google/apigee/canaryevaluations/index.md | 8 +- .../google/apigee/datacollectors/index.md | 3 +- .../google/apigee/datastores/index.md | 2 +- .../google/apigee/debugsessions/index.md | 5 +- .../apigee/deployed_ingress_config/index.md | 2 +- .../google/apigee/developers/index.md | 16 ++++ .../apigee/endpoint_attachments/index.md | 9 +- .../providers/google/apigee/entries/index.md | 7 +- .../google/apigee/envgroups/index.md | 8 +- .../index.md | 2 +- .../google/apigee/environments/index.md | 12 +-- .../apigee/environments_iam_policies/index.md | 2 +- .../apigee/environments_trace_config/index.md | 2 +- .../google/apigee/flowhooks/index.md | 2 +- .../google/apigee/host_queries/index.md | 15 +++ .../apigee/host_queries_result_view/index.md | 2 +- .../apigee/host_security_reports/index.md | 16 +++- .../index.md | 4 +- .../google/apigee/host_stats/index.md | 2 +- .../providers/google/apigee/index.md | 4 +- .../google/apigee/instances/index.md | 17 ++-- .../providers/google/apigee/keys/index.md | 8 +- .../google/apigee/nat_addresses/index.md | 6 +- .../google/apigee/operations/index.md | 8 +- .../google/apigee/organizations/index.md | 29 ------ .../google/apigee/overrides/index.md | 3 +- .../providers/google/apigee/queries/index.md | 15 +++ .../google/apigee/queries_result/index.md | 2 +- .../providers/google/apigee/reports/index.md | 32 +++---- .../google/apigee/resourcefiles/index.md | 5 + .../google/apigee/revisions/index.md | 2 +- .../apigee/revisions_deployments/index.md | 12 +-- .../google/apigee/security_incidents/index.md | 10 +- .../google/apigee/security_profiles/index.md | 14 ++- .../security_profiles_revisions/index.md | 14 ++- .../google/apigee/security_reports/index.md | 15 +-- .../apigee/security_reports_result/index.md | 2 +- .../security_reports_result_view/index.md | 4 +- .../google/apigee/subscriptions/index.md | 8 +- .../google/apigee/targetservers/index.md | 2 +- .../google/apigeeregistry/apis/index.md | 13 ++- .../apigeeregistry/apis_iam_policies/index.md | 2 +- .../google/apigeeregistry/artifacts/index.md | 16 +++- .../apigeeregistry/deployments/index.md | 17 +++- .../deployments_iam_policies/index.md | 2 +- .../deployments_revisions/index.md | 17 +++- .../providers/google/apigeeregistry/index.md | 4 +- .../google/apigeeregistry/instances/index.md | 2 +- .../instances_iam_policies/index.md | 2 +- .../google/apigeeregistry/locations/index.md | 8 +- .../google/apigeeregistry/operations/index.md | 8 +- .../google/apigeeregistry/specs/index.md | 17 +++- .../specs_iam_policies/index.md | 2 +- .../apigeeregistry/specs_revisions/index.md | 17 +++- .../google/apigeeregistry/versions/index.md | 12 ++- .../versions_iam_policies/index.md | 2 +- .../providers/google/apikeys/index.md | 4 +- .../providers/google/apikeys/keys/index.md | 13 ++- .../providers/google/appengine/apps/index.md | 20 ++-- .../authorized_certificates/index.md | 12 ++- .../appengine/authorized_domains/index.md | 5 +- .../google/appengine/domain_mappings/index.md | 1 + .../providers/google/appengine/index.md | 4 +- .../google/appengine/ingress_rules/index.md | 1 + .../google/appengine/instances/index.md | 21 ++-- .../google/appengine/locations/index.md | 8 +- .../google/appengine/operations/index.md | 8 +- .../google/appengine/services/index.md | 8 +- .../google/appengine/versions/index.md | 44 ++++++++- .../artifactregistry/docker_images/index.md | 1 + .../google/artifactregistry/files/index.md | 5 +- .../google/artifactregistry/index.md | 4 +- .../artifactregistry/locations/index.md | 8 +- .../artifactregistry/maven_artifacts/index.md | 10 +- .../artifactregistry/npm_packages/index.md | 9 +- .../google/artifactregistry/packages/index.md | 1 + .../artifactregistry/python_packages/index.md | 3 +- .../artifactregistry/repositories/index.md | 20 +++- .../repositories_iam_policies/index.md | 2 +- .../google/artifactregistry/tags/index.md | 5 +- .../google/artifactregistry/versions/index.md | 9 +- .../google/assuredworkloads/index.md | 4 +- .../assuredworkloads/operations/index.md | 8 +- .../assuredworkloads/violations/index.md | 18 +++- .../assuredworkloads/workloads/index.md | 23 ++++- .../google/baremetalsolution/index.md | 4 +- .../baremetalsolution/instances/index.md | 23 ++++- .../baremetalsolution/locations/index.md | 8 +- .../google/baremetalsolution/luns/index.md | 16 +++- .../baremetalsolution/networks/index.md | 20 +++- .../baremetalsolution/nfs_shares/index.md | 13 ++- .../provisioning_configs/index.md | 16 ++-- .../provisioning_quotas/index.md | 12 ++- .../baremetalsolution/snapshots/index.md | 3 +- .../baremetalsolution/ssh_keys/index.md | 5 +- .../google/baremetalsolution/volumes/index.md | 30 +++++- .../providers/google/batch/index.md | 4 +- .../providers/google/batch/jobs/index.md | 15 ++- .../providers/google/batch/locations/index.md | 8 +- .../google/batch/operations/index.md | 8 +- .../providers/google/batch/tasks/index.md | 6 +- .../beyondcorp/app_connections/index.md | 15 ++- .../app_connections_iam_policies/index.md | 2 +- .../google/beyondcorp/app_connectors/index.md | 13 ++- .../app_connectors_iam_policies/index.md | 2 +- .../google/beyondcorp/app_gateways/index.md | 15 ++- .../app_gateways_iam_policies/index.md | 4 +- .../client_gateways_iam_policies/index.md | 2 +- .../providers/google/beyondcorp/index.md | 4 +- .../google/beyondcorp/locations/index.md | 8 +- .../google/beyondcorp/operations/index.md | 9 +- .../google/bigquery/datasets/index.md | 11 ++- .../providers/google/bigquery/index.md | 6 +- .../providers/google/bigquery/jobs/index.md | 15 +-- .../bigquery/jobs_query_results/index.md | 16 ++-- .../providers/google/bigquery/models/index.md | 24 ++++- .../google/bigquery/projects/index.md | 11 ++- .../google/bigquery/routines/index.md | 17 ++-- .../bigquery/row_access_policies/index.md | 8 +- .../google/bigquery/tabledata/index.md | 2 +- .../providers/google/bigquery/tables/index.md | 18 +++- .../bigquery/tables_iam_policies/index.md | 32 +++++++ .../bigqueryconnection/connections/index.md | 3 +- .../connections_iam_policies/index.md | 9 +- .../google/bigqueryconnection/index.md | 6 +- .../data_sources/index.md | 20 ++-- .../google/bigquerydatatransfer/index.md | 4 +- .../bigquerydatatransfer/locations/index.md | 8 +- .../google/bigquerydatatransfer/runs/index.md | 19 +++- .../transfer_configs/index.md | 22 ++++- .../transfer_logs/index.md | 7 +- .../bigqueryreservation/assignments/index.md | 7 +- .../bi_reservation/index.md | 2 +- .../capacity_commitments/index.md | 11 ++- .../google/bigqueryreservation/index.md | 4 +- .../bigqueryreservation/reservations/index.md | 9 +- .../bigtableadmin/app_profiles/index.md | 3 +- .../google/bigtableadmin/backups/index.md | 9 +- .../backups_iam_policies/index.md | 9 +- .../google/bigtableadmin/clusters/index.md | 1 + .../google/bigtableadmin/hot_tablets/index.md | 10 +- .../providers/google/bigtableadmin/index.md | 6 +- .../google/bigtableadmin/instances/index.md | 11 ++- .../instances_iam_policies/index.md | 9 +- .../google/bigtableadmin/locations/index.md | 8 +- .../google/bigtableadmin/operations/index.md | 8 +- .../google/bigtableadmin/tables/index.md | 11 ++- .../tables_iam_policies/index.md | 9 +- .../google/billingbudgets/budgets/index.md | 10 +- .../providers/google/billingbudgets/index.md | 4 +- .../binaryauthorization/attestors/index.md | 3 +- .../google/binaryauthorization/index.md | 11 ++- .../binaryauthorization/policies/index.md | 42 ++++++++ .../blockchain_nodes/index.md | 12 ++- .../google/blockchainnodeengine/index.md | 4 +- .../blockchainnodeengine/locations/index.md | 8 +- .../blockchainnodeengine/operations/index.md | 8 +- .../certificate_issuance_configs/index.md | 13 ++- .../certificate_map_entries/index.md | 13 ++- .../certificate_maps/index.md | 10 +- .../certificatemanager/certificates/index.md | 15 ++- .../dns_authorizations/index.md | 11 ++- .../google/certificatemanager/index.md | 4 +- .../certificatemanager/locations/index.md | 8 +- .../certificatemanager/operations/index.md | 8 +- .../certificatemanager/trust_configs/index.md | 11 ++- .../google/cloudasset/assets/index.md | 17 +++- .../google/cloudasset/cloudasset/index.md | 1 + .../cloudasset_iam_policies/index.md | 7 +- .../google/cloudasset/feeds/index.md | 2 - .../providers/google/cloudasset/index.md | 7 +- .../google/cloudasset/saved_queries/index.md | 14 ++- .../cloudbilling/billing_accounts/index.md | 7 +- .../google/cloudbilling/billing_info/index.md | 2 +- .../providers/google/cloudbilling/index.md | 4 +- .../google/cloudbilling/projects/index.md | 7 +- .../google/cloudbilling/services/index.md | 7 +- .../google/cloudbilling/skus/index.md | 11 ++- .../cloudbuild/bitbucket_repos/index.md | 39 ++++++++ .../bitbucket_server_configs/index.md | 13 ++- .../google/cloudbuild/builds/index.md | 33 ++++++- .../google/cloudbuild/gitlab_configs/index.md | 10 +- .../google/cloudbuild/gitlab_repos/index.md | 39 ++++++++ .../providers/google/cloudbuild/index.md | 11 ++- .../google/cloudbuild/triggers/index.md | 31 +++++- .../google/cloudbuild/worker_pools/index.md | 13 ++- .../google/clouddeploy/config/index.md | 2 +- .../clouddeploy/delivery_pipelines/index.md | 15 ++- .../delivery_pipelines_iam_policies/index.md | 2 +- .../providers/google/clouddeploy/index.md | 4 +- .../google/clouddeploy/job_runs/index.md | 17 ++-- .../google/clouddeploy/locations/index.md | 8 +- .../google/clouddeploy/operations/index.md | 8 +- .../google/clouddeploy/releases/index.md | 25 ++++- .../google/clouddeploy/rollouts/index.md | 24 ++++- .../google/clouddeploy/targets/index.md | 20 +++- .../clouddeploy/targets_iam_policies/index.md | 2 +- .../clouderrorreporting/events/index.md | 8 +- .../clouderrorreporting/group_stats/index.md | 13 ++- .../clouderrorreporting/groups/index.md | 2 +- .../google/clouderrorreporting/index.md | 4 +- .../google/cloudfunctions/functions/index.md | 17 +++- .../functions_iam_policies/index.md | 2 +- .../providers/google/cloudfunctions/index.md | 4 +- .../google/cloudfunctions/locations/index.md | 8 +- .../google/cloudfunctions/operations/index.md | 8 +- .../cloudidentity/client_states/index.md | 15 ++- .../cloudidentity/device_users/index.md | 13 ++- .../google/cloudidentity/devices/index.md | 33 ++++++- .../google/cloudidentity/groups/index.md | 13 ++- .../cloudidentity/idp_credentials/index.md | 7 +- .../inbound_saml_sso_profiles/index.md | 1 + .../inbound_sso_assignments/index.md | 5 +- .../providers/google/cloudidentity/index.md | 4 +- .../google/cloudidentity/memberships/index.md | 10 +- .../cloudidentity/userinvitations/index.md | 1 + .../cloudkms/crypto_key_versions/index.md | 20 +++- .../crypto_key_versions_public_key/index.md | 2 +- .../google/cloudkms/crypto_keys/index.md | 15 ++- .../crypto_keys_iam_policies/index.md | 4 +- .../google/cloudkms/ekm_connections/index.md | 1 + .../ekm_connections_iam_policies/index.md | 4 +- .../google/cloudkms/import_jobs/index.md | 9 +- .../import_jobs_iam_policies/index.md | 4 +- .../providers/google/cloudkms/index.md | 4 +- .../google/cloudkms/key_rings/index.md | 1 + .../google/cloudkms/locations/index.md | 8 +- .../providers/google/cloudprofiler/index.md | 2 +- .../effective_tags/index.md | 9 +- .../cloudresourcemanager/folders/index.md | 7 +- .../folders_iam_policies/index.md | 9 +- .../google/cloudresourcemanager/index.md | 6 +- .../cloudresourcemanager/liens/index.md | 9 +- .../organizations/index.md | 2 +- .../organizations_iam_policies/index.md | 9 +- .../cloudresourcemanager/projects/index.md | 13 ++- .../projects_iam_policies/index.md | 9 +- .../tag_bindings/index.md | 7 +- .../cloudresourcemanager/tag_holds/index.md | 8 +- .../cloudresourcemanager/tag_keys/index.md | 13 ++- .../tag_keys_iam_policies/index.md | 9 +- .../cloudresourcemanager/tag_values/index.md | 11 ++- .../tag_values_iam_policies/index.md | 9 +- .../providers/google/cloudscheduler/index.md | 4 +- .../google/cloudscheduler/jobs/index.md | 17 ++-- .../google/cloudscheduler/locations/index.md | 8 +- .../google/cloudshell/environments/index.md | 8 +- .../providers/google/cloudshell/index.md | 4 +- .../google/cloudshell/operations/index.md | 8 +- .../google/cloudsupport/attachments/index.md | 9 +- .../google/cloudsupport/cases/index.md | 19 +--- .../google/cloudsupport/comments/index.md | 8 +- .../providers/google/cloudsupport/index.md | 6 +- .../google/cloudsupport/media/index.md | 7 +- .../providers/google/cloudtasks/index.md | 6 +- .../google/cloudtasks/locations/index.md | 8 +- .../google/cloudtasks/queues/index.md | 1 + .../cloudtasks/queues_iam_policies/index.md | 8 +- .../google/cloudtasks/tasks/index.md | 14 ++- .../providers/google/cloudtrace/index.md | 2 +- .../google/composer/environments/index.md | 10 +- .../google/composer/image_versions/index.md | 9 +- .../providers/google/composer/index.md | 4 +- .../google/composer/operations/index.md | 8 +- .../google/compute/accelerator_types/index.md | 7 +- .../google/compute/addresses/index.md | 23 ++--- .../google/compute/autoscalers/index.md | 13 +-- .../google/compute/backend_buckets/index.md | 11 ++- .../google/compute/backend_services/index.md | 57 +++++------ .../backend_services_iam_policies/index.md | 2 +- .../google/compute/disk_types/index.md | 9 +- .../providers/google/compute/disks/index.md | 59 ++++++------ .../compute/disks_iam_policies/index.md | 2 +- .../compute/external_vpn_gateways/index.md | 7 +- .../google/compute/firewall_policies/index.md | 13 +-- .../firewall_policies_iam_policies/index.md | 4 +- .../compute/firewall_policies_rule/index.md | 14 +-- .../google/compute/firewalls/index.md | 21 ++-- .../google/compute/forwarding_rules/index.md | 47 ++++----- .../google/compute/global_addresses/index.md | 23 ++--- .../compute/global_forwarding_rules/index.md | 45 ++++----- .../global_network_endpoint_groups/index.md | 23 ++--- .../google/compute/global_operations/index.md | 33 +++---- .../global_organization_operations/index.md | 33 +++---- .../global_public_delegated_prefixes/index.md | 11 ++- .../google/compute/health_checks/index.md | 23 ++--- .../compute/http_health_checks/index.md | 11 ++- .../compute/https_health_checks/index.md | 15 +-- .../providers/google/compute/images/index.md | 41 ++++---- .../compute/images_iam_policies/index.md | 2 +- .../providers/google/compute/index.md | 9 +- .../compute/instance_group_managers/index.md | 29 +++--- .../instance_group_managers_errors/index.md | 2 +- .../google/compute/instance_groups/index.md | 13 +-- .../compute/instance_templates/index.md | 7 +- .../instance_templates_iam_policies/index.md | 2 +- .../google/compute/instances/index.md | 65 ++++++------- .../instances_effective_firewalls/index.md | 2 +- .../instances_guest_attributes/index.md | 4 +- .../compute/instances_iam_policies/index.md | 2 +- .../compute/instances_referrers/index.md | 4 +- .../instances_serial_port_output/index.md | 4 +- .../compute/interconnect_attachments/index.md | 59 ++++++------ .../compute/interconnect_locations/index.md | 17 ++-- .../interconnect_remote_locations/index.md | 23 ++--- .../google/compute/interconnects/index.md | 31 +++--- .../google/compute/license_codes/index.md | 8 +- .../google/compute/licenses/index.md | 9 +- .../google/compute/machine_images/index.md | 19 ++-- .../machine_images_iam_policies/index.md | 2 +- .../google/compute/machine_types/index.md | 19 ++-- .../compute/network_attachments/index.md | 13 +-- .../network_attachments_iam_policies/index.md | 4 +- .../network_edge_security_services/index.md | 8 +- .../compute/network_endpoint_groups/index.md | 23 ++--- .../network_firewall_policies/index.md | 13 +-- .../index.md | 2 +- .../network_firewall_policies_rule/index.md | 14 +-- .../google/compute/networks/index.md | 19 ++-- .../google/compute/node_groups/index.md | 17 ++-- .../compute/node_groups_iam_policies/index.md | 4 +- .../google/compute/node_templates/index.md | 13 +-- .../node_templates_iam_policies/index.md | 2 +- .../google/compute/node_types/index.md | 11 ++- .../google/compute/packet_mirrorings/index.md | 13 +-- .../google/compute/projects/index.md | 14 +-- .../public_advertised_prefixes/index.md | 13 +-- .../public_delegated_prefixes/index.md | 13 +-- .../compute/region_autoscalers/index.md | 15 +-- .../compute/region_backend_services/index.md | 61 ++++++------ .../index.md | 4 +- .../compute/region_commitments/index.md | 25 ++--- .../google/compute/region_disk_types/index.md | 9 +- .../google/compute/region_disks/index.md | 63 ++++++------ .../region_disks_iam_policies/index.md | 4 +- .../region_health_check_services/index.md | 11 ++- .../compute/region_health_checks/index.md | 21 ++-- .../region_instance_group_managers/index.md | 29 +++--- .../index.md | 2 +- .../compute/region_instance_groups/index.md | 13 +-- .../region_instance_templates/index.md | 5 +- .../region_network_endpoint_groups/index.md | 17 ++-- .../region_network_firewall_policies/index.md | 17 ++-- .../index.md | 4 +- .../index.md | 16 ++-- .../region_notification_endpoints/index.md | 1 + .../google/compute/region_operations/index.md | 27 +++--- .../compute/region_security_policies/index.md | 17 ++-- .../compute/region_ssl_certificates/index.md | 15 +-- .../compute/region_ssl_policies/index.md | 11 ++- .../region_target_http_proxies/index.md | 11 ++- .../region_target_https_proxies/index.md | 21 ++-- .../region_target_tcp_proxies/index.md | 7 +- .../google/compute/region_url_maps/index.md | 15 +-- .../providers/google/compute/regions/index.md | 11 ++- .../google/compute/reservations/index.md | 13 +-- .../reservations_iam_policies/index.md | 4 +- .../google/compute/resource_policies/index.md | 13 +-- .../resource_policies_iam_policies/index.md | 4 +- .../providers/google/compute/routers/index.md | 13 +-- .../compute/routers_nat_ip_info/index.md | 31 ++++++ .../compute/routers_nat_mapping_info/index.md | 9 +- .../compute/routers_router_status/index.md | 2 +- .../providers/google/compute/routes/index.md | 25 ++--- .../google/compute/security_policies/index.md | 13 +-- .../compute/security_policies_rule/index.md | 10 +- .../compute/service_attachments/index.md | 21 ++-- .../service_attachments_iam_policies/index.md | 2 +- .../google/compute/snapshots/index.md | 39 ++++---- .../compute/snapshots_iam_policies/index.md | 2 +- .../google/compute/ssl_certificates/index.md | 13 +-- .../google/compute/ssl_policies/index.md | 11 ++- .../google/compute/subnetworks/index.md | 31 +++--- .../compute/subnetworks_iam_policies/index.md | 4 +- .../compute/subnetworks_usable/index.md | 12 +-- .../compute/target_grpc_proxies/index.md | 7 +- .../compute/target_http_proxies/index.md | 7 +- .../compute/target_https_proxies/index.md | 19 ++-- .../google/compute/target_instances/index.md | 9 +- .../google/compute/target_pools/index.md | 11 ++- .../compute/target_ssl_proxies/index.md | 11 ++- .../compute/target_tcp_proxies/index.md | 7 +- .../compute/target_vpn_gateways/index.md | 13 +-- .../google/compute/url_maps/index.md | 19 ++-- .../google/compute/vpn_gateways/index.md | 11 ++- .../google/compute/vpn_tunnels/index.md | 27 +++--- .../google/compute/xpn_host/index.md | 16 ++-- .../google/compute/xpn_resources/index.md | 6 +- .../google/compute/zone_operations/index.md | 33 +++---- .../providers/google/compute/zones/index.md | 9 +- .../google/connectors/actions/index.md | 7 +- .../google/connectors/entities/index.md | 5 +- .../google/connectors/entity_types/index.md | 6 +- .../providers/google/connectors/index.md | 4 +- .../contact_centers/index.md | 18 +++- .../google/contactcenteraiplatform/index.md | 11 +-- .../locations/index.md | 8 +- .../operations/index.md | 8 +- .../contactcenterinsights/analyses/index.md | 8 +- .../conversations/index.md | 23 ++++- .../google/contactcenterinsights/index.md | 4 +- .../issue_models/index.md | 10 +- .../contactcenterinsights/issues/index.md | 7 ++ .../contactcenterinsights/operations/index.md | 8 +- .../phrase_matchers/index.md | 14 ++- .../contactcenterinsights/views/index.md | 8 +- .../providers/google/container/index.md | 4 +- .../google/container/node_pools/index.md | 26 ++--- .../google/container/operations/index.md | 16 ++-- .../google/container/server_config/index.md | 4 +- .../container/usable_subnetworks/index.md | 8 +- .../container/zones_serverconfig/index.md | 4 +- .../google/containeranalysis/index.md | 6 +- .../google/containeranalysis/notes/index.md | 27 +++--- .../notes_iam_policies/index.md | 8 +- .../containeranalysis/occurrences/index.md | 24 ++--- .../occurrences_iam_policies/index.md | 8 +- .../occurrences_notes/index.md | 28 +++--- .../document_schemas/index.md | 5 +- .../google/contentwarehouse/index.md | 4 +- .../contentwarehouse/locations/index.md | 7 +- .../contentwarehouse/rule_sets/index.md | 3 +- .../google/contentwarehouse/status/index.md | 2 +- .../contentwarehouse/synonym_sets/index.md | 3 +- .../google/datacatalog/entries/index.md | 30 +++++- .../datacatalog/entries_iam_policies/index.md | 8 +- .../google/datacatalog/entry_groups/index.md | 3 +- .../entry_groups_iam_policies/index.md | 8 +- .../providers/google/datacatalog/index.md | 6 +- .../google/datacatalog/operations/index.md | 8 +- .../google/datacatalog/policy_tags/index.md | 8 +- .../policy_tags_iam_policies/index.md | 8 +- .../tag_templates_iam_policies/index.md | 8 +- .../google/datacatalog/tags/index.md | 9 +- .../google/datacatalog/taxonomies/index.md | 5 +- .../taxonomies_iam_policies/index.md | 8 +- .../providers/google/dataflow/index.md | 4 +- .../providers/google/dataflow/jobs/index.md | 31 +++++- .../dataflow/jobs_execution_details/index.md | 10 +- .../google/dataflow/messages/index.md | 9 +- .../stages_execution_details/index.md | 5 +- .../google/dataflow/templates/index.md | 2 +- .../dataform/compilation_results/index.md | 3 +- .../providers/google/dataform/index.md | 4 +- .../google/dataform/locations/index.md | 8 +- .../google/dataform/release_configs/index.md | 3 +- .../google/dataform/repositories/index.md | 12 ++- .../google/dataform/workflow_configs/index.md | 10 +- .../dataform/workflow_invocations/index.md | 10 +- .../google/dataform/workspaces/index.md | 6 +- .../dataform/workspaces_iam_policies/index.md | 2 +- .../google/datafusion/dns_peerings/index.md | 8 +- .../providers/google/datafusion/index.md | 4 +- .../google/datafusion/instances/index.md | 35 ++++++- .../instances_iam_policies/index.md | 2 +- .../google/datafusion/locations/index.md | 8 +- .../google/datafusion/operations/index.md | 8 +- .../google/datafusion/versions/index.md | 7 +- .../datalabeling/annotated_datasets/index.md | 11 ++- .../annotation_spec_sets/index.md | 3 +- .../google/datalabeling/data_items/index.md | 8 +- .../google/datalabeling/datasets/index.md | 11 ++- .../datalabeling/evaluation_jobs/index.md | 11 ++- .../google/datalabeling/evaluations/index.md | 4 +- .../google/datalabeling/examples/index.md | 1 + .../datalabeling/feedback_messages/index.md | 3 +- .../datalabeling/feedback_threads/index.md | 1 + .../providers/google/datalabeling/index.md | 4 +- .../google/datalabeling/instructions/index.md | 7 +- .../google/datalabeling/operations/index.md | 8 +- .../providers/google/datalineage/index.md | 4 +- .../datalineage/lineage_events/index.md | 1 + .../google/datalineage/operations/index.md | 8 +- .../google/datalineage/processes/index.md | 7 +- .../google/datalineage/runs/index.md | 9 +- .../connection_profiles/index.md | 17 +++- .../connection_profiles_iam_policies/index.md | 2 +- .../conversion_workspaces/index.md | 14 ++- .../index.md | 4 +- .../providers/google/datamigration/index.md | 4 +- .../google/datamigration/locations/index.md | 8 +- .../datamigration/mapping_rules/index.md | 22 ++++- .../datamigration/migration_jobs/index.md | 28 +++++- .../google/datamigration/operations/index.md | 8 +- .../private_connections/index.md | 12 ++- .../private_connections_iam_policies/index.md | 4 +- .../providers/google/datapipelines/index.md | 4 +- .../google/datapipelines/jobs/index.md | 10 +- .../google/datapipelines/pipelines/index.md | 14 ++- .../google/dataplex/actions/index.md | 21 +++- .../aspect_types_iam_policies/index.md | 2 +- .../providers/google/dataplex/assets/index.md | 16 +++- .../dataplex/assets_iam_policies/index.md | 2 +- .../google/dataplex/attributes/index.md | 16 +++- .../dataplex/attributes_iam_policies/index.md | 2 +- .../google/dataplex/content/index.md | 13 ++- .../google/dataplex/contentitems/index.md | 13 ++- .../contentitems_iam_policies/index.md | 4 +- .../dataplex/data_attribute_bindings/index.md | 15 ++- .../google/dataplex/data_scans/index.md | 20 +++- .../dataplex/data_scans_iam_policies/index.md | 2 +- .../google/dataplex/data_taxonomies/index.md | 14 ++- .../google/dataplex/entities/index.md | 19 ++-- .../entry_groups_iam_policies/index.md | 4 +- .../entry_types_iam_policies/index.md | 4 +- .../google/dataplex/environments/index.md | 15 ++- .../environments_iam_policies/index.md | 2 +- .../providers/google/dataplex/index.md | 4 +- .../providers/google/dataplex/jobs/index.md | 15 ++- .../providers/google/dataplex/lakes/index.md | 16 +++- .../dataplex/lakes_iam_policies/index.md | 2 +- .../google/dataplex/locations/index.md | 8 +- .../google/dataplex/operations/index.md | 8 +- .../google/dataplex/partitions/index.md | 7 +- .../google/dataplex/sessions/index.md | 7 +- .../providers/google/dataplex/tasks/index.md | 17 +++- .../dataplex/tasks_iam_policies/index.md | 2 +- .../providers/google/dataplex/zones/index.md | 15 ++- .../dataplex/zones_iam_policies/index.md | 2 +- .../dataproc/autoscaling_policies/index.md | 10 +- .../index.md | 10 +- .../google/dataproc/batches/index.md | 20 +++- .../google/dataproc/clusters/index.md | 12 ++- .../dataproc/clusters_iam_policies/index.md | 8 +- .../providers/google/dataproc/index.md | 6 +- .../providers/google/dataproc/jobs/index.md | 25 ++++- .../dataproc/jobs_iam_policies/index.md | 8 +- .../google/dataproc/operations/index.md | 9 +- .../dataproc/operations_iam_policies/index.md | 8 +- .../dataproc/workflow_templates/index.md | 14 ++- .../workflow_templates_iam_policies/index.md | 10 +- .../providers/google/datastore/index.md | 4 +- .../google/datastore/indexes/index.md | 3 +- .../google/datastore/operations/index.md | 8 +- .../datastream/connection_profiles/index.md | 17 +++- .../providers/google/datastream/index.md | 4 +- .../google/datastream/locations/index.md | 8 +- .../google/datastream/objects/index.md | 10 +- .../google/datastream/operations/index.md | 8 +- .../datastream/private_connections/index.md | 12 ++- .../google/datastream/routes/index.md | 11 ++- .../google/datastream/streams/index.md | 16 +++- .../deploymentmanager/deployments/index.md | 11 ++- .../deployments_iam_policies/index.md | 2 +- .../google/deploymentmanager/index.md | 4 +- .../deploymentmanager/manifests/index.md | 13 ++- .../deploymentmanager/operations/index.md | 33 +++---- .../deploymentmanager/resources/index.md | 15 ++- .../google/deploymentmanager/types/index.md | 8 +- .../google/dialogflow/agents/index.md | 19 ++-- .../google/dialogflow/changelogs/index.md | 3 +- .../continuous_test_results/index.md | 7 +- .../google/dialogflow/deployments/index.md | 9 +- .../google/dialogflow/entity_types/index.md | 14 ++- .../google/dialogflow/environments/index.md | 3 +- .../google/dialogflow/experiments/index.md | 18 +++- .../google/dialogflow/flows/index.md | 3 +- .../flows_validation_result/index.md | 2 +- .../providers/google/dialogflow/index.md | 4 +- .../google/dialogflow/intents/index.md | 11 ++- .../google/dialogflow/locations/index.md | 8 +- .../google/dialogflow/operations/index.md | 9 +- .../google/dialogflow/pages/index.md | 10 +- .../google/dialogflow/results/index.md | 8 +- .../dialogflow/security_settings/index.md | 11 ++- .../google/dialogflow/test_cases/index.md | 3 +- .../transition_route_groups/index.md | 12 ++- .../google/dialogflow/versions/index.md | 9 +- .../google/dialogflow/webhooks/index.md | 3 +- .../google/discoveryengine/documents/index.md | 10 +- .../providers/google/discoveryengine/index.md | 4 +- .../discoveryengine/operations/index.md | 18 +++- .../search_engine_operations/index.md | 8 +- .../target_site_operations/index.md | 8 +- .../google/dlp/deidentify_templates/index.md | 12 ++- .../providers/google/dlp/dlp_jobs/index.md | 16 +++- .../google-docs/providers/google/dlp/index.md | 4 +- .../google/dlp/inspect_templates/index.md | 12 ++- .../google/dlp/job_triggers/index.md | 15 ++- .../google/dlp/stored_info_types/index.md | 9 +- .../providers/google/dns/changes/index.md | 12 ++- .../providers/google/dns/dns_keys/index.md | 16 +++- .../google-docs/providers/google/dns/index.md | 6 +- .../dns/managed_zone_operations/index.md | 13 ++- .../google/dns/managed_zones/index.md | 22 ++++- .../dns/managed_zones_iam_policies/index.md | 9 +- .../providers/google/dns/policies/index.md | 13 ++- .../providers/google/dns/projects/index.md | 2 +- .../google/dns/resource_record_sets/index.md | 12 ++- .../google/dns/response_policies/index.md | 11 ++- .../google/dns/response_policy_rules/index.md | 5 +- .../google/documentai/evaluations/index.md | 10 +- .../providers/google/documentai/index.md | 4 +- .../google/documentai/locations/index.md | 8 +- .../google/documentai/operations/index.md | 8 +- .../documentai/processor_types/index.md | 3 +- .../documentai/processor_versions/index.md | 13 ++- .../google/documentai/processors/index.md | 9 +- .../providers/google/domains/index.md | 4 +- .../google/domains/locations/index.md | 8 +- .../google/domains/operations/index.md | 8 +- .../google/domains/registrations/index.md | 17 +++- .../registrations_iam_policies/index.md | 2 +- .../essentialcontacts/contacts/index.md | 11 ++- .../google/essentialcontacts/index.md | 4 +- .../eventarc/channel_connections/index.md | 10 +- .../channel_connections_iam_policies/index.md | 2 +- .../google/eventarc/channels/index.md | 13 ++- .../eventarc/channels_iam_policies/index.md | 2 +- .../eventarc/google_channel_config/index.md | 2 +- .../providers/google/eventarc/index.md | 4 +- .../google/eventarc/locations/index.md | 8 +- .../google/eventarc/operations/index.md | 8 +- .../google/eventarc/providers/index.md | 7 +- .../google/eventarc/triggers/index.md | 17 +++- .../eventarc/triggers_iam_policies/index.md | 4 +- .../providers/google/file/backups/index.md | 17 +++- .../providers/google/file/index.md | 4 +- .../providers/google/file/instances/index.md | 17 +++- .../providers/google/file/locations/index.md | 8 +- .../providers/google/file/operations/index.md | 8 +- .../providers/google/file/snapshots/index.md | 9 +- .../firestore/backup_schedules/index.md | 8 -- .../google/firestore/backups/index.md | 4 +- .../google/firestore/documents/index.md | 11 ++- .../google/firestore/fields/index.md | 6 +- .../providers/google/firestore/index.md | 11 +-- .../google/firestore/indexes/index.md | 3 +- .../google/firestore/locations/index.md | 8 +- .../google/firestore/operations/index.md | 8 +- .../index.md | 4 +- .../providers/google/gameservices/index.md | 4 +- .../google/gameservices/locations/index.md | 8 +- .../google/gameservices/operations/index.md | 8 +- .../google/gkebackup/backup_plans/index.md | 19 +++- .../google/gkebackup/backups/index.md | 30 +++++- .../gkebackup/backups_iam_policies/index.md | 4 +- .../providers/google/gkebackup/index.md | 4 +- .../google/gkebackup/locations/index.md | 8 +- .../google/gkebackup/operations/index.md | 8 +- .../google/gkebackup/restore_plans/index.md | 16 +++- .../restore_plans_iam_policies/index.md | 2 +- .../google/gkebackup/restores/index.md | 21 +++- .../gkebackup/restores_iam_policies/index.md | 2 +- .../google/gkebackup/volume_backups/index.md | 16 +++- .../volume_backups_iam_policies/index.md | 2 +- .../google/gkebackup/volume_restores/index.md | 15 +-- .../volume_restores_iam_policies/index.md | 2 +- .../providers/google/gkehub/bindings/index.md | 12 ++- .../providers/google/gkehub/features/index.md | 16 +++- .../gkehub/features_iam_policies/index.md | 2 +- .../providers/google/gkehub/fleets/index.md | 12 ++- .../providers/google/gkehub/index.md | 12 ++- .../google/gkehub/locations/index.md | 8 +- .../google/gkehub/memberships/index.md | 6 +- .../gkehub/memberships_iam_policies/index.md | 4 +- .../google/gkehub/namespaces/index.md | 47 +++++++++ .../google/gkehub/operations/index.md | 8 +- .../google/gkehub/rbacrolebindings/index.md | 48 ++++++++++ .../providers/google/gkehub/scopes/index.md | 12 ++- .../bare_metal_admin_clusters/index.md | 32 ++++++- .../gkeonprem/bare_metal_clusters/index.md | 35 ++++++- .../bare_metal_clusters_iam_policies/index.md | 2 +- .../gkeonprem/bare_metal_node_pools/index.md | 17 +++- .../providers/google/gkeonprem/index.md | 4 +- .../google/gkeonprem/locations/index.md | 8 +- .../google/gkeonprem/operations/index.md | 14 ++- .../gkeonprem/vmware_admin_clusters/index.md | 28 +++++- .../google/gkeonprem/vmware_clusters/index.md | 33 ++++++- .../vmware_clusters_iam_policies/index.md | 2 +- .../gkeonprem/vmware_node_pools/index.md | 18 +++- .../vmware_node_pools_iam_policies/index.md | 2 +- .../healthcare/attribute_definitions/index.md | 9 +- .../healthcare/consent_artifacts/index.md | 11 ++- .../google/healthcare/consent_stores/index.md | 7 +- .../google/healthcare/consents/index.md | 13 ++- .../healthcare/consents_revisions/index.md | 13 ++- .../google/healthcare/datasets/index.md | 1 + .../healthcare/datasets_iam_policies/index.md | 2 +- .../google/healthcare/dicom_stores/index.md | 7 +- .../dicom_stores_iam_policies/index.md | 2 +- .../google/healthcare/fhir_stores/index.md | 15 ++- .../fhir_stores_iam_policies/index.md | 4 +- .../google/healthcare/hl7_v2_stores/index.md | 8 +- .../hl7_v2_stores_iam_policies/index.md | 2 +- .../providers/google/healthcare/index.md | 4 +- .../google/healthcare/locations/index.md | 8 +- .../google/healthcare/messages/index.md | 13 ++- .../google/healthcare/operations/index.md | 8 +- .../healthcare/user_data_mappings/index.md | 9 +- .../google-docs/providers/google/iam/index.md | 10 +- .../providers/google/iam/policies/index.md | 16 ++++ .../providers/google/iamcredentials/index.md | 2 +- .../providers/google/iap/dest_groups/index.md | 6 +- .../google/iap/iap_iam_policies/index.md | 8 +- .../iap/identity_aware_proxy_clients/index.md | 1 + .../google-docs/providers/google/iap/index.md | 6 +- .../providers/google/identitytoolkit/index.md | 2 +- .../relyingparty_project_config/index.md | 14 +-- .../providers/google/ids/endpoints/index.md | 16 +++- .../google-docs/providers/google/ids/index.md | 4 +- .../providers/google/ids/locations/index.md | 8 +- .../providers/google/ids/operations/index.md | 8 +- .../google/integrations/auth_configs/index.md | 22 +++-- .../google/integrations/certificates/index.md | 7 +- .../google/integrations/connections/index.md | 29 +++++- .../index.md | 2 +- .../google/integrations/executions/index.md | 17 +++- .../providers/google/integrations/index.md | 4 +- .../google/integrations/integrations/index.md | 8 +- .../runtime_action_schemas/index.md | 6 +- .../runtime_entity_schemas/index.md | 6 +- .../integrations/sfdc_channels/index.md | 13 ++- .../integrations/sfdc_instances/index.md | 13 ++- .../google/integrations/suspensions/index.md | 14 ++- .../google/integrations/versions/index.md | 20 +++- .../providers/google/jobs/companies/index.md | 17 +++- .../providers/google/jobs/index.md | 4 +- .../providers/google/jobs/jobs/index.md | 34 ++++++- .../providers/google/jobs/tenants/index.md | 1 + .../google/kmsinventory/crypto_keys/index.md | 14 ++- .../providers/google/kmsinventory/index.md | 4 +- .../providers/google/language/index.md | 2 +- .../google/libraryagent/books/index.md | 3 +- .../providers/google/libraryagent/index.md | 4 +- .../google/libraryagent/shelves/index.md | 5 +- .../providers/google/lifesciences/index.md | 4 +- .../google/lifesciences/locations/index.md | 8 +- .../google/lifesciences/operations/index.md | 8 +- .../billing_accounts_settings/index.md | 4 +- .../providers/google/logging/buckets/index.md | 13 ++- .../google/logging/buckets_async/index.md | 1 + .../google/logging/cmek_settings/index.md | 2 +- .../google/logging/exclusions/index.md | 5 + .../providers/google/logging/index.md | 4 +- .../providers/google/logging/links/index.md | 7 +- .../google/logging/locations/index.md | 12 ++- .../logging/logging_cmek_settings/index.md | 2 +- .../providers/google/logging/logs/index.md | 13 ++- .../providers/google/logging/metrics/index.md | 15 ++- .../monitored_resource_descriptors/index.md | 9 +- .../google/logging/operations/index.md | 13 ++- .../google/logging/settings/index.md | 4 +- .../providers/google/logging/sinks/index.md | 19 +++- .../providers/google/logging/views/index.md | 12 ++- .../google/managedidentities/backups/index.md | 11 ++- .../backups_iam_policies/index.md | 2 +- .../google/managedidentities/domains/index.md | 17 +++- .../domains_iam_policies/index.md | 2 +- .../domains_ldapssettings/index.md | 2 +- .../google/managedidentities/index.md | 4 +- .../managedidentities/locations/index.md | 8 +- .../managedidentities/operations/index.md | 8 +- .../managedidentities/peerings/index.md | 12 ++- .../sql_integrations/index.md | 1 + .../providers/google/memcache/index.md | 4 +- .../google/memcache/instances/index.md | 23 ++++- .../google/memcache/locations/index.md | 8 +- .../google/memcache/operations/index.md | 8 +- .../google/metastore/backups/index.md | 3 +- .../metastore/backups_iam_policies/index.md | 2 +- .../google/metastore/federations/index.md | 14 ++- .../federations_iam_policies/index.md | 4 +- .../providers/google/metastore/index.md | 4 +- .../google/metastore/locations/index.md | 8 +- .../metastore/metadata_imports/index.md | 11 ++- .../google/metastore/operations/index.md | 8 +- .../google/metastore/services/index.md | 25 ++++- .../metastore/services_iam_policies/index.md | 4 +- .../google/migrationcenter/assets/index.md | 14 ++- .../migrationcenter/error_frames/index.md | 3 +- .../google/migrationcenter/groups/index.md | 10 +- .../import_data_files/index.md | 10 +- .../migrationcenter/import_jobs/index.md | 14 ++- .../providers/google/migrationcenter/index.md | 4 +- .../google/migrationcenter/locations/index.md | 8 +- .../migrationcenter/operations/index.md | 8 +- .../migrationcenter/preference_sets/index.md | 10 +- .../migrationcenter/report_configs/index.md | 10 +- .../google/migrationcenter/reports/index.md | 3 +- .../google/migrationcenter/sources/index.md | 15 ++- .../providers/google/ml/config/index.md | 2 +- docs/google-docs/providers/google/ml/index.md | 4 +- .../providers/google/ml/jobs/index.md | 16 +++- .../google/ml/jobs_iam_policies/index.md | 4 +- .../providers/google/ml/locations/index.md | 5 +- .../providers/google/ml/models/index.md | 11 ++- .../google/ml/models_iam_policies/index.md | 2 +- .../providers/google/ml/operations/index.md | 8 +- .../providers/google/ml/studies/index.md | 7 -- .../providers/google/ml/versions/index.md | 29 +++++- .../google/monitoring/alert_policies/index.md | 16 +++- .../google/monitoring/groups/index.md | 3 +- .../providers/google/monitoring/index.md | 4 +- .../google/monitoring/members/index.md | 6 +- .../monitoring/metric_descriptors/index.md | 14 ++- .../monitored_resource_descriptors/index.md | 9 +- .../notification_channel_descriptors/index.md | 10 +- .../monitoring/notification_channels/index.md | 14 ++- .../service_level_objectives/index.md | 13 ++- .../google/monitoring/services/index.md | 21 +++- .../google/monitoring/snoozes/index.md | 7 +- .../google/monitoring/time_series/index.md | 14 ++- .../monitoring/uptime_check_configs/index.md | 19 +++- .../monitoring/uptime_check_ips/index.md | 6 +- .../networkconnectivity/groups/index.md | 42 ++++++++ .../groups_iam_policies/index.md | 2 +- .../google/networkconnectivity/hubs/index.md | 14 ++- .../google/networkconnectivity/index.md | 6 +- .../internal_ranges/index.md | 17 +++- .../networkconnectivity/locations/index.md | 8 +- .../networkconnectivity/operations/index.md | 8 +- .../policy_based_routes_iam_policies/index.md | 2 +- .../networkconnectivity/route_tables/index.md | 11 ++- .../networkconnectivity/routes/index.md | 16 +++- .../service_classes/index.md | 11 ++- .../service_connection_maps/index.md | 17 +++- .../service_connection_policies/index.md | 15 ++- .../index.md | 2 +- .../service_connection_tokens/index.md | 13 ++- .../networkconnectivity/spokes/index.md | 21 +++- .../spokes_iam_policies/index.md | 2 +- .../connectivity_tests/index.md | 15 ++- .../connectivity_tests_iam_policies/index.md | 2 +- .../google/networkmanagement/index.md | 4 +- .../networkmanagement/locations/index.md | 8 +- .../networkmanagement/operations/index.md | 8 +- .../networksecurity/address_groups/index.md | 13 ++- .../address_groups_iam_policies/index.md | 2 +- .../address_groups_references/index.md | 6 +- .../authorization_policies/index.md | 10 +- .../client_tls_policies/index.md | 11 ++- .../gateway_security_policies/index.md | 3 +- .../providers/google/networksecurity/index.md | 4 +- .../google/networksecurity/locations/index.md | 8 +- .../networksecurity/operations/index.md | 9 +- .../google/networksecurity/rules/index.md | 9 +- .../server_tls_policies/index.md | 11 ++- .../tls_inspection_policies/index.md | 11 ++- .../google/networksecurity/url_lists/index.md | 1 + .../edge_cache_keysets_iam_policies/index.md | 2 +- .../edge_cache_origins_iam_policies/index.md | 2 +- .../edge_cache_services_iam_policies/index.md | 4 +- .../endpoint_policies/index.md | 14 ++- .../endpoint_policies_iam_policies/index.md | 2 +- .../google/networkservices/gateways/index.md | 19 +++- .../networkservices/grpc_routes/index.md | 13 ++- .../networkservices/http_routes/index.md | 13 ++- .../providers/google/networkservices/index.md | 4 +- .../google/networkservices/locations/index.md | 8 +- .../google/networkservices/meshes/index.md | 10 +- .../meshes_iam_policies/index.md | 2 +- .../networkservices/operations/index.md | 8 +- .../networkservices/service_bindings/index.md | 10 +- .../networkservices/tcp_routes/index.md | 12 ++- .../networkservices/tls_routes/index.md | 7 +- .../providers/google/notebooks/index.md | 4 +- .../google/notebooks/instances/index.md | 18 +++- .../notebooks/instances_iam_policies/index.md | 2 +- .../google/notebooks/locations/index.md | 8 +- .../google/notebooks/operations/index.md | 8 +- .../google/ondemandscanning/index.md | 4 +- .../ondemandscanning/operations/index.md | 8 +- .../ondemandscanning/vulnerabilities/index.md | 22 ++++- .../google/orgpolicy/constraints/index.md | 12 ++- .../orgpolicy/custom_constraints/index.md | 3 +- .../providers/google/orgpolicy/index.md | 4 +- .../google/orgpolicy/policies/index.md | 9 +- .../policies_effective_policy/index.md | 4 +- .../providers/google/osconfig/index.md | 4 +- .../google/osconfig/instance_details/index.md | 8 +- .../google/osconfig/inventories/index.md | 7 +- .../osconfig/os_policy_assignments/index.md | 13 +-- .../os_policy_assignments_revisions/index.md | 16 +++- .../osconfig/patch_deployments/index.md | 13 +-- .../google/osconfig/patch_jobs/index.md | 19 ++-- .../providers/google/osconfig/report/index.md | 2 +- .../google/osconfig/reports/index.md | 9 +- .../osconfig/vulnerability_reports/index.md | 6 +- .../providers/google/oslogin/index.md | 2 +- .../google/oslogin/ssh_public_keys/index.md | 2 +- .../providers/google/places/index.md | 2 +- .../providers/google/policyanalyzer/index.md | 2 +- .../providers/google/policysimulator/index.md | 4 +- .../policysimulator/operations/index.md | 11 ++- .../google/policysimulator/replays/index.md | 2 +- .../google/policysimulator/results/index.md | 11 ++- .../google/policytroubleshooter/index.md | 2 +- .../google/privateca/ca_pools/index.md | 9 +- .../privateca/ca_pools_iam_policies/index.md | 2 +- .../certificate_authorities/index.md | 21 +++- .../certificate_revocation_lists/index.md | 14 ++- .../index.md | 2 +- .../privateca/certificate_templates/index.md | 12 ++- .../index.md | 2 +- .../google/privateca/certificates/index.md | 18 +++- .../providers/google/privateca/index.md | 4 +- .../google/privateca/locations/index.md | 8 +- .../google/privateca/operations/index.md | 8 +- .../prod_tt_sasportal/customer_node/index.md | 2 +- .../prod_tt_sasportal/customer_nodes/index.md | 7 +- .../prod_tt_sasportal/customers/index.md | 1 + .../prod_tt_sasportal/deployments/index.md | 6 +- .../google/prod_tt_sasportal/devices/index.md | 18 ++-- .../google/prod_tt_sasportal/index.md | 4 +- .../google/prod_tt_sasportal/nodes/index.md | 7 +- .../providers/google/publicca/index.md | 2 +- .../providers/google/pubsub/index.md | 4 +- .../providers/google/pubsub/schemas/index.md | 1 + .../pubsub/schemas_iam_policies/index.md | 2 +- .../google/pubsub/schemas_revisions/index.md | 8 +- .../google/pubsub/snapshots/index.md | 8 +- .../google/pubsub/subscriptions/index.md | 6 +- .../subscriptions_iam_policies/index.md | 2 +- .../providers/google/pubsub/topics/index.md | 10 +- .../pubsub/topics_iam_policies/index.md | 2 +- .../google/pubsublite/cursors/index.md | 5 +- .../providers/google/pubsublite/index.md | 4 +- .../google/pubsublite/operations/index.md | 8 +- .../google/pubsublite/reservations/index.md | 5 +- .../google/pubsublite/subscriptions/index.md | 8 +- .../google/pubsublite/topics/index.md | 6 +- .../firewallpolicies/index.md | 8 +- .../google/recaptchaenterprise/index.md | 4 +- .../google/recaptchaenterprise/keys/index.md | 12 ++- .../recaptchaenterprise/keys_metrics/index.md | 2 +- .../recaptchaenterprise/memberships/index.md | 5 +- .../relatedaccountgroups/index.md | 5 +- .../catalog_items/index.md | 12 ++- .../recommendationengine/catalogs/index.md | 7 +- .../google/recommendationengine/index.md | 4 +- .../recommendationengine/operations/index.md | 9 +- .../prediction_api_key_registrations/index.md | 5 +- .../recommendationengine/user_events/index.md | 9 +- .../providers/google/recommender/index.md | 4 +- .../google/recommender/insights/index.md | 18 +++- .../recommender/recommendations/index.md | 18 +++- .../providers/google/redis/index.md | 4 +- .../providers/google/redis/instances/index.md | 39 +++++++- .../providers/google/redis/locations/index.md | 8 +- .../google/redis/operations/index.md | 8 +- .../google/resourcesettings/index.md | 4 +- .../google/resourcesettings/settings/index.md | 5 +- .../providers/google/retail/catalogs/index.md | 6 +- .../catalogs_completion_config/index.md | 12 +-- .../providers/google/retail/controls/index.md | 5 +- .../providers/google/retail/index.md | 4 +- .../providers/google/retail/models/index.md | 18 +++- .../google/retail/operations/index.md | 10 +- .../providers/google/retail/products/index.md | 37 ++++++- .../google/retail/serving_configs/index.md | 22 ++++- .../providers/google/run/executions/index.md | 30 +++++- .../google-docs/providers/google/run/index.md | 4 +- .../providers/google/run/jobs/index.md | 27 +++++- .../providers/google/run/operations/index.md | 8 +- .../providers/google/run/revisions/index.md | 32 ++++++- .../providers/google/run/services/index.md | 33 ++++++- .../google/run/services_iam_policies/index.md | 2 +- .../providers/google/run/tasks/index.md | 33 ++++++- .../providers/google/runtimeconfig/index.md | 4 +- .../google/runtimeconfig/operations/index.md | 8 +- .../google/sasportal/customer_nodes/index.md | 7 +- .../google/sasportal/customers/index.md | 1 + .../google/sasportal/deployments/index.md | 10 +- .../google/sasportal/devices/index.md | 19 +++- .../providers/google/sasportal/index.md | 4 +- .../providers/google/sasportal/nodes/index.md | 7 +- .../providers/google/secretmanager/index.md | 4 +- .../google/secretmanager/locations/index.md | 8 +- .../google/secretmanager/secrets/index.md | 15 ++- .../secrets_iam_policies/index.md | 2 +- .../google/secretmanager/versions/index.md | 11 ++- .../google/securitycenter/assets/index.md | 9 +- .../securitycenter/attack_paths/index.md | 8 +- .../securitycenter/big_query_exports/index.md | 13 ++- .../custom_modules_descendant/index.md | 12 ++- .../effective_custom_modules/index.md | 3 + .../event_threat_detection_modules/index.md | 11 ++- .../google/securitycenter/findings/index.md | 10 +- .../providers/google/securitycenter/index.md | 6 +- .../securitycenter/mute_configs/index.md | 5 +- .../notification_configs/index.md | 5 +- .../google/securitycenter/operations/index.md | 8 +- .../organization_settings/index.md | 2 +- .../resource_value_configs/index.md | 12 ++- .../index.md | 7 +- .../securitycenter/simulations/index.md | 2 +- .../google/securitycenter/sources/index.md | 9 +- .../sources_iam_policies/index.md | 9 +- .../securitycenter/valued_resources/index.md | 12 ++- .../google/serviceconsumermanagement/index.md | 4 +- .../operations/index.md | 8 +- .../tenancy_units/index.md | 8 +- .../providers/google/servicecontrol/index.md | 2 +- .../servicedirectory/endpoints/index.md | 9 +- .../google/servicedirectory/index.md | 6 +- .../servicedirectory/locations/index.md | 8 +- .../servicedirectory/namespaces/index.md | 6 +- .../namespaces_iam_policies/index.md | 8 +- .../google/servicedirectory/services/index.md | 7 +- .../services_iam_policies/index.md | 8 +- .../google/servicemanagement/configs/index.md | 31 +++++- .../consumers_iam_policies/index.md | 9 +- .../google/servicemanagement/index.md | 6 +- .../servicemanagement/operations/index.md | 8 +- .../servicemanagement/rollouts/index.md | 10 +- .../servicemanagement/services/index.md | 3 +- .../services_config/index.md | 36 +++---- .../services_iam_policies/index.md | 9 +- .../servicenetworking/dns_zones/index.md | 7 +- .../google/servicenetworking/index.md | 9 +- .../servicenetworking/networks/index.md | 16 ++-- .../servicenetworking/operations/index.md | 8 +- .../providers/google/serviceusage/index.md | 4 +- .../google/serviceusage/operations/index.md | 8 +- .../google/serviceusage/services/index.md | 2 +- .../providers/google/sourcerepo/index.md | 4 +- .../google/sourcerepo/repos/index.md | 8 +- .../google/spanner/backup_operations/index.md | 8 +- .../providers/google/spanner/backups/index.md | 17 ++-- .../spanner/backups_iam_policies/index.md | 8 +- .../spanner/database_operations/index.md | 8 +- .../google/spanner/database_roles/index.md | 5 +- .../google/spanner/databases/index.md | 15 +-- .../google/spanner/databases_ddl/index.md | 2 +- .../spanner/databases_iam_policies/index.md | 8 +- .../providers/google/spanner/index.md | 6 +- .../instance_config_operations/index.md | 8 +- .../google/spanner/instance_configs/index.md | 15 ++- .../google/spanner/instances/index.md | 16 +++- .../spanner/instances_iam_policies/index.md | 8 +- .../google/spanner/operations/index.md | 12 ++- .../providers/google/spanner/scans/index.md | 8 +- .../google/spanner/sessions/index.md | 8 +- .../google/speech/custom_classes/index.md | 8 ++ .../providers/google/speech/index.md | 4 +- .../google/speech/operations/index.md | 8 +- .../google/speech/phrase_sets/index.md | 5 +- .../google/sqladmin/backup_runs/index.md | 21 ++-- .../google/sqladmin/connect/index.md | 6 +- .../google/sqladmin/databases/index.md | 12 +-- .../providers/google/sqladmin/flags/index.md | 8 +- .../providers/google/sqladmin/index.md | 4 +- .../google/sqladmin/instances/index.md | 57 +++++------ .../instances_disk_shrink_config/index.md | 2 +- .../sqladmin/instances_server_cas/index.md | 2 +- .../google/sqladmin/operations/index.md | 23 ++--- .../google/sqladmin/ssl_certs/index.md | 10 +- .../providers/google/sqladmin/users/index.md | 11 ++- .../storage/bucket_access_controls/index.md | 12 +-- .../providers/google/storage/buckets/index.md | 43 +++++---- .../storage/buckets_iam_policies/index.md | 4 +- .../default_object_access_controls/index.md | 14 +-- .../google/storage/hmac_keys/index.md | 9 +- .../providers/google/storage/index.md | 4 +- .../google/storage/notifications/index.md | 10 +- .../storage/object_access_controls/index.md | 12 +-- .../providers/google/storage/objects/index.md | 35 +------ .../storage/objects_iam_policies/index.md | 2 +- .../google/storage/service_account/index.md | 2 +- .../storagetransfer/agent_pools/index.md | 3 +- .../providers/google/storagetransfer/index.md | 4 +- .../storagetransfer/transfer_jobs/index.md | 16 +++- .../transfer_operations/index.md | 8 +- .../providers/google/testing/index.md | 2 +- .../testing/test_environment_catalog/index.md | 2 +- .../google/testing/test_matrices/index.md | 16 ++-- .../providers/google/texttospeech/index.md | 4 +- .../google/texttospeech/operations/index.md | 8 +- .../google/tpu/accelerator_types/index.md | 3 +- .../google-docs/providers/google/tpu/index.md | 4 +- .../providers/google/tpu/locations/index.md | 8 +- .../providers/google/tpu/nodes/index.md | 28 +++++- .../providers/google/tpu/operations/index.md | 8 +- .../google/tpu/runtime_versions/index.md | 6 +- .../providers/google/trafficdirector/index.md | 2 +- .../providers/google/transcoder/index.md | 4 +- .../google/transcoder/job_templates/index.md | 7 +- .../providers/google/transcoder/jobs/index.md | 19 +++- .../google/translate/datasets/index.md | 13 ++- .../google/translate/examples/index.md | 7 +- .../google/translate/glossaries/index.md | 7 +- .../translate/glossary_entries/index.md | 7 +- .../providers/google/translate/index.md | 4 +- .../google/translate/locations/index.md | 8 +- .../google/translate/models/index.md | 13 ++- .../google/translate/operations/index.md | 8 +- .../google/videointelligence/index.md | 4 +- .../videointelligence/operations/index.md | 8 +- .../providers/google/vision/index.md | 4 +- .../google/vision/operations/index.md | 8 +- .../google/vision/product_sets/index.md | 7 +- .../providers/google/vision/products/index.md | 9 +- .../google/vision/reference_images/index.md | 1 + .../google/vmmigration/clone_jobs/index.md | 13 ++- .../google/vmmigration/cutover_jobs/index.md | 15 ++- .../datacenter_connectors/index.md | 18 +++- .../google/vmmigration/groups/index.md | 1 + .../providers/google/vmmigration/index.md | 4 +- .../google/vmmigration/locations/index.md | 8 +- .../google/vmmigration/migrating_vms/index.md | 25 ++++- .../google/vmmigration/operations/index.md | 8 +- .../vmmigration/replication_cycles/index.md | 14 ++- .../google/vmmigration/sources/index.md | 11 ++- .../vmmigration/target_projects/index.md | 9 +- .../vmmigration/utilization_reports/index.md | 9 +- .../google/vpcaccess/connectors/index.md | 11 ++- .../providers/google/vpcaccess/index.md | 4 +- .../google/vpcaccess/locations/index.md | 8 +- .../google/vpcaccess/operations/index.md | 8 +- .../providers/google/webrisk/index.md | 4 +- .../google/webrisk/operations/index.md | 8 +- .../websecurityscanner/crawled_urls/index.md | 6 +- .../websecurityscanner/findings/index.md | 21 +++- .../google/websecurityscanner/index.md | 4 +- .../websecurityscanner/scan_configs/index.md | 17 ++-- .../websecurityscanner/scan_runs/index.md | 13 +-- .../workflowexecutions/executions/index.md | 16 +++- .../google/workflowexecutions/index.md | 4 +- .../providers/google/workflows/index.md | 4 +- .../google/workflows/locations/index.md | 8 +- .../google/workflows/operations/index.md | 8 +- .../google/workflows/workflows/index.md | 18 +++- .../workloadmanager/evaluations/index.md | 15 ++- .../workloadmanager/executions/index.md | 12 ++- .../providers/google/workloadmanager/index.md | 4 +- .../google/workloadmanager/locations/index.md | 8 +- .../workloadmanager/operations/index.md | 8 +- .../google/workloadmanager/results/index.md | 9 +- .../google/workloadmanager/rules/index.md | 13 ++- .../scanned_resources/index.md | 5 +- .../providers/google/workstations/index.md | 4 +- .../google/workstations/operations/index.md | 8 +- .../workstation_clusters/index.md | 20 +++- .../workstations/workstation_configs/index.md | 24 ++++- .../workstation_configs_usable/index.md | 24 ++++- .../google/workstations/workstations/index.md | 17 +++- .../workstations_iam_policies/index.md | 2 +- .../workstations/workstations_usable/index.md | 17 +++- 1232 files changed, 10992 insertions(+), 3539 deletions(-) create mode 100644 docs/google-docs/providers/google/aiplatform/annotation_specs/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/annotations/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/artifacts/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/batch_prediction_jobs/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/contexts/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/contexts_context_artifacts_and_executions/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/contexts_context_children/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/custom_jobs/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/data_items/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/data_labeling_jobs/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/datasets/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/endpoints/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/entity_types/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/entity_types_feature_values/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/entity_types_iam_policies/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/evaluations/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/executions/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/executions_execution_events/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/experiments/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/features/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/featurestores/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/featurestores_iam_policies/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/hyperparameter_tuning_jobs/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/index_endpoints/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/indexes/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/indexes_datapoints/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/locations/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/metadata_schemas/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/metadata_stores/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/migratable_resources/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/model_deployment_monitoring_jobs/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/models/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/models_explanation_dataset/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/models_version/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/models_versions/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/nas_jobs/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/nas_trial_details/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/operations/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/runs/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/saved_queries/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/schedules/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/slices/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/specialist_pools/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/studies/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/tensorboards/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/time_series/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/training_pipelines/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/trials/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/trials_optimal_trials/index.md create mode 100644 docs/google-docs/providers/google/aiplatform/trials_trial_measurement/index.md create mode 100644 docs/google-docs/providers/google/analyticshub/data_exchanges_subscriptions/index.md create mode 100644 docs/google-docs/providers/google/analyticshub/listings_subscriptions/index.md create mode 100644 docs/google-docs/providers/google/analyticshub/subscriptions/index.md create mode 100644 docs/google-docs/providers/google/bigquery/tables_iam_policies/index.md create mode 100644 docs/google-docs/providers/google/binaryauthorization/policies/index.md create mode 100644 docs/google-docs/providers/google/cloudbuild/bitbucket_repos/index.md create mode 100644 docs/google-docs/providers/google/cloudbuild/gitlab_repos/index.md create mode 100644 docs/google-docs/providers/google/compute/routers_nat_ip_info/index.md create mode 100644 docs/google-docs/providers/google/gkehub/namespaces/index.md create mode 100644 docs/google-docs/providers/google/gkehub/rbacrolebindings/index.md create mode 100644 docs/google-docs/providers/google/networkconnectivity/groups/index.md diff --git a/docs/google-docs/index.md b/docs/google-docs/index.md index f7f7df60df..3c3d159a82 100644 --- a/docs/google-docs/index.md +++ b/docs/google-docs/index.md @@ -17,16 +17,16 @@ slug: /providers/google --- Cloud computing services offered by Google. -:::info Provider Summary (v23.08.00155) +:::info Provider Summary (v23.08.00157)
-total services: 149
-total methods: 5754
+total services: 150
+total methods: 7015
-total resources: 1418
-total selectable resources: 1101
+total resources: 1469
+total selectable resources: 1181
@@ -103,6 +103,7 @@ stackql.exe shell --auth=$Auth accessapproval
accesscontextmanager
advisorynotifications
+aiplatform
analyticshub
apigateway
apigee
@@ -174,9 +175,9 @@ stackql.exe shell --auth=$Auth gkehub
gkeonprem
healthcare
-iam
+iam
iamcredentials
iap
identitytoolkit
@@ -252,4 +253,4 @@ stackql.exe shell --auth=$Auth workloadmanager
workstations
- \ No newline at end of file + diff --git a/docs/google-docs/providers/google/accessapproval/access_approval_settings/index.md b/docs/google-docs/providers/google/accessapproval/access_approval_settings/index.md index 9051132368..8ca542af5c 100644 --- a/docs/google-docs/providers/google/accessapproval/access_approval_settings/index.md +++ b/docs/google-docs/providers/google/accessapproval/access_approval_settings/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the settings. Format is one of: * "projects/{project}/accessApprovalSettings" * "folders/{folder}/accessApprovalSettings" * "organizations/{organization}/accessApprovalSettings" | +| `invalidKeyVersion` | `boolean` | Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that there is some configuration issue with the active_key_version configured at this level in the resource hierarchy (e.g. it doesn't exist or the Access Approval service account doesn't have the correct permissions on it, etc.) This key version is not necessarily the effective key version at this level, as key versions are inherited top-down. | +| `enrolledAncestor` | `boolean` | Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors). | | `preferredRequestExpirationDays` | `integer` | This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time. | +| `enrolledServices` | `array` | A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. | +| `notificationEmails` | `array` | A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. | | `activeKeyVersion` | `string` | The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set. | | `preferNoBroadApprovalRequests` | `boolean` | This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. | -| `invalidKeyVersion` | `boolean` | Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that there is some configuration issue with the active_key_version configured at this level in the resource hierarchy (e.g. it doesn't exist or the Access Approval service account doesn't have the correct permissions on it, etc.) This key version is not necessarily the effective key version at this level, as key versions are inherited top-down. | -| `notificationEmails` | `array` | A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. | | `ancestorHasActiveKeyVersion` | `boolean` | Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors). | -| `enrolledAncestor` | `boolean` | Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors). | -| `enrolledServices` | `array` | A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/accessapproval/approval_requests/index.md b/docs/google-docs/providers/google/accessapproval/approval_requests/index.md index e78f760274..e05889d141 100644 --- a/docs/google-docs/providers/google/accessapproval/approval_requests/index.md +++ b/docs/google-docs/providers/google/accessapproval/approval_requests/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the request. Format is "{projects\|folders\|organizations}/{id}/approvalRequests/{approval_request}". | +| `approve` | `object` | A decision that has been made to approve access to a resource. | | `requestedLocations` | `object` | Home office and physical location of the principal. | | `requestedResourceProperties` | `object` | The properties associated with the resource of the request. | -| `approve` | `object` | A decision that has been made to approve access to a resource. | -| `requestedExpiration` | `string` | The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time. | -| `dismiss` | `object` | A decision that has been made to dismiss an approval request. | | `requestTime` | `string` | The time at which approval was requested. | | `requestedResourceName` | `string` | The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. | +| `dismiss` | `object` | A decision that has been made to dismiss an approval request. | | `requestedReason` | `object` | | +| `requestedExpiration` | `string` | The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -45,6 +45,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_approval_requests_list` | `SELECT` | `organizationsId` | Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. | | `projects_approval_requests_get` | `SELECT` | `approvalRequestsId, projectsId` | Gets an approval request. Returns NOT_FOUND if the request does not exist. | | `projects_approval_requests_list` | `SELECT` | `projectsId` | Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. | +| `_folders_approval_requests_list` | `EXEC` | `foldersId` | Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. | +| `_organizations_approval_requests_list` | `EXEC` | `organizationsId` | Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. | +| `_projects_approval_requests_list` | `EXEC` | `projectsId` | Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. | | `folders_approval_requests_approve` | `EXEC` | `approvalRequestsId, foldersId` | Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. | | `folders_approval_requests_dismiss` | `EXEC` | `approvalRequestsId, foldersId` | Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. | | `folders_approval_requests_invalidate` | `EXEC` | `approvalRequestsId, foldersId` | Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. | diff --git a/docs/google-docs/providers/google/accessapproval/index.md b/docs/google-docs/providers/google/accessapproval/index.md index d562ffa246..c9e1ff2f0b 100644 --- a/docs/google-docs/providers/google/accessapproval/index.md +++ b/docs/google-docs/providers/google/accessapproval/index.md @@ -21,7 +21,7 @@ An API For Controlling Access To Data By Google Personnel.
total resources: 3
total selectable resources: 3
-total methods: 27
+total methods: 30
@@ -33,7 +33,7 @@ An API For Controlling Access To Data By Google Personnel. TypeService TitleAccess Approval API DescriptionAn API For Controlling Access To Data By Google Personnel. -Idaccessapproval:v23.08.00155 +Idaccessapproval:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/accesscontextmanager/access_levels/index.md b/docs/google-docs/providers/google/accesscontextmanager/access_levels/index.md index f99deaf9d0..aabee351f0 100644 --- a/docs/google-docs/providers/google/accesscontextmanager/access_levels/index.md +++ b/docs/google-docs/providers/google/accesscontextmanager/access_levels/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name for the `AccessLevel`. Format: `accessPolicies/{access_policy}/accessLevels/{access_level}`. The `access_level` component must begin with a letter, followed by alphanumeric characters or `_`. Its maximum length is 50 characters. After you create an `AccessLevel`, you cannot change its `name`. | | `description` | `string` | Description of the `AccessLevel` and its use. Does not affect behavior. | +| `title` | `string` | Human readable title. Must be unique within the Policy. | | `basic` | `object` | `BasicLevel` is an `AccessLevel` using a set of recommended features. | | `custom` | `object` | `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec | -| `title` | `string` | Human readable title. Must be unique within the Policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -39,5 +39,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `accessPoliciesId` | Lists all access levels for an access policy. | | `create` | `INSERT` | `accessPoliciesId` | Creates an access level. The long-running operation from this RPC has a successful status after the access level propagates to long-lasting storage. If access levels contain errors, an error response is returned for the first error encountered. | | `delete` | `DELETE` | `accessLevelsId, accessPoliciesId` | Deletes an access level based on the resource name. The long-running operation from this RPC has a successful status after the access level has been removed from long-lasting storage. | +| `_list` | `EXEC` | `accessPoliciesId` | Lists all access levels for an access policy. | | `patch` | `EXEC` | `accessLevelsId, accessPoliciesId` | Updates an access level. The long-running operation from this RPC has a successful status after the changes to the access level propagate to long-lasting storage. If access levels contain errors, an error response is returned for the first error encountered. | | `replace_all` | `EXEC` | `accessPoliciesId` | Replaces all existing access levels in an access policy with the access levels provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. If the replacement contains errors, an error response is returned for the first error encountered. Upon error, the replacement is cancelled, and existing access levels are not affected. The Operation.response field contains ReplaceAccessLevelsResponse. Removing access levels contained in existing service perimeters result in an error. | diff --git a/docs/google-docs/providers/google/accesscontextmanager/access_policies/index.md b/docs/google-docs/providers/google/accesscontextmanager/access_policies/index.md index 5f90435483..30b74564cd 100644 --- a/docs/google-docs/providers/google/accesscontextmanager/access_policies/index.md +++ b/docs/google-docs/providers/google/accesscontextmanager/access_policies/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}` | -| `title` | `string` | Required. Human readable title. Does not affect behavior. | -| `etag` | `string` | Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format. | | `parent` | `string` | Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` | | `scopes` | `array` | The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=["folders/123"] has the following behavior: - vpcsc perimeters can only restrict projects within folders/123 - access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes "folders/123" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}` | +| `title` | `string` | Required. Human readable title. Does not affect behavior. | +| `etag` | `string` | Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -39,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | | Lists all access policies in an organization. | | `create` | `INSERT` | | Creates an access policy. This method fails if the organization already has an access policy. The long-running operation has a successful status after the access policy propagates to long-lasting storage. Syntactic and basic semantic errors are returned in `metadata` as a BadRequest proto. | | `delete` | `DELETE` | `accessPoliciesId` | Deletes an access policy based on the resource name. The long-running operation has a successful status after the access policy is removed from long-lasting storage. | +| `_list` | `EXEC` | | Lists all access policies in an organization. | | `patch` | `EXEC` | `accessPoliciesId` | Updates an access policy. The long-running operation from this RPC has a successful status after the changes to the access policy propagate to long-lasting storage. | diff --git a/docs/google-docs/providers/google/accesscontextmanager/access_policies_iam_policies/index.md b/docs/google-docs/providers/google/accesscontextmanager/access_policies_iam_policies/index.md index 34e36d4b84..248e090731 100644 --- a/docs/google-docs/providers/google/accesscontextmanager/access_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/accesscontextmanager/access_policies_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `accessPoliciesId` | Gets the IAM policy for the specified Access Context Manager access policy. | +| `get_iam_policy` | `SELECT` | `accessPoliciesId` | Gets the IAM policy for the specified Access Context Manager access policy. | | `set_iam_policy` | `EXEC` | `accessPoliciesId` | Sets the IAM policy for the specified Access Context Manager access policy. This method replaces the existing IAM policy on the access policy. The IAM policy controls the set of users who can perform specific operations on the Access Context Manager access policy. | | `test_iam_permissions` | `EXEC` | `accessPoliciesId` | Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources. | diff --git a/docs/google-docs/providers/google/accesscontextmanager/authorized_orgs_descs/index.md b/docs/google-docs/providers/google/accesscontextmanager/authorized_orgs_descs/index.md index 911422faec..17f1994583 100644 --- a/docs/google-docs/providers/google/accesscontextmanager/authorized_orgs_descs/index.md +++ b/docs/google-docs/providers/google/accesscontextmanager/authorized_orgs_descs/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the `AuthorizedOrgsDesc`. Format: `accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}`. The `authorized_orgs_desc` component must begin with a letter, followed by alphanumeric characters or `_`. After you create an `AuthorizedOrgsDesc`, you cannot change its `name`. | -| `orgs` | `array` | The list of organization ids in this AuthorizedOrgsDesc. Format: `organizations/` Example: `organizations/123456` | -| `assetType` | `string` | The asset type of this authorized orgs desc. Valid values are `ASSET_TYPE_DEVICE`, and `ASSET_TYPE_CREDENTIAL_STRENGTH`. | | `authorizationDirection` | `string` | The direction of the authorization relationship between this organization and the organizations listed in the `orgs` field. The valid values for this field include the following: `AUTHORIZATION_DIRECTION_FROM`: Allows this organization to evaluate traffic in the organizations listed in the `orgs` field. `AUTHORIZATION_DIRECTION_TO`: Allows the organizations listed in the `orgs` field to evaluate the traffic in this organization. For the authorization relationship to take effect, all of the organizations must authorize and specify the appropriate relationship direction. For example, if organization A authorized organization B and C to evaluate its traffic, by specifying `AUTHORIZATION_DIRECTION_TO` as the authorization direction, organizations B and C must specify `AUTHORIZATION_DIRECTION_FROM` as the authorization direction in their `AuthorizedOrgsDesc` resource. | | `authorizationType` | `string` | A granular control type for authorization levels. Valid value is `AUTHORIZATION_TYPE_TRUST`. | +| `orgs` | `array` | The list of organization ids in this AuthorizedOrgsDesc. Format: `organizations/` Example: `organizations/123456` | +| `assetType` | `string` | The asset type of this authorized orgs desc. Valid values are `ASSET_TYPE_DEVICE`, and `ASSET_TYPE_CREDENTIAL_STRENGTH`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -39,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `accessPoliciesId` | Lists all authorized orgs descs for an access policy. | | `create` | `INSERT` | `accessPoliciesId` | Creates an authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. The name of this `AuthorizedOrgsDesc` will be assigned during creation. | | `delete` | `DELETE` | `accessPoliciesId, authorizedOrgsDescsId` | Deletes an authorized orgs desc based on the resource name. The long-running operation from this RPC has a successful status after the authorized orgs desc is removed from long-lasting storage. | +| `_list` | `EXEC` | `accessPoliciesId` | Lists all authorized orgs descs for an access policy. | | `patch` | `EXEC` | `accessPoliciesId, authorizedOrgsDescsId` | Updates an authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. Only the organization list in `AuthorizedOrgsDesc` can be updated. The name, authorization_type, asset_type and authorization_direction cannot be updated. | diff --git a/docs/google-docs/providers/google/accesscontextmanager/gcp_user_access_bindings/index.md b/docs/google-docs/providers/google/accesscontextmanager/gcp_user_access_bindings/index.md index bdf266b93f..c27429984f 100644 --- a/docs/google-docs/providers/google/accesscontextmanager/gcp_user_access_bindings/index.md +++ b/docs/google-docs/providers/google/accesscontextmanager/gcp_user_access_bindings/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N" | -| `groupKey` | `string` | Required. Immutable. Google Group id whose members are subject to this binding's restrictions. See "id" in the [G Suite Directory API's Groups resource] (https://developers.google.com/admin-sdk/directory/v1/reference/groups#resource). If a group's email address/alias is changed, this resource will continue to point at the changed group. This field does not accept group email addresses or aliases. Example: "01d520gv4vjcrht" | | `accessLevels` | `array` | Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" | | `dryRunAccessLevels` | `array` | Optional. Dry run access level that will be evaluated but will not be enforced. The access denial based on dry run policy will be logged. Only one access level is supported, not multiple. This list must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" | +| `groupKey` | `string` | Required. Immutable. Google Group id whose members are subject to this binding's restrictions. See "id" in the [G Suite Directory API's Groups resource] (https://developers.google.com/admin-sdk/directory/v1/reference/groups#resource). If a group's email address/alias is changed, this resource will continue to point at the changed group. This field does not accept group email addresses or aliases. Example: "01d520gv4vjcrht" | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,4 +38,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `organizationsId` | Lists all GcpUserAccessBindings for a Google Cloud organization. | | `create` | `INSERT` | `organizationsId` | Creates a GcpUserAccessBinding. If the client specifies a name, the server ignores it. Fails if a resource already exists with the same group_key. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time. | | `delete` | `DELETE` | `gcpUserAccessBindingsId, organizationsId` | Deletes a GcpUserAccessBinding. Completion of this long-running operation does not necessarily signify that the binding deletion is deployed onto all affected users, which may take more time. | +| `_list` | `EXEC` | `organizationsId` | Lists all GcpUserAccessBindings for a Google Cloud organization. | | `patch` | `EXEC` | `gcpUserAccessBindingsId, organizationsId` | Updates a GcpUserAccessBinding. Completion of this long-running operation does not necessarily signify that the changed binding is deployed onto all affected users, which may take more time. | diff --git a/docs/google-docs/providers/google/accesscontextmanager/index.md b/docs/google-docs/providers/google/accesscontextmanager/index.md index 25eae12815..dc36a48250 100644 --- a/docs/google-docs/providers/google/accesscontextmanager/index.md +++ b/docs/google-docs/providers/google/accesscontextmanager/index.md @@ -20,8 +20,8 @@ An API For Setting Attribute Based Access Control To Requests To Google Cloud Se
total resources: 9
-total selectable resources: 6
-total methods: 37
+total selectable resources: 7
+total methods: 43
@@ -33,7 +33,7 @@ An API For Setting Attribute Based Access Control To Requests To Google Cloud Se TypeService TitleAccess Context Manager API DescriptionAn API For Setting Attribute Based Access Control To Requests To Google Cloud Services. -Idaccesscontextmanager:v23.08.00155 +Idaccesscontextmanager:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/accesscontextmanager/operations/index.md b/docs/google-docs/providers/google/accesscontextmanager/operations/index.md index 9b5dc901dc..03d62cab61 100644 --- a/docs/google-docs/providers/google/accesscontextmanager/operations/index.md +++ b/docs/google-docs/providers/google/accesscontextmanager/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `metadata` | `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. | +| `response` | `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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operationsId` | 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. | | `list` | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `operationsId` | 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`. | +| `_list` | `EXEC` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `operationsId` | 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`. | diff --git a/docs/google-docs/providers/google/accesscontextmanager/service_perimeters/index.md b/docs/google-docs/providers/google/accesscontextmanager/service_perimeters/index.md index d89be39001..d97a2c0183 100644 --- a/docs/google-docs/providers/google/accesscontextmanager/service_perimeters/index.md +++ b/docs/google-docs/providers/google/accesscontextmanager/service_perimeters/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name for the `ServicePerimeter`. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`. The `service_perimeter` component must begin with a letter, followed by alphanumeric characters or `_`. After you create a `ServicePerimeter`, you cannot change its `name`. | | `description` | `string` | Description of the `ServicePerimeter` and its use. Does not affect behavior. | -| `perimeterType` | `string` | Perimeter type indicator. A single project or VPC network is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty. | -| `spec` | `object` | `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. | | `status` | `object` | `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. | | `title` | `string` | Human readable title. Must be unique within the Policy. | | `useExplicitDryRunSpec` | `boolean` | Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists for all Service Perimeters, and that spec is identical to the status for those Service Perimeters. When this flag is set, it inhibits the generation of the implicit spec, thereby allowing the user to explicitly provide a configuration ("spec") to use in a dry-run version of the Service Perimeter. This allows the user to test changes to the enforced config ("status") without actually enforcing them. This testing is done through analyzing the differences between currently enforced and suggested restrictions. use_explicit_dry_run_spec must bet set to True if any of the fields in the spec are set to non-default values. | +| `perimeterType` | `string` | Perimeter type indicator. A single project or VPC network is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty. | +| `spec` | `object` | `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -41,6 +41,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `accessPoliciesId` | Lists all service perimeters for an access policy. | | `create` | `INSERT` | `accessPoliciesId` | Creates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered. | | `delete` | `DELETE` | `accessPoliciesId, servicePerimetersId` | Deletes a service perimeter based on the resource name. The long-running operation from this RPC has a successful status after the service perimeter is removed from long-lasting storage. | +| `_list` | `EXEC` | `accessPoliciesId` | Lists all service perimeters for an access policy. | | `commit` | `EXEC` | `accessPoliciesId` | Commits the dry-run specification for all the service perimeters in an access policy. A commit operation on a service perimeter involves copying its `spec` field to the `status` field of the service perimeter. Only service perimeters with `use_explicit_dry_run_spec` field set to true are affected by a commit operation. The long-running operation from this RPC has a successful status after the dry-run specifications for all the service perimeters have been committed. If a commit fails, it causes the long-running operation to return an error response and the entire commit operation is cancelled. When successful, the Operation.response field contains CommitServicePerimetersResponse. The `dry_run` and the `spec` fields are cleared after a successful commit operation. | | `patch` | `EXEC` | `accessPoliciesId, servicePerimetersId` | Updates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered. | | `replace_all` | `EXEC` | `accessPoliciesId` | Replace all existing service perimeters in an access policy with the service perimeters provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. Replacements containing errors result in an error response for the first error encountered. Upon an error, replacement are cancelled and existing service perimeters are not affected. The Operation.response field contains ReplaceServicePerimetersResponse. | diff --git a/docs/google-docs/providers/google/advisorynotifications/index.md b/docs/google-docs/providers/google/advisorynotifications/index.md index bd0762cd54..1f30d534f6 100644 --- a/docs/google-docs/providers/google/advisorynotifications/index.md +++ b/docs/google-docs/providers/google/advisorynotifications/index.md @@ -21,7 +21,7 @@ An API For Accessing Advisory Notifications In Google Cloud
total resources: 1
total selectable resources: 1
-total methods: 2
+total methods: 3
@@ -33,7 +33,7 @@ An API For Accessing Advisory Notifications In Google Cloud TypeService TitleAdvisory Notifications API DescriptionAn API For Accessing Advisory Notifications In Google Cloud -Idadvisorynotifications:v23.08.00155 +Idadvisorynotifications:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/advisorynotifications/notifications/index.md b/docs/google-docs/providers/google/advisorynotifications/notifications/index.md index e97cf543f6..44051ee311 100644 --- a/docs/google-docs/providers/google/advisorynotifications/notifications/index.md +++ b/docs/google-docs/providers/google/advisorynotifications/notifications/index.md @@ -28,12 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the notification. Format: organizations/{organization}/locations/{location}/notifications/{notification}. | +| `messages` | `array` | A list of messages in the notification. | | `notificationType` | `string` | Type of notification | | `subject` | `object` | A subject line of a notification. | | `createTime` | `string` | Output only. Time the notification was created. | -| `messages` | `array` | A list of messages in the notification. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, notificationsId, organizationsId` | Gets a notification. | | `list` | `SELECT` | `locationsId, organizationsId` | Lists notifications under a given parent. | +| `_list` | `EXEC` | `locationsId, organizationsId` | Lists notifications under a given parent. | diff --git a/docs/google-docs/providers/google/aiplatform/annotation_specs/index.md b/docs/google-docs/providers/google/aiplatform/annotation_specs/index.md new file mode 100644 index 0000000000..d94d9414ee --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/annotation_specs/index.md @@ -0,0 +1,38 @@ +--- +title: annotation_specs +hide_title: false +hide_table_of_contents: false +keywords: + - annotation_specs + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameannotation_specs
TypeResource
Idgoogle.aiplatform.annotation_specs
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Resource name of the AnnotationSpec. | +| `createTime` | `string` | Output only. Timestamp when this AnnotationSpec was created. | +| `displayName` | `string` | Required. The user-defined name of the AnnotationSpec. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `etag` | `string` | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `updateTime` | `string` | Output only. Timestamp when AnnotationSpec was last updated. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `get` | `SELECT` | `annotationSpecsId, datasetsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/aiplatform/annotations/index.md b/docs/google-docs/providers/google/aiplatform/annotations/index.md new file mode 100644 index 0000000000..39a6a7238f --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/annotations/index.md @@ -0,0 +1,42 @@ +--- +title: annotations +hide_title: false +hide_table_of_contents: false +keywords: + - annotations + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameannotations
TypeResource
Idgoogle.aiplatform.annotations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Resource name of the Annotation. | +| `etag` | `string` | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `labels` | `object` | Optional. The labels with user-defined metadata to organize your Annotations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Annotation(System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Annotation: * "aiplatform.googleapis.com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI. * "aiplatform.googleapis.com/payload_schema": output only, its value is the payload_schema's title. | +| `payload` | `any` | Required. The schema of the payload can be found in payload_schema. | +| `payloadSchemaUri` | `string` | Required. Google Cloud Storage URI points to a YAML file describing payload. The schema is defined as an [OpenAPI 3.0.2 Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with the parent Dataset's metadata. | +| `updateTime` | `string` | Output only. Timestamp when this Annotation was last updated. | +| `annotationSource` | `object` | References an API call. It contains more information about long running operation and Jobs that are triggered by the API call. | +| `createTime` | `string` | Output only. Timestamp when this Annotation was created. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `list` | `SELECT` | `dataItemsId, datasetsId, locationsId, projectsId` | +| `_list` | `EXEC` | `dataItemsId, datasetsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/aiplatform/artifacts/index.md b/docs/google-docs/providers/google/aiplatform/artifacts/index.md new file mode 100644 index 0000000000..cf977c4279 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/artifacts/index.md @@ -0,0 +1,52 @@ +--- +title: artifacts +hide_title: false +hide_table_of_contents: false +keywords: + - artifacts + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameartifacts
TypeResource
Idgoogle.aiplatform.artifacts
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The resource name of the Artifact. | +| `description` | `string` | Description of the Artifact | +| `state` | `string` | The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions. | +| `schemaTitle` | `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. | +| `schemaVersion` | `string` | The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store. | +| `uri` | `string` | The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file. | +| `etag` | `string` | An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `createTime` | `string` | Output only. Timestamp when this Artifact was created. | +| `displayName` | `string` | User provided display name of the Artifact. May be up to 128 Unicode characters. | +| `labels` | `object` | The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded). | +| `metadata` | `object` | Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB. | +| `updateTime` | `string` | Output only. Timestamp when this Artifact was last updated. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `artifactsId, locationsId, metadataStoresId, projectsId` | Retrieves a specific Artifact. | +| `list` | `SELECT` | `locationsId, metadataStoresId, projectsId` | Lists Artifacts in the MetadataStore. | +| `create` | `INSERT` | `locationsId, metadataStoresId, projectsId` | Creates an Artifact associated with a MetadataStore. | +| `delete` | `DELETE` | `artifactsId, locationsId, metadataStoresId, projectsId` | Deletes an Artifact. | +| `_list` | `EXEC` | `locationsId, metadataStoresId, projectsId` | Lists Artifacts in the MetadataStore. | +| `patch` | `EXEC` | `artifactsId, locationsId, metadataStoresId, projectsId` | Updates a stored Artifact. | +| `purge` | `EXEC` | `locationsId, metadataStoresId, projectsId` | Purges Artifacts. | +| `query_artifact_lineage_subgraph` | `EXEC` | `artifactsId, locationsId, metadataStoresId, projectsId` | Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph. | 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 new file mode 100644 index 0000000000..5de2230e59 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/batch_prediction_jobs/index.md @@ -0,0 +1,65 @@ +--- +title: batch_prediction_jobs +hide_title: false +hide_table_of_contents: false +keywords: + - batch_prediction_jobs + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namebatch_prediction_jobs
TypeResource
Idgoogle.aiplatform.batch_prediction_jobs
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Resource name of the BatchPredictionJob. | +| `generateExplanation` | `boolean` | Generate explanation with the batch prediction results. When set to `true`, the batch prediction output changes based on the `predictions_format` field of the BatchPredictionJob.output_config object: * `bigquery`: output includes a column named `explanation`. The value is a struct that conforms to the Explanation object. * `jsonl`: The JSON objects on each line include an additional entry keyed `explanation`. The value of the entry is a JSON object that conforms to the Explanation object. * `csv`: Generating explanations for CSV format is not supported. If this field is set to true, either the Model.explanation_spec or explanation_spec must be populated. | +| `outputInfo` | `object` | Further describes this job's output. Supplements output_config. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `error` | `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). | +| `serviceAccount` | `string` | The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources. Users deploying the Model must have the `iam.serviceAccounts.actAs` permission on this service account. | +| `modelParameters` | `any` | The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri. | +| `completionStats` | `object` | Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch. | +| `partialFailures` | `array` | Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details. | +| `createTime` | `string` | Output only. Time when the BatchPredictionJob was created. | +| `outputConfig` | `object` | Configures the output of BatchPredictionJob. See Model.supported_output_storage_formats for supported output formats, and how predictions are expressed via any of them. | +| `unmanagedContainerModel` | `object` | Contains model information necessary to perform batch prediction without requiring a full model import. | +| `startTime` | `string` | Output only. Time when the BatchPredictionJob for the first time entered the `JOB_STATE_RUNNING` state. | +| `dedicatedResources` | `object` | A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. | +| `inputConfig` | `object` | Configures the input to BatchPredictionJob. See Model.supported_input_storage_formats for Model's supported input formats, and how instances should be expressed via any of them. | +| `labels` | `object` | The labels with user-defined metadata to organize BatchPredictionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. | +| `modelVersionId` | `string` | Output only. The version ID of the Model that produces the predictions via this job. | +| `instanceConfig` | `object` | Configuration defining how to transform batch prediction input instances to the instances that the Model accepts. | +| `manualBatchTuningParameters` | `object` | Manual batch tuning parameters. | +| `model` | `string` | The name of the Model resource that produces the predictions via this job, must share the same ancestor Location. Starting this job has no impact on any existing deployments of the Model and their resources. Exactly one of model and unmanaged_container_model must be set. The model resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed. The model resource could also be a publisher model. Example: `publishers/{publisher}/models/{model}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` | +| `resourcesConsumed` | `object` | Statistics information about resource consumption. | +| `disableContainerLogging` | `boolean` | For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. | +| `state` | `string` | Output only. The detailed state of the job. | +| `displayName` | `string` | Required. The user-defined name of this BatchPredictionJob. | +| `endTime` | `string` | Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | +| `updateTime` | `string` | Output only. Time when the BatchPredictionJob was most recently updated. | +| `explanationSpec` | `object` | Specification of Model explanation. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `batchPredictionJobsId, locationsId, projectsId` | Gets a BatchPredictionJob | +| `list` | `SELECT` | `locationsId, projectsId` | Lists BatchPredictionJobs in a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start. | +| `delete` | `DELETE` | `batchPredictionJobsId, locationsId, projectsId` | Deletes a BatchPredictionJob. Can only be called on jobs that already finished. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists BatchPredictionJobs in a Location. | +| `cancel` | `EXEC` | `batchPredictionJobsId, locationsId, projectsId` | Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted. | diff --git a/docs/google-docs/providers/google/aiplatform/contexts/index.md b/docs/google-docs/providers/google/aiplatform/contexts/index.md new file mode 100644 index 0000000000..83de47f4f5 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/contexts/index.md @@ -0,0 +1,51 @@ +--- +title: contexts +hide_title: false +hide_table_of_contents: false +keywords: + - contexts + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namecontexts
TypeResource
Idgoogle.aiplatform.contexts
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Immutable. The resource name of the Context. | +| `description` | `string` | Description of the Context | +| `displayName` | `string` | User provided display name of the Context. May be up to 128 Unicode characters. | +| `etag` | `string` | An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `metadata` | `object` | Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB. | +| `schemaTitle` | `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. | +| `parentContexts` | `array` | Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts. | +| `createTime` | `string` | Output only. Timestamp when this Context was created. | +| `labels` | `object` | The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded). | +| `schemaVersion` | `string` | The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store. | +| `updateTime` | `string` | Output only. Timestamp when this Context was last updated. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `contextsId, locationsId, metadataStoresId, projectsId` | Retrieves a specific Context. | +| `list` | `SELECT` | `locationsId, metadataStoresId, projectsId` | Lists Contexts on the MetadataStore. | +| `create` | `INSERT` | `locationsId, metadataStoresId, projectsId` | Creates a Context associated with a MetadataStore. | +| `delete` | `DELETE` | `contextsId, locationsId, metadataStoresId, projectsId` | Deletes a stored Context. | +| `_list` | `EXEC` | `locationsId, metadataStoresId, projectsId` | Lists Contexts on the MetadataStore. | +| `patch` | `EXEC` | `contextsId, locationsId, metadataStoresId, projectsId` | Updates a stored Context. | +| `purge` | `EXEC` | `locationsId, metadataStoresId, projectsId` | Purges Contexts. | +| `query_context_lineage_subgraph` | `EXEC` | `contextsId, locationsId, metadataStoresId, projectsId` | Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph. | diff --git a/docs/google-docs/providers/google/aiplatform/contexts_context_artifacts_and_executions/index.md b/docs/google-docs/providers/google/aiplatform/contexts_context_artifacts_and_executions/index.md new file mode 100644 index 0000000000..9dd5f4d2ef --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/contexts_context_artifacts_and_executions/index.md @@ -0,0 +1,32 @@ +--- +title: contexts_context_artifacts_and_executions +hide_title: false +hide_table_of_contents: false +keywords: + - contexts_context_artifacts_and_executions + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namecontexts_context_artifacts_and_executions
TypeResource
Idgoogle.aiplatform.contexts_context_artifacts_and_executions
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `add_context_artifacts_and_executions` | `EXEC` | `contextsId, locationsId, metadataStoresId, projectsId` | diff --git a/docs/google-docs/providers/google/aiplatform/contexts_context_children/index.md b/docs/google-docs/providers/google/aiplatform/contexts_context_children/index.md new file mode 100644 index 0000000000..cd96ef2d8c --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/contexts_context_children/index.md @@ -0,0 +1,33 @@ +--- +title: contexts_context_children +hide_title: false +hide_table_of_contents: false +keywords: + - contexts_context_children + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namecontexts_context_children
TypeResource
Idgoogle.aiplatform.contexts_context_children
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `add_context_children` | `EXEC` | `contextsId, locationsId, metadataStoresId, projectsId` | Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error. | +| `remove_context_children` | `EXEC` | `contextsId, locationsId, metadataStoresId, projectsId` | Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped. | diff --git a/docs/google-docs/providers/google/aiplatform/custom_jobs/index.md b/docs/google-docs/providers/google/aiplatform/custom_jobs/index.md new file mode 100644 index 0000000000..c4f52613fd --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/custom_jobs/index.md @@ -0,0 +1,50 @@ +--- +title: custom_jobs +hide_title: false +hide_table_of_contents: false +keywords: + - custom_jobs + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namecustom_jobs
TypeResource
Idgoogle.aiplatform.custom_jobs
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Resource name of a CustomJob. | +| `endTime` | `string` | Output only. Time when the CustomJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | +| `error` | `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). | +| `state` | `string` | Output only. The detailed state of the job. | +| `labels` | `object` | The labels with user-defined metadata to organize CustomJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. | +| `startTime` | `string` | Output only. Time when the CustomJob for the first time entered the `JOB_STATE_RUNNING` state. | +| `webAccessUris` | `object` | Output only. URIs for accessing [interactive shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) (one URI for each training node). Only available if job_spec.enable_web_access is `true`. The keys are names of each node in the training job; for example, `workerpool0-0` for the primary node, `workerpool1-0` for the first node in the second worker pool, and `workerpool1-1` for the second node in the second worker pool. The values are the URIs for each node's interactive shell. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `createTime` | `string` | Output only. Time when the CustomJob was created. | +| `jobSpec` | `object` | Represents the spec of a CustomJob. | +| `displayName` | `string` | Required. The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `updateTime` | `string` | Output only. Time when the CustomJob was most recently updated. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `customJobsId, locationsId, projectsId` | Gets a CustomJob. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists CustomJobs in a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates a CustomJob. A created CustomJob right away will be attempted to be run. | +| `delete` | `DELETE` | `customJobsId, locationsId, projectsId` | Deletes a CustomJob. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists CustomJobs in a Location. | +| `cancel` | `EXEC` | `customJobsId, locationsId, projectsId` | Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`. | diff --git a/docs/google-docs/providers/google/aiplatform/data_items/index.md b/docs/google-docs/providers/google/aiplatform/data_items/index.md new file mode 100644 index 0000000000..545958df92 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/data_items/index.md @@ -0,0 +1,40 @@ +--- +title: data_items +hide_title: false +hide_table_of_contents: false +keywords: + - data_items + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namedata_items
TypeResource
Idgoogle.aiplatform.data_items
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The resource name of the DataItem. | +| `etag` | `string` | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `labels` | `object` | Optional. The labels with user-defined metadata to organize your DataItems. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one DataItem(System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. | +| `payload` | `any` | Required. The data that the DataItem represents (for example, an image or a text snippet). The schema of the payload is stored in the parent Dataset's metadata schema's dataItemSchemaUri field. | +| `updateTime` | `string` | Output only. Timestamp when this DataItem was last updated. | +| `createTime` | `string` | Output only. Timestamp when this DataItem was created. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `list` | `SELECT` | `datasetsId, locationsId, projectsId` | +| `_list` | `EXEC` | `datasetsId, locationsId, projectsId` | 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 new file mode 100644 index 0000000000..68e17718e1 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/data_labeling_jobs/index.md @@ -0,0 +1,56 @@ +--- +title: data_labeling_jobs +hide_title: false +hide_table_of_contents: false +keywords: + - data_labeling_jobs + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namedata_labeling_jobs
TypeResource
Idgoogle.aiplatform.data_labeling_jobs
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Resource name of the DataLabelingJob. | +| `datasets` | `array` | Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` | +| `displayName` | `string` | Required. The user-defined name of the DataLabelingJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Display name of a DataLabelingJob. | +| `specialistPools` | `array` | The SpecialistPools' resource names associated with this job. | +| `createTime` | `string` | Output only. Timestamp when this DataLabelingJob was created. | +| `annotationLabels` | `object` | Labels to assign to annotations generated by this DataLabelingJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. | +| `inputs` | `any` | Required. Input config parameters for the DataLabelingJob. | +| `instructionUri` | `string` | Required. The Google Cloud Storage location of the instruction pdf. This pdf is shared with labelers, and provides detailed description on how to label DataItems in Datasets. | +| `labelingProgress` | `integer` | Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating the percentage of DataItems that has been finished. | +| `state` | `string` | Output only. The detailed state of the job. | +| `labelerCount` | `integer` | Required. Number of labelers to work on each DataItem. | +| `labels` | `object` | The labels with user-defined metadata to organize your DataLabelingJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each DataLabelingJob: * "aiplatform.googleapis.com/schema": output only, its value is the inputs_schema's title. | +| `inputsSchemaUri` | `string` | Required. Points to a YAML file stored on Google Cloud Storage describing the config for a specific type of DataLabelingJob. The schema files that can be used here are found in the https://storage.googleapis.com/google-cloud-aiplatform bucket in the /schema/datalabelingjob/inputs/ folder. | +| `updateTime` | `string` | Output only. Timestamp when this DataLabelingJob was updated most recently. | +| `activeLearningConfig` | `object` | Parameters that configure the active learning pipeline. Active learning will label the data incrementally by several iterations. For every iteration, it will select a batch of data based on the sampling strategy. | +| `currentSpend` | `object` | Represents an amount of money with its currency type. | +| `error` | `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). | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `dataLabelingJobsId, locationsId, projectsId` | Gets a DataLabelingJob. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists DataLabelingJobs in a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates a DataLabelingJob. | +| `delete` | `DELETE` | `dataLabelingJobsId, locationsId, projectsId` | Deletes a DataLabelingJob. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists DataLabelingJobs in a Location. | +| `cancel` | `EXEC` | `dataLabelingJobsId, locationsId, projectsId` | Cancels a DataLabelingJob. Success of cancellation is not guaranteed. | diff --git a/docs/google-docs/providers/google/aiplatform/datasets/index.md b/docs/google-docs/providers/google/aiplatform/datasets/index.md new file mode 100644 index 0000000000..bfe46caa2a --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/datasets/index.md @@ -0,0 +1,54 @@ +--- +title: datasets +hide_title: false +hide_table_of_contents: false +keywords: + - datasets + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namedatasets
TypeResource
Idgoogle.aiplatform.datasets
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The resource name of the Dataset. | +| `description` | `string` | The description of the Dataset. | +| `createTime` | `string` | Output only. Timestamp when this Dataset was created. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `labels` | `object` | The labels with user-defined metadata to organize your Datasets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each Dataset: * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its value is the metadata_schema's title. | +| `metadataArtifact` | `string` | Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. | +| `savedQueries` | `array` | All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. | +| `metadata` | `any` | Required. Additional information about the Dataset. | +| `metadataSchemaUri` | `string` | Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `dataItemCount` | `string` | Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset. | +| `updateTime` | `string` | Output only. Timestamp when this Dataset was last updated. | +| `displayName` | `string` | Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `datasetsId, locationsId, projectsId` | Gets a Dataset. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists Datasets in a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates a Dataset. | +| `delete` | `DELETE` | `datasetsId, locationsId, projectsId` | Deletes a Dataset. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Datasets in a Location. | +| `export` | `EXEC` | `datasetsId, locationsId, projectsId` | Exports data from a Dataset. | +| `import` | `EXEC` | `datasetsId, locationsId, projectsId` | Imports data into a Dataset. | +| `patch` | `EXEC` | `datasetsId, locationsId, projectsId` | Updates a Dataset. | +| `search_data_items` | `EXEC` | `datasetsId, locationsId, projectsId` | Searches DataItems in a Dataset. | diff --git a/docs/google-docs/providers/google/aiplatform/endpoints/index.md b/docs/google-docs/providers/google/aiplatform/endpoints/index.md new file mode 100644 index 0000000000..1a3b2977c4 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/endpoints/index.md @@ -0,0 +1,59 @@ +--- +title: endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - endpoints + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameendpoints
TypeResource
Idgoogle.aiplatform.endpoints
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The resource name of the Endpoint. | +| `description` | `string` | The description of the Endpoint. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `trafficSplit` | `object` | A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. | +| `enablePrivateServiceConnect` | `boolean` | Deprecated: If true, expose the Endpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set. | +| `network` | `string` | Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is network name. | +| `predictRequestResponseLoggingConfig` | `object` | Configuration for logging request-response to a BigQuery table. | +| `displayName` | `string` | Required. The display name of the Endpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `updateTime` | `string` | Output only. Timestamp when this Endpoint was last updated. | +| `modelDeploymentMonitoringJob` | `string` | Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` | +| `createTime` | `string` | Output only. Timestamp when this Endpoint was created. | +| `labels` | `object` | The labels with user-defined metadata to organize your Endpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `deployedModels` | `array` | Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `endpointsId, locationsId, projectsId` | Gets an Endpoint. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists Endpoints in a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates an Endpoint. | +| `delete` | `DELETE` | `endpointsId, locationsId, projectsId` | Deletes an Endpoint. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Endpoints in a Location. | +| `deploy_model` | `EXEC` | `endpointsId, locationsId, projectsId` | Deploys a Model into this Endpoint, creating a DeployedModel within it. | +| `explain` | `EXEC` | `endpointsId, locationsId, projectsId` | 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. | +| `mutate_deployed_model` | `EXEC` | `endpointsId, locationsId, projectsId` | 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). | +| `patch` | `EXEC` | `endpointsId, locationsId, projectsId` | Updates an Endpoint. | +| `predict` | `EXEC` | `endpointsId, locationsId, projectsId` | Perform an online prediction. | +| `raw_predict` | `EXEC` | `endpointsId, locationsId, projectsId` | 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. | +| `server_streaming_predict` | `EXEC` | `endpointsId, locationsId, projectsId` | Perform a server-side streaming online prediction request for Vertex LLM streaming. | +| `undeploy_model` | `EXEC` | `endpointsId, locationsId, projectsId` | Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using. | diff --git a/docs/google-docs/providers/google/aiplatform/entity_types/index.md b/docs/google-docs/providers/google/aiplatform/entity_types/index.md new file mode 100644 index 0000000000..00a9e4b894 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/entity_types/index.md @@ -0,0 +1,51 @@ +--- +title: entity_types +hide_title: false +hide_table_of_contents: false +keywords: + - entity_types + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameentity_types
TypeResource
Idgoogle.aiplatform.entity_types
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. | +| `description` | `string` | Optional. Description of the EntityType. | +| `offlineStorageTtlDays` | `integer` | Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL. | +| `updateTime` | `string` | Output only. Timestamp when this EntityType was most recently updated. | +| `createTime` | `string` | Output only. Timestamp when this EntityType was created. | +| `etag` | `string` | Optional. Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `labels` | `object` | Optional. The labels with user-defined metadata to organize your EntityTypes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one EntityType (System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. | +| `monitoringConfig` | `object` | Configuration of how features in Featurestore are monitored. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `entityTypesId, featurestoresId, locationsId, projectsId` | Gets details of a single EntityType. | +| `list` | `SELECT` | `featurestoresId, locationsId, projectsId` | Lists EntityTypes in a given Featurestore. | +| `create` | `INSERT` | `featurestoresId, locationsId, projectsId` | Creates a new EntityType in a given Featurestore. | +| `delete` | `DELETE` | `entityTypesId, featurestoresId, locationsId, projectsId` | Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed. | +| `_list` | `EXEC` | `featurestoresId, locationsId, projectsId` | Lists EntityTypes in a given Featurestore. | +| `export_feature_values` | `EXEC` | `entityTypesId, featurestoresId, locationsId, projectsId` | Exports Feature values from all the entities of a target EntityType. | +| `import_feature_values` | `EXEC` | `entityTypesId, featurestoresId, locationsId, projectsId` | Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned. | +| `patch` | `EXEC` | `entityTypesId, featurestoresId, locationsId, projectsId` | Updates the parameters of a single EntityType. | +| `read_feature_values` | `EXEC` | `entityTypesId, featurestoresId, locationsId, projectsId` | Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues. | +| `streaming_read_feature_values` | `EXEC` | `entityTypesId, featurestoresId, locationsId, projectsId` | Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses. | +| `write_feature_values` | `EXEC` | `entityTypesId, featurestoresId, locationsId, projectsId` | Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention. | diff --git a/docs/google-docs/providers/google/aiplatform/entity_types_feature_values/index.md b/docs/google-docs/providers/google/aiplatform/entity_types_feature_values/index.md new file mode 100644 index 0000000000..0ceb186cf0 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/entity_types_feature_values/index.md @@ -0,0 +1,32 @@ +--- +title: entity_types_feature_values +hide_title: false +hide_table_of_contents: false +keywords: + - entity_types_feature_values + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameentity_types_feature_values
TypeResource
Idgoogle.aiplatform.entity_types_feature_values
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `delete_feature_values` | `EXEC` | `entityTypesId, featurestoresId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/aiplatform/entity_types_iam_policies/index.md b/docs/google-docs/providers/google/aiplatform/entity_types_iam_policies/index.md new file mode 100644 index 0000000000..2c6adeabac --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/entity_types_iam_policies/index.md @@ -0,0 +1,38 @@ +--- +title: entity_types_iam_policies +hide_title: false +hide_table_of_contents: false +keywords: + - entity_types_iam_policies + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameentity_types_iam_policies
TypeResource
Idgoogle.aiplatform.entity_types_iam_policies
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get_iam_policy` | `SELECT` | `entityTypesId, featurestoresId, locationsId, projectsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | +| `set_iam_policy` | `EXEC` | `entityTypesId, featurestoresId, locationsId, projectsId` | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. | +| `test_iam_permissions` | `EXEC` | `entityTypesId, featurestoresId, locationsId, projectsId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | diff --git a/docs/google-docs/providers/google/aiplatform/evaluations/index.md b/docs/google-docs/providers/google/aiplatform/evaluations/index.md new file mode 100644 index 0000000000..74ac769d17 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/evaluations/index.md @@ -0,0 +1,47 @@ +--- +title: evaluations +hide_title: false +hide_table_of_contents: false +keywords: + - evaluations + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameevaluations
TypeResource
Idgoogle.aiplatform.evaluations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The resource name of the ModelEvaluation. | +| `modelExplanation` | `object` | Aggregated explanation metrics for a Model over a set of instances. | +| `displayName` | `string` | The display name of the ModelEvaluation. | +| `annotationSchemaUri` | `string` | Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.predictions, EvaluatedDataItemView.ground_truths, EvaluatedAnnotation.predictions, and EvaluatedAnnotation.ground_truths. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation. | +| `createTime` | `string` | Output only. Timestamp when this ModelEvaluation was created. | +| `metadata` | `any` | The metadata of the ModelEvaluation. For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a structured value with keys of "pipeline_job_id", "evaluation_dataset_type", "evaluation_dataset_path". | +| `explanationSpecs` | `array` | Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data. | +| `metrics` | `any` | Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri | +| `dataItemSchemaUri` | `string` | Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.data_item_payload and EvaluatedAnnotation.data_item_payload. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation. | +| `metricsSchemaUri` | `string` | Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluation. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). | +| `sliceDimensions` | `array` | All possible dimensions of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices request, in the form of `slice.dimension = `. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `evaluationsId, locationsId, modelsId, projectsId` | Gets a ModelEvaluation. | +| `list` | `SELECT` | `locationsId, modelsId, projectsId` | Lists ModelEvaluations in a Model. | +| `_list` | `EXEC` | `locationsId, modelsId, projectsId` | Lists ModelEvaluations in a Model. | +| `import` | `EXEC` | `locationsId, modelsId, projectsId` | Imports an externally generated ModelEvaluation. | diff --git a/docs/google-docs/providers/google/aiplatform/executions/index.md b/docs/google-docs/providers/google/aiplatform/executions/index.md new file mode 100644 index 0000000000..038e6377e0 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/executions/index.md @@ -0,0 +1,51 @@ +--- +title: executions +hide_title: false +hide_table_of_contents: false +keywords: + - executions + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameexecutions
TypeResource
Idgoogle.aiplatform.executions
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The resource name of the Execution. | +| `description` | `string` | Description of the Execution | +| `labels` | `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). | +| `createTime` | `string` | Output only. Timestamp when this Execution was created. | +| `updateTime` | `string` | Output only. Timestamp when this Execution was last updated. | +| `state` | `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. | +| `schemaVersion` | `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. | +| `schemaTitle` | `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. | +| `displayName` | `string` | User provided display name of the Execution. May be up to 128 Unicode characters. | +| `etag` | `string` | An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `metadata` | `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. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `executionsId, locationsId, metadataStoresId, projectsId` | Retrieves a specific Execution. | +| `list` | `SELECT` | `locationsId, metadataStoresId, projectsId` | Lists Executions in the MetadataStore. | +| `create` | `INSERT` | `locationsId, metadataStoresId, projectsId` | Creates an Execution associated with a MetadataStore. | +| `delete` | `DELETE` | `executionsId, locationsId, metadataStoresId, projectsId` | Deletes an Execution. | +| `_list` | `EXEC` | `locationsId, metadataStoresId, projectsId` | Lists Executions in the MetadataStore. | +| `patch` | `EXEC` | `executionsId, locationsId, metadataStoresId, projectsId` | Updates a stored Execution. | +| `purge` | `EXEC` | `locationsId, metadataStoresId, projectsId` | Purges Executions. | +| `query_execution_inputs_and_outputs` | `EXEC` | `executionsId, locationsId, metadataStoresId, projectsId` | Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events. | 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 new file mode 100644 index 0000000000..290eeabad0 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/executions_execution_events/index.md @@ -0,0 +1,32 @@ +--- +title: executions_execution_events +hide_title: false +hide_table_of_contents: false +keywords: + - executions_execution_events + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameexecutions_execution_events
TypeResource
Idgoogle.aiplatform.executions_execution_events
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `add_execution_events` | `EXEC` | `executionsId, locationsId, metadataStoresId, projectsId` | diff --git a/docs/google-docs/providers/google/aiplatform/experiments/index.md b/docs/google-docs/providers/google/aiplatform/experiments/index.md new file mode 100644 index 0000000000..ee6988bfaf --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/experiments/index.md @@ -0,0 +1,47 @@ +--- +title: experiments +hide_title: false +hide_table_of_contents: false +keywords: + - experiments + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameexperiments
TypeResource
Idgoogle.aiplatform.experiments
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` | +| `description` | `string` | Description of this TensorboardExperiment. | +| `updateTime` | `string` | Output only. Timestamp when this TensorboardExperiment was last updated. | +| `createTime` | `string` | Output only. Timestamp when this TensorboardExperiment was created. | +| `displayName` | `string` | User provided name of this TensorboardExperiment. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `labels` | `object` | The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `aiplatform.googleapis.com/` and are immutable. The following system labels exist for each Dataset: * `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its value is the metadata_schema's title. | +| `source` | `string` | Immutable. Source of the TensorboardExperiment. Example: a custom training job. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `experimentsId, locationsId, projectsId, tensorboardsId` | Gets a TensorboardExperiment. | +| `list` | `SELECT` | `locationsId, projectsId, tensorboardsId` | Lists TensorboardExperiments in a Location. | +| `create` | `INSERT` | `locationsId, projectsId, tensorboardsId` | Creates a TensorboardExperiment. | +| `delete` | `DELETE` | `experimentsId, locationsId, projectsId, tensorboardsId` | Deletes a TensorboardExperiment. | +| `_list` | `EXEC` | `locationsId, projectsId, tensorboardsId` | Lists TensorboardExperiments in a Location. | +| `patch` | `EXEC` | `experimentsId, locationsId, projectsId, tensorboardsId` | Updates a TensorboardExperiment. | +| `write` | `EXEC` | `experimentsId, locationsId, projectsId, tensorboardsId` | Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned. | diff --git a/docs/google-docs/providers/google/aiplatform/features/index.md b/docs/google-docs/providers/google/aiplatform/features/index.md new file mode 100644 index 0000000000..b0e14bd136 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/features/index.md @@ -0,0 +1,49 @@ +--- +title: features +hide_title: false +hide_table_of_contents: false +keywords: + - features + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namefeatures
TypeResource
Idgoogle.aiplatform.features
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. | +| `description` | `string` | Description of the Feature. | +| `etag` | `string` | Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `disableMonitoring` | `boolean` | Optional. If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, all types of data monitoring are disabled despite the config on EntityType. | +| `versionLabels` | `object` | The labels with user-defined metadata to organize your versions. 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. | +| `updateTime` | `string` | Output only. Timestamp when this EntityType was most recently updated. | +| `valueType` | `string` | Required. Immutable. Type of Feature value. | +| `labels` | `object` | Optional. The labels with user-defined metadata to organize your Features. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Feature (System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. | +| `monitoringStatsAnomalies` | `array` | Output only. The list of historical stats and anomalies with specified objectives. | +| `createTime` | `string` | Output only. Timestamp when this EntityType was created. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `entityTypesId, featuresId, featurestoresId, locationsId, projectsId` | Gets details of a single Feature. | +| `list` | `SELECT` | `entityTypesId, featurestoresId, locationsId, projectsId` | Lists Features in a given EntityType. | +| `create` | `INSERT` | `entityTypesId, featurestoresId, locationsId, projectsId` | Creates a new Feature in a given EntityType. | +| `delete` | `DELETE` | `entityTypesId, featuresId, featurestoresId, locationsId, projectsId` | Deletes a single Feature. | +| `_list` | `EXEC` | `entityTypesId, featurestoresId, locationsId, projectsId` | Lists Features in a given EntityType. | +| `batch_create` | `EXEC` | `entityTypesId, featurestoresId, locationsId, projectsId` | Creates a batch of Features in a given EntityType. | +| `patch` | `EXEC` | `entityTypesId, featuresId, featurestoresId, locationsId, projectsId` | Updates the parameters of a single Feature. | diff --git a/docs/google-docs/providers/google/aiplatform/featurestores/index.md b/docs/google-docs/providers/google/aiplatform/featurestores/index.md new file mode 100644 index 0000000000..3beef9d370 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/featurestores/index.md @@ -0,0 +1,49 @@ +--- +title: featurestores +hide_title: false +hide_table_of_contents: false +keywords: + - featurestores + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namefeaturestores
TypeResource
Idgoogle.aiplatform.featurestores
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}` | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `labels` | `object` | Optional. The labels with user-defined metadata to organize your Featurestore. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Featurestore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. | +| `state` | `string` | Output only. State of the featurestore. | +| `onlineServingConfig` | `object` | OnlineServingConfig specifies the details for provisioning online serving resources. | +| `updateTime` | `string` | Output only. Timestamp when this Featurestore was last updated. | +| `createTime` | `string` | Output only. Timestamp when this Featurestore was created. | +| `etag` | `string` | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `onlineStorageTtlDays` | `integer` | Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `featurestoresId, locationsId, projectsId` | Gets details of a single Featurestore. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists Featurestores in a given project and location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates a new Featurestore in a given project and location. | +| `delete` | `DELETE` | `featurestoresId, locationsId, projectsId` | Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Featurestores in a given project and location. | +| `batch_read_feature_values` | `EXEC` | `featurestoresId, locationsId, projectsId` | Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp. | +| `patch` | `EXEC` | `featurestoresId, locationsId, projectsId` | Updates the parameters of a single Featurestore. | +| `search_features` | `EXEC` | `locationsId, projectsId` | Searches Features matching a query in a given project. | diff --git a/docs/google-docs/providers/google/aiplatform/featurestores_iam_policies/index.md b/docs/google-docs/providers/google/aiplatform/featurestores_iam_policies/index.md new file mode 100644 index 0000000000..219ed172a5 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/featurestores_iam_policies/index.md @@ -0,0 +1,38 @@ +--- +title: featurestores_iam_policies +hide_title: false +hide_table_of_contents: false +keywords: + - featurestores_iam_policies + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namefeaturestores_iam_policies
TypeResource
Idgoogle.aiplatform.featurestores_iam_policies
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get_iam_policy` | `SELECT` | `featurestoresId, locationsId, projectsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | +| `set_iam_policy` | `EXEC` | `featurestoresId, locationsId, projectsId` | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. | +| `test_iam_permissions` | `EXEC` | `featurestoresId, locationsId, projectsId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | 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 new file mode 100644 index 0000000000..4b38e1cf00 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/hyperparameter_tuning_jobs/index.md @@ -0,0 +1,54 @@ +--- +title: hyperparameter_tuning_jobs +hide_title: false +hide_table_of_contents: false +keywords: + - hyperparameter_tuning_jobs + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namehyperparameter_tuning_jobs
TypeResource
Idgoogle.aiplatform.hyperparameter_tuning_jobs
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Resource name of the HyperparameterTuningJob. | +| `maxTrialCount` | `integer` | Required. The desired total number of Trials. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `displayName` | `string` | Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `state` | `string` | Output only. The detailed state of the job. | +| `error` | `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). | +| `createTime` | `string` | Output only. Time when the HyperparameterTuningJob was created. | +| `startTime` | `string` | Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state. | +| `trials` | `array` | Output only. Trials of the HyperparameterTuningJob. | +| `labels` | `object` | The labels with user-defined metadata to organize HyperparameterTuningJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. | +| `studySpec` | `object` | Represents specification of a Study. | +| `parallelTrialCount` | `integer` | Required. The desired number of Trials to run in parallel. | +| `trialJobSpec` | `object` | Represents the spec of a CustomJob. | +| `maxFailedTrialCount` | `integer` | The number of failed Trials that need to be seen before failing the HyperparameterTuningJob. If set to 0, Vertex AI decides how many Trials must fail before the whole job fails. | +| `endTime` | `string` | Output only. Time when the HyperparameterTuningJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | +| `updateTime` | `string` | Output only. Time when the HyperparameterTuningJob was most recently updated. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `hyperparameterTuningJobsId, locationsId, projectsId` | Gets a HyperparameterTuningJob | +| `list` | `SELECT` | `locationsId, projectsId` | Lists HyperparameterTuningJobs in a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates a HyperparameterTuningJob | +| `delete` | `DELETE` | `hyperparameterTuningJobsId, locationsId, projectsId` | Deletes a HyperparameterTuningJob. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists HyperparameterTuningJobs in a Location. | +| `cancel` | `EXEC` | `hyperparameterTuningJobsId, locationsId, projectsId` | Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`. | diff --git a/docs/google-docs/providers/google/aiplatform/index.md b/docs/google-docs/providers/google/aiplatform/index.md new file mode 100644 index 0000000000..f0319c8e90 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/index.md @@ -0,0 +1,96 @@ +--- +title: aiplatform +hide_title: false +hide_table_of_contents: false +keywords: + - aiplatform + - 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 +--- +Train High-Quality Custom Machine Learning Models With Minimal Machine Learning Expertise And Effort. + +:::info Service Summary + +
+
+total resources: 51
+total selectable resources: 41
+total methods: 273
+
+
+ +::: + +## Overview + + + + + + +
Namegoogle.aiplatform
TypeService
TitleVertex AI API
DescriptionTrain High-Quality Custom Machine Learning Models With Minimal Machine Learning Expertise And Effort.
Idaiplatform:v23.08.00157
+ +## Resources +
+
+annotation_specs
+annotations
+artifacts
+batch_prediction_jobs
+contexts
+contexts_context_artifacts_and_executions
+contexts_context_children
+custom_jobs
+data_items
+data_labeling_jobs
+datasets
+endpoints
+entity_types
+entity_types_feature_values
+entity_types_iam_policies
+evaluations
+executions
+executions_execution_events
+experiments
+features
+featurestores
+featurestores_iam_policies
+hyperparameter_tuning_jobs
+index_endpoints
+indexes
+indexes_datapoints
+
+
+locations
+metadata_schemas
+metadata_stores
+migratable_resources
+model_deployment_monitoring_jobs
+models
+models_explanation_dataset
+models_version
+models_versions
+nas_jobs
+nas_trial_details
+operations
+pipeline_jobs
+runs
+saved_queries
+schedules
+slices
+specialist_pools
+studies
+tensorboards
+time_series
+training_pipelines
+trials
+trials_optimal_trials
+trials_trial_measurement
+
+
diff --git a/docs/google-docs/providers/google/aiplatform/index_endpoints/index.md b/docs/google-docs/providers/google/aiplatform/index_endpoints/index.md new file mode 100644 index 0000000000..dc20b6f6ee --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/index_endpoints/index.md @@ -0,0 +1,56 @@ +--- +title: index_endpoints +hide_title: false +hide_table_of_contents: false +keywords: + - index_endpoints + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameindex_endpoints
TypeResource
Idgoogle.aiplatform.index_endpoints
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The resource name of the IndexEndpoint. | +| `description` | `string` | The description of the IndexEndpoint. | +| `deployedIndexes` | `array` | Output only. The indexes deployed in this endpoint. | +| `enablePrivateServiceConnect` | `boolean` | Optional. Deprecated: If true, expose the IndexEndpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set. | +| `labels` | `object` | The labels with user-defined metadata to organize your IndexEndpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. | +| `network` | `string` | Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the IndexEndpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. network and private_service_connect_config are mutually exclusive. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in '12345', and {network} is network name. | +| `updateTime` | `string` | Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of. | +| `createTime` | `string` | Output only. Timestamp when this IndexEndpoint was created. | +| `privateServiceConnectConfig` | `object` | Represents configuration for private service connect. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `publicEndpointEnabled` | `boolean` | Optional. If true, the deployed index will be accessible through public endpoint. | +| `displayName` | `string` | Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `publicEndpointDomainName` | `string` | Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `indexEndpointsId, locationsId, projectsId` | Gets an IndexEndpoint. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists IndexEndpoints in a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates an IndexEndpoint. | +| `delete` | `DELETE` | `indexEndpointsId, locationsId, projectsId` | Deletes an IndexEndpoint. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists IndexEndpoints in a Location. | +| `deploy_index` | `EXEC` | `indexEndpointsId, locationsId, projectsId` | Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed. | +| `find_neighbors` | `EXEC` | `indexEndpointsId, locationsId, projectsId` | Finds the nearest neighbors of each vector within the request. | +| `mutate_deployed_index` | `EXEC` | `indexEndpointsId, locationsId, projectsId` | Update an existing DeployedIndex under an IndexEndpoint. | +| `patch` | `EXEC` | `indexEndpointsId, locationsId, projectsId` | Updates an IndexEndpoint. | +| `read_index_datapoints` | `EXEC` | `indexEndpointsId, locationsId, projectsId` | Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch. | +| `undeploy_index` | `EXEC` | `indexEndpointsId, locationsId, projectsId` | Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. | diff --git a/docs/google-docs/providers/google/aiplatform/indexes/index.md b/docs/google-docs/providers/google/aiplatform/indexes/index.md new file mode 100644 index 0000000000..9d75a027ea --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/indexes/index.md @@ -0,0 +1,51 @@ +--- +title: indexes +hide_title: false +hide_table_of_contents: false +keywords: + - indexes + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameindexes
TypeResource
Idgoogle.aiplatform.indexes
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The resource name of the Index. | +| `description` | `string` | The description of the Index. | +| `createTime` | `string` | Output only. Timestamp when this Index was created. | +| `metadata` | `any` | An additional information about the Index; the schema of the metadata can be found in metadata_schema. | +| `displayName` | `string` | Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `indexUpdateMethod` | `string` | Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default. | +| `deployedIndexes` | `array` | Output only. The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first. | +| `updateTime` | `string` | Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. | +| `indexStats` | `object` | Stats of the Index. | +| `metadataSchemaUri` | `string` | Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. | +| `labels` | `object` | The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `indexesId, locationsId, projectsId` | Gets an Index. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists Indexes in a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates an Index. | +| `delete` | `DELETE` | `indexesId, locationsId, projectsId` | Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Indexes in a Location. | +| `patch` | `EXEC` | `indexesId, locationsId, projectsId` | Updates an Index. | +| `upsert_datapoints` | `EXEC` | `indexesId, locationsId, projectsId` | Add/update Datapoints into an Index. | diff --git a/docs/google-docs/providers/google/aiplatform/indexes_datapoints/index.md b/docs/google-docs/providers/google/aiplatform/indexes_datapoints/index.md new file mode 100644 index 0000000000..fb10e3a1c5 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/indexes_datapoints/index.md @@ -0,0 +1,32 @@ +--- +title: indexes_datapoints +hide_title: false +hide_table_of_contents: false +keywords: + - indexes_datapoints + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameindexes_datapoints
TypeResource
Idgoogle.aiplatform.indexes_datapoints
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `remove_datapoints` | `EXEC` | `indexesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/aiplatform/locations/index.md b/docs/google-docs/providers/google/aiplatform/locations/index.md new file mode 100644 index 0000000000..491e5b69cb --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/locations/index.md @@ -0,0 +1,40 @@ +--- +title: locations +hide_title: false +hide_table_of_contents: false +keywords: + - locations + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namelocations
TypeResource
Idgoogle.aiplatform.locations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | +| `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/aiplatform/metadata_schemas/index.md b/docs/google-docs/providers/google/aiplatform/metadata_schemas/index.md new file mode 100644 index 0000000000..0d32520ff4 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/metadata_schemas/index.md @@ -0,0 +1,42 @@ +--- +title: metadata_schemas +hide_title: false +hide_table_of_contents: false +keywords: + - metadata_schemas + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namemetadata_schemas
TypeResource
Idgoogle.aiplatform.metadata_schemas
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The resource name of the MetadataSchema. | +| `description` | `string` | Description of the Metadata Schema | +| `schema` | `string` | Required. The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by `title` in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 [MetadataSchema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) | +| `schemaType` | `string` | The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema. | +| `schemaVersion` | `string` | The version of the MetadataSchema. The version's format must match the following regular expression: `^[0-9]+.+.+$`, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc. | +| `createTime` | `string` | Output only. Timestamp when this MetadataSchema was created. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `locationsId, metadataSchemasId, metadataStoresId, projectsId` | Retrieves a specific MetadataSchema. | +| `list` | `SELECT` | `locationsId, metadataStoresId, projectsId` | Lists MetadataSchemas. | +| `create` | `INSERT` | `locationsId, metadataStoresId, projectsId` | Creates a MetadataSchema. | +| `_list` | `EXEC` | `locationsId, metadataStoresId, projectsId` | Lists MetadataSchemas. | diff --git a/docs/google-docs/providers/google/aiplatform/metadata_stores/index.md b/docs/google-docs/providers/google/aiplatform/metadata_stores/index.md new file mode 100644 index 0000000000..3c28839a08 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/metadata_stores/index.md @@ -0,0 +1,43 @@ +--- +title: metadata_stores +hide_title: false +hide_table_of_contents: false +keywords: + - metadata_stores + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namemetadata_stores
TypeResource
Idgoogle.aiplatform.metadata_stores
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The resource name of the MetadataStore instance. | +| `description` | `string` | Description of the MetadataStore. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `state` | `object` | Represents state information for a MetadataStore. | +| `updateTime` | `string` | Output only. Timestamp when this MetadataStore was last updated. | +| `createTime` | `string` | Output only. Timestamp when this MetadataStore was created. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `locationsId, metadataStoresId, projectsId` | Retrieves a specific MetadataStore. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists MetadataStores for a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Initializes a MetadataStore, including allocation of resources. | +| `delete` | `DELETE` | `locationsId, metadataStoresId, projectsId` | Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts). | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists MetadataStores for a Location. | diff --git a/docs/google-docs/providers/google/aiplatform/migratable_resources/index.md b/docs/google-docs/providers/google/aiplatform/migratable_resources/index.md new file mode 100644 index 0000000000..da3217e2c4 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/migratable_resources/index.md @@ -0,0 +1,33 @@ +--- +title: migratable_resources +hide_title: false +hide_table_of_contents: false +keywords: + - migratable_resources + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namemigratable_resources
TypeResource
Idgoogle.aiplatform.migratable_resources
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `batch_migrate` | `EXEC` | `locationsId, projectsId` | Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI. | +| `search` | `EXEC` | `locationsId, projectsId` | Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location. | 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 new file mode 100644 index 0000000000..92148c8b8f --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/model_deployment_monitoring_jobs/index.md @@ -0,0 +1,64 @@ +--- +title: model_deployment_monitoring_jobs +hide_title: false +hide_table_of_contents: false +keywords: + - model_deployment_monitoring_jobs + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namemodel_deployment_monitoring_jobs
TypeResource
Idgoogle.aiplatform.model_deployment_monitoring_jobs
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Resource name of a ModelDeploymentMonitoringJob. | +| `labels` | `object` | The labels with user-defined metadata to organize your ModelDeploymentMonitoringJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. | +| `displayName` | `string` | Required. The user-defined name of the ModelDeploymentMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Display name of a ModelDeploymentMonitoringJob. | +| `latestMonitoringPipelineMetadata` | `object` | All metadata of most recent monitoring pipelines. | +| `logTtl` | `string` | The TTL of BigQuery tables in user projects which stores logs. A day is the basic unit of the TTL and we take the ceil of TTL/86400(a day). e.g. { second: 3600} indicates ttl = 1 day. | +| `bigqueryTables` | `array` | Output only. The created bigquery tables for the job under customer project. Customer could do their own query & analysis. There could be 4 log tables in maximum: 1. Training data logging predict request/response 2. Serving data logging predict request/response | +| `endpoint` | `string` | Required. Endpoint resource name. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` | +| `statsAnomaliesBaseDirectory` | `object` | The Google Cloud Storage location where the output is to be written to. | +| `enableMonitoringPipelineLogs` | `boolean` | If true, the scheduled monitoring pipeline logs are sent to Google Cloud Logging, including pipeline status and anomalies detected. Please note the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging#pricing). | +| `error` | `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). | +| `modelMonitoringAlertConfig` | `object` | | +| `analysisInstanceSchemaUri` | `string` | YAML schema file uri describing the format of a single instance that you want Tensorflow Data Validation (TFDV) to analyze. If this field is empty, all the feature data types are inferred from predict_instance_schema_uri, meaning that TFDV will use the data in the exact format(data type) as prediction request/response. If there are any data type differences between predict instance and TFDV instance, this field can be used to override the schema. For models trained with Vertex AI, this field must be set as all the fields in predict instance formatted as string. | +| `state` | `string` | Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'. | +| `modelDeploymentMonitoringScheduleConfig` | `object` | The config for scheduling monitoring job. | +| `loggingSamplingStrategy` | `object` | Sampling Strategy for logging, can be for both training and prediction dataset. | +| `modelDeploymentMonitoringObjectiveConfigs` | `array` | Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately. | +| `samplePredictInstance` | `any` | Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. | +| `nextScheduleTime` | `string` | Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. | +| `predictInstanceSchemaUri` | `string` | YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests. | +| `scheduleState` | `string` | Output only. Schedule state when the monitoring job is in Running state. | +| `createTime` | `string` | Output only. Timestamp when this ModelDeploymentMonitoringJob was created. | +| `updateTime` | `string` | Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `locationsId, modelDeploymentMonitoringJobsId, projectsId` | Gets a ModelDeploymentMonitoringJob. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists ModelDeploymentMonitoringJobs in a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval. | +| `delete` | `DELETE` | `locationsId, modelDeploymentMonitoringJobsId, projectsId` | Deletes a ModelDeploymentMonitoringJob. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists ModelDeploymentMonitoringJobs in a Location. | +| `patch` | `EXEC` | `locationsId, modelDeploymentMonitoringJobsId, projectsId` | Updates a ModelDeploymentMonitoringJob. | +| `pause` | `EXEC` | `locationsId, modelDeploymentMonitoringJobsId, projectsId` | Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'. | +| `resume` | `EXEC` | `locationsId, modelDeploymentMonitoringJobsId, projectsId` | Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed. | +| `search_model_deployment_monitoring_stats_anomalies` | `EXEC` | `locationsId, modelDeploymentMonitoringJobsId, projectsId` | Searches Model Monitoring Statistics generated within a given time window. | diff --git a/docs/google-docs/providers/google/aiplatform/models/index.md b/docs/google-docs/providers/google/aiplatform/models/index.md new file mode 100644 index 0000000000..eb48f87d63 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/models/index.md @@ -0,0 +1,73 @@ +--- +title: models +hide_title: false +hide_table_of_contents: false +keywords: + - models + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namemodels
TypeResource
Idgoogle.aiplatform.models
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | The resource name of the Model. | +| `description` | `string` | The description of the Model. | +| `explanationSpec` | `object` | Specification of Model explanation. | +| `labels` | `object` | The labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. | +| `supportedExportFormats` | `array` | Output only. The formats in which this Model may be exported. If empty, this Model is not available for export. | +| `metadataArtifact` | `string` | Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. | +| `versionAliases` | `array` | User provided version aliases so that a model version can be referenced via alias (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` instead of auto-generated version id (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `displayName` | `string` | Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `versionId` | `string` | Output only. Immutable. The version ID of the model. A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation. | +| `artifactUri` | `string` | Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not present for AutoML Models or Large Models. | +| `metadataSchemaUri` | `string` | Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. | +| `supportedOutputStorageFormats` | `array` | Output only. The formats this Model supports in BatchPredictionJob.output_config. If both PredictSchemata.instance_schema_uri and PredictSchemata.prediction_schema_uri exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are: * `jsonl` The JSON Lines format, where each prediction is a single line. Uses GcsDestination. * `csv` The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsDestination. * `bigquery` Each prediction is a single row in a BigQuery table, uses BigQueryDestination . If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain. | +| `supportedDeploymentResourcesTypes` | `array` | Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats. | +| `containerSpec` | `object` | Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). | +| `originalModelInfo` | `object` | Contains information about the original Model if this Model is a copy. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `deployedModels` | `array` | Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations. | +| `pipelineJob` | `string` | Optional. This field is populated if the model is produced by a pipeline job. | +| `versionCreateTime` | `string` | Output only. Timestamp when this version was created. | +| `supportedInputStorageFormats` | `array` | Output only. The formats this Model supports in BatchPredictionJob.input_config. If PredictSchemata.instance_schema_uri exists, the instances should be given as per that schema. The possible formats are: * `jsonl` The JSON Lines format, where each instance is a single line. Uses GcsSource. * `csv` The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsSource. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * `bigquery` Each instance is a single row in BigQuery. Uses BigQuerySource. * `file-list` Each line of the file is the location of an instance to process, uses `gcs_source` field of the InputConfig object. If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain. | +| `metadata` | `any` | Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information. | +| `predictSchemata` | `object` | Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. | +| `updateTime` | `string` | Output only. Timestamp when this Model was most recently updated. | +| `versionUpdateTime` | `string` | Output only. Timestamp when this version was most recently updated. | +| `modelSourceInfo` | `object` | Detail description of the source information of the model. | +| `trainingPipeline` | `string` | Output only. The resource name of the TrainingPipeline that uploaded this Model, if any. | +| `versionDescription` | `string` | The description of this version. | +| `createTime` | `string` | Output only. Timestamp when this Model was uploaded into Vertex AI. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `locationsId, modelsId, projectsId` | Gets a Model. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists Models in a Location. | +| `delete` | `DELETE` | `locationsId, modelsId, projectsId` | Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Models in a Location. | +| `copy` | `EXEC` | `locationsId, projectsId` | Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible. | +| `export` | `EXEC` | `locationsId, modelsId, projectsId` | Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format. | +| `merge_version_aliases` | `EXEC` | `locationsId, modelsId, projectsId` | Merges a set of aliases for a Model version. | +| `patch` | `EXEC` | `locationsId, modelsId, projectsId` | Updates a Model. | +| `predict` | `EXEC` | `locationsId, modelsId, projectsId, publishersId` | Perform an online prediction. | +| `raw_predict` | `EXEC` | `locationsId, modelsId, projectsId, publishersId` | 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. | +| `server_streaming_predict` | `EXEC` | `locationsId, modelsId, projectsId, publishersId` | Perform a server-side streaming online prediction request for Vertex LLM streaming. | +| `upload` | `EXEC` | `locationsId, projectsId` | Uploads a Model artifact into Vertex AI. | diff --git a/docs/google-docs/providers/google/aiplatform/models_explanation_dataset/index.md b/docs/google-docs/providers/google/aiplatform/models_explanation_dataset/index.md new file mode 100644 index 0000000000..68f903e439 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/models_explanation_dataset/index.md @@ -0,0 +1,32 @@ +--- +title: models_explanation_dataset +hide_title: false +hide_table_of_contents: false +keywords: + - models_explanation_dataset + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namemodels_explanation_dataset
TypeResource
Idgoogle.aiplatform.models_explanation_dataset
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `update_explanation_dataset` | `EXEC` | `locationsId, modelsId, projectsId` | diff --git a/docs/google-docs/providers/google/aiplatform/models_version/index.md b/docs/google-docs/providers/google/aiplatform/models_version/index.md new file mode 100644 index 0000000000..d67c00b519 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/models_version/index.md @@ -0,0 +1,32 @@ +--- +title: models_version +hide_title: false +hide_table_of_contents: false +keywords: + - models_version + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namemodels_version
TypeResource
Idgoogle.aiplatform.models_version
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `delete_version` | `DELETE` | `locationsId, modelsId, projectsId` | diff --git a/docs/google-docs/providers/google/aiplatform/models_versions/index.md b/docs/google-docs/providers/google/aiplatform/models_versions/index.md new file mode 100644 index 0000000000..1eef4fb75e --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/models_versions/index.md @@ -0,0 +1,63 @@ +--- +title: models_versions +hide_title: false +hide_table_of_contents: false +keywords: + - models_versions + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namemodels_versions
TypeResource
Idgoogle.aiplatform.models_versions
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | The resource name of the Model. | +| `description` | `string` | The description of the Model. | +| `versionUpdateTime` | `string` | Output only. Timestamp when this version was most recently updated. | +| `supportedOutputStorageFormats` | `array` | Output only. The formats this Model supports in BatchPredictionJob.output_config. If both PredictSchemata.instance_schema_uri and PredictSchemata.prediction_schema_uri exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are: * `jsonl` The JSON Lines format, where each prediction is a single line. Uses GcsDestination. * `csv` The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsDestination. * `bigquery` Each prediction is a single row in a BigQuery table, uses BigQueryDestination . If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain. | +| `metadata` | `any` | Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information. | +| `supportedDeploymentResourcesTypes` | `array` | Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `predictSchemata` | `object` | Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. | +| `createTime` | `string` | Output only. Timestamp when this Model was uploaded into Vertex AI. | +| `deployedModels` | `array` | Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations. | +| `supportedExportFormats` | `array` | Output only. The formats in which this Model may be exported. If empty, this Model is not available for export. | +| `supportedInputStorageFormats` | `array` | Output only. The formats this Model supports in BatchPredictionJob.input_config. If PredictSchemata.instance_schema_uri exists, the instances should be given as per that schema. The possible formats are: * `jsonl` The JSON Lines format, where each instance is a single line. Uses GcsSource. * `csv` The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsSource. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * `bigquery` Each instance is a single row in BigQuery. Uses BigQuerySource. * `file-list` Each line of the file is the location of an instance to process, uses `gcs_source` field of the InputConfig object. If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain. | +| `versionId` | `string` | Output only. Immutable. The version ID of the model. A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation. | +| `metadataArtifact` | `string` | Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. | +| `versionCreateTime` | `string` | Output only. Timestamp when this version was created. | +| `modelSourceInfo` | `object` | Detail description of the source information of the model. | +| `artifactUri` | `string` | Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not present for AutoML Models or Large Models. | +| `containerSpec` | `object` | Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). | +| `pipelineJob` | `string` | Optional. This field is populated if the model is produced by a pipeline job. | +| `labels` | `object` | The labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. | +| `metadataSchemaUri` | `string` | Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. | +| `updateTime` | `string` | Output only. Timestamp when this Model was most recently updated. | +| `explanationSpec` | `object` | Specification of Model explanation. | +| `displayName` | `string` | Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `versionAliases` | `array` | User provided version aliases so that a model version can be referenced via alias (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` instead of auto-generated version id (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `originalModelInfo` | `object` | Contains information about the original Model if this Model is a copy. | +| `versionDescription` | `string` | The description of this version. | +| `trainingPipeline` | `string` | Output only. The resource name of the TrainingPipeline that uploaded this Model, if any. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `list_versions` | `SELECT` | `locationsId, modelsId, projectsId` | +| `_list_versions` | `EXEC` | `locationsId, modelsId, projectsId` | diff --git a/docs/google-docs/providers/google/aiplatform/nas_jobs/index.md b/docs/google-docs/providers/google/aiplatform/nas_jobs/index.md new file mode 100644 index 0000000000..f6cc47fafe --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/nas_jobs/index.md @@ -0,0 +1,51 @@ +--- +title: nas_jobs +hide_title: false +hide_table_of_contents: false +keywords: + - nas_jobs + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namenas_jobs
TypeResource
Idgoogle.aiplatform.nas_jobs
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Resource name of the NasJob. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `labels` | `object` | The labels with user-defined metadata to organize NasJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. | +| `state` | `string` | Output only. The detailed state of the job. | +| `endTime` | `string` | Output only. Time when the NasJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | +| `enableRestrictedImageTraining` | `boolean` | Optional. Enable a separation of Custom model training and restricted image training for tenant project. | +| `error` | `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). | +| `nasJobOutput` | `object` | Represents a uCAIP NasJob output. | +| `displayName` | `string` | Required. The display name of the NasJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `nasJobSpec` | `object` | Represents the spec of a NasJob. | +| `startTime` | `string` | Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state. | +| `updateTime` | `string` | Output only. Time when the NasJob was most recently updated. | +| `createTime` | `string` | Output only. Time when the NasJob was created. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `locationsId, nasJobsId, projectsId` | Gets a NasJob | +| `list` | `SELECT` | `locationsId, projectsId` | Lists NasJobs in a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates a NasJob | +| `delete` | `DELETE` | `locationsId, nasJobsId, projectsId` | Deletes a NasJob. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists NasJobs in a Location. | +| `cancel` | `EXEC` | `locationsId, nasJobsId, projectsId` | Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`. | diff --git a/docs/google-docs/providers/google/aiplatform/nas_trial_details/index.md b/docs/google-docs/providers/google/aiplatform/nas_trial_details/index.md new file mode 100644 index 0000000000..33fb988e1b --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/nas_trial_details/index.md @@ -0,0 +1,39 @@ +--- +title: nas_trial_details +hide_title: false +hide_table_of_contents: false +keywords: + - nas_trial_details + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namenas_trial_details
TypeResource
Idgoogle.aiplatform.nas_trial_details
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Resource name of the NasTrialDetail. | +| `trainTrial` | `object` | Represents a uCAIP NasJob trial. | +| `parameters` | `string` | The parameters for the NasJob NasTrial. | +| `searchTrial` | `object` | Represents a uCAIP NasJob trial. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `locationsId, nasJobsId, nasTrialDetailsId, projectsId` | Gets a NasTrialDetail. | +| `list` | `SELECT` | `locationsId, nasJobsId, projectsId` | List top NasTrialDetails of a NasJob. | +| `_list` | `EXEC` | `locationsId, nasJobsId, projectsId` | List top NasTrialDetails of a NasJob. | diff --git a/docs/google-docs/providers/google/aiplatform/operations/index.md b/docs/google-docs/providers/google/aiplatform/operations/index.md new file mode 100644 index 0000000000..d678860df2 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/operations/index.md @@ -0,0 +1,43 @@ +--- +title: operations +hide_title: false +hide_table_of_contents: false +keywords: + - operations + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameoperations
TypeResource
Idgoogle.aiplatform.operations
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `locationsId, operationsId, projectsId, specialistPoolsId` | 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. | +| `list` | `SELECT` | `locationsId, projectsId, specialistPoolsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `delete` | `DELETE` | `locationsId, operationsId, projectsId, specialistPoolsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId, specialistPoolsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `cancel` | `EXEC` | `locationsId, operationsId, projectsId, specialistPoolsId` | 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`. | +| `wait` | `EXEC` | `locationsId, operationsId, projectsId, specialistPoolsId` | 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. | diff --git a/docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md b/docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md new file mode 100644 index 0000000000..224013ca5c --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md @@ -0,0 +1,56 @@ +--- +title: pipeline_jobs +hide_title: false +hide_table_of_contents: false +keywords: + - pipeline_jobs + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namepipeline_jobs
TypeResource
Idgoogle.aiplatform.pipeline_jobs
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The resource name of the PipelineJob. | +| `jobDetail` | `object` | The runtime detail of PipelineJob. | +| `updateTime` | `string` | Output only. Timestamp when this PipelineJob was most recently updated. | +| `runtimeConfig` | `object` | The runtime config of a PipelineJob. | +| `error` | `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). | +| `labels` | `object` | The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided. | +| `createTime` | `string` | Output only. Pipeline creation time. | +| `serviceAccount` | `string` | The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. | +| `reservedIpRanges` | `array` | A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. | +| `network` | `string` | The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. | +| `startTime` | `string` | Output only. Pipeline start time. | +| `state` | `string` | Output only. The detailed state of the job. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `templateMetadata` | `object` | Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. | +| `templateUri` | `string` | A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. | +| `displayName` | `string` | The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `endTime` | `string` | Output only. Pipeline end time. | +| `pipelineSpec` | `object` | The spec of the pipeline. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `locationsId, pipelineJobsId, projectsId` | Gets a PipelineJob. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists PipelineJobs in a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates a PipelineJob. A PipelineJob will run immediately when created. | +| `delete` | `DELETE` | `locationsId, pipelineJobsId, projectsId` | Deletes a PipelineJob. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists PipelineJobs in a Location. | +| `cancel` | `EXEC` | `locationsId, pipelineJobsId, projectsId` | Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`. | diff --git a/docs/google-docs/providers/google/aiplatform/runs/index.md b/docs/google-docs/providers/google/aiplatform/runs/index.md new file mode 100644 index 0000000000..f3a67b2d58 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/runs/index.md @@ -0,0 +1,47 @@ +--- +title: runs +hide_title: false +hide_table_of_contents: false +keywords: + - runs + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameruns
TypeResource
Idgoogle.aiplatform.runs
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` | +| `description` | `string` | Description of this TensorboardRun. | +| `updateTime` | `string` | Output only. Timestamp when this TensorboardRun was last updated. | +| `createTime` | `string` | Output only. Timestamp when this TensorboardRun was created. | +| `displayName` | `string` | Required. User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment. | +| `etag` | `string` | Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `labels` | `object` | The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `experimentsId, locationsId, projectsId, runsId, tensorboardsId` | Gets a TensorboardRun. | +| `list` | `SELECT` | `experimentsId, locationsId, projectsId, tensorboardsId` | Lists TensorboardRuns in a Location. | +| `create` | `INSERT` | `experimentsId, locationsId, projectsId, tensorboardsId` | Creates a TensorboardRun. | +| `delete` | `DELETE` | `experimentsId, locationsId, projectsId, runsId, tensorboardsId` | Deletes a TensorboardRun. | +| `_list` | `EXEC` | `experimentsId, locationsId, projectsId, tensorboardsId` | Lists TensorboardRuns in a Location. | +| `batch_create` | `EXEC` | `experimentsId, locationsId, projectsId, tensorboardsId` | Batch create TensorboardRuns. | +| `patch` | `EXEC` | `experimentsId, locationsId, projectsId, runsId, tensorboardsId` | Updates a TensorboardRun. | +| `write` | `EXEC` | `experimentsId, locationsId, projectsId, runsId, tensorboardsId` | Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned. | diff --git a/docs/google-docs/providers/google/aiplatform/saved_queries/index.md b/docs/google-docs/providers/google/aiplatform/saved_queries/index.md new file mode 100644 index 0000000000..863e995736 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/saved_queries/index.md @@ -0,0 +1,45 @@ +--- +title: saved_queries +hide_title: false +hide_table_of_contents: false +keywords: + - saved_queries + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namesaved_queries
TypeResource
Idgoogle.aiplatform.saved_queries
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Resource name of the SavedQuery. | +| `problemType` | `string` | Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING | +| `displayName` | `string` | Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `annotationFilter` | `string` | Output only. Filters on the Annotations in the dataset. | +| `annotationSpecCount` | `integer` | Output only. Number of AnnotationSpecs in the context of the SavedQuery. | +| `createTime` | `string` | Output only. Timestamp when this SavedQuery was created. | +| `updateTime` | `string` | Output only. Timestamp when SavedQuery was last updated. | +| `metadata` | `any` | Some additional information about the SavedQuery. | +| `supportAutomlTraining` | `boolean` | Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training. | +| `etag` | `string` | Used to perform a consistent read-modify-write update. If not set, a blind "overwrite" update happens. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `list` | `SELECT` | `datasetsId, locationsId, projectsId` | Lists SavedQueries in a Dataset. | +| `delete` | `DELETE` | `datasetsId, locationsId, projectsId, savedQueriesId` | Deletes a SavedQuery. | +| `_list` | `EXEC` | `datasetsId, locationsId, projectsId` | Lists SavedQueries in a Dataset. | diff --git a/docs/google-docs/providers/google/aiplatform/schedules/index.md b/docs/google-docs/providers/google/aiplatform/schedules/index.md new file mode 100644 index 0000000000..7587df1d2e --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/schedules/index.md @@ -0,0 +1,58 @@ +--- +title: schedules +hide_title: false +hide_table_of_contents: false +keywords: + - schedules + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameschedules
TypeResource
Idgoogle.aiplatform.schedules
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Immutable. The resource name of the Schedule. | +| `displayName` | `string` | Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `createPipelineJobRequest` | `object` | Request message for PipelineService.CreatePipelineJob. | +| `endTime` | `string` | Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified. | +| `state` | `string` | Output only. The state of this Schedule. | +| `maxConcurrentRunCount` | `string` | Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). | +| `createTime` | `string` | Output only. Timestamp when this Schedule was created. | +| `maxRunCount` | `string` | Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified. | +| `lastPauseTime` | `string` | Output only. Timestamp when this Schedule was last paused. Unset if never paused. | +| `startedRunCount` | `string` | Output only. The number of runs started by this schedule. | +| `cron` | `string` | Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". | +| `catchUp` | `boolean` | Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false. | +| `lastResumeTime` | `string` | Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause. | +| `lastScheduledRunResponse` | `object` | Status of a scheduled run. | +| `nextRunTime` | `string` | Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule. | +| `allowQueueing` | `boolean` | Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false. | +| `updateTime` | `string` | Output only. Timestamp when this Schedule was updated. | +| `startTime` | `string` | Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `locationsId, projectsId, schedulesId` | Gets a Schedule. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists Schedules in a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates a Schedule. | +| `delete` | `DELETE` | `locationsId, projectsId, schedulesId` | Deletes a Schedule. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Schedules in a Location. | +| `patch` | `EXEC` | `locationsId, projectsId, schedulesId` | Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled. | +| `pause` | `EXEC` | `locationsId, projectsId, schedulesId` | Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled. | +| `resume` | `EXEC` | `locationsId, projectsId, schedulesId` | Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catchUp is set up true, all missed runs will be scheduled for backfill first. | diff --git a/docs/google-docs/providers/google/aiplatform/slices/index.md b/docs/google-docs/providers/google/aiplatform/slices/index.md new file mode 100644 index 0000000000..1326a75f1e --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/slices/index.md @@ -0,0 +1,42 @@ +--- +title: slices +hide_title: false +hide_table_of_contents: false +keywords: + - slices + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nameslices
TypeResource
Idgoogle.aiplatform.slices
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The resource name of the ModelEvaluationSlice. | +| `metrics` | `any` | Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri | +| `metricsSchemaUri` | `string` | Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). | +| `modelExplanation` | `object` | Aggregated explanation metrics for a Model over a set of instances. | +| `slice` | `object` | Definition of a slice. | +| `createTime` | `string` | Output only. Timestamp when this ModelEvaluationSlice was created. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `evaluationsId, locationsId, modelsId, projectsId, slicesId` | Gets a ModelEvaluationSlice. | +| `list` | `SELECT` | `evaluationsId, locationsId, modelsId, projectsId` | Lists ModelEvaluationSlices in a ModelEvaluation. | +| `_list` | `EXEC` | `evaluationsId, locationsId, modelsId, projectsId` | Lists ModelEvaluationSlices in a ModelEvaluation. | +| `batch_import` | `EXEC` | `evaluationsId, locationsId, modelsId, projectsId, slicesId` | Imports a list of externally generated EvaluatedAnnotations. | diff --git a/docs/google-docs/providers/google/aiplatform/specialist_pools/index.md b/docs/google-docs/providers/google/aiplatform/specialist_pools/index.md new file mode 100644 index 0000000000..e44b2af606 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/specialist_pools/index.md @@ -0,0 +1,44 @@ +--- +title: specialist_pools +hide_title: false +hide_table_of_contents: false +keywords: + - specialist_pools + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namespecialist_pools
TypeResource
Idgoogle.aiplatform.specialist_pools
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Required. The resource name of the SpecialistPool. | +| `specialistWorkerEmails` | `array` | The email addresses of workers in the SpecialistPool. | +| `displayName` | `string` | Required. The user-defined name of the SpecialistPool. The name can be up to 128 characters long and can consist of any UTF-8 characters. This field should be unique on project-level. | +| `pendingDataLabelingJobs` | `array` | Output only. The resource name of the pending data labeling jobs. | +| `specialistManagerEmails` | `array` | The email addresses of the managers in the SpecialistPool. | +| `specialistManagersCount` | `integer` | Output only. The number of managers in this SpecialistPool. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `locationsId, projectsId, specialistPoolsId` | Gets a SpecialistPool. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists SpecialistPools in a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates a SpecialistPool. | +| `delete` | `DELETE` | `locationsId, projectsId, specialistPoolsId` | Deletes a SpecialistPool as well as all Specialists in the pool. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists SpecialistPools in a Location. | +| `patch` | `EXEC` | `locationsId, projectsId, specialistPoolsId` | Updates a SpecialistPool. | diff --git a/docs/google-docs/providers/google/aiplatform/studies/index.md b/docs/google-docs/providers/google/aiplatform/studies/index.md new file mode 100644 index 0000000000..eefa44c0c2 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/studies/index.md @@ -0,0 +1,44 @@ +--- +title: studies +hide_title: false +hide_table_of_contents: false +keywords: + - studies + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Namestudies
TypeResource
Idgoogle.aiplatform.studies
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The name of a study. The study's globally unique identifier. Format: `projects/{project}/locations/{location}/studies/{study}` | +| `state` | `string` | Output only. The detailed state of a Study. | +| `studySpec` | `object` | Represents specification of a Study. | +| `createTime` | `string` | Output only. Time at which the study was created. | +| `displayName` | `string` | Required. Describes the Study, default value is empty string. | +| `inactiveReason` | `string` | Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `locationsId, projectsId, studiesId` | Gets a Study by name. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists all the studies in a region for an associated project. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates a Study. A resource name will be generated after creation of the Study. | +| `delete` | `DELETE` | `locationsId, projectsId, studiesId` | Deletes a Study. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists all the studies in a region for an associated project. | +| `lookup` | `EXEC` | `locationsId, projectsId` | Looks a study up using the user-defined display_name field instead of the fully qualified resource name. | diff --git a/docs/google-docs/providers/google/aiplatform/tensorboards/index.md b/docs/google-docs/providers/google/aiplatform/tensorboards/index.md new file mode 100644 index 0000000000..364b1ebf29 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/tensorboards/index.md @@ -0,0 +1,51 @@ +--- +title: tensorboards +hide_title: false +hide_table_of_contents: false +keywords: + - tensorboards + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nametensorboards
TypeResource
Idgoogle.aiplatform.tensorboards
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}` | +| `description` | `string` | Description of this Tensorboard. | +| `blobStoragePathPrefix` | `string` | Output only. Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'. | +| `displayName` | `string` | Required. User provided name of this Tensorboard. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `updateTime` | `string` | Output only. Timestamp when this Tensorboard was last updated. | +| `runCount` | `integer` | Output only. The number of Runs stored in this Tensorboard. | +| `createTime` | `string` | Output only. Timestamp when this Tensorboard was created. | +| `etag` | `string` | Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `labels` | `object` | The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. | +| `isDefault` | `boolean` | Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `locationsId, projectsId, tensorboardsId` | Gets a Tensorboard. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists Tensorboards in a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates a Tensorboard. | +| `delete` | `DELETE` | `locationsId, projectsId, tensorboardsId` | Deletes a Tensorboard. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Tensorboards in a Location. | +| `patch` | `EXEC` | `locationsId, projectsId, tensorboardsId` | Updates a Tensorboard. | +| `read_size` | `EXEC` | `locationsId, projectsId, tensorboardsId` | Returns the storage size for a given TensorBoard instance. | +| `read_usage` | `EXEC` | `locationsId, projectsId, tensorboardsId` | Returns a list of monthly active users for a given TensorBoard instance. | diff --git a/docs/google-docs/providers/google/aiplatform/time_series/index.md b/docs/google-docs/providers/google/aiplatform/time_series/index.md new file mode 100644 index 0000000000..4d3879daa8 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/time_series/index.md @@ -0,0 +1,53 @@ +--- +title: time_series +hide_title: false +hide_table_of_contents: false +keywords: + - time_series + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nametime_series
TypeResource
Idgoogle.aiplatform.time_series
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Name of the TensorboardTimeSeries. | +| `description` | `string` | Description of this TensorboardTimeSeries. | +| `createTime` | `string` | Output only. Timestamp when this TensorboardTimeSeries was created. | +| `pluginData` | `string` | Data of the current plugin, with the size limited to 65KB. | +| `pluginName` | `string` | Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob | +| `valueType` | `string` | Required. Immutable. Type of TensorboardTimeSeries value. | +| `displayName` | `string` | Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource). | +| `metadata` | `object` | Describes metadata for a TensorboardTimeSeries. | +| `etag` | `string` | Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `updateTime` | `string` | Output only. Timestamp when this TensorboardTimeSeries was last updated. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `experimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesId` | Gets a TensorboardTimeSeries. | +| `list` | `SELECT` | `experimentsId, locationsId, projectsId, runsId, tensorboardsId` | Lists TensorboardTimeSeries in a Location. | +| `create` | `INSERT` | `experimentsId, locationsId, projectsId, runsId, tensorboardsId` | Creates a TensorboardTimeSeries. | +| `delete` | `DELETE` | `experimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesId` | Deletes a TensorboardTimeSeries. | +| `_list` | `EXEC` | `experimentsId, locationsId, projectsId, runsId, tensorboardsId` | Lists TensorboardTimeSeries in a Location. | +| `batch_create` | `EXEC` | `experimentsId, locationsId, projectsId, runsId, tensorboardsId` | Batch create TensorboardTimeSeries that belong to a TensorboardExperiment. | +| `batch_read` | `EXEC` | `experimentsId, locationsId, projectsId, runsId, tensorboardsId` | Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned. | +| `export_tensorboard_time_series` | `EXEC` | `experimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesId` | Exports a TensorboardTimeSeries' data. Data is returned in paginated responses. | +| `patch` | `EXEC` | `experimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesId` | Updates a TensorboardTimeSeries. | +| `read` | `EXEC` | `experimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesId` | Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k. | +| `read_blob_data` | `EXEC` | `experimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesId` | Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission. | diff --git a/docs/google-docs/providers/google/aiplatform/training_pipelines/index.md b/docs/google-docs/providers/google/aiplatform/training_pipelines/index.md new file mode 100644 index 0000000000..26ee2c5458 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/training_pipelines/index.md @@ -0,0 +1,55 @@ +--- +title: training_pipelines +hide_title: false +hide_table_of_contents: false +keywords: + - training_pipelines + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nametraining_pipelines
TypeResource
Idgoogle.aiplatform.training_pipelines
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Resource name of the TrainingPipeline. | +| `state` | `string` | Output only. The detailed state of the pipeline. | +| `trainingTaskDefinition` | `string` | Required. A Google Cloud Storage path to the YAML file that defines the training task which is responsible for producing the model artifact, and may also include additional auxiliary work. The definition files that can be used here are found in gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. | +| `endTime` | `string` | Output only. Time when the TrainingPipeline entered any of the following states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`. | +| `displayName` | `string` | Required. The user-defined name of this TrainingPipeline. | +| `modelToUpload` | `object` | A trained machine learning Model. | +| `trainingTaskMetadata` | `any` | Output only. The metadata information as specified in the training_task_definition's `metadata`. This metadata is an auxiliary runtime and final information about the training task. While the pipeline is running this information is populated only at a best effort basis. Only present if the pipeline's training_task_definition contains `metadata` object. | +| `createTime` | `string` | Output only. Time when the TrainingPipeline was created. | +| `modelId` | `string` | Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen. | +| `labels` | `object` | The labels with user-defined metadata to organize TrainingPipelines. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. | +| `startTime` | `string` | Output only. Time when the TrainingPipeline for the first time entered the `PIPELINE_STATE_RUNNING` state. | +| `parentModel` | `string` | Optional. When specify this field, the `model_to_upload` will not be uploaded as a new model, instead, it will become a new version of this `parent_model`. | +| `updateTime` | `string` | Output only. Time when the TrainingPipeline was most recently updated. | +| `error` | `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). | +| `inputDataConfig` | `object` | Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `trainingTaskInputs` | `any` | Required. The training task's parameter(s), as specified in the training_task_definition's `inputs`. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `locationsId, projectsId, trainingPipelinesId` | Gets a TrainingPipeline. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists TrainingPipelines in a Location. | +| `create` | `INSERT` | `locationsId, projectsId` | Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run. | +| `delete` | `DELETE` | `locationsId, projectsId, trainingPipelinesId` | Deletes a TrainingPipeline. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists TrainingPipelines in a Location. | +| `cancel` | `EXEC` | `locationsId, projectsId, trainingPipelinesId` | Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`. | diff --git a/docs/google-docs/providers/google/aiplatform/trials/index.md b/docs/google-docs/providers/google/aiplatform/trials/index.md new file mode 100644 index 0000000000..fc6ac83c0e --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/trials/index.md @@ -0,0 +1,53 @@ +--- +title: trials +hide_title: false +hide_table_of_contents: false +keywords: + - trials + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nametrials
TypeResource
Idgoogle.aiplatform.trials
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `id` | `string` | Output only. The identifier of the Trial assigned by the service. | +| `name` | `string` | Output only. Resource name of the Trial assigned by the service. | +| `webAccessUris` | `object` | Output only. URIs for accessing [interactive shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) (one URI for each training node). Only available if this trial is part of a HyperparameterTuningJob and the job's trial_job_spec.enable_web_access field is `true`. The keys are names of each node used for the trial; for example, `workerpool0-0` for the primary node, `workerpool1-0` for the first node in the second worker pool, and `workerpool1-1` for the second node in the second worker pool. The values are the URIs for each node's interactive shell. | +| `endTime` | `string` | Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`. | +| `startTime` | `string` | Output only. Time when the Trial was started. | +| `infeasibleReason` | `string` | Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is `INFEASIBLE`. | +| `parameters` | `array` | Output only. The parameters of the Trial. | +| `clientId` | `string` | Output only. The identifier of the client that originally requested this Trial. Each client is identified by a unique client_id. When a client asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client should evaluate the Trial, complete it, and report back to Vertex AI Vizier. If suggestion is asked again by same client_id before the Trial is completed, the same Trial will be returned. Multiple clients with different client_ids can ask for suggestions simultaneously, each of them will get their own Trial. | +| `finalMeasurement` | `object` | A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. | +| `state` | `string` | Output only. The detailed state of the Trial. | +| `measurements` | `array` | Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations. | +| `customJob` | `string` | Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `locationsId, projectsId, studiesId, trialsId` | Gets a Trial. | +| `list` | `SELECT` | `locationsId, projectsId, studiesId` | Lists the Trials associated with a Study. | +| `create` | `INSERT` | `locationsId, projectsId, studiesId` | Adds a user provided Trial to a Study. | +| `delete` | `DELETE` | `locationsId, projectsId, studiesId, trialsId` | Deletes a Trial. | +| `_list` | `EXEC` | `locationsId, projectsId, studiesId` | Lists the Trials associated with a Study. | +| `check_trial_early_stopping_state` | `EXEC` | `locationsId, projectsId, studiesId, trialsId` | Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse. | +| `complete` | `EXEC` | `locationsId, projectsId, studiesId, trialsId` | Marks a Trial as complete. | +| `stop` | `EXEC` | `locationsId, projectsId, studiesId, trialsId` | Stops a Trial. | +| `suggest` | `EXEC` | `locationsId, projectsId, studiesId` | Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse. | diff --git a/docs/google-docs/providers/google/aiplatform/trials_optimal_trials/index.md b/docs/google-docs/providers/google/aiplatform/trials_optimal_trials/index.md new file mode 100644 index 0000000000..e120005f12 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/trials_optimal_trials/index.md @@ -0,0 +1,32 @@ +--- +title: trials_optimal_trials +hide_title: false +hide_table_of_contents: false +keywords: + - trials_optimal_trials + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nametrials_optimal_trials
TypeResource
Idgoogle.aiplatform.trials_optimal_trials
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `list_optimal_trials` | `EXEC` | `locationsId, projectsId, studiesId` | 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 new file mode 100644 index 0000000000..627ade7737 --- /dev/null +++ b/docs/google-docs/providers/google/aiplatform/trials_trial_measurement/index.md @@ -0,0 +1,32 @@ +--- +title: trials_trial_measurement +hide_title: false +hide_table_of_contents: false +keywords: + - trials_trial_measurement + - aiplatform + - 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 +--- + + + +## Overview + + + + +
Nametrials_trial_measurement
TypeResource
Idgoogle.aiplatform.trials_trial_measurement
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `add_trial_measurement` | `EXEC` | `locationsId, projectsId, studiesId, trialsId` | diff --git a/docs/google-docs/providers/google/analyticshub/data_exchanges/index.md b/docs/google-docs/providers/google/analyticshub/data_exchanges/index.md index 4840fa1869..e056370931 100644 --- a/docs/google-docs/providers/google/analyticshub/data_exchanges/index.md +++ b/docs/google-docs/providers/google/analyticshub/data_exchanges/index.md @@ -27,8 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `dataExchanges` | `array` | The list of data exchanges. | -| `nextPageToken` | `string` | A token to request the next page of results. | +| `name` | `string` | Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. | +| `description` | `string` | Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes. | +| `displayName` | `string` | Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes. | +| `documentation` | `string` | Optional. Documentation describing the data exchange. | +| `icon` | `string` | Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. | +| `listingCount` | `integer` | Output only. Number of listings contained in the data exchange. | +| `primaryContact` | `string` | Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes. | +| `sharingEnvironmentConfig` | `object` | Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +43,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_data_exchanges_list` | `SELECT` | `locationsId, projectsId` | Lists all data exchanges in a given project and location. | | `projects_locations_data_exchanges_create` | `INSERT` | `locationsId, projectsId` | Creates a new data exchange. | | `projects_locations_data_exchanges_delete` | `DELETE` | `dataExchangesId, locationsId, projectsId` | Deletes an existing data exchange. | +| `_organizations_locations_data_exchanges_list` | `EXEC` | `locationsId, organizationsId` | Lists all data exchanges from projects in a given organization and location. | +| `_projects_locations_data_exchanges_list` | `EXEC` | `locationsId, projectsId` | Lists all data exchanges in a given project and location. | | `projects_locations_data_exchanges_patch` | `EXEC` | `dataExchangesId, locationsId, projectsId` | Updates an existing data exchange. | +| `projects_locations_data_exchanges_subscribe` | `EXEC` | `dataExchangesId, locationsId, projectsId` | Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets. | diff --git a/docs/google-docs/providers/google/analyticshub/data_exchanges_iam_policies/index.md b/docs/google-docs/providers/google/analyticshub/data_exchanges_iam_policies/index.md index 58bc9a6b52..03e518b67b 100644 --- a/docs/google-docs/providers/google/analyticshub/data_exchanges_iam_policies/index.md +++ b/docs/google-docs/providers/google/analyticshub/data_exchanges_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_locations_data_exchanges_get_iam_policy` | `EXEC` | `dataExchangesId, locationsId, projectsId` | Gets the IAM policy. | +| `projects_locations_data_exchanges_get_iam_policy` | `SELECT` | `dataExchangesId, locationsId, projectsId` | Gets the IAM policy. | | `projects_locations_data_exchanges_set_iam_policy` | `EXEC` | `dataExchangesId, locationsId, projectsId` | Sets the IAM policy. | | `projects_locations_data_exchanges_test_iam_permissions` | `EXEC` | `dataExchangesId, locationsId, projectsId` | Returns the permissions that a caller has. | diff --git a/docs/google-docs/providers/google/analyticshub/data_exchanges_subscriptions/index.md b/docs/google-docs/providers/google/analyticshub/data_exchanges_subscriptions/index.md new file mode 100644 index 0000000000..d6e4516787 --- /dev/null +++ b/docs/google-docs/providers/google/analyticshub/data_exchanges_subscriptions/index.md @@ -0,0 +1,44 @@ +--- +title: data_exchanges_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - data_exchanges_subscriptions + - analyticshub + - 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 +--- + + + +## Overview + + + + +
Namedata_exchanges_subscriptions
TypeResource
Idgoogle.analyticshub.data_exchanges_subscriptions
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. | +| `creationTime` | `string` | Output only. Timestamp when the subscription was created. | +| `organizationDisplayName` | `string` | Output only. Display name of the project of this subscription. | +| `listing` | `string` | Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 | +| `linkedDatasetMap` | `object` | Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. | +| `organizationId` | `string` | Output only. Organization of the project this subscription belongs to. | +| `state` | `string` | Output only. Current state of the subscription. | +| `subscriberContact` | `string` | Output only. Email of the subscriber. | +| `lastModifyTime` | `string` | Output only. Timestamp when the subscription was last modified. | +| `dataExchange` | `string` | Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `projects_locations_data_exchanges_list_subscriptions` | `SELECT` | `dataExchangesId, locationsId, projectsId` | +| `_projects_locations_data_exchanges_list_subscriptions` | `EXEC` | `dataExchangesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/analyticshub/index.md b/docs/google-docs/providers/google/analyticshub/index.md index 7edc316203..802499f58b 100644 --- a/docs/google-docs/providers/google/analyticshub/index.md +++ b/docs/google-docs/providers/google/analyticshub/index.md @@ -19,9 +19,9 @@ Exchange Data And Analytics Assets Securely And Efficiently.
-total resources: 4
-total selectable resources: 2
-total methods: 18
+total resources: 7
+total selectable resources: 7
+total methods: 32
@@ -33,7 +33,7 @@ Exchange Data And Analytics Assets Securely And Efficiently. TypeService TitleAnalytics Hub API DescriptionExchange Data And Analytics Assets Securely And Efficiently. -Idanalyticshub:v23.08.00155 +Idanalyticshub:v23.08.00157 ## Resources @@ -41,9 +41,12 @@ Exchange Data And Analytics Assets Securely And Efficiently.
data_exchanges
data_exchanges_iam_policies
+data_exchanges_subscriptions
+listings
-listings
listings_iam_policies
+listings_subscriptions
+subscriptions
diff --git a/docs/google-docs/providers/google/analyticshub/listings/index.md b/docs/google-docs/providers/google/analyticshub/listings/index.md index 92fcb26981..ed6f6de755 100644 --- a/docs/google-docs/providers/google/analyticshub/listings/index.md +++ b/docs/google-docs/providers/google/analyticshub/listings/index.md @@ -27,8 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to request the next page of results. | -| `listings` | `array` | The list of Listing. | +| `name` | `string` | Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` | +| `description` | `string` | Optional. Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes. | +| `requestAccess` | `string` | Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes. | +| `bigqueryDataset` | `object` | A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset. | +| `restrictedExportConfig` | `object` | Restricted export config, used to configure restricted export on linked dataset. | +| `displayName` | `string` | Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes. | +| `primaryContact` | `string` | Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes. | +| `documentation` | `string` | Optional. Documentation describing the listing. | +| `state` | `string` | Output only. Current state of the listing. | +| `dataProvider` | `object` | Contains details of the data provider. | +| `icon` | `string` | Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire. | +| `publisher` | `object` | Contains details of the listing publisher. | +| `categories` | `array` | Optional. Categories of the listing. Up to two categories are allowed. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +47,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_data_exchanges_listings_list` | `SELECT` | `dataExchangesId, locationsId, projectsId` | Lists all listings in a given project and location. | | `projects_locations_data_exchanges_listings_create` | `INSERT` | `dataExchangesId, locationsId, projectsId` | Creates a new listing. | | `projects_locations_data_exchanges_listings_delete` | `DELETE` | `dataExchangesId, listingsId, locationsId, projectsId` | Deletes a listing. | +| `_projects_locations_data_exchanges_listings_list` | `EXEC` | `dataExchangesId, locationsId, projectsId` | Lists all listings in a given project and location. | | `projects_locations_data_exchanges_listings_patch` | `EXEC` | `dataExchangesId, listingsId, locationsId, projectsId` | Updates an existing listing. | | `projects_locations_data_exchanges_listings_subscribe` | `EXEC` | `dataExchangesId, listingsId, locationsId, projectsId` | Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project. | diff --git a/docs/google-docs/providers/google/analyticshub/listings_iam_policies/index.md b/docs/google-docs/providers/google/analyticshub/listings_iam_policies/index.md index a0650ecb15..6da0f646cc 100644 --- a/docs/google-docs/providers/google/analyticshub/listings_iam_policies/index.md +++ b/docs/google-docs/providers/google/analyticshub/listings_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_locations_data_exchanges_listings_get_iam_policy` | `EXEC` | `dataExchangesId, listingsId, locationsId, projectsId` | Gets the IAM policy. | +| `projects_locations_data_exchanges_listings_get_iam_policy` | `SELECT` | `dataExchangesId, listingsId, locationsId, projectsId` | Gets the IAM policy. | | `projects_locations_data_exchanges_listings_set_iam_policy` | `EXEC` | `dataExchangesId, listingsId, locationsId, projectsId` | Sets the IAM policy. | | `projects_locations_data_exchanges_listings_test_iam_permissions` | `EXEC` | `dataExchangesId, listingsId, locationsId, projectsId` | Returns the permissions that a caller has. | diff --git a/docs/google-docs/providers/google/analyticshub/listings_subscriptions/index.md b/docs/google-docs/providers/google/analyticshub/listings_subscriptions/index.md new file mode 100644 index 0000000000..f39d928e29 --- /dev/null +++ b/docs/google-docs/providers/google/analyticshub/listings_subscriptions/index.md @@ -0,0 +1,44 @@ +--- +title: listings_subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - listings_subscriptions + - analyticshub + - 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 +--- + + + +## Overview + + + + +
Namelistings_subscriptions
TypeResource
Idgoogle.analyticshub.listings_subscriptions
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. | +| `subscriberContact` | `string` | Output only. Email of the subscriber. | +| `listing` | `string` | Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 | +| `state` | `string` | Output only. Current state of the subscription. | +| `lastModifyTime` | `string` | Output only. Timestamp when the subscription was last modified. | +| `organizationDisplayName` | `string` | Output only. Display name of the project of this subscription. | +| `organizationId` | `string` | Output only. Organization of the project this subscription belongs to. | +| `creationTime` | `string` | Output only. Timestamp when the subscription was created. | +| `dataExchange` | `string` | Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 | +| `linkedDatasetMap` | `object` | Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `projects_locations_data_exchanges_listings_list_subscriptions` | `SELECT` | `dataExchangesId, listingsId, locationsId, projectsId` | +| `_projects_locations_data_exchanges_listings_list_subscriptions` | `EXEC` | `dataExchangesId, listingsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/analyticshub/subscriptions/index.md b/docs/google-docs/providers/google/analyticshub/subscriptions/index.md new file mode 100644 index 0000000000..a8a3c04469 --- /dev/null +++ b/docs/google-docs/providers/google/analyticshub/subscriptions/index.md @@ -0,0 +1,48 @@ +--- +title: subscriptions +hide_title: false +hide_table_of_contents: false +keywords: + - subscriptions + - analyticshub + - 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 +--- + + + +## Overview + + + + +
Namesubscriptions
TypeResource
Idgoogle.analyticshub.subscriptions
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. | +| `lastModifyTime` | `string` | Output only. Timestamp when the subscription was last modified. | +| `organizationId` | `string` | Output only. Organization of the project this subscription belongs to. | +| `linkedDatasetMap` | `object` | Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE. | +| `subscriberContact` | `string` | Output only. Email of the subscriber. | +| `listing` | `string` | Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 | +| `creationTime` | `string` | Output only. Timestamp when the subscription was created. | +| `organizationDisplayName` | `string` | Output only. Display name of the project of this subscription. | +| `dataExchange` | `string` | Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 | +| `state` | `string` | Output only. Current state of the subscription. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `projects_locations_subscriptions_list` | `SELECT` | `locationsId, projectsId` | Lists all subscriptions in a given project and location. | +| `projects_locations_subscriptions_delete` | `DELETE` | `locationsId, projectsId, subscriptionsId` | Deletes a subscription. | +| `_projects_locations_subscriptions_list` | `EXEC` | `locationsId, projectsId` | Lists all subscriptions in a given project and location. | +| `projects_locations_subscriptions_get` | `EXEC` | `locationsId, projectsId, subscriptionsId` | Gets the details of a Subscription. | +| `projects_locations_subscriptions_refresh` | `EXEC` | `locationsId, projectsId, subscriptionsId` | Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets. | +| `projects_locations_subscriptions_revoke` | `EXEC` | `locationsId, projectsId, subscriptionsId` | Revokes a given subscription. | diff --git a/docs/google-docs/providers/google/apigateway/apis/index.md b/docs/google-docs/providers/google/apigateway/apis/index.md index 5948a03acb..f14824a91c 100644 --- a/docs/google-docs/providers/google/apigateway/apis/index.md +++ b/docs/google-docs/providers/google/apigateway/apis/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachableLocations` | `array` | Locations that could not be reached. | -| `apis` | `array` | APIs. | -| `nextPageToken` | `string` | Next page token. | +| `name` | `string` | Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api} | +| `createTime` | `string` | Output only. Created time. | +| `displayName` | `string` | Optional. Display name. | +| `labels` | `object` | Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources | +| `managedService` | `string` | Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API. | +| `state` | `string` | Output only. State of the API. | +| `updateTime` | `string` | Output only. Updated time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +41,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists Apis in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new Api in a given project and location. | | `delete` | `DELETE` | `apisId, locationsId, projectsId` | Deletes a single Api. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Apis in a given project and location. | | `patch` | `EXEC` | `apisId, locationsId, projectsId` | Updates the parameters of a single Api. | diff --git a/docs/google-docs/providers/google/apigateway/apis_iam_policies/index.md b/docs/google-docs/providers/google/apigateway/apis_iam_policies/index.md index c63c129cfc..c727fe5ad8 100644 --- a/docs/google-docs/providers/google/apigateway/apis_iam_policies/index.md +++ b/docs/google-docs/providers/google/apigateway/apis_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigateway/configs/index.md b/docs/google-docs/providers/google/apigateway/configs/index.md index ee7b1cee70..9ee1b95883 100644 --- a/docs/google-docs/providers/google/apigateway/configs/index.md +++ b/docs/google-docs/providers/google/apigateway/configs/index.md @@ -27,9 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `apiConfigs` | `array` | API Configs. | -| `nextPageToken` | `string` | Next page token. | -| `unreachableLocations` | `array` | Locations that could not be reached. | +| `name` | `string` | Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config} | +| `createTime` | `string` | Output only. Created time. | +| `displayName` | `string` | Optional. Display name. | +| `serviceConfigId` | `string` | Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config). | +| `gatewayServiceAccount` | `string` | Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email (`{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`) or its full resource name (`projects/{PROJECT}/accounts/{UNIQUE_ID}`). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service. | +| `openapiDocuments` | `array` | Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included. | +| `updateTime` | `string` | Output only. Updated time. | +| `grpcServices` | `array` | Optional. gRPC service definition files. If specified, openapi_documents must not be included. | +| `managedServiceConfigs` | `array` | Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields. | +| `labels` | `object` | Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources | +| `state` | `string` | Output only. State of the API Config. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +45,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `apisId, locationsId, projectsId` | Lists ApiConfigs in a given project and location. | | `create` | `INSERT` | `apisId, locationsId, projectsId` | Creates a new ApiConfig in a given project and location. | | `delete` | `DELETE` | `apisId, configsId, locationsId, projectsId` | Deletes a single ApiConfig. | +| `_list` | `EXEC` | `apisId, locationsId, projectsId` | Lists ApiConfigs in a given project and location. | | `patch` | `EXEC` | `apisId, configsId, locationsId, projectsId` | Updates the parameters of a single ApiConfig. | diff --git a/docs/google-docs/providers/google/apigateway/configs_iam_policies/index.md b/docs/google-docs/providers/google/apigateway/configs_iam_policies/index.md index 2c5164ab3c..643ebd87e9 100644 --- a/docs/google-docs/providers/google/apigateway/configs_iam_policies/index.md +++ b/docs/google-docs/providers/google/apigateway/configs_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigateway/gateways/index.md b/docs/google-docs/providers/google/apigateway/gateways/index.md index f3af281c95..4c02e792cd 100644 --- a/docs/google-docs/providers/google/apigateway/gateways/index.md +++ b/docs/google-docs/providers/google/apigateway/gateways/index.md @@ -27,9 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `gateways` | `array` | Gateways. | -| `nextPageToken` | `string` | Next page token. | -| `unreachableLocations` | `array` | Locations that could not be reached. | +| `name` | `string` | Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway} | +| `defaultHostname` | `string` | Output only. The default API Gateway host name of the form `{gateway_id}-{hash}.{region_code}.gateway.dev`. | +| `displayName` | `string` | Optional. Display name. | +| `labels` | `object` | Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources | +| `state` | `string` | Output only. The current state of the Gateway. | +| `updateTime` | `string` | Output only. Updated time. | +| `apiConfig` | `string` | Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig} | +| `createTime` | `string` | Output only. Created time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +42,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists Gateways in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new Gateway in a given project and location. | | `delete` | `DELETE` | `gatewaysId, locationsId, projectsId` | Deletes a single Gateway. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Gateways in a given project and location. | | `patch` | `EXEC` | `gatewaysId, locationsId, projectsId` | Updates the parameters of a single Gateway. | diff --git a/docs/google-docs/providers/google/apigateway/gateways_iam_policies/index.md b/docs/google-docs/providers/google/apigateway/gateways_iam_policies/index.md index 695739a4c3..d616714cae 100644 --- a/docs/google-docs/providers/google/apigateway/gateways_iam_policies/index.md +++ b/docs/google-docs/providers/google/apigateway/gateways_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigateway/index.md b/docs/google-docs/providers/google/apigateway/index.md index 240b6b7827..e463c0cece 100644 --- a/docs/google-docs/providers/google/apigateway/index.md +++ b/docs/google-docs/providers/google/apigateway/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 8
total selectable resources: 8
-total methods: 30
+total methods: 35
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleAPI Gateway API Description -Idapigateway:v23.08.00155 +Idapigateway:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/apigateway/locations/index.md b/docs/google-docs/providers/google/apigateway/locations/index.md index 06c901d249..a5fc348884 100644 --- a/docs/google-docs/providers/google/apigateway/locations/index.md +++ b/docs/google-docs/providers/google/apigateway/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/apigateway/operations/index.md b/docs/google-docs/providers/google/apigateway/operations/index.md index 4c6a0cac73..cfc56c3f38 100644 --- a/docs/google-docs/providers/google/apigateway/operations/index.md +++ b/docs/google-docs/providers/google/apigateway/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/apigee/admin_schemav2/index.md b/docs/google-docs/providers/google/apigee/admin_schemav2/index.md index d82c16450b..ff70bc4496 100644 --- a/docs/google-docs/providers/google/apigee/admin_schemav2/index.md +++ b/docs/google-docs/providers/google/apigee/admin_schemav2/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `dimensions` | `array` | List of schema fields grouped as dimensions. | | `meta` | `array` | Additional metadata associated with schema. This is a legacy field and usually consists of an empty array of strings. | | `metrics` | `array` | List of schema fields grouped as dimensions that can be used with an aggregate function such as `sum`, `avg`, `min`, and `max`. | -| `dimensions` | `array` | List of schema fields grouped as dimensions. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/aliases/index.md b/docs/google-docs/providers/google/apigee/aliases/index.md index 9e3cf6672f..6657ff9f31 100644 --- a/docs/google-docs/providers/google/apigee/aliases/index.md +++ b/docs/google-docs/providers/google/apigee/aliases/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `alias` | `string` | Resource ID for this alias. Values must match the regular expression `[^/]{1,255}`. | | `certsInfo` | `object` | | | `type` | `string` | Type of alias. | +| `alias` | `string` | Resource ID for this alias. Values must match the regular expression `[^/]{1,255}`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/aliases_certificate/index.md b/docs/google-docs/providers/google/apigee/aliases_certificate/index.md index 0368e42158..e6939f879b 100644 --- a/docs/google-docs/providers/google/apigee/aliases_certificate/index.md +++ b/docs/google-docs/providers/google/apigee/aliases_certificate/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `contentType` | `string` | The HTTP Content-Type header value specifying the content type of the body. | | `data` | `string` | The HTTP request/response body as raw binary. | | `extensions` | `array` | Application specific response metadata. Must be set in the first response for streaming APIs. | -| `contentType` | `string` | The HTTP Content-Type header value specifying the content type of the body. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/apicategories/index.md b/docs/google-docs/providers/google/apigee/apicategories/index.md index 58effbf0d4..163f7e83ce 100644 --- a/docs/google-docs/providers/google/apigee/apicategories/index.md +++ b/docs/google-docs/providers/google/apigee/apicategories/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `status` | `string` | Status of the operation. | +| `data` | `object` | the Api category resource. | | `errorCode` | `string` | ID that can be used to find errors in the log files. | | `message` | `string` | Description of the operation. | | `requestId` | `string` | ID that can be used to find request details in the log files. | -| `status` | `string` | Status of the operation. | -| `data` | `object` | the Api category resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/apiproducts/index.md b/docs/google-docs/providers/google/apigee/apiproducts/index.md index 5380303101..96ce963de6 100644 --- a/docs/google-docs/providers/google/apigee/apiproducts/index.md +++ b/docs/google-docs/providers/google/apigee/apiproducts/index.md @@ -25,6 +25,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Internal name of the API product. Characters you can use in the name are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name cannot be edited when updating the API product. | +| `description` | `string` | Description of the API product. Include key information about the API product that is not captured by other fields. | +| `operationGroup` | `object` | List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. | +| `quota` | `string` | Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours. | +| `approvalType` | `string` | Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities. | +| `grpcOperationGroup` | `object` | List of gRPC operation configuration details associated with Apigee API proxies. | +| `apiResources` | `array` | Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. | +| `proxies` | `array` | Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. **Note:** The API proxy names must already exist in the specified environment as they will be validated upon creation. | +| `quotaTimeUnit` | `string` | Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`. | +| `createdAt` | `string` | Response only. Creation time of this environment as milliseconds since epoch. | +| `quotaInterval` | `string` | Time interval over which the number of request messages is calculated. | +| `attributes` | `array` | Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal, but can be accessed by external developers. | +| `graphqlOperationGroup` | `object` | List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. | +| `scopes` | `array` | Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product. | +| `quotaCounterScope` | `string` | Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself. | +| `environments` | `array` | Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`. | +| `lastModifiedAt` | `string` | Response only. Modified time of this environment as milliseconds since epoch. | +| `displayName` | `string` | Name displayed in the UI or developer portal to developers registering for API access. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/appgroups/index.md b/docs/google-docs/providers/google/apigee/appgroups/index.md index 9ea9c751ad..b4bcb153f7 100644 --- a/docs/google-docs/providers/google/apigee/appgroups/index.md +++ b/docs/google-docs/providers/google/apigee/appgroups/index.md @@ -27,9 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `totalSize` | `integer` | Total count of AppGroups. | -| `appGroups` | `array` | List of AppGroups. | -| `nextPageToken` | `string` | Token that can be sent as `next_page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._\-$ %. | +| `channelUri` | `string` | A reference to the associated storefront/marketplace. | +| `organization` | `string` | Immutable. the org the app group is created | +| `status` | `string` | Valid values are `active` or `inactive`. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as `active` or `inactive`. | +| `lastModifiedAt` | `string` | Output only. Modified time as milliseconds since epoch. | +| `attributes` | `array` | A list of attributes | +| `channelId` | `string` | channel identifier identifies the owner maintaing this grouping. | +| `displayName` | `string` | app group name displayed in the UI | +| `appGroupId` | `string` | Output only. Internal identifier that cannot be edited | +| `createdAt` | `string` | Output only. Created time as milliseconds since epoch. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_appgroups_list` | `SELECT` | `organizationsId` | Lists all AppGroups in an organization. A maximum of 1000 AppGroups are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000. | | `organizations_appgroups_create` | `INSERT` | `organizationsId` | Creates an AppGroup. Once created, user can register apps under the AppGroup to obtain secret key and password. At creation time, the AppGroup's state is set as `active`. The attribute `Attribute` with key `attribute_name` as `__apigee_reserved__developer_details` can be used to store developers and their roles. The JSON format expected is: [ { "developer_id":"", "roles":[ "" ] } ] and is dealt in base64encoded format. Etag will be available in attribute `Attribute` with key `attribute_name` as `__apigee_reserved__developer_details_etag` for that AppGroup. | | `organizations_appgroups_delete` | `DELETE` | `appgroupsId, organizationsId` | Deletes an AppGroup. All app and API keys associations with the AppGroup are also removed. **Warning**: This API will permanently delete the AppGroup and related artifacts. **Note**: The delete operation is asynchronous. The AppGroup app is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted. | +| `_organizations_appgroups_list` | `EXEC` | `organizationsId` | Lists all AppGroups in an organization. A maximum of 1000 AppGroups are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000. | | `organizations_appgroups_update` | `EXEC` | `appgroupsId, organizationsId` | Updates an appGroup. This API replaces the existing appGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using `action`, and not via AppGroup. The custom attribute limit is 1000, and is how `__apigee_reserved__developer_details` can be updated. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds. | diff --git a/docs/google-docs/providers/google/apigee/apps/index.md b/docs/google-docs/providers/google/apigee/apps/index.md index 041faef3bb..a6b20c2c7d 100644 --- a/docs/google-docs/providers/google/apigee/apps/index.md +++ b/docs/google-docs/providers/google/apigee/apps/index.md @@ -27,19 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | Name of the developer app. | -| `scopes` | `array` | Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app. | -| `status` | `string` | Status of the credential. Valid values include `approved` or `revoked`. | -| `attributes` | `array` | List of attributes for the developer app. | -| `lastModifiedAt` | `string` | Output only. Time the developer app was modified in milliseconds since epoch. | -| `appFamily` | `string` | Developer app family. | -| `appId` | `string` | ID of the developer app. | -| `keyExpiresIn` | `string` | Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. | -| `callbackUrl` | `string` | Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps. | -| `credentials` | `array` | Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. | +| `name` | `string` | Name of the app. | +| `status` | `string` | Status of the credential. | +| `keyExpiresIn` | `string` | Duration, in milliseconds, of the consumer key that will be generated for the app. The default value, -1, indicates an infinite validity period. Once set, the expiration can't be updated. json key: keyExpiresIn | +| `apiProducts` | `array` | List of API products associated with the app. | +| `attributes` | `array` | List of attributes. | | `developerId` | `string` | ID of the developer. | -| `createdAt` | `string` | Output only. Time the developer app was created in milliseconds since epoch. | -| `apiProducts` | `array` | List of API products associated with the developer app. | +| `appId` | `string` | ID of the app. | +| `credentials` | `array` | Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products. | +| `callbackUrl` | `string` | Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps. | +| `companyName` | `string` | Name of the company that owns the app. | +| `developerEmail` | `string` | Email of the developer. | +| `scopes` | `array` | Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app. | +| `createdAt` | `string` | Output only. Unix time when the app was created. | +| `lastModifiedAt` | `string` | Output only. Last modified time as milliseconds since epoch. | +| `appGroup` | `string` | Name of the AppGroup | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -53,6 +55,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_developers_apps_create` | `INSERT` | `developersId, organizationsId` | Creates an app associated with a developer. This API associates the developer app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product. The `name` is the unique ID of the app that you can use in API calls. The `DisplayName` (set as an attribute) appears in the UI. If you don't set the `DisplayName` attribute, the `name` appears in the UI. | | `organizations_appgroups_apps_delete` | `DELETE` | `appgroupsId, appsId, organizationsId` | Deletes an AppGroup app. **Note**: The delete operation is asynchronous. The AppGroup app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted. | | `organizations_developers_apps_delete` | `DELETE` | `appsId, developersId, organizationsId` | Deletes a developer app. **Note**: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted. | +| `_organizations_appgroups_apps_list` | `EXEC` | `appgroupsId, organizationsId` | Lists all apps created by an AppGroup in an Apigee organization. Optionally, you can request an expanded view of the AppGroup apps. Lists all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000. | +| `_organizations_apps_list` | `EXEC` | `organizationsId` | Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company). | | `organizations_appgroups_apps_update` | `EXEC` | `appgroupsId, appsId, organizationsId` | Updates the details for an AppGroup app. In addition, you can add an API product to an AppGroup app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as it is the primary key used to identify the app and cannot be changed. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively. | | `organizations_developers_apps_attributes` | `EXEC` | `appsId, developersId, organizationsId` | Updates attributes for a developer app. This API replaces the current attributes with those specified in the request. | | `organizations_developers_apps_generate_key_pair_or_update_developer_app_status` | `EXEC` | `appsId, developersId, organizationsId` | Manages access to a developer app by enabling you to: * Approve or revoke a developer app * Generate a new consumer key and secret for a developer app To approve or revoke a developer app, set the `action` query parameter to `approve` or `revoke`, respectively, and the `Content-Type` header to `application/octet-stream`. If a developer app is revoked, none of its API keys are valid for API calls even though the keys are still approved. If successful, the API call returns the following HTTP status code: `204 No Content` To generate a new consumer key and secret for a developer app, pass the new key/secret details. Rather than replace an existing key, this API generates a new key. In this case, multiple key pairs may be associated with a single developer app. Each key pair has an independent status (`approve` or `revoke`) and expiration time. Any approved, non-expired key can be used in an API call. For example, if you're using API key rotation, you can generate new keys with expiration times that overlap keys that are going to expire. You might also generate a new consumer key/secret if the security of the original key/secret is compromised. The `keyExpiresIn` property defines the expiration time for the API key in milliseconds. If you don't set this property or set it to `-1`, the API key never expires. **Notes**: * When generating a new key/secret, this API replaces the existing attributes, notes, and callback URLs with those specified in the request. Include or exclude any existing information that you want to retain or delete, respectively. * To migrate existing consumer keys and secrets to hybrid from another system, see the CreateDeveloperAppKey API. | 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 b7cb0f8fea..f336abad7b 100644 --- a/docs/google-docs/providers/google/apigee/archive_deployments/index.md +++ b/docs/google-docs/providers/google/apigee/archive_deployments/index.md @@ -27,14 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `archiveDeployments` | `array` | Archive Deployments in the specified environment. | -| `nextPageToken` | `string` | Page token that you can include in a ListArchiveDeployments request to retrieve the next page. If omitted, no subsequent pages exist. | +| `name` | `string` | Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`. | +| `createdAt` | `string` | Output only. The time at which the Archive Deployment was created in milliseconds since the epoch. | +| `gcsUri` | `string` | Input only. The Google Cloud Storage signed URL returned from GenerateUploadUrl and used to upload the Archive zip file. | +| `labels` | `object` | User-supplied key-value pairs used to organize ArchiveDeployments. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. | +| `operation` | `string` | Output only. A reference to the LRO that created this Archive Deployment in the following format: `organizations/{org}/operations/{id}` | +| `updatedAt` | `string` | Output only. The time at which the Archive Deployment was updated in milliseconds since the epoch. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `organizations_environments_archive_deployments_list` | `SELECT` | `environmentsId, organizationsId` | Lists the ArchiveDeployments in the specified Environment. | | `organizations_environments_archive_deployments_create` | `INSERT` | `environmentsId, organizationsId` | Creates a new ArchiveDeployment. | | `organizations_environments_archive_deployments_delete` | `DELETE` | `archiveDeploymentsId, environmentsId, organizationsId` | Deletes an archive deployment. | +| `_organizations_environments_archive_deployments_list` | `EXEC` | `environmentsId, organizationsId` | Lists the ArchiveDeployments in the specified Environment. | | `organizations_environments_archive_deployments_generate_download_url` | `EXEC` | `archiveDeploymentsId, environmentsId, organizationsId` | Generates a signed URL for downloading the original zip file used to create an Archive Deployment. The URL is only valid for a limited period and should be used within minutes after generation. Each call returns a new upload URL. | | `organizations_environments_archive_deployments_generate_upload_url` | `EXEC` | `environmentsId, organizationsId` | Generates a signed URL for uploading an Archive zip file to Google Cloud Storage. Once the upload is complete, the signed URL should be passed to CreateArchiveDeployment. When uploading to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 1GB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` * `x-goog-content-length-range: 0,1073741824` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN` | | `organizations_environments_archive_deployments_get` | `EXEC` | `archiveDeploymentsId, environmentsId, organizationsId` | Gets the specified ArchiveDeployment. | diff --git a/docs/google-docs/providers/google/apigee/attachments/index.md b/docs/google-docs/providers/google/apigee/attachments/index.md index 25e03a443b..539ec76adb 100644 --- a/docs/google-docs/providers/google/apigee/attachments/index.md +++ b/docs/google-docs/providers/google/apigee/attachments/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. ID of the attachment. | -| `createdAt` | `string` | Output only. Time the attachment was created in milliseconds since epoch. | | `environment` | `string` | ID of the attached environment. | +| `createdAt` | `string` | Output only. Time the attachment was created in milliseconds since epoch. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -41,3 +41,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_instances_attachments_create` | `INSERT` | `instancesId, organizationsId` | Creates a new attachment of an environment to an instance. **Note:** Not supported for Apigee hybrid. | | `organizations_envgroups_attachments_delete` | `DELETE` | `attachmentsId, envgroupsId, organizationsId` | Deletes an environment group attachment. | | `organizations_instances_attachments_delete` | `DELETE` | `attachmentsId, instancesId, organizationsId` | Deletes an attachment. **Note:** Not supported for Apigee hybrid. | +| `_organizations_envgroups_attachments_list` | `EXEC` | `envgroupsId, organizationsId` | Lists all attachments of an environment group. | +| `_organizations_instances_attachments_list` | `EXEC` | `instancesId, organizationsId` | Lists all attachments to an instance. **Note:** Not supported for Apigee hybrid. | diff --git a/docs/google-docs/providers/google/apigee/attributes/index.md b/docs/google-docs/providers/google/apigee/attributes/index.md index 8dcacb6447..e762b853f0 100644 --- a/docs/google-docs/providers/google/apigee/attributes/index.md +++ b/docs/google-docs/providers/google/apigee/attributes/index.md @@ -25,10 +25,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | API key of the attribute. | -| `value` | `string` | Value of the attribute. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/canaryevaluations/index.md b/docs/google-docs/providers/google/apigee/canaryevaluations/index.md index e2d2927b0e..4018327be8 100644 --- a/docs/google-docs/providers/google/apigee/canaryevaluations/index.md +++ b/docs/google-docs/providers/google/apigee/canaryevaluations/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Name of the canary evalution. | +| `verdict` | `string` | Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL. | +| `treatment` | `string` | Required. The newer version that is serving requests. | | `createTime` | `string` | Output only. Create time of the canary evaluation. | +| `metricLabels` | `object` | Labels that can be used to filter Apigee metrics. | | `startTime` | `string` | Required. Start time for the canary evaluation's analysis. | -| `endTime` | `string` | Required. End time for the evaluation's analysis. | -| `verdict` | `string` | Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL. | | `control` | `string` | Required. The stable version that is serving requests. | | `state` | `string` | Output only. The current state of the canary evaluation. | -| `treatment` | `string` | Required. The newer version that is serving requests. | -| `metricLabels` | `object` | Labels that can be used to filter Apigee metrics. | +| `endTime` | `string` | Required. End time for the evaluation's analysis. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/datacollectors/index.md b/docs/google-docs/providers/google/apigee/datacollectors/index.md index 14cb9dcad0..71d9bd3590 100644 --- a/docs/google-docs/providers/google/apigee/datacollectors/index.md +++ b/docs/google-docs/providers/google/apigee/datacollectors/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | ID of the data collector. Must begin with `dc_`. | | `description` | `string` | A description of the data collector. | +| `lastModifiedAt` | `string` | Output only. The time at which the Data Collector was last updated in milliseconds since the epoch. | | `type` | `string` | Immutable. The type of data this data collector will collect. | | `createdAt` | `string` | Output only. The time at which the data collector was created in milliseconds since the epoch. | -| `lastModifiedAt` | `string` | Output only. The time at which the Data Collector was last updated in milliseconds since the epoch. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -39,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_datacollectors_list` | `SELECT` | `organizationsId` | Lists all data collectors. | | `organizations_datacollectors_create` | `INSERT` | `organizationsId` | Creates a new data collector. | | `organizations_datacollectors_delete` | `DELETE` | `datacollectorsId, organizationsId` | Deletes a data collector. | +| `_organizations_datacollectors_list` | `EXEC` | `organizationsId` | Lists all data collectors. | | `organizations_datacollectors_patch` | `EXEC` | `datacollectorsId, organizationsId` | Updates a data collector. | diff --git a/docs/google-docs/providers/google/apigee/datastores/index.md b/docs/google-docs/providers/google/apigee/datastores/index.md index 8c003626d4..93575e80e1 100644 --- a/docs/google-docs/providers/google/apigee/datastores/index.md +++ b/docs/google-docs/providers/google/apigee/datastores/index.md @@ -27,13 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `org` | `string` | Output only. Organization that the datastore belongs to | | `self` | `string` | Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}` | | `targetType` | `string` | Destination storage type. Supported types `gcs` or `bigquery`. | | `createTime` | `string` | Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z | | `datastoreConfig` | `object` | Configuration detail for datastore | | `displayName` | `string` | Required. Display name in UI | | `lastUpdateTime` | `string` | Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z | +| `org` | `string` | Output only. Organization that the datastore belongs to | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/debugsessions/index.md b/docs/google-docs/providers/google/apigee/debugsessions/index.md index 28f0e23f88..a54955af3e 100644 --- a/docs/google-docs/providers/google/apigee/debugsessions/index.md +++ b/docs/google-docs/providers/google/apigee/debugsessions/index.md @@ -27,11 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Page token that you can include in a ListDebugSessionsRequest to retrieve the next page. If omitted, no subsequent pages exist. | -| `sessions` | `array` | Session info that includes debug session ID and the first transaction creation timestamp. | +| `id` | `string` | The debug session ID. | +| `timestampMs` | `string` | The first transaction creation timestamp in millisecond, recorded by UAP. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `organizations_environments_apis_revisions_debugsessions_get` | `SELECT` | `apisId, debugsessionsId, environmentsId, organizationsId, revisionsId` | Retrieves a debug session. | | `organizations_environments_apis_revisions_debugsessions_list` | `SELECT` | `apisId, environmentsId, organizationsId, revisionsId` | Lists debug sessions that are currently active in the given API Proxy revision. | | `organizations_environments_apis_revisions_debugsessions_create` | `INSERT` | `apisId, environmentsId, organizationsId, revisionsId` | Creates a debug session for a deployed API Proxy revision. | +| `_organizations_environments_apis_revisions_debugsessions_list` | `EXEC` | `apisId, environmentsId, organizationsId, revisionsId` | Lists debug sessions that are currently active in the given API Proxy revision. | diff --git a/docs/google-docs/providers/google/apigee/deployed_ingress_config/index.md b/docs/google-docs/providers/google/apigee/deployed_ingress_config/index.md index 76c0f82419..134f94db01 100644 --- a/docs/google-docs/providers/google/apigee/deployed_ingress_config/index.md +++ b/docs/google-docs/providers/google/apigee/deployed_ingress_config/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Name of the resource in the following format: `organizations/{org}/deployedIngressConfig`. | -| `environmentGroups` | `array` | List of environment groups in the organization. | | `revisionCreateTime` | `string` | Time at which the IngressConfig revision was created. | | `revisionId` | `string` | Revision id that defines the ordering on IngressConfig resources. The higher the revision, the more recently the configuration was deployed. | | `uid` | `string` | A unique id for the ingress config that will only change if the organization is deleted and recreated. | +| `environmentGroups` | `array` | List of environment groups in the organization. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/developers/index.md b/docs/google-docs/providers/google/apigee/developers/index.md index 1166ecbf79..f363b273e2 100644 --- a/docs/google-docs/providers/google/apigee/developers/index.md +++ b/docs/google-docs/providers/google/apigee/developers/index.md @@ -25,6 +25,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `appFamily` | `string` | Developer app family. | +| `lastName` | `string` | Required. Last name of the developer. | +| `developerId` | `string` | ID of the developer. **Note**: IDs are generated internally by Apigee and are not guaranteed to stay the same over time. | +| `status` | `string` | Output only. Status of the developer. Valid values are `active` and `inactive`. | +| `companies` | `array` | List of companies associated with the developer. | +| `email` | `string` | Required. Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only. | +| `userName` | `string` | Required. User name of the developer. Not used by Apigee hybrid. | +| `apps` | `array` | List of apps associated with the developer. | +| `organizationName` | `string` | Output only. Name of the Apigee organization in which the developer resides. | +| `createdAt` | `string` | Output only. Time at which the developer was created in milliseconds since epoch. | +| `attributes` | `array` | Optional. Developer attributes (name/value pairs). The custom attribute limit is 18. | +| `lastModifiedAt` | `string` | Output only. Time at which the developer was last modified in milliseconds since epoch. | +| `accessType` | `string` | Access type. | +| `firstName` | `string` | Required. First name of the developer. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 783feff7c0..4b11c4a915 100644 --- a/docs/google-docs/providers/google/apigee/endpoint_attachments/index.md +++ b/docs/google-docs/providers/google/apigee/endpoint_attachments/index.md @@ -27,8 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `endpointAttachments` | `array` | Endpoint attachments in the specified organization. | -| `nextPageToken` | `string` | Page token that you can include in an `ListEndpointAttachments` request to retrieve the next page. If omitted, no subsequent pages exist. | +| `name` | `string` | Name of the endpoint attachment. Use the following structure in your request: `organizations/{org}/endpointAttachments/{endpoint_attachment}` | +| `host` | `string` | Output only. Host that can be used in either the HTTP target endpoint directly or as the host in target server. | +| `location` | `string` | Required. Location of the endpoint attachment. | +| `serviceAttachment` | `string` | Format: projects/*/regions/*/serviceAttachments/* | +| `state` | `string` | Output only. State of the endpoint attachment. Values other than `ACTIVE` mean the resource is not ready to use. | +| `connectionState` | `string` | Output only. State of the endpoint attachment connection to the service attachment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,3 +40,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_endpoint_attachments_list` | `SELECT` | `organizationsId` | Lists the endpoint attachments in an organization. | | `organizations_endpoint_attachments_create` | `INSERT` | `organizationsId` | Creates an endpoint attachment. **Note:** Not supported for Apigee hybrid. | | `organizations_endpoint_attachments_delete` | `DELETE` | `endpointAttachmentsId, organizationsId` | Deletes an endpoint attachment. | +| `_organizations_endpoint_attachments_list` | `EXEC` | `organizationsId` | Lists the endpoint attachments in an organization. | diff --git a/docs/google-docs/providers/google/apigee/entries/index.md b/docs/google-docs/providers/google/apigee/entries/index.md index 7739038eca..836219d2b6 100644 --- a/docs/google-docs/providers/google/apigee/entries/index.md +++ b/docs/google-docs/providers/google/apigee/entries/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `keyValueEntries` | `array` | One or more key value map keys and values. | -| `nextPageToken` | `string` | Token that can be sent as `next_page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Resource URI that can be used to identify the scope of the key value map entries. | +| `value` | `string` | Required. Data or payload that is being retrieved and associated with the unique key. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,3 +44,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_apis_keyvaluemaps_entries_delete` | `DELETE` | `apisId, entriesId, keyvaluemapsId, organizationsId` | Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher. | | `organizations_environments_keyvaluemaps_entries_delete` | `DELETE` | `entriesId, environmentsId, keyvaluemapsId, organizationsId` | Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher. | | `organizations_keyvaluemaps_entries_delete` | `DELETE` | `entriesId, keyvaluemapsId, organizationsId` | Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy. **Notes:** * After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior. * Supported for Apigee hybrid 1.8.x and higher. | +| `_organizations_apis_keyvaluemaps_entries_list` | `EXEC` | `apisId, keyvaluemapsId, organizationsId` | Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher. | +| `_organizations_environments_keyvaluemaps_entries_list` | `EXEC` | `environmentsId, keyvaluemapsId, organizationsId` | Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher. | +| `_organizations_keyvaluemaps_entries_list` | `EXEC` | `keyvaluemapsId, organizationsId` | Lists key value entries for key values maps scoped to an organization, environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and higher. | diff --git a/docs/google-docs/providers/google/apigee/envgroups/index.md b/docs/google-docs/providers/google/apigee/envgroups/index.md index 0a0d27d4af..bcc56432bd 100644 --- a/docs/google-docs/providers/google/apigee/envgroups/index.md +++ b/docs/google-docs/providers/google/apigee/envgroups/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `environmentGroups` | `array` | EnvironmentGroups in the specified organization. | -| `nextPageToken` | `string` | Page token that you can include in a ListEnvironmentGroups request to retrieve the next page. If omitted, no subsequent pages exist. | +| `name` | `string` | ID of the environment group. | +| `hostnames` | `array` | Required. Host names for this environment group. | +| `lastModifiedAt` | `string` | Output only. The time at which the environment group was last updated as milliseconds since epoch. | +| `state` | `string` | Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use. | +| `createdAt` | `string` | Output only. The time at which the environment group was created as milliseconds since epoch. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_envgroups_list` | `SELECT` | `organizationsId` | Lists all environment groups. | | `organizations_envgroups_create` | `INSERT` | `organizationsId` | Creates a new environment group. | | `organizations_envgroups_delete` | `DELETE` | `envgroupsId, organizationsId` | Deletes an environment group. | +| `_organizations_envgroups_list` | `EXEC` | `organizationsId` | Lists all environment groups. | | `organizations_envgroups_patch` | `EXEC` | `envgroupsId, organizationsId` | Updates an environment group. | diff --git a/docs/google-docs/providers/google/apigee/envgroups_deployed_ingress_config/index.md b/docs/google-docs/providers/google/apigee/envgroups_deployed_ingress_config/index.md index 96e5da5489..9b57cdec52 100644 --- a/docs/google-docs/providers/google/apigee/envgroups_deployed_ingress_config/index.md +++ b/docs/google-docs/providers/google/apigee/envgroups_deployed_ingress_config/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`. | +| `hostnames` | `array` | Host names for the environment group. | | `location` | `string` | When this message appears in the top-level IngressConfig, this field will be populated in lieu of the inlined routing_rules and hostnames fields. Some URL for downloading the full EnvironmentGroupConfig for this group. | | `revisionId` | `string` | Revision id that defines the ordering of the EnvironmentGroupConfig resource. The higher the revision, the more recently the configuration was deployed. | | `routingRules` | `array` | Ordered list of routing rules defining how traffic to this environment group's hostnames should be routed to different environments. | | `uid` | `string` | A unique id for the environment group config that will only change if the environment group is deleted and recreated. | | `endpointChainingRules` | `array` | A list of proxies in each deployment group for proxy chaining calls. | -| `hostnames` | `array` | Host names for the environment group. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/environments/index.md b/docs/google-docs/providers/google/apigee/environments/index.md index 577d97dfaa..bd8c726718 100644 --- a/docs/google-docs/providers/google/apigee/environments/index.md +++ b/docs/google-docs/providers/google/apigee/environments/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$` | | `description` | `string` | Optional. Description of the environment. | | `state` | `string` | Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use. | -| `displayName` | `string` | Optional. Display name for this environment. | -| `apiProxyType` | `string` | Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. | +| `nodeConfig` | `object` | NodeConfig for setting the min/max number of nodes associated with the environment. | | `deploymentType` | `string` | Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be **prevented from performing** a [subset of actions](/apigee/docs/api-platform/local-development/overview#prevented-actions) within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers | -| `hasAttachedFlowHooks` | `boolean` | | -| `properties` | `object` | Message for compatibility with legacy Edge specification for Java Properties object in JSON. | | `lastModifiedAt` | `string` | Output only. Last modification time of this environment as milliseconds since epoch. | -| `createdAt` | `string` | Output only. Creation time of this environment as milliseconds since epoch. | +| `hasAttachedFlowHooks` | `boolean` | | +| `apiProxyType` | `string` | Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. | | `forwardProxyUri` | `string` | Optional. Url of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that scheme must be one of "http" or "https", and port must be supplied. | -| `nodeConfig` | `object` | NodeConfig for setting the min/max number of nodes associated with the environment. | +| `displayName` | `string` | Optional. Display name for this environment. | +| `createdAt` | `string` | Output only. Creation time of this environment as milliseconds since epoch. | +| `properties` | `object` | Message for compatibility with legacy Edge specification for Java Properties object in JSON. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/environments_iam_policies/index.md b/docs/google-docs/providers/google/apigee/environments_iam_policies/index.md index 20ee0bc125..45de893fd4 100644 --- a/docs/google-docs/providers/google/apigee/environments_iam_policies/index.md +++ b/docs/google-docs/providers/google/apigee/environments_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 526935372b..757473b813 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 @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `endpoint` | `string` | Required. Endpoint of the exporter. | | `exporter` | `string` | Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. | | `samplingConfig` | `object` | TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. | -| `endpoint` | `string` | Required. Endpoint of the exporter. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/flowhooks/index.md b/docs/google-docs/providers/google/apigee/flowhooks/index.md index 5656a588fb..5799e09c56 100644 --- a/docs/google-docs/providers/google/apigee/flowhooks/index.md +++ b/docs/google-docs/providers/google/apigee/flowhooks/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `description` | `string` | Description of the flow hook. | -| `sharedFlow` | `string` | Shared flow attached to this flow hook, or empty if there is none attached. | | `continueOnError` | `boolean` | Optional. Flag that specifies whether execution should continue if the flow hook throws an exception. Set to `true` to continue execution. Set to `false` to stop execution if the flow hook throws an exception. Defaults to `true`. | | `flowHookPoint` | `string` | Output only. Where in the API call flow the flow hook is invoked. Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or `PostTargetFlowHook`. | +| `sharedFlow` | `string` | Shared flow attached to this flow hook, or empty if there is none attached. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 f8310af9dc..a036459829 100644 --- a/docs/google-docs/providers/google/apigee/host_queries/index.md +++ b/docs/google-docs/providers/google/apigee/host_queries/index.md @@ -25,6 +25,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Asynchronous Query Name. | +| `resultRows` | `string` | ResultRows is available only after the query is completed. | +| `reportDefinitionId` | `string` | Asynchronous Report ID. | +| `updated` | `string` | Last updated timestamp for the query. | +| `executionTime` | `string` | ExecutionTime is available only after the query is completed. | +| `result` | `object` | | +| `self` | `string` | Self link of the query. Example: `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` or following format if query is running at host level: `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` | +| `created` | `string` | Creation time of the query. | +| `envgroupHostname` | `string` | Hostname is available only when query is executed at host level. | +| `error` | `string` | Error is set when query fails. | +| `resultFileSize` | `string` | ResultFileSize is available only after the query is completed. | +| `state` | `string` | Query state could be "enqueued", "running", "completed", "failed". | +| `queryParams` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/host_queries_result_view/index.md b/docs/google-docs/providers/google/apigee/host_queries_result_view/index.md index 7a686466ed..6f2e684ee0 100644 --- a/docs/google-docs/providers/google/apigee/host_queries_result_view/index.md +++ b/docs/google-docs/providers/google/apigee/host_queries_result_view/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `rows` | `array` | Rows of query result. Each row is a JSON object. Example: {sum(message_count): 1, developer_app: "(not set)",…} | | `state` | `string` | State of retrieving ResultView. | | `code` | `integer` | Error code when there is a failure. | | `error` | `string` | Error message when there is a failure. | | `metadata` | `object` | | -| `rows` | `array` | Rows of query result. Each row is a JSON object. Example: {sum(message_count): 1, developer_app: "(not set)",…} | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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 1d890642e9..af2f9fbd5a 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 @@ -27,11 +27,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `securityReports` | `array` | The security reports belong to requested resource name. | -| `nextPageToken` | `string` | If the number of security reports exceeded the page size requested, the token can be used to fetch the next page in a subsequent call. If the response is the last page and there are no more reports to return this field is left empty. | +| `resultFileSize` | `string` | ResultFileSize is available only after the query is completed. | +| `result` | `object` | Contains informations about the security report results. | +| `created` | `string` | Creation time of the query. | +| `error` | `string` | Error is set when query fails. | +| `resultRows` | `string` | ResultRows is available only after the query is completed. | +| `state` | `string` | Query state could be "enqueued", "running", "completed", "expired" and "failed". | +| `displayName` | `string` | Display Name specified by the user. | +| `executionTime` | `string` | ExecutionTime is available only after the query is completed. | +| `self` | `string` | Self link of the query. Example: `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` or following format if query is running at host level: `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` | +| `updated` | `string` | Output only. Last updated timestamp for the query. | +| `queryParams` | `object` | Metadata for the security report. | +| `reportDefinitionId` | `string` | Report Definition ID. | +| `envgroupHostname` | `string` | Hostname is available only when query is executed at host level. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `organizations_host_security_reports_get` | `SELECT` | `hostSecurityReportsId, organizationsId` | Get status of a query submitted at host level. If the query is still in progress, the `state` is set to "running" After the query has completed successfully, `state` is set to "completed" | | `organizations_host_security_reports_list` | `SELECT` | `organizationsId` | Return a list of Security Reports at host level. | | `organizations_host_security_reports_create` | `INSERT` | `organizationsId` | Submit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the `state` of "enqueued" means that the request succeeded. | +| `_organizations_host_security_reports_list` | `EXEC` | `organizationsId` | Return a list of Security Reports at host level. | diff --git a/docs/google-docs/providers/google/apigee/host_security_reports_result_view/index.md b/docs/google-docs/providers/google/apigee/host_security_reports_result_view/index.md index f0d6bb9cab..19d450b885 100644 --- a/docs/google-docs/providers/google/apigee/host_security_reports_result_view/index.md +++ b/docs/google-docs/providers/google/apigee/host_security_reports_result_view/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `error` | `string` | Error message when there is a failure. | +| `metadata` | `object` | Metadata for the security report. | | `rows` | `array` | Rows of security report result. Each row is a JSON object. Example: {sum(message_count): 1, developer_app: "(not set)",…} | | `state` | `string` | State of retrieving ResultView. | | `code` | `integer` | Error code when there is a failure. | -| `error` | `string` | Error message when there is a failure. | -| `metadata` | `object` | Metadata for the security report. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/host_stats/index.md b/docs/google-docs/providers/google/apigee/host_stats/index.md index 1953093b42..ad0e4ebbd0 100644 --- a/docs/google-docs/providers/google/apigee/host_stats/index.md +++ b/docs/google-docs/providers/google/apigee/host_stats/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `metaData` | `object` | Encapsulates additional information about query execution. | | `environments` | `array` | List of query results on the environment level. | | `hosts` | `array` | List of query results grouped by host. | +| `metaData` | `object` | Encapsulates additional information about query execution. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/index.md b/docs/google-docs/providers/google/apigee/index.md index 8ced869c0f..6b8c9430a2 100644 --- a/docs/google-docs/providers/google/apigee/index.md +++ b/docs/google-docs/providers/google/apigee/index.md @@ -21,7 +21,7 @@ Use The Apigee API To Programmatically Develop And Manage APIs With A Set Of RES
total resources: 90
total selectable resources: 70
-total methods: 287
+total methods: 309
@@ -33,7 +33,7 @@ Use The Apigee API To Programmatically Develop And Manage APIs With A Set Of RES TypeService TitleApigee API DescriptionUse The Apigee API To Programmatically Develop And Manage APIs With A Set Of RESTful Operations. Develop And Secure API Proxies, Deploy And Undeploy API Proxy Revisions, Monitor APIs, Configure Environments, Manage Users, And More. Note: This Product Is Available As A Free Trial For A Time Period Of 60 Days. -Idapigee:v23.08.00155 +Idapigee:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/apigee/instances/index.md b/docs/google-docs/providers/google/apigee/instances/index.md index 12a5cbc319..d6dc4b000e 100644 --- a/docs/google-docs/providers/google/apigee/instances/index.md +++ b/docs/google-docs/providers/google/apigee/instances/index.md @@ -29,19 +29,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`. | | `description` | `string` | Optional. Description of the instance. | -| `state` | `string` | Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. | -| `peeringCidrRange` | `string` | Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`. | | `createdAt` | `string` | Output only. Time the instance was created in milliseconds since epoch. | +| `location` | `string` | Required. Compute Engine location where the instance resides. | +| `peeringCidrRange` | `string` | Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`. | +| `consumerAcceptList` | `array` | Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list. | +| `state` | `string` | Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. | +| `host` | `string` | Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. | | `diskEncryptionKeyName` | `string` | Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` | -| `ipRange` | `string` | Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28` | | `runtimeVersion` | `string` | Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments. | -| `serviceAttachment` | `string` | Output only. Resource name of the service attachment created for the instance in the format: `projects/*/regions/*/serviceAttachments/*` Apigee customers can privately forward traffic to this service attachment using the PSC endpoints. | +| `ipRange` | `string` | Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28` | | `port` | `string` | Output only. Port number of the exposed Apigee endpoint. | -| `consumerAcceptList` | `array` | Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list. | -| `location` | `string` | Required. Compute Engine location where the instance resides. | -| `host` | `string` | Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. | -| `lastModifiedAt` | `string` | Output only. Time the instance was last modified in milliseconds since epoch. | | `displayName` | `string` | Optional. Display name for the instance. | +| `lastModifiedAt` | `string` | Output only. Time the instance was last modified in milliseconds since epoch. | +| `serviceAttachment` | `string` | Output only. Resource name of the service attachment created for the instance in the format: `projects/*/regions/*/serviceAttachments/*` Apigee customers can privately forward traffic to this service attachment using the PSC endpoints. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -49,5 +49,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_instances_list` | `SELECT` | `organizationsId` | Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid. | | `organizations_instances_create` | `INSERT` | `organizationsId` | Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. **Note:** Not supported for Apigee hybrid. | | `organizations_instances_delete` | `DELETE` | `instancesId, organizationsId` | Deletes an Apigee runtime instance. The instance stops serving requests and the runtime data is deleted. **Note:** Not supported for Apigee hybrid. | +| `_organizations_instances_list` | `EXEC` | `organizationsId` | Lists all Apigee runtime instances for the organization. **Note:** Not supported for Apigee hybrid. | | `organizations_instances_patch` | `EXEC` | `instancesId, organizationsId` | Updates an Apigee runtime instance. You can update the fields described in NodeConfig. No other fields will be updated. **Note:** Not supported for Apigee hybrid. | | `organizations_instances_report_status` | `EXEC` | `instancesId, organizationsId` | Reports the latest status for a runtime instance. | diff --git a/docs/google-docs/providers/google/apigee/keys/index.md b/docs/google-docs/providers/google/apigee/keys/index.md index 6a9d2a3d77..9314485140 100644 --- a/docs/google-docs/providers/google/apigee/keys/index.md +++ b/docs/google-docs/providers/google/apigee/keys/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `attributes` | `array` | List of attributes associated with the credential. | -| `expiresAt` | `string` | Time the developer app expires in milliseconds since epoch. | -| `expiresInSeconds` | `string` | Input only. Expiration time, in seconds, for the consumer key. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. | -| `consumerKey` | `string` | Consumer key. | | `scopes` | `array` | Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app. | +| `apiProducts` | `array` | List of API products for which the credential can be used. **Note**: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. | +| `consumerKey` | `string` | Consumer key. | | `status` | `string` | Status of the credential. Valid values include `approved` or `revoked`. | +| `expiresInSeconds` | `string` | Input only. Expiration time, in seconds, for the consumer key. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. | | `consumerSecret` | `string` | Secret key. | +| `expiresAt` | `string` | Time the developer app expires in milliseconds since epoch. | | `issuedAt` | `string` | Time the developer app was created in milliseconds since epoch. | -| `apiProducts` | `array` | List of API products for which the credential can be used. **Note**: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 8f1878f3ca..a0b57d546c 100644 --- a/docs/google-docs/providers/google/apigee/nat_addresses/index.md +++ b/docs/google-docs/providers/google/apigee/nat_addresses/index.md @@ -27,8 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `natAddresses` | `array` | List of NAT Addresses for the instance. | -| `nextPageToken` | `string` | Page token that you can include in a ListNatAddresses request to retrieve the next page of content. If omitted, no subsequent pages exist. | +| `name` | `string` | Required. Resource ID of the NAT address. | +| `ipAddress` | `string` | Output only. The static IPV4 address. | +| `state` | `string` | Output only. State of the nat address. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +37,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_instances_nat_addresses_list` | `SELECT` | `instancesId, organizationsId` | Lists the NAT addresses for an Apigee instance. **Note:** Not supported for Apigee hybrid. | | `organizations_instances_nat_addresses_create` | `INSERT` | `instancesId, organizationsId` | Creates a NAT address. The address is created in the RESERVED state and a static external IP address will be provisioned. At this time, the instance will not use this IP address for Internet egress traffic. The address can be activated for use once any required firewall IP whitelisting has been completed. **Note:** Not supported for Apigee hybrid. | | `organizations_instances_nat_addresses_delete` | `DELETE` | `instancesId, natAddressesId, organizationsId` | Deletes the NAT address. Connections that are actively using the address are drained before it is removed. **Note:** Not supported for Apigee hybrid. | +| `_organizations_instances_nat_addresses_list` | `EXEC` | `instancesId, organizationsId` | Lists the NAT addresses for an Apigee instance. **Note:** Not supported for Apigee hybrid. | | `organizations_instances_nat_addresses_activate` | `EXEC` | `instancesId, natAddressesId, organizationsId` | Activates the NAT address. The Apigee instance can now use this for Internet egress traffic. **Note:** Not supported for Apigee hybrid. | diff --git a/docs/google-docs/providers/google/apigee/operations/index.md b/docs/google-docs/providers/google/apigee/operations/index.md index 9942fc23ce..66f87b5914 100644 --- a/docs/google-docs/providers/google/apigee/operations/index.md +++ b/docs/google-docs/providers/google/apigee/operations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `organizations_operations_list` | `SELECT` | `organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_organizations_operations_list` | `EXEC` | `organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `organizations_operations_get` | `EXEC` | `operationsId, organizationsId` | 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. | diff --git a/docs/google-docs/providers/google/apigee/organizations/index.md b/docs/google-docs/providers/google/apigee/organizations/index.md index 4e075b1192..e9cdae2c61 100644 --- a/docs/google-docs/providers/google/apigee/organizations/index.md +++ b/docs/google-docs/providers/google/apigee/organizations/index.md @@ -25,35 +25,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. Name of the Apigee organization. | -| `description` | `string` | Description of the Apigee organization. | -| `apiConsumerDataEncryptionKeyName` | `string` | Cloud KMS key name used for encrypting API consumer data. Required for US/EU regions when [BillingType](#BillingType) is `SUBSCRIPTION`. When [BillingType](#BillingType) is `EVALUATION` or the region is not US/EU, a Google-Managed encryption key will be used. Format: `projects/*/locations/*/keyRings/*/cryptoKeys/*` | -| `analyticsRegion` | `string` | Required. DEPRECATED: This field will eventually be deprecated and replaced with a differently-named field. Primary Google Cloud region for analytics data storage. For valid values, see [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). | -| `createdAt` | `string` | Output only. Time that the Apigee organization was created in milliseconds since epoch. | -| `attributes` | `array` | Not used by Apigee. | -| `authorizedNetwork` | `string` | Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Valid only when [RuntimeType](#RuntimeType) is set to `CLOUD`. The value must be set before the creation of a runtime instance and can be updated only when there are no runtime instances. For example: `default`. Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See [Shared VPC overview](https://cloud.google.com/vpc/docs/shared-vpc). To use a shared VPC network, use the following format: `projects/{host-project-id}/{region}/networks/{network-name}`. For example: `projects/my-sharedvpc-host/global/networks/mynetwork` **Note:** Not supported for Apigee hybrid. | -| `portalDisabled` | `boolean` | Configuration for the Portals settings. | -| `addonsConfig` | `object` | Add-on configurations for the Apigee organization. | -| `properties` | `object` | Message for compatibility with legacy Edge specification for Java Properties object in JSON. | -| `runtimeDatabaseEncryptionKeyName` | `string` | Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. Required when [RuntimeType](#RuntimeType) is `CLOUD`. If not specified when [RuntimeType](#RuntimeType) is `TRIAL`, a Google-Managed encryption key will be used. For example: "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". **Note:** Not supported for Apigee hybrid. | -| `billingType` | `string` | Billing type of the Apigee organization. See [Apigee pricing](https://cloud.google.com/apigee/pricing). | -| `subscriptionType` | `string` | Output only. DEPRECATED: This will eventually be replaced by BillingType. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased). See [Apigee pricing](https://cloud.google.com/apigee/pricing/). | -| `runtimeType` | `string` | Required. Runtime type of the Apigee organization based on the Apigee subscription purchased. | -| `lastModifiedAt` | `string` | Output only. Time that the Apigee organization was last modified in milliseconds since epoch. | -| `apigeeProjectId` | `string` | Output only. Apigee Project ID associated with the organization. Use this project to allowlist Apigee in the Service Attachment when using private service connect with Apigee. | -| `customerName` | `string` | Not used by Apigee. | -| `environments` | `array` | Output only. List of environments in the Apigee organization. | -| `projectId` | `string` | Output only. Project ID associated with the Apigee organization. | -| `type` | `string` | Not used by Apigee. | -| `expiresAt` | `string` | Output only. Time that the Apigee organization is scheduled for deletion. | -| `apiConsumerDataLocation` | `string` | This field is needed only for customers with control plane in US or EU. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use. For example: "us-west1" when control plane is in US or "europe-west2" when control plane is in EU. | -| `displayName` | `string` | Display name for the Apigee organization. Unused, but reserved for future use. | -| `state` | `string` | Output only. State of the organization. Values other than ACTIVE means the resource is not ready to use. | -| `controlPlaneEncryptionKeyName` | `string` | Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Required when [BillingType](#BillingType) is `SUBSCRIPTION`. When [BillingType](#BillingType) is `EVALUATION`, a Google-Managed encryption key will be used. Format: `projects/*/locations/*/keyRings/*/cryptoKeys/*` | -| `caCertificate` | `string` | Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when [RuntimeType](#RuntimeType) is `CLOUD`. | -| `disableVpcPeering` | `boolean` | Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. **Note:** Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/overrides/index.md b/docs/google-docs/providers/google/apigee/overrides/index.md index 9cbef34f8e..f4e36f223c 100644 --- a/docs/google-docs/providers/google/apigee/overrides/index.md +++ b/docs/google-docs/providers/google/apigee/overrides/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | ID of the trace configuration override specified as a system-generated UUID. | -| `samplingConfig` | `object` | TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. | | `apiProxy` | `string` | ID of the API proxy that will have its trace configuration overridden. | +| `samplingConfig` | `object` | TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +37,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_environments_trace_config_overrides_list` | `SELECT` | `environmentsId, organizationsId` | Lists all of the distributed trace configuration overrides in an environment. | | `organizations_environments_trace_config_overrides_create` | `INSERT` | `environmentsId, organizationsId` | Creates a trace configuration override. The response contains a system-generated UUID, that can be used to view, update, or delete the configuration override. Use the List API to view the existing trace configuration overrides. | | `organizations_environments_trace_config_overrides_delete` | `DELETE` | `environmentsId, organizationsId, overridesId` | Deletes a distributed trace configuration override. | +| `_organizations_environments_trace_config_overrides_list` | `EXEC` | `environmentsId, organizationsId` | Lists all of the distributed trace configuration overrides in an environment. | | `organizations_environments_trace_config_overrides_patch` | `EXEC` | `environmentsId, organizationsId, overridesId` | Updates a distributed trace configuration override. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body. | diff --git a/docs/google-docs/providers/google/apigee/queries/index.md b/docs/google-docs/providers/google/apigee/queries/index.md index e8bd72c7ce..c0cd9c887e 100644 --- a/docs/google-docs/providers/google/apigee/queries/index.md +++ b/docs/google-docs/providers/google/apigee/queries/index.md @@ -25,6 +25,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Asynchronous Query Name. | +| `reportDefinitionId` | `string` | Asynchronous Report ID. | +| `self` | `string` | Self link of the query. Example: `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` or following format if query is running at host level: `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` | +| `error` | `string` | Error is set when query fails. | +| `executionTime` | `string` | ExecutionTime is available only after the query is completed. | +| `result` | `object` | | +| `queryParams` | `object` | | +| `resultFileSize` | `string` | ResultFileSize is available only after the query is completed. | +| `updated` | `string` | Last updated timestamp for the query. | +| `created` | `string` | Creation time of the query. | +| `envgroupHostname` | `string` | Hostname is available only when query is executed at host level. | +| `resultRows` | `string` | ResultRows is available only after the query is completed. | +| `state` | `string` | Query state could be "enqueued", "running", "completed", "failed". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/queries_result/index.md b/docs/google-docs/providers/google/apigee/queries_result/index.md index 12717141d4..49d4db0016 100644 --- a/docs/google-docs/providers/google/apigee/queries_result/index.md +++ b/docs/google-docs/providers/google/apigee/queries_result/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `data` | `string` | The HTTP request/response body as raw binary. | | `extensions` | `array` | Application specific response metadata. Must be set in the first response for streaming APIs. | | `contentType` | `string` | The HTTP Content-Type header value specifying the content type of the body. | +| `data` | `string` | The HTTP request/response body as raw binary. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/reports/index.md b/docs/google-docs/providers/google/apigee/reports/index.md index 65789d2095..ce3a988aa7 100644 --- a/docs/google-docs/providers/google/apigee/reports/index.md +++ b/docs/google-docs/providers/google/apigee/reports/index.md @@ -28,27 +28,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id | -| `environment` | `string` | Output only. Environment name | -| `timeUnit` | `string` | This field contains the time unit of aggregation for the report | -| `organization` | `string` | Output only. Organization name | -| `createdAt` | `string` | Output only. Unix time when the app was created json key: createdAt | -| `offset` | `string` | Legacy field: not used. This field contains the offset for the data | -| `toTime` | `string` | Legacy field: not used. Contains the end time for the report | -| `tags` | `array` | Legacy field: not used. This field contains a list of tags associated with custom report | -| `properties` | `array` | This field contains report properties such as ui metadata etc. | -| `chartType` | `string` | This field contains the chart type for the report | -| `filter` | `string` | This field contains the filter expression | | `lastViewedAt` | `string` | Output only. Last viewed time of this entity as milliseconds since epoch | -| `displayName` | `string` | This is the display name for the report | -| `lastModifiedAt` | `string` | Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt | -| `sortOrder` | `string` | Legacy field: not used much. Contains the sort order for the sort columns | +| `metrics` | `array` | Required. This contains the list of metrics | +| `organization` | `string` | Output only. Organization name | | `topk` | `string` | Legacy field: not used. This field contains the top k parameter value for restricting the result | +| `createdAt` | `string` | Output only. Unix time when the app was created json key: createdAt | | `comments` | `array` | Legacy field: not used. This field contains a list of comments associated with custom report | -| `fromTime` | `string` | Legacy field: not used. Contains the from time for the report | +| `dimensions` | `array` | This contains the list of dimensions for the report | | `limit` | `string` | Legacy field: not used This field contains the limit for the result retrieved | -| `metrics` | `array` | Required. This contains the list of metrics | +| `displayName` | `string` | This is the display name for the report | +| `tags` | `array` | Legacy field: not used. This field contains a list of tags associated with custom report | +| `lastModifiedAt` | `string` | Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt | +| `environment` | `string` | Output only. Environment name | +| `filter` | `string` | This field contains the filter expression | | `sortByCols` | `array` | Legacy field: not used much. Contains the list of sort by columns | -| `dimensions` | `array` | This contains the list of dimensions for the report | +| `properties` | `array` | This field contains report properties such as ui metadata etc. | +| `fromTime` | `string` | Legacy field: not used. Contains the from time for the report | +| `sortOrder` | `string` | Legacy field: not used much. Contains the sort order for the sort columns | +| `toTime` | `string` | Legacy field: not used. Contains the end time for the report | +| `timeUnit` | `string` | This field contains the time unit of aggregation for the report | +| `offset` | `string` | Legacy field: not used. This field contains the offset for the data | +| `chartType` | `string` | This field contains the chart type for the report | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/resourcefiles/index.md b/docs/google-docs/providers/google/apigee/resourcefiles/index.md index 99583c375a..d97c963cba 100644 --- a/docs/google-docs/providers/google/apigee/resourcefiles/index.md +++ b/docs/google-docs/providers/google/apigee/resourcefiles/index.md @@ -25,6 +25,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `data` | `string` | The HTTP request/response body as raw binary. | +| `extensions` | `array` | Application specific response metadata. Must be set in the first response for streaming APIs. | +| `contentType` | `string` | The HTTP Content-Type header value specifying the content type of the body. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/revisions/index.md b/docs/google-docs/providers/google/apigee/revisions/index.md index 7863a24a7a..d9e3387e21 100644 --- a/docs/google-docs/providers/google/apigee/revisions/index.md +++ b/docs/google-docs/providers/google/apigee/revisions/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `contentType` | `string` | The HTTP Content-Type header value specifying the content type of the body. | | `data` | `string` | The HTTP request/response body as raw binary. | | `extensions` | `array` | Application specific response metadata. Must be set in the first response for streaming APIs. | +| `contentType` | `string` | The HTTP Content-Type header value specifying the content type of the body. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/revisions_deployments/index.md b/docs/google-docs/providers/google/apigee/revisions_deployments/index.md index 65191c8bcc..efc88c4a7d 100644 --- a/docs/google-docs/providers/google/apigee/revisions_deployments/index.md +++ b/docs/google-docs/providers/google/apigee/revisions_deployments/index.md @@ -27,16 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `errors` | `array` | Errors reported for this deployment. Populated only when state == ERROR. **Note**: This field is displayed only when viewing deployment status. | +| `routeConflicts` | `array` | Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be `ERROR`, but it will mean that some of the deployment's base paths are not routed to its environment. If the conflicts change, the state will transition to `PROGRESSING` until the latest configuration is rolled out to all instances. **Note**: This field is displayed only when viewing deployment status. | +| `environment` | `string` | Environment. | | `revision` | `string` | API proxy revision. | -| `instances` | `array` | Status reported by each runtime instance. **Note**: This field is displayed only when viewing deployment status. | +| `errors` | `array` | Errors reported for this deployment. Populated only when state == ERROR. **Note**: This field is displayed only when viewing deployment status. | | `pods` | `array` | Status reported by runtime pods. **Note**: **This field is deprecated**. Runtime versions 1.3 and above report instance level status rather than pod status. | -| `routeConflicts` | `array` | Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be `ERROR`, but it will mean that some of the deployment's base paths are not routed to its environment. If the conflicts change, the state will transition to `PROGRESSING` until the latest configuration is rolled out to all instances. **Note**: This field is displayed only when viewing deployment status. | +| `instances` | `array` | Status reported by each runtime instance. **Note**: This field is displayed only when viewing deployment status. | +| `apiProxy` | `string` | API proxy. | | `deployStartTime` | `string` | Time the API proxy was marked `deployed` in the control plane in millisconds since epoch. | -| `environment` | `string` | Environment. | -| `serviceAccount` | `string` | The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`. | | `state` | `string` | Current state of the deployment. **Note**: This field is displayed only when viewing deployment status. | -| `apiProxy` | `string` | API proxy. | +| `serviceAccount` | `string` | The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/security_incidents/index.md b/docs/google-docs/providers/google/apigee/security_incidents/index.md index 4c6e11c7d9..ef25d08c77 100644 --- a/docs/google-docs/providers/google/apigee/security_incidents/index.md +++ b/docs/google-docs/providers/google/apigee/security_incidents/index.md @@ -27,10 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `securityIncidents` | `array` | List of security incidents in the organization | +| `name` | `string` | Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111 | +| `firstDetectedTime` | `string` | Output only. The time when events associated with the incident were first detected. | +| `lastDetectedTime` | `string` | Output only. The time when events associated with the incident were last detected. | +| `riskLevel` | `string` | Output only. Risk level of the incident. | +| `trafficCount` | `string` | Total traffic detected as part of the incident. | +| `detectionTypes` | `array` | Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection. | +| `displayName` | `string` | Display name of the security incident. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `organizations_environments_security_incidents_get` | `SELECT` | `environmentsId, organizationsId, securityIncidentsId` | GetSecurityIncident gets the specified security incident. Returns NOT_FOUND if security incident is not present for the specified organization and environment. | | `organizations_environments_security_incidents_list` | `SELECT` | `environmentsId, organizationsId` | ListSecurityIncidents lists all the security incident associated with the environment. | +| `_organizations_environments_security_incidents_list` | `EXEC` | `environmentsId, organizationsId` | ListSecurityIncidents lists all the security incident associated with the environment. | 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 94bf05f321..25404181c8 100644 --- a/docs/google-docs/providers/google/apigee/security_profiles/index.md +++ b/docs/google-docs/providers/google/apigee/security_profiles/index.md @@ -27,10 +27,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `securityProfiles` | `array` | List of security profiles in the organization. The profiles may be attached or unattached to any environment. This will return latest revision of each profile. | +| `name` | `string` | Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile} | +| `description` | `string` | Description of the security profile. | +| `maxScore` | `integer` | Output only. Maximum security score that can be generated by this profile. | +| `revisionId` | `string` | Output only. Revision ID of the security profile. | +| `revisionUpdateTime` | `string` | Output only. The time when revision was updated. | +| `minScore` | `integer` | Output only. Minimum security score that can be generated by this profile. | +| `revisionPublishTime` | `string` | Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments. | +| `displayName` | `string` | Display name of the security profile. | +| `revisionCreateTime` | `string` | Output only. The time when revision was created. | +| `scoringConfigs` | `array` | List of profile scoring configs in this revision. | +| `environments` | `array` | List of environments attached to security profile. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `organizations_security_profiles_get` | `SELECT` | `organizationsId, securityProfilesId` | GetSecurityProfile gets the specified security profile. Returns NOT_FOUND if security profile is not present for the specified organization. | | `organizations_security_profiles_list` | `SELECT` | `organizationsId` | ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles. | +| `_organizations_security_profiles_list` | `EXEC` | `organizationsId` | ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles. | diff --git a/docs/google-docs/providers/google/apigee/security_profiles_revisions/index.md b/docs/google-docs/providers/google/apigee/security_profiles_revisions/index.md index d80b69d219..0cb1ef5117 100644 --- a/docs/google-docs/providers/google/apigee/security_profiles_revisions/index.md +++ b/docs/google-docs/providers/google/apigee/security_profiles_revisions/index.md @@ -27,9 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `securityProfiles` | `array` | List of security profile revisions. The revisions may be attached or unattached to any environment. | +| `name` | `string` | Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile} | +| `description` | `string` | Description of the security profile. | +| `revisionCreateTime` | `string` | Output only. The time when revision was created. | +| `revisionPublishTime` | `string` | Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments. | +| `displayName` | `string` | Display name of the security profile. | +| `revisionUpdateTime` | `string` | Output only. The time when revision was updated. | +| `scoringConfigs` | `array` | List of profile scoring configs in this revision. | +| `maxScore` | `integer` | Output only. Maximum security score that can be generated by this profile. | +| `environments` | `array` | List of environments attached to security profile. | +| `minScore` | `integer` | Output only. Minimum security score that can be generated by this profile. | +| `revisionId` | `string` | Output only. Revision ID of the security profile. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `organizations_security_profiles_list_revisions` | `SELECT` | `organizationsId, securityProfilesId` | +| `_organizations_security_profiles_list_revisions` | `EXEC` | `organizationsId, 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 9d7d2443a3..1f8b01c659 100644 --- a/docs/google-docs/providers/google/apigee/security_reports/index.md +++ b/docs/google-docs/providers/google/apigee/security_reports/index.md @@ -27,22 +27,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `error` | `string` | Error is set when query fails. | +| `queryParams` | `object` | Metadata for the security report. | +| `updated` | `string` | Output only. Last updated timestamp for the query. | +| `envgroupHostname` | `string` | Hostname is available only when query is executed at host level. | +| `displayName` | `string` | Display Name specified by the user. | | `reportDefinitionId` | `string` | Report Definition ID. | | `resultFileSize` | `string` | ResultFileSize is available only after the query is completed. | -| `queryParams` | `object` | Metadata for the security report. | -| `self` | `string` | Self link of the query. Example: `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` or following format if query is running at host level: `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` | | `created` | `string` | Creation time of the query. | -| `envgroupHostname` | `string` | Hostname is available only when query is executed at host level. | -| `error` | `string` | Error is set when query fails. | | `executionTime` | `string` | ExecutionTime is available only after the query is completed. | +| `resultRows` | `string` | ResultRows is available only after the query is completed. | +| `self` | `string` | Self link of the query. Example: `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` or following format if query is running at host level: `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` | | `result` | `object` | Contains informations about the security report results. | | `state` | `string` | Query state could be "enqueued", "running", "completed", "expired" and "failed". | -| `updated` | `string` | Output only. Last updated timestamp for the query. | -| `displayName` | `string` | Display Name specified by the user. | -| `resultRows` | `string` | ResultRows is available only after the query is completed. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `organizations_environments_security_reports_get` | `SELECT` | `environmentsId, organizationsId, securityReportsId` | Get security report status If the query is still in progress, the `state` is set to "running" After the query has completed successfully, `state` is set to "completed" | | `organizations_environments_security_reports_list` | `SELECT` | `environmentsId, organizationsId` | Return a list of Security Reports | | `organizations_environments_security_reports_create` | `INSERT` | `environmentsId, organizationsId` | Submit a report request to be processed in the background. If the submission succeeds, the API returns a 200 status and an ID that refer to the report request. In addition to the HTTP status 200, the `state` of "enqueued" means that the request succeeded. | +| `_organizations_environments_security_reports_list` | `EXEC` | `environmentsId, organizationsId` | Return a list of Security Reports | diff --git a/docs/google-docs/providers/google/apigee/security_reports_result/index.md b/docs/google-docs/providers/google/apigee/security_reports_result/index.md index a9fc91222b..129c531afb 100644 --- a/docs/google-docs/providers/google/apigee/security_reports_result/index.md +++ b/docs/google-docs/providers/google/apigee/security_reports_result/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `data` | `string` | The HTTP request/response body as raw binary. | | `extensions` | `array` | Application specific response metadata. Must be set in the first response for streaming APIs. | | `contentType` | `string` | The HTTP Content-Type header value specifying the content type of the body. | +| `data` | `string` | The HTTP request/response body as raw binary. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/security_reports_result_view/index.md b/docs/google-docs/providers/google/apigee/security_reports_result_view/index.md index d8cf875000..be58ba8581 100644 --- a/docs/google-docs/providers/google/apigee/security_reports_result_view/index.md +++ b/docs/google-docs/providers/google/apigee/security_reports_result_view/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `rows` | `array` | Rows of security report result. Each row is a JSON object. Example: {sum(message_count): 1, developer_app: "(not set)",…} | -| `state` | `string` | State of retrieving ResultView. | | `code` | `integer` | Error code when there is a failure. | | `error` | `string` | Error message when there is a failure. | | `metadata` | `object` | Metadata for the security report. | +| `rows` | `array` | Rows of security report result. Each row is a JSON object. Example: {sum(message_count): 1, developer_app: "(not set)",…} | +| `state` | `string` | State of retrieving ResultView. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/subscriptions/index.md b/docs/google-docs/providers/google/apigee/subscriptions/index.md index 8d184aec2f..1f4734c49a 100644 --- a/docs/google-docs/providers/google/apigee/subscriptions/index.md +++ b/docs/google-docs/providers/google/apigee/subscriptions/index.md @@ -27,8 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `developerSubscriptions` | `array` | List of all subscriptions. | -| `nextStartKey` | `string` | Value that can be sent as `startKey` to retrieve the next page of content. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Output only. Name of the API product subscription. | +| `apiproduct` | `string` | Name of the API product for which the developer is purchasing a subscription. | +| `createdAt` | `string` | Output only. Time when the API product subscription was created in milliseconds since epoch. | +| `endTime` | `string` | Time when the API product subscription ends in milliseconds since epoch. | +| `lastModifiedAt` | `string` | Output only. Time when the API product subscription was last modified in milliseconds since epoch. | +| `startTime` | `string` | Time when the API product subscription starts in milliseconds since epoch. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/targetservers/index.md b/docs/google-docs/providers/google/apigee/targetservers/index.md index b84b2f2a46..4427eb1802 100644 --- a/docs/google-docs/providers/google/apigee/targetservers/index.md +++ b/docs/google-docs/providers/google/apigee/targetservers/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. The resource id of this target server. Values must match the regular expression | | `description` | `string` | Optional. A human-readable description of this TargetServer. | +| `port` | `integer` | Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. | | `protocol` | `string` | Immutable. The protocol used by this TargetServer. | | `sSLInfo` | `object` | TLS configuration information for virtual hosts and TargetServers. | | `host` | `string` | Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. | | `isEnabled` | `boolean` | Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. | -| `port` | `integer` | Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/apis/index.md b/docs/google-docs/providers/google/apigeeregistry/apis/index.md index fec6085b7a..2f80120448 100644 --- a/docs/google-docs/providers/google/apigeeregistry/apis/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/apis/index.md @@ -27,13 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `apis` | `array` | The APIs from the specified publisher. | +| `name` | `string` | Resource name. | +| `description` | `string` | A detailed description. | +| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | +| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | +| `availability` | `string` | A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN". | +| `createTime` | `string` | Output only. Creation timestamp. | +| `displayName` | `string` | Human-meaningful name. | +| `recommendedDeployment` | `string` | The recommended deployment of the API. Format: `projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}` | +| `recommendedVersion` | `string` | The recommended version of the API. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` | +| `updateTime` | `string` | Output only. Last update timestamp. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_apis_list` | `SELECT` | `locationsId, projectsId` | Returns matching APIs. | | `projects_locations_apis_create` | `INSERT` | `locationsId, projectsId` | Creates a specified API. | | `projects_locations_apis_delete` | `DELETE` | `apisId, locationsId, projectsId` | Removes a specified API and all of the resources that it owns. | +| `_projects_locations_apis_list` | `EXEC` | `locationsId, projectsId` | Returns matching APIs. | | `projects_locations_apis_get` | `EXEC` | `apisId, locationsId, projectsId` | Returns a specified API. | | `projects_locations_apis_patch` | `EXEC` | `apisId, locationsId, projectsId` | Used to modify a specified API. | diff --git a/docs/google-docs/providers/google/apigeeregistry/apis_iam_policies/index.md b/docs/google-docs/providers/google/apigeeregistry/apis_iam_policies/index.md index e38c693f28..5fe5928ff0 100644 --- a/docs/google-docs/providers/google/apigeeregistry/apis_iam_policies/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/apis_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/artifacts/index.md b/docs/google-docs/providers/google/apigeeregistry/artifacts/index.md index f4431c0074..c76fcd4289 100644 --- a/docs/google-docs/providers/google/apigeeregistry/artifacts/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/artifacts/index.md @@ -27,8 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `artifacts` | `array` | The artifacts from the specified publisher. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Resource name. | +| `contents` | `string` | Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents. | +| `sizeBytes` | `integer` | Output only. The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact. | +| `hash` | `string` | Output only. A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact. | +| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | +| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "registry.googleapis.com/" and cannot be changed. | +| `createTime` | `string` | Output only. Creation timestamp. | +| `updateTime` | `string` | Output only. Last update timestamp. | +| `mimeType` | `string` | A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip"). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,6 +54,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_apis_versions_artifacts_delete` | `DELETE` | `apisId, artifactsId, locationsId, projectsId, versionsId` | Removes a specified artifact. | | `projects_locations_apis_versions_specs_artifacts_delete` | `DELETE` | `apisId, artifactsId, locationsId, projectsId, specsId, versionsId` | Removes a specified artifact. | | `projects_locations_artifacts_delete` | `DELETE` | `artifactsId, locationsId, projectsId` | Removes a specified artifact. | +| `_projects_locations_apis_artifacts_list` | `EXEC` | `apisId, locationsId, projectsId` | Returns matching artifacts. | +| `_projects_locations_apis_deployments_artifacts_list` | `EXEC` | `apisId, deploymentsId, locationsId, projectsId` | Returns matching artifacts. | +| `_projects_locations_apis_versions_artifacts_list` | `EXEC` | `apisId, locationsId, projectsId, versionsId` | Returns matching artifacts. | +| `_projects_locations_apis_versions_specs_artifacts_list` | `EXEC` | `apisId, locationsId, projectsId, specsId, versionsId` | Returns matching artifacts. | +| `_projects_locations_artifacts_list` | `EXEC` | `locationsId, projectsId` | Returns matching artifacts. | | `projects_locations_apis_artifacts_get` | `EXEC` | `apisId, artifactsId, locationsId, projectsId` | Returns a specified artifact. | | `projects_locations_apis_artifacts_replace_artifact` | `EXEC` | `apisId, artifactsId, locationsId, projectsId` | Used to replace a specified artifact. | | `projects_locations_apis_deployments_artifacts_get` | `EXEC` | `apisId, artifactsId, deploymentsId, locationsId, projectsId` | Returns a specified artifact. | diff --git a/docs/google-docs/providers/google/apigeeregistry/deployments/index.md b/docs/google-docs/providers/google/apigeeregistry/deployments/index.md index 408da01ead..e61ac25114 100644 --- a/docs/google-docs/providers/google/apigeeregistry/deployments/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/deployments/index.md @@ -27,14 +27,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `apiDeployments` | `array` | The deployments from the specified publisher. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Resource name. | +| `description` | `string` | A detailed description. | +| `apiSpecRevision` | `string` | The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}` | +| `revisionUpdateTime` | `string` | Output only. Last update timestamp: when the represented revision was last modified. | +| `intendedAudience` | `string` | Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision. | +| `createTime` | `string` | Output only. Creation timestamp; when the deployment resource was created. | +| `endpointUri` | `string` | The address where the deployment is serving. Changes to this value will update the revision. | +| `externalChannelUri` | `string` | The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision. | +| `revisionCreateTime` | `string` | Output only. Revision creation timestamp; when the represented revision was created. | +| `revisionId` | `string` | Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string. | +| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | +| `accessGuidance` | `string` | Text briefly describing how to access the endpoint. Changes to this value will not affect the revision. | +| `displayName` | `string` | Human-meaningful name. | +| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_apis_deployments_list` | `SELECT` | `apisId, locationsId, projectsId` | Returns matching deployments. | | `projects_locations_apis_deployments_create` | `INSERT` | `apisId, locationsId, projectsId` | Creates a specified deployment. | | `projects_locations_apis_deployments_delete` | `DELETE` | `apisId, deploymentsId, locationsId, projectsId` | Removes a specified deployment, all revisions, and all child resources (e.g., artifacts). | +| `_projects_locations_apis_deployments_list` | `EXEC` | `apisId, locationsId, projectsId` | Returns matching deployments. | | `projects_locations_apis_deployments_get` | `EXEC` | `apisId, deploymentsId, locationsId, projectsId` | Returns a specified deployment. | | `projects_locations_apis_deployments_patch` | `EXEC` | `apisId, deploymentsId, locationsId, projectsId` | Used to modify a specified deployment. | | `projects_locations_apis_deployments_rollback` | `EXEC` | `apisId, deploymentsId, locationsId, projectsId` | Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID. | diff --git a/docs/google-docs/providers/google/apigeeregistry/deployments_iam_policies/index.md b/docs/google-docs/providers/google/apigeeregistry/deployments_iam_policies/index.md index d7c7300147..6df3504b38 100644 --- a/docs/google-docs/providers/google/apigeeregistry/deployments_iam_policies/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/deployments_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/deployments_revisions/index.md b/docs/google-docs/providers/google/apigeeregistry/deployments_revisions/index.md index c87e02ead6..6e147eadce 100644 --- a/docs/google-docs/providers/google/apigeeregistry/deployments_revisions/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/deployments_revisions/index.md @@ -27,9 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `apiDeployments` | `array` | The revisions of the deployment. | -| `nextPageToken` | `string` | A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Resource name. | +| `description` | `string` | A detailed description. | +| `revisionId` | `string` | Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string. | +| `accessGuidance` | `string` | Text briefly describing how to access the endpoint. Changes to this value will not affect the revision. | +| `apiSpecRevision` | `string` | The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}` | +| `displayName` | `string` | Human-meaningful name. | +| `createTime` | `string` | Output only. Creation timestamp; when the deployment resource was created. | +| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | +| `externalChannelUri` | `string` | The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision. | +| `intendedAudience` | `string` | Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision. | +| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | +| `revisionUpdateTime` | `string` | Output only. Last update timestamp: when the represented revision was last modified. | +| `revisionCreateTime` | `string` | Output only. Revision creation timestamp; when the represented revision was created. | +| `endpointUri` | `string` | The address where the deployment is serving. Changes to this value will update the revision. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_locations_apis_deployments_list_revisions` | `SELECT` | `apisId, deploymentsId, locationsId, projectsId` | +| `_projects_locations_apis_deployments_list_revisions` | `EXEC` | `apisId, deploymentsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/apigeeregistry/index.md b/docs/google-docs/providers/google/apigeeregistry/index.md index 0acabc78ca..63bedf3bd6 100644 --- a/docs/google-docs/providers/google/apigeeregistry/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 21
total selectable resources: 19
-total methods: 98
+total methods: 111
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleApigee Registry API Description -Idapigeeregistry:v23.08.00155 +Idapigeeregistry:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/apigeeregistry/instances/index.md b/docs/google-docs/providers/google/apigeeregistry/instances/index.md index d0c39744ad..25d986dc97 100644 --- a/docs/google-docs/providers/google/apigeeregistry/instances/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/instances/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Format: `projects/*/locations/*/instance`. Currently only `locations/global` is supported. | -| `state` | `string` | Output only. The current state of the Instance. | | `stateMessage` | `string` | Output only. Extra information of Instance.State if the state is `FAILED`. | | `updateTime` | `string` | Output only. Last update timestamp. | | `build` | `object` | Build information of the Instance if it's in `ACTIVE` state. | | `config` | `object` | Available configurations to provision an Instance. | | `createTime` | `string` | Output only. Creation timestamp. | +| `state` | `string` | Output only. The current state of the Instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/instances_iam_policies/index.md b/docs/google-docs/providers/google/apigeeregistry/instances_iam_policies/index.md index 334de287e0..288e4c169f 100644 --- a/docs/google-docs/providers/google/apigeeregistry/instances_iam_policies/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/instances_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/locations/index.md b/docs/google-docs/providers/google/apigeeregistry/locations/index.md index e11dea1869..ca64d3cf55 100644 --- a/docs/google-docs/providers/google/apigeeregistry/locations/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/apigeeregistry/operations/index.md b/docs/google-docs/providers/google/apigeeregistry/operations/index.md index fac7de727d..a1bcefe343 100644 --- a/docs/google-docs/providers/google/apigeeregistry/operations/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | | `projects_locations_operations_get` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/apigeeregistry/specs/index.md b/docs/google-docs/providers/google/apigeeregistry/specs/index.md index 00b08a04ba..8dbc076f1b 100644 --- a/docs/google-docs/providers/google/apigeeregistry/specs/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/specs/index.md @@ -27,14 +27,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `apiSpecs` | `array` | The specs from the specified publisher. | +| `name` | `string` | Resource name. | +| `description` | `string` | A detailed description. | +| `revisionId` | `string` | Output only. Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string. | +| `sourceUri` | `string` | The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved. | +| `contents` | `string` | Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents. | +| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | +| `hash` | `string` | Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec. | +| `revisionCreateTime` | `string` | Output only. Revision creation timestamp; when the represented revision was created. | +| `createTime` | `string` | Output only. Creation timestamp; when the spec resource was created. | +| `filename` | `string` | A possibly-hierarchical name used to refer to the spec from other specs. | +| `mimeType` | `string` | A style (format) descriptor for this spec that is specified as a Media Type (https://en.wikipedia.org/wiki/Media_type). Possible values include `application/vnd.apigee.proto`, `application/vnd.apigee.openapi`, and `application/vnd.apigee.graphql`, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip"). | +| `sizeBytes` | `integer` | Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec. | +| `revisionUpdateTime` | `string` | Output only. Last update timestamp: when the represented revision was last modified. | +| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_apis_versions_specs_list` | `SELECT` | `apisId, locationsId, projectsId, versionsId` | Returns matching specs. | | `projects_locations_apis_versions_specs_create` | `INSERT` | `apisId, locationsId, projectsId, versionsId` | Creates a specified spec. | | `projects_locations_apis_versions_specs_delete` | `DELETE` | `apisId, locationsId, projectsId, specsId, versionsId` | Removes a specified spec, all revisions, and all child resources (e.g., artifacts). | +| `_projects_locations_apis_versions_specs_list` | `EXEC` | `apisId, locationsId, projectsId, versionsId` | Returns matching specs. | | `projects_locations_apis_versions_specs_get` | `EXEC` | `apisId, locationsId, projectsId, specsId, versionsId` | Returns a specified spec. | | `projects_locations_apis_versions_specs_patch` | `EXEC` | `apisId, locationsId, projectsId, specsId, versionsId` | Used to modify a specified spec. | | `projects_locations_apis_versions_specs_rollback` | `EXEC` | `apisId, locationsId, projectsId, specsId, versionsId` | Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID. | diff --git a/docs/google-docs/providers/google/apigeeregistry/specs_iam_policies/index.md b/docs/google-docs/providers/google/apigeeregistry/specs_iam_policies/index.md index d1af555936..e9fa389ca2 100644 --- a/docs/google-docs/providers/google/apigeeregistry/specs_iam_policies/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/specs_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/specs_revisions/index.md b/docs/google-docs/providers/google/apigeeregistry/specs_revisions/index.md index 807e112a7c..5acdd83af1 100644 --- a/docs/google-docs/providers/google/apigeeregistry/specs_revisions/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/specs_revisions/index.md @@ -27,9 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `apiSpecs` | `array` | The revisions of the spec. | +| `name` | `string` | Resource name. | +| `description` | `string` | A detailed description. | +| `revisionId` | `string` | Output only. Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string. | +| `mimeType` | `string` | A style (format) descriptor for this spec that is specified as a Media Type (https://en.wikipedia.org/wiki/Media_type). Possible values include `application/vnd.apigee.proto`, `application/vnd.apigee.openapi`, and `application/vnd.apigee.graphql`, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip"). | +| `revisionCreateTime` | `string` | Output only. Revision creation timestamp; when the represented revision was created. | +| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | +| `revisionUpdateTime` | `string` | Output only. Last update timestamp: when the represented revision was last modified. | +| `filename` | `string` | A possibly-hierarchical name used to refer to the spec from other specs. | +| `sizeBytes` | `integer` | Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec. | +| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | +| `hash` | `string` | Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec. | +| `sourceUri` | `string` | The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved. | +| `createTime` | `string` | Output only. Creation timestamp; when the spec resource was created. | +| `contents` | `string` | Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_locations_apis_versions_specs_list_revisions` | `SELECT` | `apisId, locationsId, projectsId, specsId, versionsId` | +| `_projects_locations_apis_versions_specs_list_revisions` | `EXEC` | `apisId, locationsId, projectsId, specsId, versionsId` | diff --git a/docs/google-docs/providers/google/apigeeregistry/versions/index.md b/docs/google-docs/providers/google/apigeeregistry/versions/index.md index ec4389086e..9afd339e52 100644 --- a/docs/google-docs/providers/google/apigeeregistry/versions/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/versions/index.md @@ -27,13 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `apiVersions` | `array` | The versions from the specified publisher. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Resource name. | +| `description` | `string` | A detailed description. | +| `state` | `string` | A user-definable description of the lifecycle phase of this API version. Format: free-form, but we expect single words that describe API maturity, e.g., "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION", "DEPRECATED", "RETIRED". | +| `updateTime` | `string` | Output only. Last update timestamp. | +| `createTime` | `string` | Output only. Creation timestamp. | +| `displayName` | `string` | Human-meaningful name. | +| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | +| `primarySpec` | `string` | The primary spec for this version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec} | +| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_apis_versions_list` | `SELECT` | `apisId, locationsId, projectsId` | Returns matching versions. | | `projects_locations_apis_versions_create` | `INSERT` | `apisId, locationsId, projectsId` | Creates a specified version. | | `projects_locations_apis_versions_delete` | `DELETE` | `apisId, locationsId, projectsId, versionsId` | Removes a specified version and all of the resources that it owns. | +| `_projects_locations_apis_versions_list` | `EXEC` | `apisId, locationsId, projectsId` | Returns matching versions. | | `projects_locations_apis_versions_get` | `EXEC` | `apisId, locationsId, projectsId, versionsId` | Returns a specified version. | | `projects_locations_apis_versions_patch` | `EXEC` | `apisId, locationsId, projectsId, versionsId` | Used to modify a specified version. | diff --git a/docs/google-docs/providers/google/apigeeregistry/versions_iam_policies/index.md b/docs/google-docs/providers/google/apigeeregistry/versions_iam_policies/index.md index fe01aa65ba..15c7dff1e8 100644 --- a/docs/google-docs/providers/google/apigeeregistry/versions_iam_policies/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/versions_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apikeys/index.md b/docs/google-docs/providers/google/apikeys/index.md index 01f2e25824..ec362a81d4 100644 --- a/docs/google-docs/providers/google/apikeys/index.md +++ b/docs/google-docs/providers/google/apikeys/index.md @@ -21,7 +21,7 @@ Manages The API Keys Associated With Developer Projects.
total resources: 3
total selectable resources: 2
-total methods: 9
+total methods: 10
@@ -33,7 +33,7 @@ Manages The API Keys Associated With Developer Projects. TypeService TitleAPI Keys API DescriptionManages The API Keys Associated With Developer Projects. -Idapikeys:v23.08.00155 +Idapikeys:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/apikeys/keys/index.md b/docs/google-docs/providers/google/apikeys/keys/index.md index 3785e3d455..6e51f58544 100644 --- a/docs/google-docs/providers/google/apikeys/keys/index.md +++ b/docs/google-docs/providers/google/apikeys/keys/index.md @@ -27,8 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `keys` | `array` | A list of API keys. | -| `nextPageToken` | `string` | The pagination token for the next page of results. | +| `name` | `string` | Output only. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`. | +| `restrictions` | `object` | Describes the restrictions on the key. | +| `updateTime` | `string` | Output only. A timestamp identifying the time this key was last updated. | +| `uid` | `string` | Output only. Unique id in UUID4 format. | +| `annotations` | `object` | Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. | +| `deleteTime` | `string` | Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty. | +| `displayName` | `string` | Human-readable display name of this key that you can modify. The maximum length is 63 characters. | +| `createTime` | `string` | Output only. A timestamp identifying the time this key was originally created. | +| `keyString` | `string` | Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method. | +| `etag` | `string` | Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +44,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists the API keys owned by a project. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new API key. NOTE: Key is a global resource; hence the only supported value for location is `global`. | | `delete` | `DELETE` | `keysId, locationsId, projectsId` | Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project. NOTE: Key is a global resource; hence the only supported value for location is `global`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists the API keys owned by a project. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`. | | `lookup_key` | `EXEC` | | Find the parent project and resource name of the API key that matches the key string in the request. If the API key has been purged, resource name will not be set. The service account must have the `apikeys.keys.lookup` permission on the parent project. | | `patch` | `EXEC` | `keysId, locationsId, projectsId` | Patches the modifiable fields of an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`. | | `undelete` | `EXEC` | `keysId, locationsId, projectsId` | Undeletes an API key which was deleted within 30 days. NOTE: Key is a global resource; hence the only supported value for location is `global`. | diff --git a/docs/google-docs/providers/google/appengine/apps/index.md b/docs/google-docs/providers/google/appengine/apps/index.md index 73e19b3080..be290efdc9 100644 --- a/docs/google-docs/providers/google/appengine/apps/index.md +++ b/docs/google-docs/providers/google/appengine/apps/index.md @@ -29,19 +29,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp. | | `name` | `string` | Output only. Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly | -| `databaseType` | `string` | The type of the Cloud Firestore or Cloud Datastore database associated with this application. | -| `defaultBucket` | `string` | Output only. Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly | -| `defaultHostname` | `string` | Output only. Hostname used to reach this application, as resolved by App Engine.@OutputOnly | -| `featureSettings` | `object` | The feature specific settings to be used in the application. These define behaviors that are user configurable. | -| `serviceAccount` | `string` | The service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one. | +| `authDomain` | `string` | Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account. | | `defaultCookieExpiration` | `string` | Cookie expiration policy for this application. | -| `servingStatus` | `string` | Serving status of this application. | -| `gcrDomain` | `string` | Output only. The Google Container Registry domain used for storing managed build docker images for this application. | -| `dispatchRules` | `array` | HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported. | +| `codeBucket` | `string` | Output only. Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly | | `iap` | `object` | Identity-Aware Proxy | +| `serviceAccount` | `string` | The service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one. | +| `databaseType` | `string` | The type of the Cloud Firestore or Cloud Datastore database associated with this application. | +| `dispatchRules` | `array` | HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported. | | `locationId` | `string` | Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations). | -| `authDomain` | `string` | Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account. | -| `codeBucket` | `string` | Output only. Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly | +| `servingStatus` | `string` | Serving status of this application. | +| `defaultBucket` | `string` | Output only. Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly | +| `gcrDomain` | `string` | Output only. The Google Container Registry domain used for storing managed build docker images for this application. | +| `featureSettings` | `object` | The feature specific settings to be used in the application. These define behaviors that are user configurable. | +| `defaultHostname` | `string` | Output only. Hostname used to reach this application, as resolved by App Engine.@OutputOnly | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/appengine/authorized_certificates/index.md b/docs/google-docs/providers/google/appengine/authorized_certificates/index.md index cc6443450a..06c97277dc 100644 --- a/docs/google-docs/providers/google/appengine/authorized_certificates/index.md +++ b/docs/google-docs/providers/google/appengine/authorized_certificates/index.md @@ -27,8 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Continuation token for fetching the next page of results. | -| `certificates` | `array` | The SSL certificates the user is authorized to administer. | +| `id` | `string` | Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly | +| `name` | `string` | Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly | +| `domainMappingsCount` | `integer` | Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly | +| `certificateRawData` | `object` | An SSL certificate obtained from a certificate authority. | +| `expireTime` | `string` | The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly | +| `managedCertificate` | `object` | A certificate managed by App Engine. | +| `displayName` | `string` | The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. | +| `visibleDomainMappings` | `array` | The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly | +| `domainNames` | `array` | Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +43,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `appsId` | Lists all SSL certificates the user is authorized to administer. | | `create` | `INSERT` | `appsId` | Uploads the specified SSL certificate. | | `delete` | `DELETE` | `appsId, authorizedCertificatesId` | Deletes the specified SSL certificate. | +| `_list` | `EXEC` | `appsId` | Lists all SSL certificates the user is authorized to administer. | | `patch` | `EXEC` | `appsId, authorizedCertificatesId` | Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated. | diff --git a/docs/google-docs/providers/google/appengine/authorized_domains/index.md b/docs/google-docs/providers/google/appengine/authorized_domains/index.md index a561c17b93..2f88c971d9 100644 --- a/docs/google-docs/providers/google/appengine/authorized_domains/index.md +++ b/docs/google-docs/providers/google/appengine/authorized_domains/index.md @@ -27,9 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `domains` | `array` | The authorized domains belonging to the user. | -| `nextPageToken` | `string` | Continuation token for fetching the next page of results. | +| `id` | `string` | Fully qualified domain name of the domain authorized for use. Example: example.com. | +| `name` | `string` | Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `appsId` | +| `_list` | `EXEC` | `appsId` | diff --git a/docs/google-docs/providers/google/appengine/domain_mappings/index.md b/docs/google-docs/providers/google/appengine/domain_mappings/index.md index d13d5b80c0..8aef74e90a 100644 --- a/docs/google-docs/providers/google/appengine/domain_mappings/index.md +++ b/docs/google-docs/providers/google/appengine/domain_mappings/index.md @@ -38,4 +38,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `appsId` | Lists the domain mappings on an application. | | `create` | `INSERT` | `appsId` | Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains. | | `delete` | `DELETE` | `appsId, domainMappingsId` | Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource. | +| `_list` | `EXEC` | `appsId` | Lists the domain mappings on an application. | | `patch` | `EXEC` | `appsId, domainMappingsId` | Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource. | diff --git a/docs/google-docs/providers/google/appengine/index.md b/docs/google-docs/providers/google/appengine/index.md index f8b1711371..c322b9ae92 100644 --- a/docs/google-docs/providers/google/appengine/index.md +++ b/docs/google-docs/providers/google/appengine/index.md @@ -21,7 +21,7 @@ Provisions And Manages Developers' App Engine Applications.
total resources: 10
total selectable resources: 10
-total methods: 38
+total methods: 47
@@ -33,7 +33,7 @@ Provisions And Manages Developers' App Engine Applications. TypeService TitleApp Engine Admin API DescriptionProvisions And Manages Developers' App Engine Applications. -Idappengine:v23.08.00155 +Idappengine:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/appengine/ingress_rules/index.md b/docs/google-docs/providers/google/appengine/ingress_rules/index.md index bf074a3e54..5615dd86cd 100644 --- a/docs/google-docs/providers/google/appengine/ingress_rules/index.md +++ b/docs/google-docs/providers/google/appengine/ingress_rules/index.md @@ -38,5 +38,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `appsId` | Lists the firewall rules of an application. | | `create` | `INSERT` | `appsId` | Creates a firewall rule for the application. | | `delete` | `DELETE` | `appsId, ingressRulesId` | Deletes the specified firewall rule. | +| `_list` | `EXEC` | `appsId` | Lists the firewall rules of an application. | | `batch_update` | `EXEC` | `appsId` | Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list. | | `patch` | `EXEC` | `appsId, ingressRulesId` | Updates the specified firewall rule. | diff --git a/docs/google-docs/providers/google/appengine/instances/index.md b/docs/google-docs/providers/google/appengine/instances/index.md index 62b4800a9b..06c2e1ca9e 100644 --- a/docs/google-docs/providers/google/appengine/instances/index.md +++ b/docs/google-docs/providers/google/appengine/instances/index.md @@ -29,25 +29,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Output only. Relative name of the instance within the version. Example: instance-1. | | `name` | `string` | Output only. Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1. | -| `qps` | `number` | Output only. Average queries per second (QPS) over the last minute. | -| `errors` | `integer` | Output only. Number of errors since this instance was started. | -| `requests` | `integer` | Output only. Number of requests since this instance was started. | -| `vmLiveness` | `string` | Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment. | | `availability` | `string` | Output only. Availability of the instance. | -| `vmIp` | `string` | Output only. The IP address of this instance. Only applicable for instances in App Engine flexible environment. | -| `vmZoneName` | `string` | Output only. Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. | | `vmName` | `string` | Output only. Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. | -| `vmId` | `string` | Output only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. | +| `errors` | `integer` | Output only. Number of errors since this instance was started. | | `vmDebugEnabled` | `boolean` | Output only. Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. | -| `memoryUsage` | `string` | Output only. Total memory in use (bytes). | -| `averageLatency` | `integer` | Output only. Average latency (ms) over the last minute. | -| `vmStatus` | `string` | Output only. Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. | | `appEngineRelease` | `string` | Output only. App Engine release this instance is running on. | | `startTime` | `string` | Output only. Time that this instance was started.@OutputOnly | +| `vmStatus` | `string` | Output only. Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. | +| `vmLiveness` | `string` | Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment. | +| `averageLatency` | `integer` | Output only. Average latency (ms) over the last minute. | +| `memoryUsage` | `string` | Output only. Total memory in use (bytes). | +| `vmId` | `string` | Output only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. | +| `qps` | `number` | Output only. Average queries per second (QPS) over the last minute. | +| `requests` | `integer` | Output only. Number of requests since this instance was started. | +| `vmIp` | `string` | Output only. The IP address of this instance. Only applicable for instances in App Engine flexible environment. | +| `vmZoneName` | `string` | Output only. Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `appsId, instancesId, servicesId, versionsId` | Gets instance information. | | `list` | `SELECT` | `appsId, servicesId, versionsId` | Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). | | `delete` | `DELETE` | `appsId, instancesId, servicesId, versionsId` | Stops a running instance.The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment (https://cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) \| flexible environment (https://cloud.google.com/appengine/docs/flexible/python/how-instances-are-managed)).To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions/patch) method. | +| `_list` | `EXEC` | `appsId, servicesId, versionsId` | Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). | | `debug` | `EXEC` | `appsId, instancesId, servicesId, versionsId` | Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment. | diff --git a/docs/google-docs/providers/google/appengine/locations/index.md b/docs/google-docs/providers/google/appengine/locations/index.md index 3c2a783af9..eb76eab31b 100644 --- a/docs/google-docs/providers/google/appengine/locations/index.md +++ b/docs/google-docs/providers/google/appengine/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1" | +| `locationId` | `string` | The canonical id for this location. For example: "us-east1". | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `appsId, locationsId` | Gets information about a location. | | `list` | `SELECT` | `appsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `appsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/appengine/operations/index.md b/docs/google-docs/providers/google/appengine/operations/index.md index ff316e1ee3..4599cba3d8 100644 --- a/docs/google-docs/providers/google/appengine/operations/index.md +++ b/docs/google-docs/providers/google/appengine/operations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}. | +| `response` | `object` | The normal response of the operation in case of success. 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. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `appsId, operationsId` | 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. | | `list` | `SELECT` | `appsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | +| `_list` | `EXEC` | `appsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | diff --git a/docs/google-docs/providers/google/appengine/services/index.md b/docs/google-docs/providers/google/appengine/services/index.md index 9f78525a88..7611f2c38a 100644 --- a/docs/google-docs/providers/google/appengine/services/index.md +++ b/docs/google-docs/providers/google/appengine/services/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `services` | `array` | The services belonging to the requested application. | -| `nextPageToken` | `string` | Continuation token for fetching the next page of results. | +| `id` | `string` | Relative name of the service within the application. Example: default.@OutputOnly | +| `name` | `string` | Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly | +| `networkSettings` | `object` | A NetworkSettings resource is a container for ingress settings for a version or service. | +| `split` | `object` | Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. | +| `labels` | `object` | A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `appsId, servicesId` | Gets the current configuration of the specified service. | | `list` | `SELECT` | `appsId` | Lists all the services in the application. | | `delete` | `DELETE` | `appsId, servicesId` | Deletes the specified service and all enclosed versions. | +| `_list` | `EXEC` | `appsId` | Lists all the services in the application. | | `patch` | `EXEC` | `appsId, servicesId` | Updates the configuration of the specified service. | diff --git a/docs/google-docs/providers/google/appengine/versions/index.md b/docs/google-docs/providers/google/appengine/versions/index.md index 8277511cfe..47272b97d9 100644 --- a/docs/google-docs/providers/google/appengine/versions/index.md +++ b/docs/google-docs/providers/google/appengine/versions/index.md @@ -27,8 +27,47 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `versions` | `array` | The versions belonging to the requested service. | -| `nextPageToken` | `string` | Continuation token for fetching the next page of results. | +| `id` | `string` | Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-". | +| `name` | `string` | Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly | +| `envVariables` | `object` | Environment variables available to the application.Only returned in GET requests if view=FULL is set. | +| `healthCheck` | `object` | Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. | +| `instanceClass` | `string` | Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling. | +| `nobuildFilesRegex` | `string` | Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set. | +| `libraries` | `array` | Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set. | +| `serviceAccount` | `string` | The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag. | +| `endpointsApiService` | `object` | Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). | +| `servingStatus` | `string` | Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING. | +| `errorHandlers` | `array` | Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set. | +| `livenessCheck` | `object` | Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. | +| `zones` | `array` | The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated. | +| `basicScaling` | `object` | A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. | +| `runtimeApiVersion` | `string` | The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard//config/appref | +| `betaSettings` | `object` | Metadata settings that are supplied to this version to enable beta runtime features. | +| `apiConfig` | `object` | Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration for API handlers. | +| `runtime` | `string` | Desired runtime. Example: python27. | +| `runtimeChannel` | `string` | The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel. | +| `handlers` | `array` | An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set. | +| `versionUrl` | `string` | Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly | +| `automaticScaling` | `object` | Automatic scaling is based on request rate, response latencies, and other application metrics. | +| `entrypoint` | `object` | The entrypoint for the application. | +| `appEngineApis` | `boolean` | Allows App Engine second generation runtimes to access the legacy bundled services. | +| `env` | `string` | App Engine execution environment for this version.Defaults to standard. | +| `createTime` | `string` | Time that this version was created.@OutputOnly | +| `network` | `object` | Extra network settings. Only applicable in the App Engine flexible environment. | +| `resources` | `object` | Machine resources for a version. | +| `inboundServices` | `array` | Before an application can receive email or XMPP messages, the application must be configured to enable the service. | +| `buildEnvVariables` | `object` | Environment variables available to the build environment.Only returned in GET requests if view=FULL is set. | +| `flexibleRuntimeSettings` | `object` | Runtime settings for the App Engine flexible environment. | +| `createdBy` | `string` | Email address of the user who created this version.@OutputOnly | +| `runtimeMainExecutablePath` | `string` | The path or name of the app's main executable. | +| `deployment` | `object` | Code and application artifacts used to deploy a version to App Engine. | +| `diskUsageBytes` | `string` | Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly | +| `threadsafe` | `boolean` | Whether multiple requests can be dispatched to this version at once. | +| `defaultExpiration` | `string` | Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set. | +| `vpcAccessConnector` | `object` | VPC access connector specification. | +| `vm` | `boolean` | Whether to deploy this version in a container on a virtual machine. | +| `readinessCheck` | `object` | Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. | +| `manualScaling` | `object` | A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +75,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `appsId, servicesId` | Lists the versions of a service. | | `create` | `INSERT` | `appsId, servicesId` | Deploys code and resource files to a new version. | | `delete` | `DELETE` | `appsId, servicesId, versionsId` | Deletes an existing Version resource. | +| `_list` | `EXEC` | `appsId, servicesId` | Lists the versions of a service. | | `patch` | `EXEC` | `appsId, servicesId, versionsId` | Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#manualscaling) | diff --git a/docs/google-docs/providers/google/artifactregistry/docker_images/index.md b/docs/google-docs/providers/google/artifactregistry/docker_images/index.md index 814c799b35..db34329beb 100644 --- a/docs/google-docs/providers/google/artifactregistry/docker_images/index.md +++ b/docs/google-docs/providers/google/artifactregistry/docker_images/index.md @@ -40,3 +40,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `dockerImagesId, locationsId, projectsId, repositoriesId` | Gets a docker image. | | `list` | `SELECT` | `locationsId, projectsId, repositoriesId` | Lists docker images. | +| `_list` | `EXEC` | `locationsId, projectsId, repositoriesId` | Lists docker images. | diff --git a/docs/google-docs/providers/google/artifactregistry/files/index.md b/docs/google-docs/providers/google/artifactregistry/files/index.md index 78e2bc331f..be324519b0 100644 --- a/docs/google-docs/providers/google/artifactregistry/files/index.md +++ b/docs/google-docs/providers/google/artifactregistry/files/index.md @@ -28,14 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name of the file, for example: "projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt". If the file ID part contains slashes, they are escaped. | +| `owner` | `string` | The name of the Package or Version that owns this file, if any. | +| `sizeBytes` | `string` | The size of the File in bytes. | | `updateTime` | `string` | Output only. The time when the File was last updated. | | `createTime` | `string` | Output only. The time when the File was created. | | `fetchTime` | `string` | Output only. The time when the last attempt to refresh the file's data was made. Only set when the repository is remote. | | `hashes` | `array` | The hashes of the file content. | -| `owner` | `string` | The name of the Package or Version that owns this file, if any. | -| `sizeBytes` | `string` | The size of the File in bytes. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `filesId, locationsId, projectsId, repositoriesId` | Gets a file. | | `list` | `SELECT` | `locationsId, projectsId, repositoriesId` | Lists files. | +| `_list` | `EXEC` | `locationsId, projectsId, repositoriesId` | Lists files. | diff --git a/docs/google-docs/providers/google/artifactregistry/index.md b/docs/google-docs/providers/google/artifactregistry/index.md index f3fde97c38..87d9bcb242 100644 --- a/docs/google-docs/providers/google/artifactregistry/index.md +++ b/docs/google-docs/providers/google/artifactregistry/index.md @@ -21,7 +21,7 @@ Store And Manage Build Artifacts In A Scalable And Integrated Service Built On G
total resources: 19
total selectable resources: 13
-total methods: 45
+total methods: 55
@@ -33,7 +33,7 @@ Store And Manage Build Artifacts In A Scalable And Integrated Service Built On G TypeService TitleArtifact Registry API DescriptionStore And Manage Build Artifacts In A Scalable And Integrated Service Built On Google Infrastructure. -Idartifactregistry:v23.08.00155 +Idartifactregistry:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/artifactregistry/locations/index.md b/docs/google-docs/providers/google/artifactregistry/locations/index.md index 16437f15ff..94a2387c91 100644 --- a/docs/google-docs/providers/google/artifactregistry/locations/index.md +++ b/docs/google-docs/providers/google/artifactregistry/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/artifactregistry/maven_artifacts/index.md b/docs/google-docs/providers/google/artifactregistry/maven_artifacts/index.md index b0172f125e..86fcb86915 100644 --- a/docs/google-docs/providers/google/artifactregistry/maven_artifacts/index.md +++ b/docs/google-docs/providers/google/artifactregistry/maven_artifacts/index.md @@ -27,10 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The token to retrieve the next page of artifacts, or empty if there are no more artifacts to return. | -| `mavenArtifacts` | `array` | The maven artifacts returned. | +| `name` | `string` | Required. registry_location, project_id, repository_name and maven_artifact forms a unique artifact For example, "projects/test-project/locations/us-west4/repositories/test-repo/mavenArtifacts/ com.google.guava:guava:31.0-jre", where "us-west4" is the registry_location, "test-project" is the project_id, "test-repo" is the repository_name and "com.google.guava:guava:31.0-jre" is the maven artifact. | +| `createTime` | `string` | Output only. Time the artifact was created. | +| `groupId` | `string` | Group ID for the artifact. Example: com.google.guava | +| `pomUri` | `string` | Required. URL to access the pom file of the artifact. Example: us-west4-maven.pkg.dev/test-project/test-repo/com/google/guava/guava/31.0/guava-31.0.pom | +| `updateTime` | `string` | Output only. Time the artifact was updated. | +| `version` | `string` | Version of this artifact. | +| `artifactId` | `string` | Artifact ID for the artifact. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, mavenArtifactsId, projectsId, repositoriesId` | Gets a maven artifact. | | `list` | `SELECT` | `locationsId, projectsId, repositoriesId` | Lists maven artifacts. | +| `_list` | `EXEC` | `locationsId, projectsId, repositoriesId` | Lists maven artifacts. | diff --git a/docs/google-docs/providers/google/artifactregistry/npm_packages/index.md b/docs/google-docs/providers/google/artifactregistry/npm_packages/index.md index 0d08574376..2f0cf6db74 100644 --- a/docs/google-docs/providers/google/artifactregistry/npm_packages/index.md +++ b/docs/google-docs/providers/google/artifactregistry/npm_packages/index.md @@ -27,10 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The token to retrieve the next page of artifacts, or empty if there are no more artifacts to return. | -| `npmPackages` | `array` | The npm packages returned. | +| `name` | `string` | Required. registry_location, project_id, repository_name and npm_package forms a unique package For example, "projects/test-project/locations/us-west4/repositories/test-repo/npmPackages/ npm_test:1.0.0", where "us-west4" is the registry_location, "test-project" is the project_id, "test-repo" is the repository_name and npm_test:1.0.0" is the npm package. | +| `tags` | `array` | Tags attached to this package. | +| `updateTime` | `string` | Output only. Time the package was updated. | +| `version` | `string` | Version of this package. | +| `createTime` | `string` | Output only. Time the package was created. | +| `packageName` | `string` | Package for the artifact. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, npmPackagesId, projectsId, repositoriesId` | Gets a npm package. | | `list` | `SELECT` | `locationsId, projectsId, repositoriesId` | Lists npm packages. | +| `_list` | `EXEC` | `locationsId, projectsId, repositoriesId` | Lists npm packages. | diff --git a/docs/google-docs/providers/google/artifactregistry/packages/index.md b/docs/google-docs/providers/google/artifactregistry/packages/index.md index 6a42ebb879..df700b3409 100644 --- a/docs/google-docs/providers/google/artifactregistry/packages/index.md +++ b/docs/google-docs/providers/google/artifactregistry/packages/index.md @@ -37,3 +37,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `get` | `SELECT` | `locationsId, packagesId, projectsId, repositoriesId` | Gets a package. | | `list` | `SELECT` | `locationsId, projectsId, repositoriesId` | Lists packages. | | `delete` | `DELETE` | `locationsId, packagesId, projectsId, repositoriesId` | Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted. | +| `_list` | `EXEC` | `locationsId, projectsId, repositoriesId` | Lists packages. | diff --git a/docs/google-docs/providers/google/artifactregistry/python_packages/index.md b/docs/google-docs/providers/google/artifactregistry/python_packages/index.md index 6deffe2547..08de61ec78 100644 --- a/docs/google-docs/providers/google/artifactregistry/python_packages/index.md +++ b/docs/google-docs/providers/google/artifactregistry/python_packages/index.md @@ -28,13 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. registry_location, project_id, repository_name and python_package forms a unique package name:`projects//locations//repository//pythonPackages/`. For example, "projects/test-project/locations/us-west4/repositories/test-repo/pythonPackages/ python_package:1.0.0", where "us-west4" is the registry_location, "test-project" is the project_id, "test-repo" is the repository_name and python_package:1.0.0" is the python package. | -| `uri` | `string` | Required. URL to access the package. Example: us-west4-python.pkg.dev/test-project/test-repo/python_package/file-name-1.0.0.tar.gz | | `version` | `string` | Version of this package. | | `createTime` | `string` | Output only. Time the package was created. | | `packageName` | `string` | Package for the artifact. | | `updateTime` | `string` | Output only. Time the package was updated. | +| `uri` | `string` | Required. URL to access the package. Example: us-west4-python.pkg.dev/test-project/test-repo/python_package/file-name-1.0.0.tar.gz | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId, pythonPackagesId, repositoriesId` | Gets a python package. | | `list` | `SELECT` | `locationsId, projectsId, repositoriesId` | Lists python packages. | +| `_list` | `EXEC` | `locationsId, projectsId, repositoriesId` | Lists python packages. | diff --git a/docs/google-docs/providers/google/artifactregistry/repositories/index.md b/docs/google-docs/providers/google/artifactregistry/repositories/index.md index 00d9054aac..25bb560235 100644 --- a/docs/google-docs/providers/google/artifactregistry/repositories/index.md +++ b/docs/google-docs/providers/google/artifactregistry/repositories/index.md @@ -27,8 +27,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The token to retrieve the next page of repositories, or empty if there are no more repositories to return. | -| `repositories` | `array` | The repositories returned. | +| `name` | `string` | The name of the repository, for example: "projects/p1/locations/us-central1/repositories/repo1". | +| `description` | `string` | The user-provided description of the repository. | +| `cleanupPolicyDryRun` | `boolean` | Optional. If true, the cleanup pipeline is prevented from deleting versions in this repository. | +| `labels` | `object` | Labels with user-defined metadata. This field may contain up to 64 entries. Label keys and values may be no longer than 63 characters. Label keys must begin with a lowercase letter and may only contain lowercase letters, numeric characters, underscores, and dashes. | +| `sbomConfig` | `object` | Config for whether to generate SBOMs for resources in this repository, as well as output fields describing current state. | +| `mavenConfig` | `object` | MavenRepositoryConfig is maven related repository details. Provides additional configuration details for repositories of the maven format type. | +| `virtualRepositoryConfig` | `object` | Virtual repository configuration. | +| `format` | `string` | The format of packages that are stored in the repository. | +| `cleanupPolicies` | `object` | Optional. Cleanup policies for this repository. Cleanup policies indicate when certain package versions can be automatically deleted. Map keys are policy IDs supplied by users during policy creation. They must unique within a repository and be under 128 characters in length. | +| `sizeBytes` | `string` | Output only. The size, in bytes, of all artifact storage in this repository. Repositories that are generally available or in public preview use this to calculate storage costs. | +| `mode` | `string` | The mode of the repository. | +| `dockerConfig` | `object` | DockerRepositoryConfig is docker related repository details. Provides additional configuration details for repositories of the docker format type. | +| `remoteRepositoryConfig` | `object` | Remote repository configuration. | +| `updateTime` | `string` | Output only. The time when the repository was last updated. | +| `kmsKeyName` | `string` | The Cloud KMS resource name of the customer managed encryption key that's used to encrypt the contents of the Repository. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. This value may not be changed after the Repository has been created. | +| `createTime` | `string` | Output only. The time when the repository was created. | +| `satisfiesPzs` | `boolean` | Output only. If set, the repository satisfies physical zone separation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +51,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists repositories. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository. | | `delete` | `DELETE` | `locationsId, projectsId, repositoriesId` | Deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists repositories. | | `patch` | `EXEC` | `locationsId, projectsId, repositoriesId` | Updates a repository. | diff --git a/docs/google-docs/providers/google/artifactregistry/repositories_iam_policies/index.md b/docs/google-docs/providers/google/artifactregistry/repositories_iam_policies/index.md index 3c06c43ed4..6051a21dd3 100644 --- a/docs/google-docs/providers/google/artifactregistry/repositories_iam_policies/index.md +++ b/docs/google-docs/providers/google/artifactregistry/repositories_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/artifactregistry/tags/index.md b/docs/google-docs/providers/google/artifactregistry/tags/index.md index 75da2883fb..65d5eeb9c7 100644 --- a/docs/google-docs/providers/google/artifactregistry/tags/index.md +++ b/docs/google-docs/providers/google/artifactregistry/tags/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The token to retrieve the next page of tags, or empty if there are no more tags to return. | -| `tags` | `array` | The tags returned. | +| `name` | `string` | The name of the tag, for example: "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1". If the package part contains slashes, the slashes are escaped. The tag part can only have characters in [a-zA-Z0-9\-._~:@], anything else must be URL encoded. | +| `version` | `string` | The name of the version the tag refers to, for example: "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811" If the package or version ID parts contain slashes, the slashes are escaped. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +36,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, packagesId, projectsId, repositoriesId` | Lists tags. | | `create` | `INSERT` | `locationsId, packagesId, projectsId, repositoriesId` | Creates a tag. | | `delete` | `DELETE` | `locationsId, packagesId, projectsId, repositoriesId, tagsId` | Deletes a tag. | +| `_list` | `EXEC` | `locationsId, packagesId, projectsId, repositoriesId` | Lists tags. | | `patch` | `EXEC` | `locationsId, packagesId, projectsId, repositoriesId, tagsId` | Updates a tag. | diff --git a/docs/google-docs/providers/google/artifactregistry/versions/index.md b/docs/google-docs/providers/google/artifactregistry/versions/index.md index d029528381..ce630aa4e9 100644 --- a/docs/google-docs/providers/google/artifactregistry/versions/index.md +++ b/docs/google-docs/providers/google/artifactregistry/versions/index.md @@ -27,12 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The token to retrieve the next page of versions, or empty if there are no more versions to return. | -| `versions` | `array` | The versions returned. | +| `name` | `string` | The name of the version, for example: "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1". If the package or version ID parts contain slashes, the slashes are escaped. | +| `description` | `string` | Optional. Description of the version, as specified in its metadata. | +| `metadata` | `object` | Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the resources could be: DockerImage MavenArtifact | +| `relatedTags` | `array` | Output only. A list of related tags. Will contain up to 100 tags that reference this version. | +| `updateTime` | `string` | The time when the version was last updated. | +| `createTime` | `string` | The time when the version was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, packagesId, projectsId, repositoriesId, versionsId` | Gets a version | | `list` | `SELECT` | `locationsId, packagesId, projectsId, repositoriesId` | Lists versions. | | `delete` | `DELETE` | `locationsId, packagesId, projectsId, repositoriesId, versionsId` | Deletes a version and all of its content. The returned operation will complete once the version has been deleted. | +| `_list` | `EXEC` | `locationsId, packagesId, projectsId, repositoriesId` | Lists versions. | | `batch_delete` | `EXEC` | `locationsId, packagesId, projectsId, repositoriesId` | Deletes multiple versions across a repository. The returned operation will complete once the versions have been deleted. | diff --git a/docs/google-docs/providers/google/assuredworkloads/index.md b/docs/google-docs/providers/google/assuredworkloads/index.md index 3e5bb8a98e..a354561967 100644 --- a/docs/google-docs/providers/google/assuredworkloads/index.md +++ b/docs/google-docs/providers/google/assuredworkloads/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 3
total selectable resources: 3
-total methods: 12
+total methods: 15
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleAssured Workloads API Description -Idassuredworkloads:v23.08.00155 +Idassuredworkloads:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/assuredworkloads/operations/index.md b/docs/google-docs/providers/google/assuredworkloads/operations/index.md index 2b069ae49c..79ec66e93e 100644 --- a/docs/google-docs/providers/google/assuredworkloads/operations/index.md +++ b/docs/google-docs/providers/google/assuredworkloads/operations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, organizationsId` | 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. | | `list` | `SELECT` | `locationsId, organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_list` | `EXEC` | `locationsId, organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | diff --git a/docs/google-docs/providers/google/assuredworkloads/violations/index.md b/docs/google-docs/providers/google/assuredworkloads/violations/index.md index 8120b977df..9e58c03114 100644 --- a/docs/google-docs/providers/google/assuredworkloads/violations/index.md +++ b/docs/google-docs/providers/google/assuredworkloads/violations/index.md @@ -27,11 +27,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The next page token. Returns empty if reached the last page. | -| `violations` | `array` | List of Violations under a Workload. | +| `name` | `string` | Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id} | +| `description` | `string` | Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value. | +| `acknowledged` | `boolean` | A boolean that indicates if the violation is acknowledged | +| `nonCompliantOrgPolicy` | `string` | Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name} | +| `exceptionContexts` | `array` | Output only. List of all the exception detail added for the violation. | +| `beginTime` | `string` | Output only. Time of the event which triggered the Violation. | +| `exceptionAuditLogLink` | `string` | Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} | +| `category` | `string` | Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc. | +| `state` | `string` | Output only. State of the violation | +| `resolveTime` | `string` | Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty. | +| `orgPolicyConstraint` | `string` | Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation. | +| `remediation` | `object` | Represents remediation guidance to resolve compliance violation for AssuredWorkload | +| `updateTime` | `string` | Output only. The last time when the Violation record was updated. | +| `auditLogLink` | `string` | Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} | +| `acknowledgementTime` | `string` | Optional. Timestamp when this violation was acknowledged first. Check exception_contexts to find the last time the violation was acknowledged when there are more than one violations. This field will be absent when acknowledged field is marked as false. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, organizationsId, violationsId, workloadsId` | Retrieves Assured Workload Violation based on ID. | | `list` | `SELECT` | `locationsId, organizationsId, workloadsId` | Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-` | +| `_list` | `EXEC` | `locationsId, organizationsId, workloadsId` | Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-` | | `acknowledge` | `EXEC` | `locationsId, organizationsId, violationsId, workloadsId` | Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted. | diff --git a/docs/google-docs/providers/google/assuredworkloads/workloads/index.md b/docs/google-docs/providers/google/assuredworkloads/workloads/index.md index af4e9cd255..af994403a7 100644 --- a/docs/google-docs/providers/google/assuredworkloads/workloads/index.md +++ b/docs/google-docs/providers/google/assuredworkloads/workloads/index.md @@ -27,8 +27,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The next page token. Return empty if reached the last page. | -| `workloads` | `array` | List of Workloads under a given parent. | +| `name` | `string` | Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. | +| `resources` | `array` | Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only. | +| `partnerPermissions` | `object` | Permissions granted to the AW Partner SA account for the customer workload | +| `resourceSettings` | `array` | Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. | +| `compliantButDisallowedServices` | `array` | Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment." | +| `displayName` | `string` | Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload | +| `enableSovereignControls` | `boolean` | Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. | +| `violationNotificationsEnabled` | `boolean` | Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload. | +| `etag` | `string` | Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. | +| `complianceStatus` | `object` | Represents the Compliance Status of this workload | +| `complianceRegime` | `string` | Required. Immutable. Compliance Regime associated with this workload. | +| `partner` | `string` | Optional. Partner regime associated with this workload. | +| `billingAccount` | `string` | Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. | +| `kajEnrollmentState` | `string` | Output only. Represents the KAJ enrollment state of the given workload. | +| `labels` | `object` | Optional. Labels applied to the workload. | +| `kmsSettings` | `object` | Settings specific to the Key Management Service. | +| `createTime` | `string` | Output only. Immutable. The Workload creation timestamp. | +| `saaEnrollmentResponse` | `object` | Signed Access Approvals (SAA) enrollment response. | +| `ekmProvisioningResponse` | `object` | External key management systems(EKM) Provisioning response | +| `provisionedResourcesParent` | `string` | Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +54,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, organizationsId` | Lists Assured Workloads under a CRM Node. | | `create` | `INSERT` | `locationsId, organizationsId` | Creates Assured Workload. | | `delete` | `DELETE` | `locationsId, organizationsId, workloadsId` | Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies. | +| `_list` | `EXEC` | `locationsId, organizationsId` | Lists Assured Workloads under a CRM Node. | | `mutate_partner_permissions` | `EXEC` | `locationsId, organizationsId, workloadsId` | Update the permissions settings for an existing partner workload. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress. | | `patch` | `EXEC` | `locationsId, organizationsId, workloadsId` | Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress. | | `restrict_allowed_resources` | `EXEC` | `locationsId, organizationsId, workloadsId` | Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality. | diff --git a/docs/google-docs/providers/google/baremetalsolution/index.md b/docs/google-docs/providers/google/baremetalsolution/index.md index a849b8f4d9..83e1b7cb9a 100644 --- a/docs/google-docs/providers/google/baremetalsolution/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/index.md @@ -21,7 +21,7 @@ Provides Ways To Manage Bare Metal Solution Hardware Installed In A Regional Ext
total resources: 12
total selectable resources: 11
-total methods: 46
+total methods: 55
@@ -33,7 +33,7 @@ Provides Ways To Manage Bare Metal Solution Hardware Installed In A Regional Ext TypeService TitleBare Metal Solution API DescriptionProvides Ways To Manage Bare Metal Solution Hardware Installed In A Regional Extension Located Near A Google Cloud Data Center. -Idbaremetalsolution:v23.08.00155 +Idbaremetalsolution:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/baremetalsolution/instances/index.md b/docs/google-docs/providers/google/baremetalsolution/instances/index.md index 6e3e3a8a26..f680313b9c 100644 --- a/docs/google-docs/providers/google/baremetalsolution/instances/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/instances/index.md @@ -27,14 +27,31 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `instances` | `array` | The list of servers. | -| `nextPageToken` | `string` | A token identifying a page of results from the server. | +| `id` | `string` | Output only. An identifier for the `Instance`, generated by the backend. | +| `name` | `string` | Immutable. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}` | +| `machineType` | `string` | Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) | +| `firmwareVersion` | `string` | Output only. The firmware version for the instance. | +| `state` | `string` | Output only. The state of the server. | +| `networks` | `array` | Output only. List of networks associated with this server. | +| `osImage` | `string` | The OS image currently installed on the server. | +| `loginInfo` | `string` | Output only. Text field about info for logging in. | +| `createTime` | `string` | Output only. Create a time stamp. | +| `hyperthreadingEnabled` | `boolean` | True if you enable hyperthreading for the server, otherwise false. The default value is false. | +| `interactiveSerialConsoleEnabled` | `boolean` | Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false. | +| `labels` | `object` | Labels as key value pairs. | +| `workloadProfile` | `string` | The workload profile for the instance. | +| `logicalInterfaces` | `array` | List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled. | +| `updateTime` | `string` | Output only. Update a time stamp. | +| `luns` | `array` | Immutable. List of LUNs associated with this server. | +| `pod` | `string` | Immutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only. | +| `networkTemplate` | `string` | Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic". | +| `volumes` | `array` | Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `instancesId, locationsId, projectsId` | Get details about a single server. | | `list` | `SELECT` | `locationsId, projectsId` | List servers in a given project and location. | +| `_list` | `EXEC` | `locationsId, projectsId` | List servers in a given project and location. | | `detach_lun` | `EXEC` | `instancesId, locationsId, projectsId` | Detach LUN from Instance. | | `disable_interactive_serial_console` | `EXEC` | `instancesId, locationsId, projectsId` | Disable the interactive serial console feature on an instance. | | `enable_interactive_serial_console` | `EXEC` | `instancesId, locationsId, projectsId` | Enable the interactive serial console feature on an instance. | diff --git a/docs/google-docs/providers/google/baremetalsolution/locations/index.md b/docs/google-docs/providers/google/baremetalsolution/locations/index.md index 37ee953161..cb81d6027a 100644 --- a/docs/google-docs/providers/google/baremetalsolution/locations/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/baremetalsolution/luns/index.md b/docs/google-docs/providers/google/baremetalsolution/luns/index.md index 3614d0b46a..f809efbfdd 100644 --- a/docs/google-docs/providers/google/baremetalsolution/luns/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/luns/index.md @@ -27,12 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `luns` | `array` | The list of luns. | -| `nextPageToken` | `string` | A token identifying a page of results from the server. | -| `unreachable` | `array` | Locations that could not be reached. | +| `id` | `string` | An identifier for the LUN, generated by the backend. | +| `name` | `string` | Output only. The name of the LUN. | +| `sizeGb` | `string` | The size of this LUN, in gigabytes. | +| `expireTime` | `string` | Output only. Time after which LUN will be fully deleted. It is filled only for LUNs in COOL_OFF state. | +| `storageVolume` | `string` | Display the storage volume for this LUN. | +| `multiprotocolType` | `string` | The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system. | +| `state` | `string` | The state of this storage volume. | +| `storageType` | `string` | The storage type for this LUN. | +| `wwid` | `string` | The WWID for this LUN. | +| `shareable` | `boolean` | Display if this LUN can be shared between multiple physical servers. | +| `bootLun` | `boolean` | Display if this LUN is a boot LUN. | +| `instances` | `array` | Output only. Instances this Lun is attached to. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, lunsId, projectsId, volumesId` | Get details of a single storage logical unit number(LUN). | | `list` | `SELECT` | `locationsId, projectsId, volumesId` | List storage volume luns for given storage volume. | +| `_list` | `EXEC` | `locationsId, projectsId, volumesId` | List storage volume luns for given storage volume. | | `evict` | `EXEC` | `locationsId, lunsId, projectsId, volumesId` | Skips lun's cooloff and deletes it now. Lun must be in cooloff state. | diff --git a/docs/google-docs/providers/google/baremetalsolution/networks/index.md b/docs/google-docs/providers/google/baremetalsolution/networks/index.md index 1af97ac170..f2ea2716b8 100644 --- a/docs/google-docs/providers/google/baremetalsolution/networks/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/networks/index.md @@ -27,13 +27,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `networks` | `array` | The list of networks. | -| `nextPageToken` | `string` | A token identifying a page of results from the server. | -| `unreachable` | `array` | Locations that could not be reached. | +| `id` | `string` | An identifier for the `Network`, generated by the backend. | +| `name` | `string` | Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}` | +| `macAddress` | `array` | List of physical interfaces. | +| `state` | `string` | The Network state. | +| `reservations` | `array` | List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server. | +| `mountPoints` | `array` | Input only. List of mount points to attach the network to. | +| `cidr` | `string` | The cidr of the Network. | +| `jumboFramesEnabled` | `boolean` | Whether network uses standard frames or jumbo ones. | +| `ipAddress` | `string` | IP address configured. | +| `pod` | `string` | Output only. Pod name. | +| `servicesCidr` | `string` | IP range for reserved for services (e.g. NFS). | +| `labels` | `object` | Labels as key value pairs. | +| `vlanId` | `string` | The vlan id of the Network. | +| `vrf` | `object` | A network VRF. | +| `gatewayIp` | `string` | Output only. Gateway ip address. | +| `type` | `string` | The type of this network. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, networksId, projectsId` | Get details of a single network. | | `list` | `SELECT` | `locationsId, projectsId` | List network in a given project and location. | +| `_list` | `EXEC` | `locationsId, projectsId` | List network in a given project and location. | | `patch` | `EXEC` | `locationsId, networksId, projectsId` | Update details of a single network. | | `rename` | `EXEC` | `locationsId, networksId, projectsId` | RenameNetwork sets a new name for a network. Use with caution, previous names become immediately invalidated. | diff --git a/docs/google-docs/providers/google/baremetalsolution/nfs_shares/index.md b/docs/google-docs/providers/google/baremetalsolution/nfs_shares/index.md index 92cd6394ad..579826cb3b 100644 --- a/docs/google-docs/providers/google/baremetalsolution/nfs_shares/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/nfs_shares/index.md @@ -27,9 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nfsShares` | `array` | The list of NFS shares. | -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | A token identifying a page of results from the server. | +| `id` | `string` | Output only. An identifier for the NFS share, generated by the backend. This is the same value as nfs_share_id and will replace it in the future. | +| `name` | `string` | Immutable. The name of the NFS share. | +| `state` | `string` | Output only. The state of the NFS share. | +| `labels` | `object` | Labels as key value pairs. | +| `volume` | `string` | Output only. The underlying volume of the share. Created automatically during provisioning. | +| `nfsShareId` | `string` | Output only. An identifier for the NFS share, generated by the backend. This field will be deprecated in the future, use `id` instead. | +| `storageType` | `string` | Immutable. The storage type of the underlying volume. | +| `requestedSizeGib` | `string` | The requested size, in GiB. | +| `allowedClients` | `array` | List of allowed access points. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,5 +43,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | List NFS shares. | | `create` | `INSERT` | `locationsId, projectsId` | Create an NFS share. | | `delete` | `DELETE` | `locationsId, nfsSharesId, projectsId` | Delete an NFS share. The underlying volume is automatically deleted. | +| `_list` | `EXEC` | `locationsId, projectsId` | List NFS shares. | | `patch` | `EXEC` | `locationsId, nfsSharesId, projectsId` | Update details of a single NFS share. | | `rename` | `EXEC` | `locationsId, nfsSharesId, projectsId` | RenameNfsShare sets a new name for an nfsshare. Use with caution, previous names become immediately invalidated. | diff --git a/docs/google-docs/providers/google/baremetalsolution/provisioning_configs/index.md b/docs/google-docs/providers/google/baremetalsolution/provisioning_configs/index.md index 34aa6591c5..29e5a9877f 100644 --- a/docs/google-docs/providers/google/baremetalsolution/provisioning_configs/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/provisioning_configs/index.md @@ -28,19 +28,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The system-generated name of the provisioning config. This follows the UUID format. | -| `state` | `string` | Output only. State of ProvisioningConfig. | -| `customId` | `string` | Optional. The user-defined identifier of the provisioning config. | +| `handoverServiceAccount` | `string` | A service account to enable customers to access instance credentials upon handover. | | `statusMessage` | `string` | Optional status messages associated with the FAILED state. | -| `location` | `string` | Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. | +| `updateTime` | `string` | Output only. Last update timestamp. | | `ticketId` | `string` | A generated ticket id to track provisioning request. | -| `handoverServiceAccount` | `string` | A service account to enable customers to access instance credentials upon handover. | | `instances` | `array` | Instances to be created. | -| `networks` | `array` | Networks to be created. | -| `volumes` | `array` | Volumes to be created. | | `email` | `string` | Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages. | -| `cloudConsoleUri` | `string` | Output only. URI to Cloud Console UI view of this provisioning config. | -| `updateTime` | `string` | Output only. Last update timestamp. | +| `state` | `string` | Output only. State of ProvisioningConfig. | +| `networks` | `array` | Networks to be created. | | `vpcScEnabled` | `boolean` | If true, VPC SC is enabled for the cluster. | +| `customId` | `string` | Optional. The user-defined identifier of the provisioning config. | +| `location` | `string` | Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. | +| `cloudConsoleUri` | `string` | Output only. URI to Cloud Console UI view of this provisioning config. | +| `volumes` | `array` | Volumes to be created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/baremetalsolution/provisioning_quotas/index.md b/docs/google-docs/providers/google/baremetalsolution/provisioning_quotas/index.md index cdb2a08f1a..1ecff34d88 100644 --- a/docs/google-docs/providers/google/baremetalsolution/provisioning_quotas/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/provisioning_quotas/index.md @@ -27,9 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `provisioningQuotas` | `array` | The provisioning quotas registered in this project. | +| `name` | `string` | Output only. The name of the provisioning quota. | +| `location` | `string` | The specific location of the provisioining quota. | +| `storageGib` | `string` | Storage size (GB). | +| `instanceQuota` | `object` | A resource budget. | +| `serverCount` | `string` | Server count. | +| `networkBandwidth` | `string` | Network bandwidth, Gbps | +| `availableCount` | `integer` | The available count of the provisioning quota. | +| `assetType` | `string` | The asset type of this provisioning quota. | +| `gcpService` | `string` | The gcp service of the provisioning quota. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `locationsId, projectsId` | +| `_list` | `EXEC` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/baremetalsolution/snapshots/index.md b/docs/google-docs/providers/google/baremetalsolution/snapshots/index.md index f0c812748d..c31c5acf6c 100644 --- a/docs/google-docs/providers/google/baremetalsolution/snapshots/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/snapshots/index.md @@ -30,9 +30,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | Output only. An identifier for the snapshot, generated by the backend. | | `name` | `string` | The name of the snapshot. | | `description` | `string` | The description of the snapshot. | +| `type` | `string` | Output only. The type of the snapshot which indicates whether it was scheduled or manual/ad-hoc. | | `createTime` | `string` | Output only. The creation time of the snapshot. | | `storageVolume` | `string` | Output only. The name of the volume which this snapshot belongs to. | -| `type` | `string` | Output only. The type of the snapshot which indicates whether it was scheduled or manual/ad-hoc. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -40,4 +40,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId, volumesId` | Retrieves the list of snapshots for the specified volume. Returns a response with an empty list of snapshots if called for a non-boot volume. | | `create` | `INSERT` | `locationsId, projectsId, volumesId` | Takes a snapshot of a boot volume. Returns INVALID_ARGUMENT if called for a non-boot volume. | | `delete` | `DELETE` | `locationsId, projectsId, snapshotsId, volumesId` | Deletes a volume snapshot. Returns INVALID_ARGUMENT if called for a non-boot volume. | +| `_list` | `EXEC` | `locationsId, projectsId, volumesId` | Retrieves the list of snapshots for the specified volume. Returns a response with an empty list of snapshots if called for a non-boot volume. | | `restore_volume_snapshot` | `EXEC` | `locationsId, projectsId, snapshotsId, volumesId` | Uses the specified snapshot to restore its parent volume. Returns INVALID_ARGUMENT if called for a non-boot volume. | diff --git a/docs/google-docs/providers/google/baremetalsolution/ssh_keys/index.md b/docs/google-docs/providers/google/baremetalsolution/ssh_keys/index.md index 6e084235ef..891de16a35 100644 --- a/docs/google-docs/providers/google/baremetalsolution/ssh_keys/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/ssh_keys/index.md @@ -27,11 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `sshKeys` | `array` | The SSH keys registered in the project. | +| `name` | `string` | Output only. The name of this SSH key. Currently, the only valid value for the location is "global". | +| `publicKey` | `string` | The public SSH key. This must be in OpenSSH .authorized_keys format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `list` | `SELECT` | `locationsId, projectsId` | Lists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature. | | `create` | `INSERT` | `locationsId, projectsId` | Register a public SSH key in the specified project for use with the interactive serial console feature. | | `delete` | `DELETE` | `locationsId, projectsId, sshKeysId` | Deletes a public SSH key registered in the specified project. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature. | diff --git a/docs/google-docs/providers/google/baremetalsolution/volumes/index.md b/docs/google-docs/providers/google/baremetalsolution/volumes/index.md index dc0474ec31..57f339c0f5 100644 --- a/docs/google-docs/providers/google/baremetalsolution/volumes/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/volumes/index.md @@ -27,14 +27,38 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `volumes` | `array` | The list of storage volumes. | -| `nextPageToken` | `string` | A token identifying a page of results from the server. | +| `id` | `string` | An identifier for the `Volume`, generated by the backend. | +| `name` | `string` | Output only. The resource name of this `Volume`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/volumes/{volume}` | +| `performanceTier` | `string` | Immutable. Performance tier of the Volume. Default is SHARED. | +| `instances` | `array` | Output only. Instances this Volume is attached to. This field is set only in Get requests. | +| `emergencySizeGib` | `string` | Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value. | +| `notes` | `string` | Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention. | +| `attached` | `boolean` | Output only. Is the Volume attached at at least one instance. This field is a lightweight counterpart of `instances` field. It is filled in List responses as well. | +| `autoGrownSizeGib` | `string` | The size, in GiB, that this storage volume has expanded as a result of an auto grow policy. In the absence of auto-grow, the value is 0. | +| `workloadProfile` | `string` | The workload profile for the volume. | +| `labels` | `object` | Labels as key value pairs. | +| `snapshotEnabled` | `boolean` | Whether snapshots are enabled. | +| `storageType` | `string` | The storage type for this volume. | +| `storageAggregatePool` | `string` | Input only. Name of the storage aggregate pool to allocate the volume in. Can be used only for VOLUME_PERFORMANCE_TIER_ASSIGNED volumes. | +| `currentSizeGib` | `string` | The current size of this storage volume, in GiB, including space reserved for snapshots. This size might be different than the requested size if the storage volume has been configured with auto grow or auto shrink. | +| `requestedSizeGib` | `string` | The requested size of this storage volume, in GiB. | +| `state` | `string` | The state of this storage volume. | +| `snapshotSchedulePolicy` | `string` | The name of the snapshot schedule policy in use for this volume, if any. | +| `maxSizeGib` | `string` | Maximum size volume can be expanded to in case of evergency, in GiB. | +| `remainingSpaceGib` | `string` | The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots. | +| `protocol` | `string` | Output only. Storage protocol for the Volume. | +| `snapshotAutoDeleteBehavior` | `string` | The behavior to use when snapshot reserved space is full. | +| `bootVolume` | `boolean` | Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN. | +| `pod` | `string` | Immutable. Pod name. | +| `originallyRequestedSizeGib` | `string` | Originally requested size, in GiB. | +| `snapshotReservationDetail` | `object` | Details about snapshot space reservation and usage on the storage volume. | +| `expireTime` | `string` | Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId, volumesId` | Get details of a single storage volume. | | `list` | `SELECT` | `locationsId, projectsId` | List storage volumes in a given project and location. | +| `_list` | `EXEC` | `locationsId, projectsId` | List storage volumes in a given project and location. | | `evict` | `EXEC` | `locationsId, projectsId, volumesId` | Skips volume's cooloff and deletes it now. Volume must be in cooloff state. | | `patch` | `EXEC` | `locationsId, projectsId, volumesId` | Update details of a single storage volume. | | `rename` | `EXEC` | `locationsId, projectsId, volumesId` | RenameVolume sets a new name for a volume. Use with caution, previous names become immediately invalidated. | diff --git a/docs/google-docs/providers/google/batch/index.md b/docs/google-docs/providers/google/batch/index.md index 5cad1b1909..3bc653f760 100644 --- a/docs/google-docs/providers/google/batch/index.md +++ b/docs/google-docs/providers/google/batch/index.md @@ -21,7 +21,7 @@ An API To Manage The Running Of Batch Jobs On Google Cloud Platform.
total resources: 5
total selectable resources: 4
-total methods: 13
+total methods: 17
@@ -33,7 +33,7 @@ An API To Manage The Running Of Batch Jobs On Google Cloud Platform. TypeService TitleBatch API DescriptionAn API To Manage The Running Of Batch Jobs On Google Cloud Platform. -Idbatch:v23.08.00155 +Idbatch:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/batch/jobs/index.md b/docs/google-docs/providers/google/batch/jobs/index.md index d972b24596..e5332b4dba 100644 --- a/docs/google-docs/providers/google/batch/jobs/index.md +++ b/docs/google-docs/providers/google/batch/jobs/index.md @@ -27,9 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `jobs` | `array` | Jobs. | -| `nextPageToken` | `string` | Next page token. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01". | +| `logsPolicy` | `object` | LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved. | +| `taskGroups` | `array` | Required. TaskGroups in the Job. Only one TaskGroup is supported now. | +| `updateTime` | `string` | Output only. The last time the Job was updated. | +| `priority` | `string` | Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied. | +| `uid` | `string` | Output only. A system generated unique ID (in UUID4 format) for the Job. | +| `createTime` | `string` | Output only. When the Job was created. | +| `notifications` | `array` | Notification configurations. | +| `status` | `object` | Job status. | +| `allocationPolicy` | `object` | A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. | +| `labels` | `object` | Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,3 +45,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | List all Jobs for a project within a region. | | `create` | `INSERT` | `locationsId, projectsId` | Create a Job. | | `delete` | `DELETE` | `jobsId, locationsId, projectsId` | Delete a Job. | +| `_list` | `EXEC` | `locationsId, projectsId` | List all Jobs for a project within a region. | diff --git a/docs/google-docs/providers/google/batch/locations/index.md b/docs/google-docs/providers/google/batch/locations/index.md index 04a6629c1b..1463fba2aa 100644 --- a/docs/google-docs/providers/google/batch/locations/index.md +++ b/docs/google-docs/providers/google/batch/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `locations` | `array` | A list of locations that matches the specified filter in the request. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/batch/operations/index.md b/docs/google-docs/providers/google/batch/operations/index.md index 9d0e673c89..2fa48114f9 100644 --- a/docs/google-docs/providers/google/batch/operations/index.md +++ b/docs/google-docs/providers/google/batch/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/batch/tasks/index.md b/docs/google-docs/providers/google/batch/tasks/index.md index 5298b53aef..6867d82b8c 100644 --- a/docs/google-docs/providers/google/batch/tasks/index.md +++ b/docs/google-docs/providers/google/batch/tasks/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `tasks` | `array` | Tasks. | -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | Next page token. | +| `name` | `string` | Task name. The name is generated from the parent TaskGroup name and 'id' field. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01". | +| `status` | `object` | Status of a task | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `jobsId, locationsId, projectsId, taskGroupsId, tasksId` | Return a single Task. | | `list` | `SELECT` | `jobsId, locationsId, projectsId, taskGroupsId` | List Tasks associated with a job. | +| `_list` | `EXEC` | `jobsId, locationsId, projectsId, taskGroupsId` | List Tasks associated with a job. | diff --git a/docs/google-docs/providers/google/beyondcorp/app_connections/index.md b/docs/google-docs/providers/google/beyondcorp/app_connections/index.md index 7d12d29048..b1f16afffd 100644 --- a/docs/google-docs/providers/google/beyondcorp/app_connections/index.md +++ b/docs/google-docs/providers/google/beyondcorp/app_connections/index.md @@ -27,15 +27,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `appConnections` | `array` | A list of BeyondCorp AppConnections in the project. | -| `nextPageToken` | `string` | A token to retrieve the next page of results, or empty if there are no more results in the list. | -| `unreachable` | `array` | A list of locations that could not be reached. | +| `name` | `string` | Required. Unique resource name of the AppConnection. The name is ignored when creating a AppConnection. | +| `type` | `string` | Required. The type of network connectivity used by the AppConnection. | +| `uid` | `string` | Output only. A unique identifier for the instance generated by the system. | +| `connectors` | `array` | Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection. | +| `updateTime` | `string` | Output only. Timestamp when the resource was last modified. | +| `applicationEndpoint` | `object` | ApplicationEndpoint represents a remote application endpoint. | +| `displayName` | `string` | Optional. An arbitrary user-provided name for the AppConnection. Cannot exceed 64 characters. | +| `createTime` | `string` | Output only. Timestamp when the resource was created. | +| `labels` | `object` | Optional. Resource labels to represent user provided metadata. | +| `state` | `string` | Output only. The current state of the AppConnection. | +| `gateway` | `object` | Gateway represents a user facing component that serves as an entrance to enable connectivity. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_app_connections_list` | `SELECT` | `locationsId, projectsId` | Lists AppConnections in a given project and location. | | `projects_locations_app_connections_create` | `INSERT` | `locationsId, projectsId` | Creates a new AppConnection in a given project and location. | | `projects_locations_app_connections_delete` | `DELETE` | `appConnectionsId, locationsId, projectsId` | Deletes a single AppConnection. | +| `_projects_locations_app_connections_list` | `EXEC` | `locationsId, projectsId` | Lists AppConnections in a given project and location. | | `projects_locations_app_connections_get` | `EXEC` | `appConnectionsId, locationsId, projectsId` | Gets details of a single AppConnection. | | `projects_locations_app_connections_patch` | `EXEC` | `appConnectionsId, locationsId, projectsId` | Updates the parameters of a single AppConnection. | | `projects_locations_app_connections_resolve` | `EXEC` | `locationsId, projectsId` | Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to. | diff --git a/docs/google-docs/providers/google/beyondcorp/app_connections_iam_policies/index.md b/docs/google-docs/providers/google/beyondcorp/app_connections_iam_policies/index.md index 3997f1bcbc..7a12dfd59a 100644 --- a/docs/google-docs/providers/google/beyondcorp/app_connections_iam_policies/index.md +++ b/docs/google-docs/providers/google/beyondcorp/app_connections_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 0613592dd6..1cb46f83a5 100644 --- a/docs/google-docs/providers/google/beyondcorp/app_connectors/index.md +++ b/docs/google-docs/providers/google/beyondcorp/app_connectors/index.md @@ -27,15 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `appConnectors` | `array` | A list of BeyondCorp AppConnectors in the project. | -| `nextPageToken` | `string` | A token to retrieve the next page of results, or empty if there are no more results in the list. | -| `unreachable` | `array` | A list of locations that could not be reached. | +| `name` | `string` | Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector. | +| `principalInfo` | `object` | PrincipalInfo represents an Identity oneof. | +| `createTime` | `string` | Output only. Timestamp when the resource was created. | +| `state` | `string` | Output only. The current state of the AppConnector. | +| `displayName` | `string` | Optional. An arbitrary user-provided name for the AppConnector. Cannot exceed 64 characters. | +| `uid` | `string` | Output only. A unique identifier for the instance generated by the system. | +| `labels` | `object` | Optional. Resource labels to represent user provided metadata. | +| `resourceInfo` | `object` | ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent | +| `updateTime` | `string` | Output only. Timestamp when the resource was last modified. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_app_connectors_list` | `SELECT` | `locationsId, projectsId` | Lists AppConnectors in a given project and location. | | `projects_locations_app_connectors_create` | `INSERT` | `locationsId, projectsId` | Creates a new AppConnector in a given project and location. | | `projects_locations_app_connectors_delete` | `DELETE` | `appConnectorsId, locationsId, projectsId` | Deletes a single AppConnector. | +| `_projects_locations_app_connectors_list` | `EXEC` | `locationsId, projectsId` | Lists AppConnectors in a given project and location. | | `projects_locations_app_connectors_get` | `EXEC` | `appConnectorsId, locationsId, projectsId` | Gets details of a single AppConnector. | | `projects_locations_app_connectors_patch` | `EXEC` | `appConnectorsId, locationsId, projectsId` | Updates the parameters of a single AppConnector. | | `projects_locations_app_connectors_report_status` | `EXEC` | `appConnectorsId, locationsId, projectsId` | Report status for a given connector. | diff --git a/docs/google-docs/providers/google/beyondcorp/app_connectors_iam_policies/index.md b/docs/google-docs/providers/google/beyondcorp/app_connectors_iam_policies/index.md index d7c6a78983..42a9ed47db 100644 --- a/docs/google-docs/providers/google/beyondcorp/app_connectors_iam_policies/index.md +++ b/docs/google-docs/providers/google/beyondcorp/app_connectors_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/beyondcorp/app_gateways/index.md b/docs/google-docs/providers/google/beyondcorp/app_gateways/index.md index 5d0bbc3135..c0ea3c1bc5 100644 --- a/docs/google-docs/providers/google/beyondcorp/app_gateways/index.md +++ b/docs/google-docs/providers/google/beyondcorp/app_gateways/index.md @@ -27,13 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | A list of locations that could not be reached. | -| `appGateways` | `array` | A list of BeyondCorp AppGateways in the project. | -| `nextPageToken` | `string` | A token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Required. Unique resource name of the AppGateway. The name is ignored when creating an AppGateway. | +| `state` | `string` | Output only. The current state of the AppGateway. | +| `type` | `string` | Required. The type of network connectivity used by the AppGateway. | +| `hostType` | `string` | Required. The type of hosting used by the AppGateway. | +| `labels` | `object` | Optional. Resource labels to represent user provided metadata. | +| `updateTime` | `string` | Output only. Timestamp when the resource was last modified. | +| `uri` | `string` | Output only. Server-defined URI for this resource. | +| `displayName` | `string` | Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters. | +| `uid` | `string` | Output only. A unique identifier for the instance generated by the system. | +| `createTime` | `string` | Output only. Timestamp when the resource was created. | +| `allocatedConnections` | `array` | Output only. A list of connections allocated for the Gateway | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_app_gateways_list` | `SELECT` | `locationsId, projectsId` | Lists AppGateways in a given project and location. | | `projects_locations_app_gateways_create` | `INSERT` | `locationsId, projectsId` | Creates a new AppGateway in a given project and location. | | `projects_locations_app_gateways_delete` | `DELETE` | `appGatewaysId, locationsId, projectsId` | Deletes a single AppGateway. | +| `_projects_locations_app_gateways_list` | `EXEC` | `locationsId, projectsId` | Lists AppGateways in a given project and location. | | `projects_locations_app_gateways_get` | `EXEC` | `appGatewaysId, locationsId, projectsId` | Gets details of a single AppGateway. | diff --git a/docs/google-docs/providers/google/beyondcorp/app_gateways_iam_policies/index.md b/docs/google-docs/providers/google/beyondcorp/app_gateways_iam_policies/index.md index 11997335df..d5de0b9514 100644 --- a/docs/google-docs/providers/google/beyondcorp/app_gateways_iam_policies/index.md +++ b/docs/google-docs/providers/google/beyondcorp/app_gateways_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/beyondcorp/client_gateways_iam_policies/index.md b/docs/google-docs/providers/google/beyondcorp/client_gateways_iam_policies/index.md index 571e3b3f03..6961883298 100644 --- a/docs/google-docs/providers/google/beyondcorp/client_gateways_iam_policies/index.md +++ b/docs/google-docs/providers/google/beyondcorp/client_gateways_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/beyondcorp/index.md b/docs/google-docs/providers/google/beyondcorp/index.md index 1f0ed15074..7811dee4ab 100644 --- a/docs/google-docs/providers/google/beyondcorp/index.md +++ b/docs/google-docs/providers/google/beyondcorp/index.md @@ -21,7 +21,7 @@ Beyondcorp Enterprise Provides Identity And Context Aware Access Controls For En
total resources: 10
total selectable resources: 10
-total methods: 42
+total methods: 48
@@ -33,7 +33,7 @@ Beyondcorp Enterprise Provides Identity And Context Aware Access Controls For En TypeService TitleBeyondCorp API DescriptionBeyondcorp Enterprise Provides Identity And Context Aware Access Controls For Enterprise Resources And Enables Zero-Trust Access. Using The Beyondcorp Enterprise APIs, Enterprises Can Set Up Multi-Cloud And On-Prem Connectivity Solutions. -Idbeyondcorp:v23.08.00155 +Idbeyondcorp:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/beyondcorp/locations/index.md b/docs/google-docs/providers/google/beyondcorp/locations/index.md index 746ab35bd6..6a3c7be784 100644 --- a/docs/google-docs/providers/google/beyondcorp/locations/index.md +++ b/docs/google-docs/providers/google/beyondcorp/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/beyondcorp/operations/index.md b/docs/google-docs/providers/google/beyondcorp/operations/index.md index 62ec6d7158..e27c6fc809 100644 --- a/docs/google-docs/providers/google/beyondcorp/operations/index.md +++ b/docs/google-docs/providers/google/beyondcorp/operations/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| @@ -36,6 +39,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `organizations_locations_operations_delete` | `DELETE` | `locationsId, operationsId, organizationsId` | 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`. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_organizations_locations_operations_list` | `EXEC` | `locationsId, organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `organizations_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, organizationsId` | 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`. | | `organizations_locations_operations_get` | `EXEC` | `locationsId, operationsId, organizationsId` | 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. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/bigquery/datasets/index.md b/docs/google-docs/providers/google/bigquery/datasets/index.md index 63f87713ae..50b1e1beb0 100644 --- a/docs/google-docs/providers/google/bigquery/datasets/index.md +++ b/docs/google-docs/providers/google/bigquery/datasets/index.md @@ -27,10 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `datasets` | `array` | An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project. | -| `etag` | `string` | A hash value of the results page. You can use this property to determine if the page has changed since the last request. | -| `kind` | `string` | The list type. This property always returns the value "bigquery#datasetList". | -| `nextPageToken` | `string` | A token that can be used to request the next results page. This property is omitted on the final results page. | +| `id` | `string` | The fully-qualified, unique, opaque ID of the dataset. | +| `friendlyName` | `string` | A descriptive name for the dataset, if one exists. | +| `kind` | `string` | The resource type. This property always returns the value "bigquery#dataset". | +| `labels` | `object` | The labels associated with this dataset. You can use these to organize and group your datasets. | +| `location` | `string` | The geographic location where the data resides. | +| `datasetReference` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,5 +40,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectId` | Lists all datasets in the specified project to which you have been granted the READER dataset role. | | `insert` | `INSERT` | `projectId` | Creates a new empty dataset. | | `delete` | `DELETE` | `datasetId, projectId` | Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name. | +| `_list` | `EXEC` | `projectId` | Lists all datasets in the specified project to which you have been granted the READER dataset role. | | `patch` | `EXEC` | `datasetId, projectId` | Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics. | | `update` | `EXEC` | `datasetId, projectId` | Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. | diff --git a/docs/google-docs/providers/google/bigquery/index.md b/docs/google-docs/providers/google/bigquery/index.md index 2a6b3a91e8..a5e03f1927 100644 --- a/docs/google-docs/providers/google/bigquery/index.md +++ b/docs/google-docs/providers/google/bigquery/index.md @@ -21,7 +21,7 @@ A Data Platform For Customers To Create, Manage, Share And Query Data.
total resources: 11
total selectable resources: 10
-total methods: 34
+total methods: 41
@@ -33,7 +33,7 @@ A Data Platform For Customers To Create, Manage, Share And Query Data. TypeService TitleBigQuery API DescriptionA Data Platform For Customers To Create, Manage, Share And Query Data. -Idbigquery:v23.08.00155 +Idbigquery:v23.08.00157 ## Resources @@ -48,9 +48,9 @@ A Data Platform For Customers To Create, Manage, Share And Query Data.
row_access_policies
-row_access_policies_iam_policies
service_account
tabledata
tables
+tables_iam_policies
diff --git a/docs/google-docs/providers/google/bigquery/jobs/index.md b/docs/google-docs/providers/google/bigquery/jobs/index.md index 7046410374..2d49087ef0 100644 --- a/docs/google-docs/providers/google/bigquery/jobs/index.md +++ b/docs/google-docs/providers/google/bigquery/jobs/index.md @@ -27,15 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | [Output-only] Opaque ID field of the job | -| `jobReference` | `object` | | -| `user_email` | `string` | [Output-only] Email address of the user who ran the job. | -| `configuration` | `object` | | -| `etag` | `string` | [Output-only] A hash of this resource. | -| `kind` | `string` | [Output-only] The type of the resource. | -| `selfLink` | `string` | [Output-only] A URL that can be used to access this resource again. | +| `id` | `string` | Unique opaque ID of the job. | | `status` | `object` | | | `statistics` | `object` | | +| `errorResult` | `object` | | +| `kind` | `string` | The resource type. | +| `user_email` | `string` | [Full-projection-only] Email address of the user who ran the job. | +| `configuration` | `object` | | +| `jobReference` | `object` | | +| `state` | `string` | Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -43,5 +43,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectId` | Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. | | `insert` | `INSERT` | `projectId` | Starts a new asynchronous job. Requires the Can View project role. | | `delete` | `DELETE` | `+jobId, projectId` | Requests the deletion of the metadata of a job. This call returns when the job's metadata is deleted. | +| `_list` | `EXEC` | `projectId` | Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. | | `cancel` | `EXEC` | `jobId, projectId` | Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. | | `query` | `EXEC` | `projectId` | Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout. | diff --git a/docs/google-docs/providers/google/bigquery/jobs_query_results/index.md b/docs/google-docs/providers/google/bigquery/jobs_query_results/index.md index 099b34fae5..73ac332a27 100644 --- a/docs/google-docs/providers/google/bigquery/jobs_query_results/index.md +++ b/docs/google-docs/providers/google/bigquery/jobs_query_results/index.md @@ -27,18 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `jobReference` | `object` | | -| `numDmlAffectedRows` | `string` | [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. | -| `pageToken` | `string` | A token used for paging results. | -| `rows` | `array` | An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully. | -| `schema` | `object` | | -| `totalRows` | `string` | The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully. | | `cacheHit` | `boolean` | Whether the query result was fetched from the query cache. | -| `jobComplete` | `boolean` | Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available. | +| `totalBytesProcessed` | `string` | The total number of bytes processed for this query. | | `etag` | `string` | A hash of this response. | +| `jobComplete` | `boolean` | Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available. | +| `pageToken` | `string` | A token used for paging results. | +| `numDmlAffectedRows` | `string` | [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. | +| `schema` | `object` | | | `errors` | `array` | [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. | -| `totalBytesProcessed` | `string` | The total number of bytes processed for this query. | +| `jobReference` | `object` | | +| `totalRows` | `string` | The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully. | | `kind` | `string` | The resource type of the response. | +| `rows` | `array` | An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/bigquery/models/index.md b/docs/google-docs/providers/google/bigquery/models/index.md index 0e906f7815..8e80c4c8f9 100644 --- a/docs/google-docs/providers/google/bigquery/models/index.md +++ b/docs/google-docs/providers/google/bigquery/models/index.md @@ -27,12 +27,32 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `models` | `array` | Models in the requested dataset. Only the following fields are populated: model_reference, model_type, creation_time, last_modified_time and labels. | -| `nextPageToken` | `string` | A token to request the next page of results. | +| `description` | `string` | Optional. A user-friendly description of this model. | +| `modelReference` | `object` | | +| `creationTime` | `string` | Output only. The time when this model was created, in millisecs since the epoch. | +| `hparamTrials` | `array` | Output only. Trials of a [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) model sorted by trial_id. | +| `defaultTrialId` | `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. | +| `expirationTime` | `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. | +| `hparamSearchSpaces` | `object` | Hyperparameter search spaces. These should be a subset of training_options. | +| `location` | `string` | Output only. The geographic location where the model resides. This value is inherited from the dataset. | +| `optimalTrialIds` | `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. | +| `transformColumns` | `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. | +| `friendlyName` | `string` | Optional. A descriptive name for this model. | +| `bestTrialId` | `string` | The best trial_id across all training runs. | +| `labels` | `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. | +| `featureColumns` | `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. | +| `encryptionConfiguration` | `object` | | +| `remoteModelInfo` | `object` | Remote Model Info | +| `trainingRuns` | `array` | Information for all training runs in increasing order of start_time. | +| `labelColumns` | `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. | +| `lastModifiedTime` | `string` | Output only. The time when this model was last modified, in millisecs since the epoch. | +| `modelType` | `string` | Output only. Type of the model resource. | +| `etag` | `string` | Output only. A hash of this resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `+datasetId, +modelId, projectId` | Gets the specified model resource by model ID. | | `list` | `SELECT` | `+datasetId, projectId` | Lists all models in the specified dataset. Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method. | | `delete` | `DELETE` | `+datasetId, +modelId, projectId` | Deletes the model specified by modelId from the dataset. | +| `_list` | `EXEC` | `+datasetId, projectId` | Lists all models in the specified dataset. Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method. | | `patch` | `EXEC` | `+datasetId, +modelId, projectId` | Patch specific fields in the specified model. | diff --git a/docs/google-docs/providers/google/bigquery/projects/index.md b/docs/google-docs/providers/google/bigquery/projects/index.md index 316312ffd5..41e41b626c 100644 --- a/docs/google-docs/providers/google/bigquery/projects/index.md +++ b/docs/google-docs/providers/google/bigquery/projects/index.md @@ -27,12 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | A hash of the page of results | -| `kind` | `string` | The type of list. | -| `nextPageToken` | `string` | A token to request the next page of results. | -| `projects` | `array` | Projects to which you have at least READ access. | -| `totalItems` | `integer` | The total number of projects in the list. | +| `id` | `string` | An opaque ID of this project. | +| `friendlyName` | `string` | A descriptive name for this project. | +| `kind` | `string` | The resource type. | +| `numericId` | `string` | The numeric ID of this project. | +| `projectReference` | `object` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | | +| `_list` | `EXEC` | | diff --git a/docs/google-docs/providers/google/bigquery/routines/index.md b/docs/google-docs/providers/google/bigquery/routines/index.md index d8cb58d456..b8e7924b04 100644 --- a/docs/google-docs/providers/google/bigquery/routines/index.md +++ b/docs/google-docs/providers/google/bigquery/routines/index.md @@ -28,21 +28,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `description` | `string` | Optional. The description of the routine, if defined. | -| `sparkOptions` | `object` | Options for a user-defined Spark routine. | -| `creationTime` | `string` | Output only. The time when this routine was created, in milliseconds since the epoch. | +| `returnType` | `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"} } } ] } } | +| `importedLibraries` | `array` | Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. | | `language` | `string` | Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise. | +| `strictMode` | `boolean` | Optional. Can be set for procedures only. If true (default), the definition body will be validated in the creation and the updates of the procedure. For procedures with an argument of ANY TYPE, the definition body validtion is not supported at creation/update time, and thus this field must be set to false explicitly. | +| `returnTableType` | `object` | A table type | | `routineType` | `string` | Required. The type of routine. | -| `importedLibraries` | `array` | Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. | +| `definitionBody` | `string` | Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))` The definition_body is `concat(x, "\n", y)` (\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'` The definition_body is `return "\n";\n` Note that both \n are replaced with linebreaks. | | `lastModifiedTime` | `string` | Output only. The time when this routine was last modified, in milliseconds since the epoch. | -| `returnType` | `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"} } } ] } } | +| `creationTime` | `string` | Output only. The time when this routine was created, in milliseconds since the epoch. | | `routineReference` | `object` | | -| `returnTableType` | `object` | A table type | -| `etag` | `string` | Output only. A hash of this resource. | +| `sparkOptions` | `object` | Options for a user-defined Spark routine. | | `determinismLevel` | `string` | Optional. The determinism level of the JavaScript UDF, if defined. | -| `strictMode` | `boolean` | Optional. Can be set for procedures only. If true (default), the definition body will be validated in the creation and the updates of the procedure. For procedures with an argument of ANY TYPE, the definition body validtion is not supported at creation/update time, and thus this field must be set to false explicitly. | +| `etag` | `string` | Output only. A hash of this resource. | | `arguments` | `array` | Optional. | | `remoteFunctionOptions` | `object` | Options for a remote user-defined function. | -| `definitionBody` | `string` | Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))` The definition_body is `concat(x, "\n", y)` (\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'` The definition_body is `return "\n";\n` Note that both \n are replaced with linebreaks. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -50,4 +50,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `+datasetId, projectId` | Lists all routines in the specified dataset. Requires the READER dataset role. | | `insert` | `INSERT` | `+datasetId, projectId` | Creates a new routine in the dataset. | | `delete` | `DELETE` | `+datasetId, +routineId, projectId` | Deletes the routine specified by routineId from the dataset. | +| `_list` | `EXEC` | `+datasetId, projectId` | Lists all routines in the specified dataset. Requires the READER dataset role. | | `update` | `EXEC` | `+datasetId, +routineId, projectId` | Updates information in an existing routine. The update method replaces the entire Routine resource. | diff --git a/docs/google-docs/providers/google/bigquery/row_access_policies/index.md b/docs/google-docs/providers/google/bigquery/row_access_policies/index.md index 15541e12c4..2fd6fdfcab 100644 --- a/docs/google-docs/providers/google/bigquery/row_access_policies/index.md +++ b/docs/google-docs/providers/google/bigquery/row_access_policies/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to request the next page of results. | -| `rowAccessPolicies` | `array` | Row access policies on the requested table. | +| `creationTime` | `string` | Output only. The time when this row access policy was created, in milliseconds since the epoch. | +| `etag` | `string` | Output only. A hash of this resource. | +| `filterPredicate` | `string` | Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0 | +| `lastModifiedTime` | `string` | Output only. The time when this row access policy was last modified, in milliseconds since the epoch. | +| `rowAccessPolicyReference` | `object` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `+datasetId, +tableId, projectId` | +| `_list` | `EXEC` | `+datasetId, +tableId, projectId` | diff --git a/docs/google-docs/providers/google/bigquery/tabledata/index.md b/docs/google-docs/providers/google/bigquery/tabledata/index.md index 0b8fd05e36..f34c007569 100644 --- a/docs/google-docs/providers/google/bigquery/tabledata/index.md +++ b/docs/google-docs/providers/google/bigquery/tabledata/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `pageToken` | `string` | A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing. | | `rows` | `array` | Rows of results. | | `totalRows` | `string` | The total number of rows in the complete table. | | `etag` | `string` | A hash of this page of results. | | `kind` | `string` | The resource type of the response. | -| `pageToken` | `string` | A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigquery/tables/index.md b/docs/google-docs/providers/google/bigquery/tables/index.md index 3762c06650..263a4f3298 100644 --- a/docs/google-docs/providers/google/bigquery/tables/index.md +++ b/docs/google-docs/providers/google/bigquery/tables/index.md @@ -27,11 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `kind` | `string` | The type of list. | -| `nextPageToken` | `string` | A token to request the next page of results. | -| `tables` | `array` | Tables in the requested dataset. | -| `totalItems` | `integer` | The total number of tables in the dataset. | -| `etag` | `string` | A hash of this page of results. | +| `id` | `string` | An opaque ID of the table | +| `kind` | `string` | The resource type. | +| `tableReference` | `object` | | +| `type` | `string` | The type of table. Possible values are: TABLE, VIEW. | +| `expirationTime` | `string` | [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. | +| `friendlyName` | `string` | The user-friendly name for this table. | +| `timePartitioning` | `object` | | +| `view` | `object` | Additional details for a view. | +| `clustering` | `object` | | +| `creationTime` | `string` | The time when this table was created, in milliseconds since the epoch. | +| `labels` | `object` | The labels associated with this table. You can use these to organize and group your tables. | +| `rangePartitioning` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -39,5 +46,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `datasetId, projectId` | Lists all tables in the specified dataset. Requires the READER dataset role. | | `insert` | `INSERT` | `datasetId, projectId` | Creates a new, empty table in the dataset. | | `delete` | `DELETE` | `datasetId, projectId, tableId` | Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted. | +| `_list` | `EXEC` | `datasetId, projectId` | Lists all tables in the specified dataset. Requires the READER dataset role. | | `patch` | `EXEC` | `datasetId, projectId, tableId` | Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics. | | `update` | `EXEC` | `datasetId, projectId, tableId` | Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. | diff --git a/docs/google-docs/providers/google/bigquery/tables_iam_policies/index.md b/docs/google-docs/providers/google/bigquery/tables_iam_policies/index.md new file mode 100644 index 0000000000..dcb9481004 --- /dev/null +++ b/docs/google-docs/providers/google/bigquery/tables_iam_policies/index.md @@ -0,0 +1,32 @@ +--- +title: tables_iam_policies +hide_title: false +hide_table_of_contents: false +keywords: + - tables_iam_policies + - bigquery + - 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 +--- + + + +## Overview + + + + +
Nametables_iam_policies
TypeResource
Idgoogle.bigquery.tables_iam_policies
+ +## Fields +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `set_iam_policy` | `EXEC` | `resource` | diff --git a/docs/google-docs/providers/google/bigqueryconnection/connections/index.md b/docs/google-docs/providers/google/bigqueryconnection/connections/index.md index be345e1886..12a282494e 100644 --- a/docs/google-docs/providers/google/bigqueryconnection/connections/index.md +++ b/docs/google-docs/providers/google/bigqueryconnection/connections/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` | | `description` | `string` | User provided description. | -| `creationTime` | `string` | Output only. The creation timestamp of the connection. | | `friendlyName` | `string` | User provided display name for the connection. | | `hasCredential` | `boolean` | Output only. True, if credential is configured for this connection. | | `lastModifiedTime` | `string` | Output only. The last update timestamp of the connection. | | `cloudSql` | `object` | Connection properties specific to the Cloud SQL. | +| `creationTime` | `string` | Output only. The creation timestamp of the connection. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -41,4 +41,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Returns a list of connections in the given project. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new connection. | | `delete` | `DELETE` | `connectionsId, locationsId, projectsId` | Deletes connection and associated credential. | +| `_list` | `EXEC` | `locationsId, projectsId` | Returns a list of connections in the given project. | | `patch` | `EXEC` | `connectionsId, locationsId, projectsId` | Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask. | diff --git a/docs/google-docs/providers/google/bigqueryconnection/connections_iam_policies/index.md b/docs/google-docs/providers/google/bigqueryconnection/connections_iam_policies/index.md index cc4533c0d4..54be12af0b 100644 --- a/docs/google-docs/providers/google/bigqueryconnection/connections_iam_policies/index.md +++ b/docs/google-docs/providers/google/bigqueryconnection/connections_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `connectionsId, locationsId, projectsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | +| `get_iam_policy` | `SELECT` | `connectionsId, locationsId, projectsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | | `set_iam_policy` | `EXEC` | `connectionsId, locationsId, projectsId` | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. | | `test_iam_permissions` | `EXEC` | `connectionsId, locationsId, projectsId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | diff --git a/docs/google-docs/providers/google/bigqueryconnection/index.md b/docs/google-docs/providers/google/bigqueryconnection/index.md index 6857a1abce..08d47e11de 100644 --- a/docs/google-docs/providers/google/bigqueryconnection/index.md +++ b/docs/google-docs/providers/google/bigqueryconnection/index.md @@ -20,8 +20,8 @@ Allows Users To Manage BigQuery Connections To External Data Sources.
total resources: 3
-total selectable resources: 1
-total methods: 9
+total selectable resources: 2
+total methods: 10
@@ -33,7 +33,7 @@ Allows Users To Manage BigQuery Connections To External Data Sources. TypeService TitleBigQuery Connection API DescriptionAllows Users To Manage BigQuery Connections To External Data Sources. -Idbigqueryconnection:v23.08.00155 +Idbigqueryconnection:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/bigquerydatatransfer/data_sources/index.md b/docs/google-docs/providers/google/bigquerydatatransfer/data_sources/index.md index 7770548053..9f3bf0debd 100644 --- a/docs/google-docs/providers/google/bigquerydatatransfer/data_sources/index.md +++ b/docs/google-docs/providers/google/bigquerydatatransfer/data_sources/index.md @@ -29,22 +29,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Data source resource name. | | `description` | `string` | User friendly data source description string. | -| `displayName` | `string` | User friendly data source name. | -| `minimumScheduleInterval` | `string` | The minimum interval for scheduler to schedule runs. | +| `defaultDataRefreshWindowDays` | `integer` | Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`. | | `dataRefreshType` | `string` | Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically. | -| `supportsCustomSchedule` | `boolean` | Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule. | | `parameters` | `array` | Data source parameters. | -| `transferType` | `string` | Deprecated. This field has no effect. | -| `helpUrl` | `string` | Url for the help document for this data source. | -| `supportsMultipleTransfers` | `boolean` | Deprecated. This field has no effect. | | `manualRunsDisabled` | `boolean` | Disables backfilling and manual run scheduling for the data source. | | `dataSourceId` | `string` | Data source id. | +| `helpUrl` | `string` | Url for the help document for this data source. | +| `transferType` | `string` | Deprecated. This field has no effect. | | `scopes` | `array` | Api auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery | -| `authorizationType` | `string` | Indicates the type of authorization. | -| `clientId` | `string` | Data source client id which should be used to receive refresh token. | | `updateDeadlineSeconds` | `integer` | The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED. | -| `defaultDataRefreshWindowDays` | `integer` | Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`. | +| `supportsMultipleTransfers` | `boolean` | Deprecated. This field has no effect. | | `defaultSchedule` | `string` | Default data transfer schedule. Examples of valid schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. | +| `minimumScheduleInterval` | `string` | The minimum interval for scheduler to schedule runs. | +| `displayName` | `string` | User friendly data source name. | +| `authorizationType` | `string` | Indicates the type of authorization. | +| `supportsCustomSchedule` | `boolean` | Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule. | +| `clientId` | `string` | Data source client id which should be used to receive refresh token. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -52,5 +52,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_data_sources_list` | `SELECT` | `projectsId` | Lists supported data sources and returns their settings. | | `projects_locations_data_sources_get` | `SELECT` | `dataSourcesId, locationsId, projectsId` | Retrieves a supported data source and returns its settings. | | `projects_locations_data_sources_list` | `SELECT` | `locationsId, projectsId` | Lists supported data sources and returns their settings. | +| `_projects_data_sources_list` | `EXEC` | `projectsId` | Lists supported data sources and returns their settings. | +| `_projects_locations_data_sources_list` | `EXEC` | `locationsId, projectsId` | Lists supported data sources and returns their settings. | | `projects_data_sources_check_valid_creds` | `EXEC` | `dataSourcesId, projectsId` | Returns true if valid credentials exist for the given data source and requesting user. | | `projects_locations_data_sources_check_valid_creds` | `EXEC` | `dataSourcesId, locationsId, projectsId` | Returns true if valid credentials exist for the given data source and requesting user. | diff --git a/docs/google-docs/providers/google/bigquerydatatransfer/index.md b/docs/google-docs/providers/google/bigquerydatatransfer/index.md index 3452bb4088..cfa1fa9ccf 100644 --- a/docs/google-docs/providers/google/bigquerydatatransfer/index.md +++ b/docs/google-docs/providers/google/bigquerydatatransfer/index.md @@ -21,7 +21,7 @@ Schedule Queries Or Transfer External Data From SaaS Applications To Google BigQ
total resources: 6
total selectable resources: 5
-total methods: 32
+total methods: 41
@@ -33,7 +33,7 @@ Schedule Queries Or Transfer External Data From SaaS Applications To Google BigQ TypeService TitleBigQuery Data Transfer API DescriptionSchedule Queries Or Transfer External Data From SaaS Applications To Google BigQuery On A Regular Basis. -Idbigquerydatatransfer:v23.08.00155 +Idbigquerydatatransfer:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/bigquerydatatransfer/locations/index.md b/docs/google-docs/providers/google/bigquerydatatransfer/locations/index.md index a45ae5897e..ae801aff2e 100644 --- a/docs/google-docs/providers/google/bigquerydatatransfer/locations/index.md +++ b/docs/google-docs/providers/google/bigquerydatatransfer/locations/index.md @@ -27,11 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `projects_locations_enroll_data_sources` | `EXEC` | `locationsId, projectsId` | Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers). | | `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/bigquerydatatransfer/runs/index.md b/docs/google-docs/providers/google/bigquerydatatransfer/runs/index.md index b9aff4b56c..35075fdecb 100644 --- a/docs/google-docs/providers/google/bigquerydatatransfer/runs/index.md +++ b/docs/google-docs/providers/google/bigquerydatatransfer/runs/index.md @@ -27,8 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferRunsRequest.page_token` to request the next page of list results. | -| `transferRuns` | `array` | Output only. The stored pipeline transfer runs. | +| `name` | `string` | The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run. | +| `notificationPubsubTopic` | `string` | Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}` | +| `startTime` | `string` | Output only. Time when transfer run was started. Parameter ignored by server for input requests. | +| `errorStatus` | `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). | +| `schedule` | `string` | Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this. | +| `dataSourceId` | `string` | Output only. Data source id. | +| `scheduleTime` | `string` | Minimum time after which a transfer run can be started. | +| `emailPreferences` | `object` | Represents preferences for sending email notifications for transfer run events. | +| `userId` | `string` | Deprecated. Unique ID of the user on whose behalf transfer is done. | +| `params` | `object` | Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq | +| `endTime` | `string` | Output only. Time when transfer run ended. Parameter ignored by server for input requests. | +| `runTime` | `string` | For batch transfer runs, specifies the date and time of the data should be ingested. | +| `updateTime` | `string` | Output only. Last time the data transfer run state was updated. | +| `destinationDatasetId` | `string` | Output only. The BigQuery target dataset id. | +| `state` | `string` | Data transfer run state. Ignored for input requests. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +49,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_transfer_configs_runs_list` | `SELECT` | `projectsId, transferConfigsId` | Returns information about running and completed transfer runs. | | `projects_locations_transfer_configs_runs_delete` | `DELETE` | `locationsId, projectsId, runsId, transferConfigsId` | Deletes the specified transfer run. | | `projects_transfer_configs_runs_delete` | `DELETE` | `projectsId, runsId, transferConfigsId` | Deletes the specified transfer run. | +| `_projects_locations_transfer_configs_runs_list` | `EXEC` | `locationsId, projectsId, transferConfigsId` | Returns information about running and completed transfer runs. | +| `_projects_transfer_configs_runs_list` | `EXEC` | `projectsId, transferConfigsId` | Returns information about running and completed transfer runs. | | `projects_locations_transfer_configs_runs_get` | `EXEC` | `locationsId, projectsId, runsId, transferConfigsId` | Returns information about the particular transfer run. | | `projects_transfer_configs_runs_get` | `EXEC` | `projectsId, runsId, transferConfigsId` | Returns information about the particular transfer run. | diff --git a/docs/google-docs/providers/google/bigquerydatatransfer/transfer_configs/index.md b/docs/google-docs/providers/google/bigquerydatatransfer/transfer_configs/index.md index 1e29d288a8..217ed9436f 100644 --- a/docs/google-docs/providers/google/bigquerydatatransfer/transfer_configs/index.md +++ b/docs/google-docs/providers/google/bigquerydatatransfer/transfer_configs/index.md @@ -27,8 +27,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Output only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferConfigsRequest.page_token` to request the next page of list results. | -| `transferConfigs` | `array` | Output only. The stored pipeline transfer configurations. | +| `name` | `string` | The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config. | +| `dataSourceId` | `string` | Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list | +| `datasetRegion` | `string` | Output only. Region in which BigQuery dataset is located. | +| `schedule` | `string` | Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source. | +| `nextRunTime` | `string` | Output only. Next time when data transfer will run. | +| `dataRefreshWindowDays` | `integer` | The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. | +| `userId` | `string` | Deprecated. Unique ID of the user on whose behalf transfer is done. | +| `emailPreferences` | `object` | Represents preferences for sending email notifications for transfer run events. | +| `notificationPubsubTopic` | `string` | Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}` | +| `destinationDatasetId` | `string` | The BigQuery target dataset id. | +| `updateTime` | `string` | Output only. Data transfer modification time. Ignored by server on input. | +| `state` | `string` | Output only. State of the most recently updated transfer run. | +| `disabled` | `boolean` | Is this config disabled. When set to true, no runs are scheduled for a given transfer. | +| `ownerInfo` | `object` | Information about a user. | +| `encryptionConfiguration` | `object` | Represents the encryption configuration for a transfer. | +| `displayName` | `string` | User specified display name for the data transfer. | +| `params` | `object` | Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq | +| `scheduleOptions` | `object` | Options customizing the data transfer schedule. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,6 +54,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_transfer_configs_create` | `INSERT` | `projectsId` | Creates a new data transfer configuration. | | `projects_locations_transfer_configs_delete` | `DELETE` | `locationsId, projectsId, transferConfigsId` | Deletes a data transfer configuration, including any associated transfer runs and logs. | | `projects_transfer_configs_delete` | `DELETE` | `projectsId, transferConfigsId` | Deletes a data transfer configuration, including any associated transfer runs and logs. | +| `_projects_locations_transfer_configs_list` | `EXEC` | `locationsId, projectsId` | Returns information about all transfer configs owned by a project in the specified location. | +| `_projects_transfer_configs_list` | `EXEC` | `projectsId` | Returns information about all transfer configs owned by a project in the specified location. | | `projects_locations_transfer_configs_get` | `EXEC` | `locationsId, projectsId, transferConfigsId` | Returns information about a data transfer config. | | `projects_locations_transfer_configs_patch` | `EXEC` | `locationsId, projectsId, transferConfigsId` | Updates a data transfer configuration. All fields must be set, even if they are not updated. | | `projects_locations_transfer_configs_schedule_runs` | `EXEC` | `locationsId, projectsId, transferConfigsId` | Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead. | diff --git a/docs/google-docs/providers/google/bigquerydatatransfer/transfer_logs/index.md b/docs/google-docs/providers/google/bigquerydatatransfer/transfer_logs/index.md index b7cb63f022..150130e6c5 100644 --- a/docs/google-docs/providers/google/bigquerydatatransfer/transfer_logs/index.md +++ b/docs/google-docs/providers/google/bigquerydatatransfer/transfer_logs/index.md @@ -27,10 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Output only. The next-pagination token. For multiple-page list results, this token can be used as the `GetTransferRunLogRequest.page_token` to request the next page of list results. | -| `transferMessages` | `array` | Output only. The stored pipeline transfer messages. | +| `messageText` | `string` | Message text. | +| `messageTime` | `string` | Time when message was logged. | +| `severity` | `string` | Message severity. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_locations_transfer_configs_runs_transfer_logs_list` | `SELECT` | `locationsId, projectsId, runsId, transferConfigsId` | | `projects_transfer_configs_runs_transfer_logs_list` | `SELECT` | `projectsId, runsId, transferConfigsId` | +| `_projects_locations_transfer_configs_runs_transfer_logs_list` | `EXEC` | `locationsId, projectsId, runsId, transferConfigsId` | +| `_projects_transfer_configs_runs_transfer_logs_list` | `EXEC` | `projectsId, runsId, transferConfigsId` | diff --git a/docs/google-docs/providers/google/bigqueryreservation/assignments/index.md b/docs/google-docs/providers/google/bigqueryreservation/assignments/index.md index 72afe39160..f0c8c2dc55 100644 --- a/docs/google-docs/providers/google/bigqueryreservation/assignments/index.md +++ b/docs/google-docs/providers/google/bigqueryreservation/assignments/index.md @@ -27,13 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `assignments` | `array` | List of assignments visible to the user. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. | +| `state` | `string` | Output only. State of the assignment. | +| `assignee` | `string` | The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. | +| `jobType` | `string` | Which type of jobs will use the reservation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `list` | `SELECT` | `locationsId, projectsId, reservationsId` | Lists assignments. Only explicitly created assignments will be returned. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: `` and `` In this example, ListAssignments will just return the above two assignments for reservation `res1`, and no expansion/merge will happen. The wildcard "-" can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed. **Note** "-" cannot be used for projects nor locations. | | `create` | `INSERT` | `locationsId, projectsId, reservationsId` | Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation. Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location) combination, and that reservation will be used for all jobs of the matching type. Different assignments can be created on different levels of the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query. When creating assignments, it does not matter if other assignments exist at higher levels. Example: * The organization `organizationA` contains two projects, `project1` and `project2`. * Assignments for all three entities (`organizationA`, `project1`, and `project2`) could all be created and mapped to the same or different reservations. "None" assignments represent an absence of the assignment. Projects assigned to None use on-demand pricing. To create a "None" assignment, use "none" as a reservation_id in the parent. Example parent: `projects/myproject/locations/US/reservations/none`. Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation. Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment does not match location of the reservation. | | `delete` | `DELETE` | `assignmentsId, locationsId, projectsId, reservationsId` | Deletes a assignment. No expansion will happen. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: `` and `` In this example, deletion of the `` assignment won't affect the other assignment ``. After said deletion, queries from `project1` will still use `res1` while queries from `project2` will switch to use on-demand mode. | +| `_list` | `EXEC` | `locationsId, projectsId, reservationsId` | Lists assignments. Only explicitly created assignments will be returned. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: `` and `` In this example, ListAssignments will just return the above two assignments for reservation `res1`, and no expansion/merge will happen. The wildcard "-" can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed. **Note** "-" cannot be used for projects nor locations. | | `move` | `EXEC` | `assignmentsId, locationsId, projectsId, reservationsId` | Moves an assignment under a new reservation. This differs from removing an existing assignment and recreating a new one by providing a transactional change that ensures an assignee always has an associated reservation. | | `patch` | `EXEC` | `assignmentsId, locationsId, projectsId, reservationsId` | Updates an existing assignment. Only the `priority` field can be updated. | diff --git a/docs/google-docs/providers/google/bigqueryreservation/bi_reservation/index.md b/docs/google-docs/providers/google/bigqueryreservation/bi_reservation/index.md index 5271358432..afc1c32c0c 100644 --- a/docs/google-docs/providers/google/bigqueryreservation/bi_reservation/index.md +++ b/docs/google-docs/providers/google/bigqueryreservation/bi_reservation/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`. | -| `preferredTables` | `array` | Preferred tables to use BI capacity for. | | `size` | `string` | Size of a reservation, in bytes. | | `updateTime` | `string` | Output only. The last update timestamp of a reservation. | +| `preferredTables` | `array` | Preferred tables to use BI capacity for. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigqueryreservation/capacity_commitments/index.md b/docs/google-docs/providers/google/bigqueryreservation/capacity_commitments/index.md index b5dcec86e3..f986379812 100644 --- a/docs/google-docs/providers/google/bigqueryreservation/capacity_commitments/index.md +++ b/docs/google-docs/providers/google/bigqueryreservation/capacity_commitments/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123` The commitment_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. | -| `slotCount` | `string` | Number of slots in this commitment. | | `edition` | `string` | Edition of the capacity commitment. | | `failureStatus` | `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). | -| `plan` | `string` | Capacity commitment commitment plan. | -| `isFlatRate` | `boolean` | Output only. If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment. | -| `commitmentEndTime` | `string` | Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. | -| `state` | `string` | Output only. State of the commitment. | | `multiRegionAuxiliary` | `boolean` | Applicable only for commitments located within one of the BigQuery multi-regions (US or EU). If set to true, this commitment is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this commitment is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. | | `renewalPlan` | `string` | The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments. | | `commitmentStartTime` | `string` | Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments. | +| `isFlatRate` | `boolean` | Output only. If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment. | +| `slotCount` | `string` | Number of slots in this commitment. | +| `plan` | `string` | Capacity commitment commitment plan. | +| `state` | `string` | Output only. State of the commitment. | +| `commitmentEndTime` | `string` | Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -45,6 +45,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists all the capacity commitments for the admin project. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new capacity commitment resource. | | `delete` | `DELETE` | `capacityCommitmentsId, locationsId, projectsId` | Deletes a capacity commitment. Attempting to delete capacity commitment before its commitment_end_time will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists all the capacity commitments for the admin project. | | `merge` | `EXEC` | `locationsId, projectsId` | Merges capacity commitments of the same plan into a single commitment. The resulting capacity commitment has the greater commitment_end_time out of the to-be-merged capacity commitments. Attempting to merge capacity commitments of different plan will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`. | | `patch` | `EXEC` | `capacityCommitmentsId, locationsId, projectsId` | Updates an existing capacity commitment. Only `plan` and `renewal_plan` fields can be updated. Plan can only be changed to a plan of a longer commitment period. Attempting to change to a plan with shorter commitment period will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`. | | `split` | `EXEC` | `capacityCommitmentsId, locationsId, projectsId` | Splits capacity commitment to two commitments of the same plan and `commitment_end_time`. A common use case is to enable downgrading commitments. For example, in order to downgrade from 10000 slots to 8000, you might split a 10000 capacity commitment into commitments of 2000 and 8000. Then, you delete the first one after the commitment end time passes. | diff --git a/docs/google-docs/providers/google/bigqueryreservation/index.md b/docs/google-docs/providers/google/bigqueryreservation/index.md index 3672751959..9499329957 100644 --- a/docs/google-docs/providers/google/bigqueryreservation/index.md +++ b/docs/google-docs/providers/google/bigqueryreservation/index.md @@ -21,7 +21,7 @@ A Service To Modify Your BigQuery Flat-Rate Reservations.
total resources: 5
total selectable resources: 4
-total methods: 21
+total methods: 24
@@ -33,7 +33,7 @@ A Service To Modify Your BigQuery Flat-Rate Reservations. TypeService TitleBigQuery Reservation API DescriptionA Service To Modify Your BigQuery Flat-Rate Reservations. -Idbigqueryreservation:v23.08.00155 +Idbigqueryreservation:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/bigqueryreservation/reservations/index.md b/docs/google-docs/providers/google/bigqueryreservation/reservations/index.md index d342be9978..6b0a550264 100644 --- a/docs/google-docs/providers/google/bigqueryreservation/reservations/index.md +++ b/docs/google-docs/providers/google/bigqueryreservation/reservations/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. | -| `autoscale` | `object` | Auto scaling settings. | -| `ignoreIdleSlots` | `boolean` | If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most. | -| `edition` | `string` | Edition of the reservation. | | `concurrency` | `string` | Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as `target_job_concurrency` in the Information Schema, DDL and BQ CLI. | | `creationTime` | `string` | Output only. Creation time of the reservation. | -| `updateTime` | `string` | Output only. Last update time of the reservation. | +| `edition` | `string` | Edition of the reservation. | +| `autoscale` | `object` | Auto scaling settings. | | `multiRegionAuxiliary` | `boolean` | Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. | | `slotCapacity` | `string` | Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. If edition is EDITION_UNSPECIFIED and total slot_capacity of the reservation and its siblings exceeds the total slot_count of all capacity commitments, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. If edition is any value but EDITION_UNSPECIFIED, then the above requirement is not needed. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes. | +| `updateTime` | `string` | Output only. Last update time of the reservation. | +| `ignoreIdleSlots` | `boolean` | If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -43,4 +43,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists all the reservations for the project in the specified location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new reservation resource. | | `delete` | `DELETE` | `locationsId, projectsId, reservationsId` | Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has assignments. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists all the reservations for the project in the specified location. | | `patch` | `EXEC` | `locationsId, projectsId, reservationsId` | Updates an existing reservation 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 a40dd6d8ee..1efcf80040 100644 --- a/docs/google-docs/providers/google/bigtableadmin/app_profiles/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/app_profiles/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The unique name of the app profile. Values are of the form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`. | | `description` | `string` | Long form description of the use case for this AppProfile. | -| `multiClusterRoutingUseAny` | `object` | Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability. | | `singleClusterRouting` | `object` | Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability. | | `etag` | `string` | Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details. | +| `multiClusterRoutingUseAny` | `object` | Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -39,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `instancesId, projectsId` | Lists information about app profiles in an instance. | | `create` | `INSERT` | `instancesId, projectsId` | Creates an app profile within an instance. | | `delete` | `DELETE` | `appProfilesId, instancesId, projectsId` | Deletes an app profile from an instance. | +| `_list` | `EXEC` | `instancesId, projectsId` | Lists information about app profiles in an instance. | | `patch` | `EXEC` | `appProfilesId, instancesId, projectsId` | Updates an app profile within an instance. | diff --git a/docs/google-docs/providers/google/bigtableadmin/backups/index.md b/docs/google-docs/providers/google/bigtableadmin/backups/index.md index 9e71bbc97c..3b3745f0aa 100644 --- a/docs/google-docs/providers/google/bigtableadmin/backups/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/backups/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `sourceBackup` | `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//backups/. | | `sizeBytes` | `string` | Output only. Size of the backup in bytes. | | `endTime` | `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. | +| `startTime` | `string` | Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp. | +| `sourceBackup` | `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//backups/. | +| `expireTime` | `string` | Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup. | +| `encryptionInfo` | `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. | | `sourceTable` | `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}`. | | `state` | `string` | Output only. The current state of the backup. | -| `encryptionInfo` | `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. | -| `expireTime` | `string` | Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup. | -| `startTime` | `string` | Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -43,5 +43,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `clustersId, instancesId, projectsId` | Lists Cloud Bigtable backups. Returns both completed and pending backups. | | `create` | `INSERT` | `clustersId, instancesId, projectsId` | Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. | | `delete` | `DELETE` | `backupsId, clustersId, instancesId, projectsId` | Deletes a pending or completed Cloud Bigtable backup. | +| `_list` | `EXEC` | `clustersId, instancesId, projectsId` | Lists Cloud Bigtable backups. Returns both completed and pending backups. | | `copy` | `EXEC` | `clustersId, instancesId, projectsId` | Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project. | | `patch` | `EXEC` | `backupsId, clustersId, instancesId, projectsId` | Updates a pending or completed Cloud Bigtable Backup. | diff --git a/docs/google-docs/providers/google/bigtableadmin/backups_iam_policies/index.md b/docs/google-docs/providers/google/bigtableadmin/backups_iam_policies/index.md index 3cfe3aca39..27c6ac08ff 100644 --- a/docs/google-docs/providers/google/bigtableadmin/backups_iam_policies/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/backups_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `backupsId, clustersId, instancesId, projectsId` | Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set. | +| `get_iam_policy` | `SELECT` | `backupsId, clustersId, instancesId, projectsId` | Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set. | | `set_iam_policy` | `EXEC` | `backupsId, clustersId, instancesId, projectsId` | Sets the access control policy on a Table resource. Replaces any existing policy. | | `test_iam_permissions` | `EXEC` | `backupsId, clustersId, instancesId, projectsId` | Returns permissions that the caller has on the specified table resource. | diff --git a/docs/google-docs/providers/google/bigtableadmin/clusters/index.md b/docs/google-docs/providers/google/bigtableadmin/clusters/index.md index a77b01b3a6..f11fd6ff6a 100644 --- a/docs/google-docs/providers/google/bigtableadmin/clusters/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/clusters/index.md @@ -41,5 +41,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `instancesId, projectsId` | Lists information about clusters in an instance. | | `create` | `INSERT` | `instancesId, projectsId` | Creates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled. | | `delete` | `DELETE` | `clustersId, instancesId, projectsId` | Deletes a cluster from an instance. | +| `_list` | `EXEC` | `instancesId, projectsId` | Lists information about clusters in an instance. | | `partial_update_cluster` | `EXEC` | `clustersId, instancesId, projectsId` | Partially updates a cluster within a project. This method is the preferred way to update a Cluster. To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask. To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask. | | `update` | `EXEC` | `clustersId, instancesId, projectsId` | Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster. | diff --git a/docs/google-docs/providers/google/bigtableadmin/hot_tablets/index.md b/docs/google-docs/providers/google/bigtableadmin/hot_tablets/index.md index 9a1efe226f..763af1aa50 100644 --- a/docs/google-docs/providers/google/bigtableadmin/hot_tablets/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/hot_tablets/index.md @@ -27,9 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Set if not all hot tablets could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results. | -| `hotTablets` | `array` | List of hot tablets in the tables of the requested cluster that fall within the requested time range. Hot tablets are ordered by node cpu usage percent. If there are multiple hot tablets that correspond to the same tablet within a 15-minute interval, only the hot tablet with the highest node cpu usage will be included in the response. | +| `name` | `string` | The unique name of the hot tablet. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/[a-zA-Z0-9_-]*`. | +| `startTime` | `string` | Output only. The start time of the hot tablet. | +| `tableName` | `string` | Name of the table that contains the tablet. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. | +| `endKey` | `string` | Tablet End Key (inclusive). | +| `endTime` | `string` | Output only. The end time of the hot tablet. | +| `nodeCpuUsagePercent` | `number` | Output only. The average CPU usage spent by a node on this tablet over the start_time to end_time time range. The percentage is the amount of CPU used by the node to serve the tablet, from 0% (tablet was not interacted with) to 100% (the node spent all cycles serving the hot tablet). | +| `startKey` | `string` | Tablet Start Key (inclusive). | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `clustersId, instancesId, projectsId` | +| `_list` | `EXEC` | `clustersId, instancesId, projectsId` | diff --git a/docs/google-docs/providers/google/bigtableadmin/index.md b/docs/google-docs/providers/google/bigtableadmin/index.md index 63de755ab8..57073d2b99 100644 --- a/docs/google-docs/providers/google/bigtableadmin/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/index.md @@ -20,8 +20,8 @@ Administer Your Cloud Bigtable Tables And Instances.
total resources: 11
-total selectable resources: 8
-total methods: 50
+total selectable resources: 11
+total methods: 58
@@ -33,7 +33,7 @@ Administer Your Cloud Bigtable Tables And Instances. TypeService TitleCloud Bigtable Admin API DescriptionAdminister Your Cloud Bigtable Tables And Instances. -Idbigtableadmin:v23.08.00155 +Idbigtableadmin:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/bigtableadmin/instances/index.md b/docs/google-docs/providers/google/bigtableadmin/instances/index.md index d343be7772..dee2f18ede 100644 --- a/docs/google-docs/providers/google/bigtableadmin/instances/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/instances/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | DEPRECATED: This field is unused and ignored. | -| `failedLocations` | `array` | Locations from which Instance information could not be retrieved, due to an outage or some other transient condition. Instances whose Clusters are all in one of the failed locations may be missing from `instances`, and Instances with at least one Cluster in a failed location may only have partial information returned. Values are of the form `projects//locations/` | -| `instances` | `array` | The list of requested instances. | +| `name` | `string` | The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`. | +| `createTime` | `string` | Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is `seconds: 0, nanos: 1`. | +| `displayName` | `string` | Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. | +| `labels` | `object` | Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `state` | `string` | Output only. The current state of the instance. | +| `type` | `string` | The type of the instance. Defaults to `PRODUCTION`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,5 +41,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId` | Lists information about instances in a project. | | `create` | `INSERT` | `projectsId` | Create an instance within a project. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled. | | `delete` | `DELETE` | `instancesId, projectsId` | Delete an instance from a project. | +| `_list` | `EXEC` | `projectsId` | Lists information about instances in a project. | | `partial_update_instance` | `EXEC` | `instancesId, projectsId` | Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance. | | `update` | `EXEC` | `instancesId, projectsId` | Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance. | diff --git a/docs/google-docs/providers/google/bigtableadmin/instances_iam_policies/index.md b/docs/google-docs/providers/google/bigtableadmin/instances_iam_policies/index.md index 8cf2a4fa12..a839817a25 100644 --- a/docs/google-docs/providers/google/bigtableadmin/instances_iam_policies/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/instances_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `instancesId, projectsId` | Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set. | +| `get_iam_policy` | `SELECT` | `instancesId, projectsId` | Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set. | | `set_iam_policy` | `EXEC` | `instancesId, projectsId` | Sets the access control policy on an instance resource. Replaces any existing policy. | | `test_iam_permissions` | `EXEC` | `instancesId, projectsId` | Returns permissions that the caller has on the specified instance resource. | diff --git a/docs/google-docs/providers/google/bigtableadmin/locations/index.md b/docs/google-docs/providers/google/bigtableadmin/locations/index.md index 17f0a9d47b..7270f53324 100644 --- a/docs/google-docs/providers/google/bigtableadmin/locations/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `locations` | `array` | A list of locations that matches the specified filter in the request. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/bigtableadmin/operations/index.md b/docs/google-docs/providers/google/bigtableadmin/operations/index.md index 3c32a51b4b..cee89899c0 100644 --- a/docs/google-docs/providers/google/bigtableadmin/operations/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operationsId` | 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. | | `list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `operationsId` | 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`. | +| `_list` | `EXEC` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `operationsId` | 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`. | diff --git a/docs/google-docs/providers/google/bigtableadmin/tables/index.md b/docs/google-docs/providers/google/bigtableadmin/tables/index.md index 124fe6fe79..1cb3f55615 100644 --- a/docs/google-docs/providers/google/bigtableadmin/tables/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/tables/index.md @@ -27,8 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Set if not all tables could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results. | -| `tables` | `array` | The tables present in the requested instance. | +| `name` | `string` | The unique name of the table. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `STATS_VIEW`, `FULL` | +| `columnFamilies` | `object` | The column families configured for this table, mapped by column family ID. Views: `SCHEMA_VIEW`, `STATS_VIEW`, `FULL` | +| `deletionProtection` | `boolean` | Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs. | +| `granularity` | `string` | Immutable. The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. | +| `restoreInfo` | `object` | Information about a table restore. | +| `stats` | `object` | Approximate statistics related to a table. These statistics are calculated infrequently, while simultaneously, data in the table can change rapidly. Thus the values reported here (e.g. row count) are very likely out-of date, even the instant they are received in this API. Thus, only treat these values as approximate. IMPORTANT: Everything below is approximate, unless otherwise specified. | +| `changeStreamConfig` | `object` | Change stream configuration. | +| `clusterStates` | `object` | Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN `replication_status`. Views: `REPLICATION_VIEW`, `ENCRYPTION_VIEW`, `FULL` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +42,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `instancesId, projectsId` | Lists all tables served from a specified instance. | | `create` | `INSERT` | `instancesId, projectsId` | Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request. | | `delete` | `DELETE` | `instancesId, projectsId, tablesId` | Permanently deletes a specified table and all of its data. | +| `_list` | `EXEC` | `instancesId, projectsId` | Lists all tables served from a specified instance. | | `check_consistency` | `EXEC` | `instancesId, projectsId, tablesId` | Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request. | | `drop_row_range` | `EXEC` | `instancesId, projectsId, tablesId` | Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix. | | `generate_consistency_token` | `EXEC` | `instancesId, projectsId, tablesId` | Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days. | diff --git a/docs/google-docs/providers/google/bigtableadmin/tables_iam_policies/index.md b/docs/google-docs/providers/google/bigtableadmin/tables_iam_policies/index.md index 2dbb63497f..d5b014d0fc 100644 --- a/docs/google-docs/providers/google/bigtableadmin/tables_iam_policies/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/tables_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `instancesId, projectsId, tablesId` | Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set. | +| `get_iam_policy` | `SELECT` | `instancesId, projectsId, tablesId` | Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set. | | `set_iam_policy` | `EXEC` | `instancesId, projectsId, tablesId` | Sets the access control policy on a Table resource. Replaces any existing policy. | | `test_iam_permissions` | `EXEC` | `instancesId, projectsId, tablesId` | Returns permissions that the caller has on the specified table resource. | diff --git a/docs/google-docs/providers/google/billingbudgets/budgets/index.md b/docs/google-docs/providers/google/billingbudgets/budgets/index.md index a85aa0b326..7c95d8b6ef 100644 --- a/docs/google-docs/providers/google/billingbudgets/budgets/index.md +++ b/docs/google-docs/providers/google/billingbudgets/budgets/index.md @@ -27,8 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `budgets` | `array` | List of the budgets owned by the requested billing account. | -| `nextPageToken` | `string` | If not empty, indicates that there may be more budgets that match the request; this value should be passed in a new `ListBudgetsRequest`. | +| `name` | `string` | Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`. | +| `thresholdRules` | `array` | Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. | +| `amount` | `object` | The budgeted amount for each usage period. | +| `budgetFilter` | `object` | A filter for a budget, limiting the scope of the cost to calculate. | +| `displayName` | `string` | User data for display name in UI. The name must be less than or equal to 60 characters. | +| `etag` | `string` | Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag causes an update to overwrite other changes. | +| `notificationsRule` | `object` | NotificationsRule defines notifications that are sent based on budget spend and thresholds. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +41,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `billingAccountsId` | Returns a list of budgets for a billing account. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console. | | `create` | `INSERT` | `billingAccountsId` | Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more information on the limits of the number of budgets you can create. | | `delete` | `DELETE` | `billingAccountsId, budgetsId` | Deletes a budget. Returns successfully if already deleted. | +| `_list` | `EXEC` | `billingAccountsId` | Returns a list of budgets for a billing account. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console. | | `patch` | `EXEC` | `billingAccountsId, budgetsId` | Updates a budget and returns the updated budget. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. Budget fields that are not exposed in this API will not be changed by this method. | diff --git a/docs/google-docs/providers/google/billingbudgets/index.md b/docs/google-docs/providers/google/billingbudgets/index.md index f58ca3b44f..f3ebe199fa 100644 --- a/docs/google-docs/providers/google/billingbudgets/index.md +++ b/docs/google-docs/providers/google/billingbudgets/index.md @@ -21,7 +21,7 @@ The Cloud Billing Budget API Stores Cloud Billing Budgets, Which Define A Budget
total resources: 1
total selectable resources: 1
-total methods: 5
+total methods: 6
@@ -33,7 +33,7 @@ The Cloud Billing Budget API Stores Cloud Billing Budgets, Which Define A Budget TypeService TitleCloud Billing Budget API DescriptionThe Cloud Billing Budget API Stores Cloud Billing Budgets, Which Define A Budget Plan And The Rules To Execute As Spend Is Tracked Against That Plan. -Idbillingbudgets:v23.08.00155 +Idbillingbudgets:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/binaryauthorization/attestors/index.md b/docs/google-docs/providers/google/binaryauthorization/attestors/index.md index a14b16971d..3596c06716 100644 --- a/docs/google-docs/providers/google/binaryauthorization/attestors/index.md +++ b/docs/google-docs/providers/google/binaryauthorization/attestors/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. The resource name, in the format: `projects/*/attestors/*`. This field may not be updated. | | `description` | `string` | Optional. A descriptive comment. This field may be updated. The field may be displayed in chooser dialogs. | +| `etag` | `string` | Optional. A checksum, returned by the server, that can be sent on update requests to ensure the attestor has an up-to-date value before attempting to update it. See https://google.aip.dev/154. | | `updateTime` | `string` | Output only. Time when the attestor was last updated. | | `userOwnedGrafeasNote` | `object` | An user owned Grafeas note references a Grafeas Attestation.Authority Note created by the user. | -| `etag` | `string` | Optional. A checksum, returned by the server, that can be sent on update requests to ensure the attestor has an up-to-date value before attempting to update it. See https://google.aip.dev/154. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -39,5 +39,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId` | Lists attestors. Returns INVALID_ARGUMENT if the project does not exist. | | `create` | `INSERT` | `projectsId` | Creates an attestor, and returns a copy of the new attestor. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the attestor already exists. | | `delete` | `DELETE` | `attestorsId, projectsId` | Deletes an attestor. Returns NOT_FOUND if the attestor does not exist. | +| `_list` | `EXEC` | `projectsId` | Lists attestors. Returns INVALID_ARGUMENT if the project does not exist. | | `update` | `EXEC` | `attestorsId, projectsId` | Updates an attestor. Returns NOT_FOUND if the attestor does not exist. | | `validate_attestation_occurrence` | `EXEC` | `attestorsId, projectsId` | Returns whether the given Attestation for the given image URI was signed by the given Attestor | diff --git a/docs/google-docs/providers/google/binaryauthorization/index.md b/docs/google-docs/providers/google/binaryauthorization/index.md index c2d70c31b5..bfd647f0f3 100644 --- a/docs/google-docs/providers/google/binaryauthorization/index.md +++ b/docs/google-docs/providers/google/binaryauthorization/index.md @@ -19,9 +19,9 @@ The Management Interface For Binary Authorization, A Service That Provides Polic
-total resources: 5
-total selectable resources: 3
-total methods: 15
+total resources: 6
+total selectable resources: 4
+total methods: 22
@@ -33,7 +33,7 @@ The Management Interface For Binary Authorization, A Service That Provides Polic TypeService TitleBinary Authorization API DescriptionThe Management Interface For Binary Authorization, A Service That Provides Policy-Based Deployment Validation And Control For Images Deployed To Google Kubernetes Engine (GKE), Anthos Service Mesh, Anthos Clusters, And Cloud Run. -Idbinaryauthorization:v23.08.00155 +Idbinaryauthorization:v23.08.00157 ## Resources @@ -41,9 +41,10 @@ The Management Interface For Binary Authorization, A Service That Provides Polic
attestors
attestors_iam_policies
-policy
+policies
+policy
policy_iam_policies
systempolicy_policy
diff --git a/docs/google-docs/providers/google/binaryauthorization/policies/index.md b/docs/google-docs/providers/google/binaryauthorization/policies/index.md new file mode 100644 index 0000000000..2dfaf75c27 --- /dev/null +++ b/docs/google-docs/providers/google/binaryauthorization/policies/index.md @@ -0,0 +1,42 @@ +--- +title: policies +hide_title: false +hide_table_of_contents: false +keywords: + - policies + - binaryauthorization + - 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 +--- + + + +## Overview + + + + +
Namepolicies
TypeResource
Idgoogle.binaryauthorization.policies
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The relative resource name of the BinAuthz platform policy, in the form of `projects/*/platforms/*/policies/*`. | +| `description` | `string` | Optional. A description comment about the policy. | +| `gkePolicy` | `object` | A Binary Authorization policy for a GKE cluster. This is one type of policy that can occur as a `PlatformPolicy`. | +| `updateTime` | `string` | Output only. Time when the policy was last updated. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `platformsId, policiesId, projectsId` | Gets a platform policy. Returns NOT_FOUND if the policy doesn't exist. | +| `list` | `SELECT` | `platformsId, projectsId` | Lists platform policies owned by a project in the specified platform. Returns INVALID_ARGUMENT if the project or the platform doesn't exist. | +| `create` | `INSERT` | `platformsId, projectsId` | Creates a platform policy, and returns a copy of it. Returns NOT_FOUND if the project or platform doesn't exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the policy already exists, and INVALID_ARGUMENT if the policy contains a platform-specific policy that does not match the platform value specified in the URL. | +| `delete` | `DELETE` | `platformsId, policiesId, projectsId` | Deletes a platform policy. Returns NOT_FOUND if the policy doesn't exist. | +| `_list` | `EXEC` | `platformsId, projectsId` | Lists platform policies owned by a project in the specified platform. Returns INVALID_ARGUMENT if the project or the platform doesn't exist. | +| `replace_platform_policy` | `EXEC` | `platformsId, policiesId, projectsId` | Replaces a platform policy. Returns NOT_FOUND if the policy doesn't exist. | diff --git a/docs/google-docs/providers/google/blockchainnodeengine/blockchain_nodes/index.md b/docs/google-docs/providers/google/blockchainnodeengine/blockchain_nodes/index.md index 5542e6c277..a93675263f 100644 --- a/docs/google-docs/providers/google/blockchainnodeengine/blockchain_nodes/index.md +++ b/docs/google-docs/providers/google/blockchainnodeengine/blockchain_nodes/index.md @@ -27,9 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `blockchainNodes` | `array` | The list of nodes | -| `nextPageToken` | `string` | A token identifying a page of results the server should return. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | Output only. The fully qualified name of the blockchain node. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`. | +| `createTime` | `string` | Output only. The timestamp at which the blockchain node was first created. | +| `ethereumDetails` | `object` | Ethereum-specific blockchain node details. | +| `labels` | `object` | User-provided key-value pairs. | +| `state` | `string` | Output only. A status representing the state of the node. | +| `updateTime` | `string` | Output only. The timestamp at which the blockchain node was last updated. | +| `blockchainType` | `string` | Immutable. The blockchain type of the node. | +| `connectionInfo` | `object` | The connection information through which to interact with a blockchain node. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +42,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists blockchain nodes in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new blockchain node in a given project and location. | | `delete` | `DELETE` | `blockchainNodesId, locationsId, projectsId` | Deletes a single blockchain node. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists blockchain nodes in a given project and location. | | `patch` | `EXEC` | `blockchainNodesId, locationsId, projectsId` | Updates the parameters of a single blockchain node. | diff --git a/docs/google-docs/providers/google/blockchainnodeengine/index.md b/docs/google-docs/providers/google/blockchainnodeengine/index.md index 2885173e04..5ff26ee59f 100644 --- a/docs/google-docs/providers/google/blockchainnodeengine/index.md +++ b/docs/google-docs/providers/google/blockchainnodeengine/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 3
total selectable resources: 3
-total methods: 11
+total methods: 14
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleBlockchain Node Engine API Description -Idblockchainnodeengine:v23.08.00155 +Idblockchainnodeengine:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/blockchainnodeengine/locations/index.md b/docs/google-docs/providers/google/blockchainnodeengine/locations/index.md index 7d1eb83dfe..395f18c1c0 100644 --- a/docs/google-docs/providers/google/blockchainnodeengine/locations/index.md +++ b/docs/google-docs/providers/google/blockchainnodeengine/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/blockchainnodeengine/operations/index.md b/docs/google-docs/providers/google/blockchainnodeengine/operations/index.md index b0f61ac149..f3e9b8c2d3 100644 --- a/docs/google-docs/providers/google/blockchainnodeengine/operations/index.md +++ b/docs/google-docs/providers/google/blockchainnodeengine/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/certificatemanager/certificate_issuance_configs/index.md b/docs/google-docs/providers/google/certificatemanager/certificate_issuance_configs/index.md index d68af82b56..e18f7817ac 100644 --- a/docs/google-docs/providers/google/certificatemanager/certificate_issuance_configs/index.md +++ b/docs/google-docs/providers/google/certificatemanager/certificate_issuance_configs/index.md @@ -27,9 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | -| `unreachable` | `array` | Locations that could not be reached. | -| `certificateIssuanceConfigs` | `array` | A list of certificate configs for the parent resource. | +| `name` | `string` | A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`. | +| `description` | `string` | One or more paragraphs of text description of a CertificateIssuanceConfig. | +| `createTime` | `string` | Output only. The creation timestamp of a CertificateIssuanceConfig. | +| `rotationWindowPercentage` | `integer` | Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive. | +| `keyAlgorithm` | `string` | Required. The key algorithm to use when generating the private key. | +| `labels` | `object` | Set of labels associated with a CertificateIssuanceConfig. | +| `lifetime` | `string` | Required. Workload certificate lifetime requested. | +| `updateTime` | `string` | Output only. The last update timestamp of a CertificateIssuanceConfig. | +| `certificateAuthorityConfig` | `object` | The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,3 +43,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists CertificateIssuanceConfigs in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new CertificateIssuanceConfig in a given project and location. | | `delete` | `DELETE` | `certificateIssuanceConfigsId, locationsId, projectsId` | Deletes a single CertificateIssuanceConfig. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists CertificateIssuanceConfigs in a given project and location. | diff --git a/docs/google-docs/providers/google/certificatemanager/certificate_map_entries/index.md b/docs/google-docs/providers/google/certificatemanager/certificate_map_entries/index.md index 5fb0ee45ca..3b97788d6b 100644 --- a/docs/google-docs/providers/google/certificatemanager/certificate_map_entries/index.md +++ b/docs/google-docs/providers/google/certificatemanager/certificate_map_entries/index.md @@ -27,9 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | -| `unreachable` | `array` | Locations that could not be reached. | -| `certificateMapEntries` | `array` | A list of certificate map entries for the parent resource. | +| `name` | `string` | A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`. | +| `description` | `string` | One or more paragraphs of text description of a certificate map entry. | +| `certificates` | `array` | A set of Certificates defines for the given `hostname`. There can be defined up to four certificates in each Certificate Map Entry. Each certificate must match pattern `projects/*/locations/*/certificates/*`. | +| `labels` | `object` | Set of labels associated with a Certificate Map Entry. | +| `matcher` | `string` | A predefined matcher for particular cases, other than SNI selection. | +| `state` | `string` | Output only. A serving state of this Certificate Map Entry. | +| `updateTime` | `string` | Output only. The update timestamp of a Certificate Map Entry. | +| `hostname` | `string` | A Hostname (FQDN, e.g. `example.com`) or a wildcard hostname expression (`*.example.com`) for a set of hostnames with common suffix. Used as Server Name Indication (SNI) for selecting a proper certificate. | +| `createTime` | `string` | Output only. The creation timestamp of a Certificate Map Entry. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +43,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `certificateMapsId, locationsId, projectsId` | Lists CertificateMapEntries in a given project and location. | | `create` | `INSERT` | `certificateMapsId, locationsId, projectsId` | Creates a new CertificateMapEntry in a given project and location. | | `delete` | `DELETE` | `certificateMapEntriesId, certificateMapsId, locationsId, projectsId` | Deletes a single CertificateMapEntry. | +| `_list` | `EXEC` | `certificateMapsId, locationsId, projectsId` | Lists CertificateMapEntries in a given project and location. | | `patch` | `EXEC` | `certificateMapEntriesId, certificateMapsId, locationsId, projectsId` | Updates a CertificateMapEntry. | diff --git a/docs/google-docs/providers/google/certificatemanager/certificate_maps/index.md b/docs/google-docs/providers/google/certificatemanager/certificate_maps/index.md index 72e458d478..49f9d586bf 100644 --- a/docs/google-docs/providers/google/certificatemanager/certificate_maps/index.md +++ b/docs/google-docs/providers/google/certificatemanager/certificate_maps/index.md @@ -27,9 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | -| `unreachable` | `array` | Locations that could not be reached. | -| `certificateMaps` | `array` | A list of certificate maps for the parent resource. | +| `name` | `string` | A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`. | +| `description` | `string` | One or more paragraphs of text description of a certificate map. | +| `createTime` | `string` | Output only. The creation timestamp of a Certificate Map. | +| `gclbTargets` | `array` | Output only. A list of GCLB targets that use this Certificate Map. A Target Proxy is only present on this list if it's attached to a Forwarding Rule. | +| `labels` | `object` | Set of labels associated with a Certificate Map. | +| `updateTime` | `string` | Output only. The update timestamp of a Certificate Map. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +40,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists CertificateMaps in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new CertificateMap in a given project and location. | | `delete` | `DELETE` | `certificateMapsId, locationsId, projectsId` | Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists CertificateMaps in a given project and location. | | `patch` | `EXEC` | `certificateMapsId, locationsId, projectsId` | Updates a CertificateMap. | diff --git a/docs/google-docs/providers/google/certificatemanager/certificates/index.md b/docs/google-docs/providers/google/certificatemanager/certificates/index.md index e5fd70c851..5d415ed4f6 100644 --- a/docs/google-docs/providers/google/certificatemanager/certificates/index.md +++ b/docs/google-docs/providers/google/certificatemanager/certificates/index.md @@ -27,9 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `certificates` | `array` | A list of certificates for the parent resource. | -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | -| `unreachable` | `array` | A list of locations that could not be reached. | +| `name` | `string` | A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/*/locations/*/certificates/*`. | +| `description` | `string` | One or more paragraphs of text description of a certificate. | +| `managed` | `object` | Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so. | +| `expireTime` | `string` | Output only. The expiry timestamp of a Certificate. | +| `createTime` | `string` | Output only. The creation timestamp of a Certificate. | +| `scope` | `string` | Immutable. The scope of the certificate. | +| `labels` | `object` | Set of labels associated with a Certificate. | +| `pemCertificate` | `string` | Output only. The PEM-encoded certificate chain. | +| `selfManaged` | `object` | Certificate data for a SelfManaged Certificate. SelfManaged Certificates are uploaded by the user. Updating such certificates before they expire remains the user's responsibility. | +| `sanDnsnames` | `array` | Output only. The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6). Managed certificates that haven't been provisioned yet have this field populated with a value of the managed.domains field. | +| `updateTime` | `string` | Output only. The last update timestamp of a Certificate. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +45,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists Certificates in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new Certificate in a given project and location. | | `delete` | `DELETE` | `certificatesId, locationsId, projectsId` | Deletes a single Certificate. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Certificates in a given project and location. | | `patch` | `EXEC` | `certificatesId, locationsId, projectsId` | Updates a Certificate. | diff --git a/docs/google-docs/providers/google/certificatemanager/dns_authorizations/index.md b/docs/google-docs/providers/google/certificatemanager/dns_authorizations/index.md index 4793612de9..5c8ea826f5 100644 --- a/docs/google-docs/providers/google/certificatemanager/dns_authorizations/index.md +++ b/docs/google-docs/providers/google/certificatemanager/dns_authorizations/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | -| `unreachable` | `array` | Locations that could not be reached. | -| `dnsAuthorizations` | `array` | A list of dns authorizations for the parent resource. | +| `name` | `string` | A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. | +| `description` | `string` | One or more paragraphs of text description of a DnsAuthorization. | +| `dnsResourceRecord` | `object` | The structure describing the DNS Resource Record that needs to be added to DNS configuration for the authorization to be usable by certificate. | +| `domain` | `string` | Required. Immutable. A domain that is being authorized. A DnsAuthorization resource covers a single domain and its wildcard, e.g. authorization for `example.com` can be used to issue certificates for `example.com` and `*.example.com`. | +| `labels` | `object` | Set of labels associated with a DnsAuthorization. | +| `updateTime` | `string` | Output only. The last update timestamp of a DnsAuthorization. | +| `createTime` | `string` | Output only. The creation timestamp of a DnsAuthorization. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +41,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists DnsAuthorizations in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new DnsAuthorization in a given project and location. | | `delete` | `DELETE` | `dnsAuthorizationsId, locationsId, projectsId` | Deletes a single DnsAuthorization. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists DnsAuthorizations in a given project and location. | | `patch` | `EXEC` | `dnsAuthorizationsId, locationsId, projectsId` | Updates a DnsAuthorization. | diff --git a/docs/google-docs/providers/google/certificatemanager/index.md b/docs/google-docs/providers/google/certificatemanager/index.md index cf25fade4f..3954811c99 100644 --- a/docs/google-docs/providers/google/certificatemanager/index.md +++ b/docs/google-docs/providers/google/certificatemanager/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 8
total selectable resources: 8
-total methods: 35
+total methods: 43
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleCertificate Manager API Description -Idcertificatemanager:v23.08.00155 +Idcertificatemanager:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/certificatemanager/locations/index.md b/docs/google-docs/providers/google/certificatemanager/locations/index.md index 6af27db958..a5d77c1026 100644 --- a/docs/google-docs/providers/google/certificatemanager/locations/index.md +++ b/docs/google-docs/providers/google/certificatemanager/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `locations` | `array` | A list of locations that matches the specified filter in the request. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/certificatemanager/operations/index.md b/docs/google-docs/providers/google/certificatemanager/operations/index.md index efe1538528..0fc7f399c7 100644 --- a/docs/google-docs/providers/google/certificatemanager/operations/index.md +++ b/docs/google-docs/providers/google/certificatemanager/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/certificatemanager/trust_configs/index.md b/docs/google-docs/providers/google/certificatemanager/trust_configs/index.md index 5a1f06dae3..3b566ff673 100644 --- a/docs/google-docs/providers/google/certificatemanager/trust_configs/index.md +++ b/docs/google-docs/providers/google/certificatemanager/trust_configs/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `trustConfigs` | `array` | A list of TrustConfigs for the parent resource. | -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | +| `name` | `string` | A user-defined name of the trust config. TrustConfig names must be unique globally and match pattern `projects/*/locations/*/trustConfigs/*`. | +| `description` | `string` | One or more paragraphs of text description of a TrustConfig. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `labels` | `object` | Set of labels associated with a TrustConfig. | +| `trustStores` | `array` | Set of trust stores to perform validation against. This field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. Only one TrustStore specified is currently allowed. | +| `updateTime` | `string` | Output only. The last update timestamp of a TrustConfig. | +| `createTime` | `string` | Output only. The creation timestamp of a TrustConfig. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +41,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists TrustConfigs in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new TrustConfig in a given project and location. | | `delete` | `DELETE` | `locationsId, projectsId, trustConfigsId` | Deletes a single TrustConfig. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists TrustConfigs in a given project and location. | | `patch` | `EXEC` | `locationsId, projectsId, trustConfigsId` | Updates a TrustConfig. | diff --git a/docs/google-docs/providers/google/cloudasset/assets/index.md b/docs/google-docs/providers/google/cloudasset/assets/index.md index 7cceee0494..d4def6d48d 100644 --- a/docs/google-docs/providers/google/cloudasset/assets/index.md +++ b/docs/google-docs/providers/google/cloudasset/assets/index.md @@ -27,10 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results. It expires 72 hours after the page token for the first page is generated. Set to empty if there are no remaining results. | -| `readTime` | `string` | Time the snapshot was taken. | -| `assets` | `array` | Assets. | +| `name` | `string` | The full name of the asset. Example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1` See [Resource names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more information. | +| `iamPolicy` | `object` | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). | +| `relatedAssets` | `object` | DEPRECATED. This message only presents for the purpose of backward-compatibility. The server will never populate this message in responses. The detailed related assets with the `relationship_type`. | +| `assetType` | `string` | The type of the asset. Example: `compute.googleapis.com/Disk` See [Supported asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) for more information. | +| `accessLevel` | `object` | An `AccessLevel` is a label that can be applied to requests to Google Cloud services, along with a list of requirements necessary for the label to be applied. | +| `accessPolicy` | `object` | `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use Google Cloud services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. | +| `orgPolicy` | `array` | A representation of an [organization policy](https://cloud.google.com/resource-manager/docs/organization-policy/overview#organization_policy). There can be more than one organization policy with different constraints set on a given resource. | +| `relatedAsset` | `object` | An asset identifier in Google Cloud which contains its name, type and ancestors. An asset can be any resource in the Google Cloud [resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), a resource outside the Google Cloud resource hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy (e.g. IAM policy). See [Supported asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) for more information. | +| `ancestors` | `array` | The ancestry path of an asset in Google Cloud [resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), represented as a list of relative resource names. An ancestry path starts with the closest ancestor in the hierarchy and ends at root. If the asset is a project, folder, or organization, the ancestry path starts from the asset itself. Example: `["projects/123456789", "folders/5432", "organizations/1234"]` | +| `osInventory` | `object` | This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time. You can use this API resource to determine the inventory data of your VM. For more information, see [Information provided by OS inventory management](https://cloud.google.com/compute/docs/instances/os-inventory-management#data-collected). | +| `resource` | `object` | A representation of a Google Cloud resource. | +| `servicePerimeter` | `object` | `ServicePerimeter` describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project or VPC network can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges. | +| `updateTime` | `string` | The last update timestamp of an asset. update_time is updated when create/update/delete operation is performed. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `parent` | +| `_list` | `EXEC` | `parent` | diff --git a/docs/google-docs/providers/google/cloudasset/cloudasset/index.md b/docs/google-docs/providers/google/cloudasset/cloudasset/index.md index 7712b4840d..9cae3cc2df 100644 --- a/docs/google-docs/providers/google/cloudasset/cloudasset/index.md +++ b/docs/google-docs/providers/google/cloudasset/cloudasset/index.md @@ -30,4 +30,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `analyze_move` | `EXEC` | `resource` | Analyze moving a resource to a specified destination without kicking off the actual move. The analysis is best effort depending on the user's permissions of viewing different hierarchical policies and configurations. The policies and configuration are subject to change before the actual resource migration takes place. | +| `analyze_org_policies` | `EXEC` | `scope` | Analyzes organization policies under a scope. | | `export_assets` | `EXEC` | `parent` | Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a google.cloud.asset.v1.Asset in the JSON format; for BigQuery table destinations, the output table stores the fields in asset Protobuf as columns. This API implements the google.longrunning.Operation API, which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes. | diff --git a/docs/google-docs/providers/google/cloudasset/cloudasset_iam_policies/index.md b/docs/google-docs/providers/google/cloudasset/cloudasset_iam_policies/index.md index 5c1709f30e..ef4895156b 100644 --- a/docs/google-docs/providers/google/cloudasset/cloudasset_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudasset/cloudasset_iam_policies/index.md @@ -27,7 +27,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields `SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `analyze_iam_policy` | `EXEC` | `scope` | Analyzes IAM policies to answer which identities have what accesses on which resources. | -| `analyze_iam_policy_longrunning` | `EXEC` | `scope` | Analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination. For Cloud Storage destination, the output format is the JSON format that represents a AnalyzeIamPolicyResponse. This method implements the google.longrunning.Operation, which allows you to track the operation status. We recommend intervals of at least 2 seconds with exponential backoff retry to poll the operation result. The metadata contains the metadata for the long-running operation. | +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `analyze_iam_policy_longrunning` | `EXEC` | `scope` | diff --git a/docs/google-docs/providers/google/cloudasset/feeds/index.md b/docs/google-docs/providers/google/cloudasset/feeds/index.md index f84411455d..e4f24fff58 100644 --- a/docs/google-docs/providers/google/cloudasset/feeds/index.md +++ b/docs/google-docs/providers/google/cloudasset/feeds/index.md @@ -30,5 +30,3 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:--------------|:----------------|:------------| | `list` | `SELECT` | `parent` | Lists all asset feeds in a parent project/folder/organization. | | `create` | `INSERT` | `parent` | Creates a feed in a parent project/folder/organization to listen to its asset updates. | -| `delete` | `DELETE` | `name` | Deletes an asset feed. | -| `patch` | `EXEC` | `name` | Updates an asset feed configuration. | diff --git a/docs/google-docs/providers/google/cloudasset/index.md b/docs/google-docs/providers/google/cloudasset/index.md index 0ae9966eb6..e1d6bf2a80 100644 --- a/docs/google-docs/providers/google/cloudasset/index.md +++ b/docs/google-docs/providers/google/cloudasset/index.md @@ -19,9 +19,9 @@ The Cloud Asset API Manages The History And Inventory Of Google Cloud Resources.
-total resources: 8
+total resources: 7
total selectable resources: 3
-total methods: 14
+total methods: 16
@@ -33,7 +33,7 @@ The Cloud Asset API Manages The History And Inventory Of Google Cloud Resources. TypeService TitleCloud Asset API DescriptionThe Cloud Asset API Manages The History And Inventory Of Google Cloud Resources. -Idcloudasset:v23.08.00155 +Idcloudasset:v23.08.00157 ## Resources @@ -47,7 +47,6 @@ The Cloud Asset API Manages The History And Inventory Of Google Cloud Resources.
effective_iam_policies
feeds
-operations
saved_queries
diff --git a/docs/google-docs/providers/google/cloudasset/saved_queries/index.md b/docs/google-docs/providers/google/cloudasset/saved_queries/index.md index d400f3e5e3..73b234bd8b 100644 --- a/docs/google-docs/providers/google/cloudasset/saved_queries/index.md +++ b/docs/google-docs/providers/google/cloudasset/saved_queries/index.md @@ -27,10 +27,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `savedQueries` | `array` | A list of savedQueries. | +| `name` | `string` | The resource name of the saved query. The format must be: * projects/project_number/savedQueries/saved_query_id * folders/folder_number/savedQueries/saved_query_id * organizations/organization_number/savedQueries/saved_query_id | +| `description` | `string` | The description of this saved query. This value should be fewer than 255 characters. | +| `createTime` | `string` | Output only. The create time of this saved query. | +| `creator` | `string` | Output only. The account's email address who has created this saved query. | +| `labels` | `object` | Labels applied on the resource. This value should not contain more than 10 entries. The key and value of each entry must be non-empty and fewer than 64 characters. | +| `lastUpdateTime` | `string` | Output only. The last update time of this saved query. | +| `lastUpdater` | `string` | Output only. The account's email address who has updated this saved query most recently. | +| `content` | `object` | The query content. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `name` | Gets details about a saved query. | | `list` | `SELECT` | `parent` | Lists all saved queries in a parent project/folder/organization. | | `create` | `INSERT` | `parent` | Creates a saved query in a parent project/folder/organization. | +| `delete` | `DELETE` | `name` | Deletes a saved query. | +| `_list` | `EXEC` | `parent` | Lists all saved queries in a parent project/folder/organization. | +| `patch` | `EXEC` | `name` | Updates a saved query. | diff --git a/docs/google-docs/providers/google/cloudbilling/billing_accounts/index.md b/docs/google-docs/providers/google/cloudbilling/billing_accounts/index.md index 6d8442ff93..86dedcd45d 100644 --- a/docs/google-docs/providers/google/cloudbilling/billing_accounts/index.md +++ b/docs/google-docs/providers/google/cloudbilling/billing_accounts/index.md @@ -27,12 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `billingAccounts` | `array` | A list of billing accounts. | -| `nextPageToken` | `string` | A token to retrieve the next page of results. To retrieve the next page, call `ListBillingAccounts` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve. | +| `name` | `string` | Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. | +| `displayName` | `string` | The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. | +| `masterBillingAccount` | `string` | If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. | +| `open` | `boolean` | Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `billingAccountsId` | Gets information about a billing account. The current authenticated user must be a [viewer of the billing account](https://cloud.google.com/billing/docs/how-to/billing-access). | | `list` | `SELECT` | | Lists the billing accounts that the current authenticated user has permission to [view](https://cloud.google.com/billing/docs/how-to/billing-access). | | `create` | `INSERT` | | This method creates [billing subaccounts](https://cloud.google.com/billing/docs/concepts#subaccounts). Google Cloud resellers should use the Channel Services APIs, [accounts.customers.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers/create) and [accounts.customers.entitlements.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers.entitlements/create). When creating a subaccount, the current authenticated user must have the `billing.accounts.update` IAM permission on the parent account, which is typically given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). This method will return an error if the parent account has not been provisioned as a reseller account. | +| `_list` | `EXEC` | | Lists the billing accounts that the current authenticated user has permission to [view](https://cloud.google.com/billing/docs/how-to/billing-access). | | `patch` | `EXEC` | `billingAccountsId` | Updates a billing account's fields. Currently the only field that can be edited is `display_name`. The current authenticated user must have the `billing.accounts.update` IAM permission, which is typically given to the [administrator](https://cloud.google.com/billing/docs/how-to/billing-access) of the billing account. | diff --git a/docs/google-docs/providers/google/cloudbilling/billing_info/index.md b/docs/google-docs/providers/google/cloudbilling/billing_info/index.md index 4fd3254960..11f772429f 100644 --- a/docs/google-docs/providers/google/cloudbilling/billing_info/index.md +++ b/docs/google-docs/providers/google/cloudbilling/billing_info/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. | -| `projectId` | `string` | Output only. The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. | | `billingAccountName` | `string` | The resource name of the billing account associated with the project, if any. For example, `billingAccounts/012345-567890-ABCDEF`. | | `billingEnabled` | `boolean` | Output only. True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. | +| `projectId` | `string` | Output only. The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudbilling/index.md b/docs/google-docs/providers/google/cloudbilling/index.md index e78e0536cc..ce4c1e63d3 100644 --- a/docs/google-docs/providers/google/cloudbilling/index.md +++ b/docs/google-docs/providers/google/cloudbilling/index.md @@ -21,7 +21,7 @@ Allows Developers To Manage Billing For Their Google Cloud Platform Projects Pro
total resources: 6
total selectable resources: 6
-total methods: 12
+total methods: 16
@@ -33,7 +33,7 @@ Allows Developers To Manage Billing For Their Google Cloud Platform Projects Pro TypeService TitleCloud Billing API DescriptionAllows Developers To Manage Billing For Their Google Cloud Platform Projects Programmatically. -Idcloudbilling:v23.08.00155 +Idcloudbilling:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/cloudbilling/projects/index.md b/docs/google-docs/providers/google/cloudbilling/projects/index.md index 9bb12d10f1..07660223d5 100644 --- a/docs/google-docs/providers/google/cloudbilling/projects/index.md +++ b/docs/google-docs/providers/google/cloudbilling/projects/index.md @@ -27,9 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to retrieve the next page of results. To retrieve the next page, call `ListProjectBillingInfo` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve. | -| `projectBillingInfo` | `array` | A list of `ProjectBillingInfo` resources representing the projects associated with the billing account. | +| `name` | `string` | Output only. The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. | +| `projectId` | `string` | Output only. The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. | +| `billingAccountName` | `string` | The resource name of the billing account associated with the project, if any. For example, `billingAccounts/012345-567890-ABCDEF`. | +| `billingEnabled` | `boolean` | Output only. True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `billingAccountsId` | +| `_list` | `EXEC` | `billingAccountsId` | diff --git a/docs/google-docs/providers/google/cloudbilling/services/index.md b/docs/google-docs/providers/google/cloudbilling/services/index.md index 819a591620..a3c370b8fc 100644 --- a/docs/google-docs/providers/google/cloudbilling/services/index.md +++ b/docs/google-docs/providers/google/cloudbilling/services/index.md @@ -27,9 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to retrieve the next page of results. To retrieve the next page, call `ListServices` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve. | -| `services` | `array` | A list of services. | +| `name` | `string` | The resource name for the service. Example: "services/DA34-426B-A397" | +| `serviceId` | `string` | The identifier for the service. Example: "DA34-426B-A397" | +| `businessEntityName` | `string` | The business under which the service is offered. Ex. "businessEntities/GCP", "businessEntities/Maps" | +| `displayName` | `string` | A human readable display name for this service. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | | +| `_list` | `EXEC` | | diff --git a/docs/google-docs/providers/google/cloudbilling/skus/index.md b/docs/google-docs/providers/google/cloudbilling/skus/index.md index 7539734746..45ac8beb62 100644 --- a/docs/google-docs/providers/google/cloudbilling/skus/index.md +++ b/docs/google-docs/providers/google/cloudbilling/skus/index.md @@ -27,9 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to retrieve the next page of results. To retrieve the next page, call `ListSkus` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve. | -| `skus` | `array` | The list of public SKUs of the given service. | +| `name` | `string` | The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" | +| `description` | `string` | A human readable description of the SKU, has a maximum length of 256 characters. | +| `serviceProviderName` | `string` | Identifies the service provider. This is 'Google' for first party services in Google Cloud Platform. | +| `serviceRegions` | `array` | List of service regions this SKU is offered at. Example: "asia-east1" Service regions can be found at https://cloud.google.com/about/locations/ | +| `skuId` | `string` | The identifier for the SKU. Example: "AA95-CD31-42FE" | +| `category` | `object` | Represents the category hierarchy of a SKU. | +| `geoTaxonomy` | `object` | Encapsulates the geographic taxonomy data for a sku. | +| `pricingInfo` | `array` | A timeline of pricing info for this SKU in chronological order. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `servicesId` | +| `_list` | `EXEC` | `servicesId` | diff --git a/docs/google-docs/providers/google/cloudbuild/bitbucket_repos/index.md b/docs/google-docs/providers/google/cloudbuild/bitbucket_repos/index.md new file mode 100644 index 0000000000..889a7d68a3 --- /dev/null +++ b/docs/google-docs/providers/google/cloudbuild/bitbucket_repos/index.md @@ -0,0 +1,39 @@ +--- +title: bitbucket_repos +hide_title: false +hide_table_of_contents: false +keywords: + - bitbucket_repos + - cloudbuild + - 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 +--- + + + +## Overview + + + + +
Namebitbucket_repos
TypeResource
Idgoogle.cloudbuild.bitbucket_repos
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | The resource name of the repository. | +| `description` | `string` | Description of the repository. | +| `repoId` | `object` | BitbucketServerRepositoryId identifies a specific repository hosted on a Bitbucket Server. | +| `browseUri` | `string` | Link to the browse repo page on the Bitbucket Server instance. | +| `displayName` | `string` | Display name of the repository. | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `projects_locations_bitbucket_server_configs_repos_list` | `SELECT` | `bitbucketServerConfigsId, locationsId, projectsId` | +| `_projects_locations_bitbucket_server_configs_repos_list` | `EXEC` | `bitbucketServerConfigsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/cloudbuild/bitbucket_server_configs/index.md b/docs/google-docs/providers/google/cloudbuild/bitbucket_server_configs/index.md index 347692a33a..56c77f7a9d 100644 --- a/docs/google-docs/providers/google/cloudbuild/bitbucket_server_configs/index.md +++ b/docs/google-docs/providers/google/cloudbuild/bitbucket_server_configs/index.md @@ -27,8 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bitbucketServerConfigs` | `array` | A list of BitbucketServerConfigs | -| `nextPageToken` | `string` | A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | The resource name for the config. | +| `createTime` | `string` | Time when the config was created. | +| `secrets` | `object` | BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. | +| `apiKey` | `string` | Required. Immutable. API Key that will be attached to webhook. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. | +| `connectedRepositories` | `array` | Output only. Connected Bitbucket Server repositories for this config. | +| `peeredNetwork` | `string` | Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. | +| `username` | `string` | Username of the account Cloud Build will use on Bitbucket Server. | +| `webhookKey` | `string` | Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config. | +| `hostUri` | `string` | Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. | +| `sslCa` | `string` | Optional. SSL certificate to use for requests to Bitbucket Server. The format should be PEM format but the extension can be one of .pem, .cer, or .crt. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_bitbucket_server_configs_list` | `SELECT` | `locationsId, projectsId` | List all `BitbucketServerConfigs` for a given project. This API is experimental. | | `projects_locations_bitbucket_server_configs_create` | `INSERT` | `locationsId, projectsId` | Creates a new `BitbucketServerConfig`. This API is experimental. | | `projects_locations_bitbucket_server_configs_delete` | `DELETE` | `bitbucketServerConfigsId, locationsId, projectsId` | Delete a `BitbucketServerConfig`. This API is experimental. | +| `_projects_locations_bitbucket_server_configs_list` | `EXEC` | `locationsId, projectsId` | List all `BitbucketServerConfigs` for a given project. This API is experimental. | | `projects_locations_bitbucket_server_configs_patch` | `EXEC` | `bitbucketServerConfigsId, locationsId, projectsId` | Updates an existing `BitbucketServerConfig`. This API is experimental. | diff --git a/docs/google-docs/providers/google/cloudbuild/builds/index.md b/docs/google-docs/providers/google/cloudbuild/builds/index.md index a630f56f56..9e504e5ef0 100644 --- a/docs/google-docs/providers/google/cloudbuild/builds/index.md +++ b/docs/google-docs/providers/google/cloudbuild/builds/index.md @@ -27,8 +27,35 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `builds` | `array` | Builds will be sorted by `create_time`, descending. | -| `nextPageToken` | `string` | Token to receive the next page of results. This will be absent if the end of the response list has been reached. | +| `id` | `string` | Output only. Unique identifier of the build. | +| `name` | `string` | Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service. | +| `options` | `object` | Optional arguments to enable specific features of builds. | +| `warnings` | `array` | Output only. Non-fatal problems encountered during the execution of the build. | +| `buildTriggerId` | `string` | Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. | +| `projectId` | `string` | Output only. ID of the project. | +| `approval` | `object` | BuildApproval describes a build's approval configuration, state, and result. | +| `startTime` | `string` | Output only. Time at which execution of the build was started. | +| `timeout` | `string` | Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is 60 minutes. | +| `images` | `array` | A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. | +| `logsBucket` | `string` | Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. | +| `statusDetail` | `string` | Output only. Customer-readable message about the current status. | +| `sourceProvenance` | `object` | Provenance of the source. Ways to find the original source, or verify that some source was used for this build. | +| `source` | `object` | Location of the source in a supported storage service. | +| `logUrl` | `string` | Output only. URL to logs for this build in Google Cloud Console. | +| `substitutions` | `object` | Substitutions data for `Build` resource. | +| `timing` | `object` | Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included. | +| `secrets` | `array` | Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use `available_secrets` to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets | +| `createTime` | `string` | Output only. Time at which the request to create the build was received. | +| `failureInfo` | `object` | A fatal problem encountered during the execution of the build. | +| `availableSecrets` | `object` | Secrets and secret environment variables. | +| `results` | `object` | Artifacts created by the build pipeline. | +| `status` | `string` | Output only. Status of the build. | +| `serviceAccount` | `string` | IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. | +| `finishTime` | `string` | Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. | +| `queueTtl` | `string` | TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time. | +| `artifacts` | `object` | Artifacts produced by a build that should be uploaded upon successful completion of all build steps. | +| `steps` | `array` | Required. The operations to be performed on the workspace. | +| `tags` | `array` | Tags for annotation of a `Build`. These are not docker tags. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +63,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_builds_list` | `SELECT` | `locationsId, projectsId` | Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. | | `projects_builds_create` | `INSERT` | `projectId` | Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). | | `projects_locations_builds_create` | `INSERT` | `locationsId, projectsId` | Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). | +| `_projects_builds_list` | `EXEC` | `projectId` | Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. | +| `_projects_locations_builds_list` | `EXEC` | `locationsId, projectsId` | Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. | | `projects_builds_approve` | `EXEC` | `buildsId, projectsId` | Approves or rejects a pending build. If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call. If rejected, the returned LRO will be immediately done. | | `projects_builds_cancel` | `EXEC` | `id, projectId` | Cancels a build in progress. | | `projects_builds_get` | `EXEC` | `id, projectId` | Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. | diff --git a/docs/google-docs/providers/google/cloudbuild/gitlab_configs/index.md b/docs/google-docs/providers/google/cloudbuild/gitlab_configs/index.md index 1445cc40e4..aa1429e816 100644 --- a/docs/google-docs/providers/google/cloudbuild/gitlab_configs/index.md +++ b/docs/google-docs/providers/google/cloudbuild/gitlab_configs/index.md @@ -27,8 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `gitlabConfigs` | `array` | A list of GitLabConfigs | -| `nextPageToken` | `string` | A token that can be sent as `page_token` to retrieve the next page If this field is omitted, there are no subsequent pages. | +| `name` | `string` | The resource name for the config. | +| `secrets` | `object` | GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. | +| `username` | `string` | Username of the GitLab.com or GitLab Enterprise account Cloud Build will use. | +| `webhookKey` | `string` | Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config. | +| `connectedRepositories` | `array` | Connected GitLab.com or GitLabEnterprise repositories for this config. | +| `createTime` | `string` | Output only. Time when the config was created. | +| `enterpriseConfig` | `object` | GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +41,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_gitlab_configs_list` | `SELECT` | `locationsId, projectsId` | List all `GitLabConfigs` for a given project. This API is experimental | | `projects_locations_gitlab_configs_create` | `INSERT` | `locationsId, projectsId` | Creates a new `GitLabConfig`. This API is experimental | | `projects_locations_gitlab_configs_delete` | `DELETE` | `gitLabConfigsId, locationsId, projectsId` | Delete a `GitLabConfig`. This API is experimental | +| `_projects_locations_gitlab_configs_list` | `EXEC` | `locationsId, projectsId` | List all `GitLabConfigs` for a given project. This API is experimental | | `projects_locations_gitlab_configs_patch` | `EXEC` | `gitLabConfigsId, locationsId, projectsId` | Updates an existing `GitLabConfig`. This API is experimental | diff --git a/docs/google-docs/providers/google/cloudbuild/gitlab_repos/index.md b/docs/google-docs/providers/google/cloudbuild/gitlab_repos/index.md new file mode 100644 index 0000000000..8cae860dd4 --- /dev/null +++ b/docs/google-docs/providers/google/cloudbuild/gitlab_repos/index.md @@ -0,0 +1,39 @@ +--- +title: gitlab_repos +hide_title: false +hide_table_of_contents: false +keywords: + - gitlab_repos + - cloudbuild + - 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 +--- + + + +## Overview + + + + +
Namegitlab_repos
TypeResource
Idgoogle.cloudbuild.gitlab_repos
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | The resource name of the repository | +| `description` | `string` | Description of the repository | +| `repositoryId` | `object` | GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise | +| `browseUri` | `string` | Link to the browse repo page on the GitLab instance | +| `displayName` | `string` | Display name of the repository | +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `projects_locations_gitlab_configs_repos_list` | `SELECT` | `gitLabConfigsId, locationsId, projectsId` | +| `_projects_locations_gitlab_configs_repos_list` | `EXEC` | `gitLabConfigsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/cloudbuild/index.md b/docs/google-docs/providers/google/cloudbuild/index.md index 7cd470850e..6ff33ef156 100644 --- a/docs/google-docs/providers/google/cloudbuild/index.md +++ b/docs/google-docs/providers/google/cloudbuild/index.md @@ -19,9 +19,9 @@ Creates And Manages Builds On Google Cloud Platform.
-total resources: 14
-total selectable resources: 7
-total methods: 64
+total resources: 15
+total selectable resources: 8
+total methods: 73
@@ -33,12 +33,13 @@ Creates And Manages Builds On Google Cloud Platform. TypeService TitleCloud Build API DescriptionCreates And Manages Builds On Google Cloud Platform. -Idcloudbuild:v23.08.00155 +Idcloudbuild:v23.08.00157 ## Resources
+bitbucket_repos
bitbucket_server_configs
bitbucket_server_configs_bitbucket_server_connected_repository
builds
@@ -50,9 +51,9 @@ Creates And Manages Builds On Google Cloud Platform.
gitlab_configs
gitlab_configs_gitlab_connected_repository
+gitlab_repos
locations
operations
-repos
triggers
worker_pools
diff --git a/docs/google-docs/providers/google/cloudbuild/triggers/index.md b/docs/google-docs/providers/google/cloudbuild/triggers/index.md index 183887f669..eabc2505b7 100644 --- a/docs/google-docs/providers/google/cloudbuild/triggers/index.md +++ b/docs/google-docs/providers/google/cloudbuild/triggers/index.md @@ -27,8 +27,33 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `triggers` | `array` | `BuildTriggers` for the project, sorted by `create_time` descending. | -| `nextPageToken` | `string` | Token to receive the next page of results. | +| `id` | `string` | Output only. Unique identifier of the trigger. | +| `name` | `string` | User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. | +| `description` | `string` | Human-readable description of this trigger. | +| `bitbucketServerTriggerConfig` | `object` | BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. | +| `createTime` | `string` | Output only. Time when the trigger was created. | +| `includedFiles` | `array` | If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build. | +| `filter` | `string` | A Common Expression Language string. | +| `approvalConfig` | `object` | ApprovalConfig describes configuration for manual approval of a build. | +| `gitFileSource` | `object` | GitFileSource describes a file within a (possibly remote) code repository. | +| `disabled` | `boolean` | If true, the trigger will never automatically execute a build. | +| `pubsubConfig` | `object` | PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. | +| `github` | `object` | GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. | +| `repositoryEventConfig` | `object` | The configuration of a trigger that creates a build whenever an event from Repo API is received. | +| `tags` | `array` | Tags for annotation of a `BuildTrigger` | +| `webhookConfig` | `object` | WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL. | +| `triggerTemplate` | `object` | Location of the source in a Google Cloud Source Repository. | +| `build` | `object` | A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. | +| `eventType` | `string` | EventType allows the user to explicitly set the type of event to which this BuildTrigger should respond. This field will be validated against the rest of the configuration if it is set. | +| `serviceAccount` | `string` | The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` | +| `resourceName` | `string` | The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. | +| `sourceToBuild` | `object` | GitRepoSource describes a repo and ref of a code repository. | +| `substitutions` | `object` | Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. | +| `gitlabEnterpriseEventsConfig` | `object` | GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. | +| `autodetect` | `boolean` | Autodetect build configuration. The following precedence is used (case insensitive): 1. cloudbuild.yaml 2. cloudbuild.yml 3. cloudbuild.json 4. Dockerfile Currently only available for GitHub App Triggers. | +| `filename` | `string` | Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). | +| `ignoredFiles` | `array` | ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. | +| `includeBuildLogs` | `string` | If set to INCLUDE_BUILD_LOGS_WITH_STATUS, log url will be shown on GitHub page when build status is final. Setting this field to INCLUDE_BUILD_LOGS_WITH_STATUS for non GitHub triggers results in INVALID_ARGUMENT error. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,6 +63,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_triggers_create` | `INSERT` | `projectId` | Creates a new `BuildTrigger`. This API is experimental. | | `projects_locations_triggers_delete` | `DELETE` | `locationsId, projectsId, triggersId` | Deletes a `BuildTrigger` by its project ID and trigger ID. This API is experimental. | | `projects_triggers_delete` | `DELETE` | `projectId, triggerId` | Deletes a `BuildTrigger` by its project ID and trigger ID. This API is experimental. | +| `_projects_locations_triggers_list` | `EXEC` | `locationsId, projectsId` | Lists existing `BuildTrigger`s. This API is experimental. | +| `_projects_triggers_list` | `EXEC` | `projectId` | Lists existing `BuildTrigger`s. This API is experimental. | | `projects_locations_triggers_get` | `EXEC` | `locationsId, projectsId, triggersId` | Returns information about a `BuildTrigger`. This API is experimental. | | `projects_locations_triggers_patch` | `EXEC` | `locationsId, projectsId, triggersId` | Updates a `BuildTrigger` by its project ID and trigger ID. This API is experimental. | | `projects_locations_triggers_run` | `EXEC` | `locationsId, projectsId, triggersId` | Runs a `BuildTrigger` at a particular source revision. To run a regional or global trigger, use the POST request that includes the location endpoint in the path (ex. v1/projects/{projectId}/locations/{region}/triggers/{triggerId}:run). The POST request that does not include the location endpoint in the path can only be used when running global triggers. | diff --git a/docs/google-docs/providers/google/cloudbuild/worker_pools/index.md b/docs/google-docs/providers/google/cloudbuild/worker_pools/index.md index 0f577d93ab..f86d1dd6e8 100644 --- a/docs/google-docs/providers/google/cloudbuild/worker_pools/index.md +++ b/docs/google-docs/providers/google/cloudbuild/worker_pools/index.md @@ -27,13 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Continuation token used to page through large result sets. Provide this value in a subsequent ListWorkerPoolsRequest to return the next page of results. | -| `workerPools` | `array` | `WorkerPools` for the specified project. | +| `name` | `string` | Output only. The resource name of the `WorkerPool`, with format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. The value of `{worker_pool}` is provided by `worker_pool_id` in `CreateWorkerPool` request and the value of `{location}` is determined by the endpoint accessed. | +| `state` | `string` | Output only. `WorkerPool` state. | +| `uid` | `string` | Output only. A unique identifier for the `WorkerPool`. | +| `displayName` | `string` | A user-specified, human-readable name for the `WorkerPool`. If provided, this value must be 1-63 characters. | +| `createTime` | `string` | Output only. Time at which the request to create the `WorkerPool` was received. | +| `annotations` | `object` | User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations. | +| `deleteTime` | `string` | Output only. Time at which the request to delete the `WorkerPool` was received. | +| `updateTime` | `string` | Output only. Time at which the request to update the `WorkerPool` was received. | +| `privatePoolV1Config` | `object` | Configuration for a V1 `PrivatePool`. | +| `etag` | `string` | Output only. Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_worker_pools_list` | `SELECT` | `locationsId, projectsId` | Lists `WorkerPool`s. | | `projects_locations_worker_pools_create` | `INSERT` | `locationsId, projectsId` | Creates a `WorkerPool`. | | `projects_locations_worker_pools_delete` | `DELETE` | `locationsId, projectsId, workerPoolsId` | Deletes a `WorkerPool`. | +| `_projects_locations_worker_pools_list` | `EXEC` | `locationsId, projectsId` | Lists `WorkerPool`s. | | `projects_locations_worker_pools_get` | `EXEC` | `locationsId, projectsId, workerPoolsId` | Returns details of a `WorkerPool`. | | `projects_locations_worker_pools_patch` | `EXEC` | `locationsId, projectsId, workerPoolsId` | Updates a `WorkerPool`. | diff --git a/docs/google-docs/providers/google/clouddeploy/config/index.md b/docs/google-docs/providers/google/clouddeploy/config/index.md index e81732e07c..ae64579241 100644 --- a/docs/google-docs/providers/google/clouddeploy/config/index.md +++ b/docs/google-docs/providers/google/clouddeploy/config/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Name of the configuration. | -| `supportedVersions` | `array` | All supported versions of Skaffold. | | `defaultSkaffoldVersion` | `string` | Default Skaffold version that is assigned when a Release is created without specifying a Skaffold version. | +| `supportedVersions` | `array` | All supported versions of Skaffold. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/clouddeploy/delivery_pipelines/index.md b/docs/google-docs/providers/google/clouddeploy/delivery_pipelines/index.md index 7683fa8532..50081c3daf 100644 --- a/docs/google-docs/providers/google/clouddeploy/delivery_pipelines/index.md +++ b/docs/google-docs/providers/google/clouddeploy/delivery_pipelines/index.md @@ -27,9 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `deliveryPipelines` | `array` | The `DeliveryPipeline` objects. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Optional. Name of the `DeliveryPipeline`. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}. | +| `description` | `string` | Description of the `DeliveryPipeline`. Max length is 255 characters. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `labels` | `object` | Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. | +| `serialPipeline` | `object` | SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`. | +| `condition` | `object` | PipelineCondition contains all conditions relevant to a Delivery Pipeline. | +| `uid` | `string` | Output only. Unique identifier of the `DeliveryPipeline`. | +| `suspended` | `boolean` | When suspended, no new releases or rollouts can be created, but in-progress ones will complete. | +| `annotations` | `object` | User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. | +| `updateTime` | `string` | Output only. Most recent time at which the pipeline was updated. | +| `createTime` | `string` | Output only. Time at which the pipeline was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +45,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists DeliveryPipelines in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new DeliveryPipeline in a given project and location. | | `delete` | `DELETE` | `deliveryPipelinesId, locationsId, projectsId` | Deletes a single DeliveryPipeline. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists DeliveryPipelines in a given project and location. | | `patch` | `EXEC` | `deliveryPipelinesId, locationsId, projectsId` | Updates the parameters of a single DeliveryPipeline. | diff --git a/docs/google-docs/providers/google/clouddeploy/delivery_pipelines_iam_policies/index.md b/docs/google-docs/providers/google/clouddeploy/delivery_pipelines_iam_policies/index.md index d8042f8dcf..56affa6576 100644 --- a/docs/google-docs/providers/google/clouddeploy/delivery_pipelines_iam_policies/index.md +++ b/docs/google-docs/providers/google/clouddeploy/delivery_pipelines_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/clouddeploy/index.md b/docs/google-docs/providers/google/clouddeploy/index.md index e11e4b5ab5..48fa788883 100644 --- a/docs/google-docs/providers/google/clouddeploy/index.md +++ b/docs/google-docs/providers/google/clouddeploy/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 10
total selectable resources: 10
-total methods: 38
+total methods: 45
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleCloud Deploy API Description -Idclouddeploy:v23.08.00155 +Idclouddeploy:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/clouddeploy/job_runs/index.md b/docs/google-docs/providers/google/clouddeploy/job_runs/index.md index 618f640a58..0dba00a21d 100644 --- a/docs/google-docs/providers/google/clouddeploy/job_runs/index.md +++ b/docs/google-docs/providers/google/clouddeploy/job_runs/index.md @@ -28,21 +28,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Optional. Name of the `JobRun`. Format is projects/{project}/locations/{location}/ deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/ {rollouts}/jobRuns/{uuid}. | -| `advanceChildRolloutJobRun` | `object` | AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout `JobRun`. | -| `verifyJobRun` | `object` | VerifyJobRun contains information specific to a verify `JobRun`. | -| `endTime` | `string` | Output only. Time at which the `JobRun` ended. | | `etag` | `string` | Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | | `uid` | `string` | Output only. Unique identifier of the `JobRun`. | -| `phaseId` | `string` | Output only. ID of the `Rollout` phase this `JobRun` belongs in. | +| `createTime` | `string` | Output only. Time at which the `JobRun` was created. | | `state` | `string` | Output only. The current state of the `JobRun`. | +| `predeployJobRun` | `object` | PredeployJobRun contains information specific to a predeploy `JobRun`. | +| `advanceChildRolloutJobRun` | `object` | AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout `JobRun`. | +| `postdeployJobRun` | `object` | PostdeployJobRun contains information specific to a postdeploy `JobRun`. | +| `endTime` | `string` | Output only. Time at which the `JobRun` ended. | +| `verifyJobRun` | `object` | VerifyJobRun contains information specific to a verify `JobRun`. | +| `phaseId` | `string` | Output only. ID of the `Rollout` phase this `JobRun` belongs in. | +| `jobId` | `string` | Output only. ID of the `Rollout` job this `JobRun` corresponds to. | +| `createChildRolloutJobRun` | `object` | CreateChildRolloutJobRun contains information specific to a createChildRollout `JobRun`. | | `deployJobRun` | `object` | DeployJobRun contains information specific to a deploy `JobRun`. | | `startTime` | `string` | Output only. Time at which the `JobRun` was started. | -| `createChildRolloutJobRun` | `object` | CreateChildRolloutJobRun contains information specific to a createChildRollout `JobRun`. | -| `createTime` | `string` | Output only. Time at which the `JobRun` was created. | -| `jobId` | `string` | Output only. ID of the `Rollout` job this `JobRun` corresponds to. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `deliveryPipelinesId, jobRunsId, locationsId, projectsId, releasesId, rolloutsId` | Gets details of a single JobRun. | | `list` | `SELECT` | `deliveryPipelinesId, locationsId, projectsId, releasesId, rolloutsId` | Lists JobRuns in a given project and location. | +| `_list` | `EXEC` | `deliveryPipelinesId, locationsId, projectsId, releasesId, rolloutsId` | Lists JobRuns in a given project and location. | | `terminate` | `EXEC` | `deliveryPipelinesId, jobRunsId, locationsId, projectsId, releasesId, rolloutsId` | Terminates a Job Run in a given project and location. | diff --git a/docs/google-docs/providers/google/clouddeploy/locations/index.md b/docs/google-docs/providers/google/clouddeploy/locations/index.md index d4f08c0bd3..a6017e861d 100644 --- a/docs/google-docs/providers/google/clouddeploy/locations/index.md +++ b/docs/google-docs/providers/google/clouddeploy/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/clouddeploy/operations/index.md b/docs/google-docs/providers/google/clouddeploy/operations/index.md index a88b772c2a..2074bb20ee 100644 --- a/docs/google-docs/providers/google/clouddeploy/operations/index.md +++ b/docs/google-docs/providers/google/clouddeploy/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/clouddeploy/releases/index.md b/docs/google-docs/providers/google/clouddeploy/releases/index.md index 309021d964..5aa1b5eeab 100644 --- a/docs/google-docs/providers/google/clouddeploy/releases/index.md +++ b/docs/google-docs/providers/google/clouddeploy/releases/index.md @@ -27,13 +27,32 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `releases` | `array` | The `Release` objects. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | Optional. Name of the `Release`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/a-z{0,62}. | +| `description` | `string` | Description of the `Release`. Max length is 255 characters. | +| `renderStartTime` | `string` | Output only. Time at which the render began. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `skaffoldVersion` | `string` | The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set of versions. If unset, the most recent supported Skaffold version will be used. | +| `skaffoldConfigPath` | `string` | Filepath of the Skaffold config inside of the config URI. | +| `targetSnapshots` | `array` | Output only. Snapshot of the targets taken at release creation time. | +| `deployParameters` | `object` | Optional. The deploy parameters to use for all targets in this release. | +| `abandoned` | `boolean` | Output only. Indicates whether this is an abandoned release. | +| `skaffoldConfigUri` | `string` | Cloud Storage URI of tar.gz archive containing Skaffold configuration. | +| `uid` | `string` | Output only. Unique identifier of the `Release`. | +| `labels` | `object` | Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. | +| `renderEndTime` | `string` | Output only. Time at which the render completed. | +| `targetArtifacts` | `object` | Output only. Map from target ID to the target artifacts created during the render operation. | +| `buildArtifacts` | `array` | List of artifacts to pass through to Skaffold command. | +| `deliveryPipelineSnapshot` | `object` | A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. | +| `condition` | `object` | ReleaseCondition contains all conditions relevant to a Release. | +| `annotations` | `object` | User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations. | +| `targetRenders` | `object` | Output only. Map from target ID to details of the render operation for that target. | +| `createTime` | `string` | Output only. Time at which the `Release` was created. | +| `renderState` | `string` | Output only. Current state of the render operation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `deliveryPipelinesId, locationsId, projectsId, releasesId` | Gets details of a single Release. | | `list` | `SELECT` | `deliveryPipelinesId, locationsId, projectsId` | Lists Releases in a given project and location. | | `create` | `INSERT` | `deliveryPipelinesId, locationsId, projectsId` | Creates a new Release in a given project and location. | +| `_list` | `EXEC` | `deliveryPipelinesId, locationsId, projectsId` | Lists Releases in a given project and location. | | `abandon` | `EXEC` | `deliveryPipelinesId, locationsId, projectsId, releasesId` | Abandons a Release in the Delivery Pipeline. | diff --git a/docs/google-docs/providers/google/clouddeploy/rollouts/index.md b/docs/google-docs/providers/google/clouddeploy/rollouts/index.md index 29340642a3..e94b1e87f2 100644 --- a/docs/google-docs/providers/google/clouddeploy/rollouts/index.md +++ b/docs/google-docs/providers/google/clouddeploy/rollouts/index.md @@ -27,15 +27,33 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `rollouts` | `array` | The `Rollout` objects. | -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Optional. Name of the `Rollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}. | +| `description` | `string` | Description of the `Rollout` for user purposes. Max length is 255 characters. | +| `phases` | `array` | Output only. The phases that represent the workflows of this `Rollout`. | +| `labels` | `object` | Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `approveTime` | `string` | Output only. Time at which the `Rollout` was approved. | +| `state` | `string` | Output only. Current state of the `Rollout`. | +| `targetId` | `string` | Required. The ID of Target to which this `Rollout` is deploying. | +| `uid` | `string` | Output only. Unique identifier of the `Rollout`. | +| `metadata` | `object` | Metadata includes information associated with a `Rollout`. | +| `failureReason` | `string` | Output only. Additional information about the rollout failure, if available. | +| `annotations` | `object` | User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations. | +| `enqueueTime` | `string` | Output only. Time at which the `Rollout` was enqueued. | +| `controllerRollout` | `string` | Output only. Name of the `ControllerRollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}. | +| `deployStartTime` | `string` | Output only. Time at which the `Rollout` started deploying. | +| `createTime` | `string` | Output only. Time at which the `Rollout` was created. | +| `deployFailureCause` | `string` | Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress. | +| `deployEndTime` | `string` | Output only. Time at which the `Rollout` finished deploying. | +| `approvalState` | `string` | Output only. Approval state of the `Rollout`. | +| `deployingBuild` | `string` | Output only. The resource name of the Cloud Build `Build` object that is used to deploy the Rollout. Format is `projects/{project}/locations/{location}/builds/{build}`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `deliveryPipelinesId, locationsId, projectsId, releasesId, rolloutsId` | Gets details of a single Rollout. | | `list` | `SELECT` | `deliveryPipelinesId, locationsId, projectsId, releasesId` | Lists Rollouts in a given project and location. | | `create` | `INSERT` | `deliveryPipelinesId, locationsId, projectsId, releasesId` | Creates a new Rollout in a given project and location. | +| `_list` | `EXEC` | `deliveryPipelinesId, locationsId, projectsId, releasesId` | Lists Rollouts in a given project and location. | | `advance` | `EXEC` | `deliveryPipelinesId, locationsId, projectsId, releasesId, rolloutsId` | Advances a Rollout in a given project and location. | | `approve` | `EXEC` | `deliveryPipelinesId, locationsId, projectsId, releasesId, rolloutsId` | Approves a Rollout. | | `cancel` | `EXEC` | `deliveryPipelinesId, locationsId, projectsId, releasesId, rolloutsId` | Cancels a Rollout in a given project and location. | diff --git a/docs/google-docs/providers/google/clouddeploy/targets/index.md b/docs/google-docs/providers/google/clouddeploy/targets/index.md index 2276249dee..0c6e349769 100644 --- a/docs/google-docs/providers/google/clouddeploy/targets/index.md +++ b/docs/google-docs/providers/google/clouddeploy/targets/index.md @@ -27,9 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `targets` | `array` | The `Target` objects. | -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Optional. Name of the `Target`. Format is projects/{project}/locations/{location}/targets/a-z{0,62}. | +| `description` | `string` | Optional. Description of the `Target`. Max length is 255 characters. | +| `annotations` | `object` | Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations. | +| `createTime` | `string` | Output only. Time at which the `Target` was created. | +| `run` | `object` | Information specifying where to deploy a Cloud Run Service. | +| `labels` | `object` | Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. | +| `multiTarget` | `object` | Information specifying a multiTarget. | +| `anthosCluster` | `object` | Information specifying an Anthos Cluster. | +| `targetId` | `string` | Output only. Resource id of the `Target`. | +| `uid` | `string` | Output only. Unique identifier of the `Target`. | +| `requireApproval` | `boolean` | Optional. Whether or not the `Target` requires approval. | +| `etag` | `string` | Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `executionConfigs` | `array` | Configurations for all execution that relates to this `Target`. Each `ExecutionEnvironmentUsage` value may only be used in a single configuration; using the same value multiple times is an error. When one or more configurations are specified, they must include the `RENDER` and `DEPLOY` `ExecutionEnvironmentUsage` values. When no configurations are specified, execution will use the default specified in `DefaultPool`. | +| `updateTime` | `string` | Output only. Most recent time at which the `Target` was updated. | +| `gke` | `object` | Information specifying a GKE Cluster. | +| `deployParameters` | `object` | Optional. The deploy parameters to use for this target. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +50,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists Targets in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new Target in a given project and location. | | `delete` | `DELETE` | `locationsId, projectsId, targetsId` | Deletes a single Target. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Targets in a given project and location. | | `patch` | `EXEC` | `locationsId, projectsId, targetsId` | Updates the parameters of a single Target. | diff --git a/docs/google-docs/providers/google/clouddeploy/targets_iam_policies/index.md b/docs/google-docs/providers/google/clouddeploy/targets_iam_policies/index.md index 1c25875d26..7b7c9ee0d5 100644 --- a/docs/google-docs/providers/google/clouddeploy/targets_iam_policies/index.md +++ b/docs/google-docs/providers/google/clouddeploy/targets_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/clouderrorreporting/events/index.md b/docs/google-docs/providers/google/clouderrorreporting/events/index.md index 5c8b709e59..16723f6269 100644 --- a/docs/google-docs/providers/google/clouderrorreporting/events/index.md +++ b/docs/google-docs/providers/google/clouderrorreporting/events/index.md @@ -27,12 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If non-empty, more results are available. Pass this token, along with the same query parameters as the first request, to view the next page of results. | -| `timeRangeBegin` | `string` | The timestamp specifies the start time to which the request was restricted. | -| `errorEvents` | `array` | The error events which match the given request. | +| `message` | `string` | The stack trace that was reported or logged by the service. | +| `serviceContext` | `object` | Describes a running service that sends errors. Its version changes over time and multiple versions can run in parallel. | +| `context` | `object` | A description of the context in which an error occurred. This data should be provided by the application when reporting an error, unless the error report has been generated automatically from Google App Engine logs. | +| `eventTime` | `string` | Time when the event occurred as provided in the error report. If the report did not contain a timestamp, the time the error was received by the Error Reporting system is used. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `list` | `SELECT` | `projectsId` | Lists the specified events. | | `delete_events` | `DELETE` | `projectsId` | Deletes all error events of a given project. | +| `_list` | `EXEC` | `projectsId` | Lists the specified events. | | `report` | `EXEC` | `projectsId` | Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects. | diff --git a/docs/google-docs/providers/google/clouderrorreporting/group_stats/index.md b/docs/google-docs/providers/google/clouderrorreporting/group_stats/index.md index 46abeab079..8a345b3b73 100644 --- a/docs/google-docs/providers/google/clouderrorreporting/group_stats/index.md +++ b/docs/google-docs/providers/google/clouderrorreporting/group_stats/index.md @@ -27,10 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `timeRangeBegin` | `string` | The timestamp specifies the start time to which the request was restricted. The start time is set based on the requested time range. It may be adjusted to a later time if a project has exceeded the storage quota and older data has been deleted. | -| `errorGroupStats` | `array` | The error group stats which match the given request. | -| `nextPageToken` | `string` | If non-empty, more results are available. Pass this token, along with the same query parameters as the first request, to view the next page of results. | +| `count` | `string` | Approximate total number of events in the given group that match the filter criteria. | +| `affectedUsersCount` | `string` | Approximate number of affected users in the given group that match the filter criteria. Users are distinguished by data in the ErrorContext of the individual error events, such as their login name or their remote IP address in case of HTTP requests. The number of affected users can be zero even if the number of errors is non-zero if no data was provided from which the affected user could be deduced. Users are counted based on data in the request context that was provided in the error report. If more users are implicitly affected, such as due to a crash of the whole service, this is not reflected here. | +| `representative` | `object` | An error event which is returned by the Error Reporting system. | +| `timedCounts` | `array` | Approximate number of occurrences over time. Timed counts returned by ListGroups are guaranteed to be: - Inside the requested time interval - Non-overlapping, and - Ordered by ascending time. | +| `group` | `object` | Description of a group of similar error events. | +| `lastSeenTime` | `string` | Approximate last occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request. | +| `affectedServices` | `array` | Service contexts with a non-zero error count for the given filter criteria. This list can be truncated if multiple services are affected. Refer to `num_affected_services` for the total count. | +| `firstSeenTime` | `string` | Approximate first occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request. | +| `numAffectedServices` | `integer` | The total number of services with a non-zero error count for the given filter criteria. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `projectsId` | +| `_list` | `EXEC` | `projectsId` | diff --git a/docs/google-docs/providers/google/clouderrorreporting/groups/index.md b/docs/google-docs/providers/google/clouderrorreporting/groups/index.md index 98e1ef41a2..5d8d9add1e 100644 --- a/docs/google-docs/providers/google/clouderrorreporting/groups/index.md +++ b/docs/google-docs/providers/google/clouderrorreporting/groups/index.md @@ -27,7 +27,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | The group resource name. Example: projects/my-project-123/groups/CNSgkpnppqKCUw | +| `name` | `string` | The group resource name. Written as `projects/{projectID}/groups/{group_id}`. Example: `projects/my-project-123/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). | | `groupId` | `string` | Group IDs are unique for a given project. If the same kind of error occurs in different service contexts, it will receive the same group ID. | | `resolutionStatus` | `string` | Error group's resolution status. An unspecified resolution status will be interpreted as OPEN | | `trackingIssues` | `array` | Associated tracking issues. | diff --git a/docs/google-docs/providers/google/clouderrorreporting/index.md b/docs/google-docs/providers/google/clouderrorreporting/index.md index 86364c10a9..bf7368d756 100644 --- a/docs/google-docs/providers/google/clouderrorreporting/index.md +++ b/docs/google-docs/providers/google/clouderrorreporting/index.md @@ -21,7 +21,7 @@ Groups And Counts Similar Errors From Cloud Services And Applications, Reports N
total resources: 3
total selectable resources: 3
-total methods: 6
+total methods: 8
@@ -33,7 +33,7 @@ Groups And Counts Similar Errors From Cloud Services And Applications, Reports N TypeService TitleError Reporting API DescriptionGroups And Counts Similar Errors From Cloud Services And Applications, Reports New Errors, And Provides Access To Error Groups And Their Associated Errors. -Idclouderrorreporting:v23.08.00155 +Idclouderrorreporting:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/cloudfunctions/functions/index.md b/docs/google-docs/providers/google/cloudfunctions/functions/index.md index 318385f786..30c4c90a24 100644 --- a/docs/google-docs/providers/google/cloudfunctions/functions/index.md +++ b/docs/google-docs/providers/google/cloudfunctions/functions/index.md @@ -27,9 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `unreachable` | `array` | Locations that could not be reached. The response does not include any functions from these locations. | -| `functions` | `array` | The functions that match the request. | +| `name` | `string` | A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*` | +| `description` | `string` | User-provided description of a function. | +| `kmsKeyName` | `string` | [Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. | +| `environment` | `string` | Describe whether the function is 1st Gen or 2nd Gen. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `serviceConfig` | `object` | Describes the Service being deployed. Currently Supported : Cloud Run (fully managed). | +| `state` | `string` | Output only. State of the function. | +| `buildConfig` | `object` | Describes the Build step of the function that builds a container from the given source. | +| `labels` | `object` | Labels associated with this Cloud Function. | +| `url` | `string` | Output only. The deployed url for the function. | +| `eventTrigger` | `object` | Describes EventTrigger, used to request events to be sent from another service. | +| `updateTime` | `string` | Output only. The last update timestamp of a Cloud Function. | +| `stateMessages` | `array` | Output only. State Messages for this Cloud Function. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +47,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Returns a list of functions that belong to the requested project. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error. | | `delete` | `DELETE` | `functionsId, locationsId, projectsId` | Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function. | +| `_list` | `EXEC` | `locationsId, projectsId` | Returns a list of functions that belong to the requested project. | | `generate_download_url` | `EXEC` | `functionsId, locationsId, projectsId` | Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within 30 minutes of generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls | | `generate_upload_url` | `EXEC` | `locationsId, projectsId` | Returns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls. Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code. When uploading source code to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN` | | `patch` | `EXEC` | `functionsId, locationsId, projectsId` | Updates existing function. | diff --git a/docs/google-docs/providers/google/cloudfunctions/functions_iam_policies/index.md b/docs/google-docs/providers/google/cloudfunctions/functions_iam_policies/index.md index a968e26857..23eaaf89a0 100644 --- a/docs/google-docs/providers/google/cloudfunctions/functions_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudfunctions/functions_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudfunctions/index.md b/docs/google-docs/providers/google/cloudfunctions/index.md index caf0f40840..5386503931 100644 --- a/docs/google-docs/providers/google/cloudfunctions/index.md +++ b/docs/google-docs/providers/google/cloudfunctions/index.md @@ -21,7 +21,7 @@ Manages Lightweight User-Provided Functions Executed In Response To Events.
total resources: 5
total selectable resources: 5
-total methods: 14
+total methods: 17
@@ -33,7 +33,7 @@ Manages Lightweight User-Provided Functions Executed In Response To Events. TypeService TitleCloud Functions API DescriptionManages Lightweight User-Provided Functions Executed In Response To Events. -Idcloudfunctions:v23.08.00155 +Idcloudfunctions:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/cloudfunctions/locations/index.md b/docs/google-docs/providers/google/cloudfunctions/locations/index.md index ecd5ee6847..793a9ce10d 100644 --- a/docs/google-docs/providers/google/cloudfunctions/locations/index.md +++ b/docs/google-docs/providers/google/cloudfunctions/locations/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `projectsId` | +| `_list` | `EXEC` | `projectsId` | diff --git a/docs/google-docs/providers/google/cloudfunctions/operations/index.md b/docs/google-docs/providers/google/cloudfunctions/operations/index.md index c3c9b79bad..8cbb4d9b6e 100644 --- a/docs/google-docs/providers/google/cloudfunctions/operations/index.md +++ b/docs/google-docs/providers/google/cloudfunctions/operations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | diff --git a/docs/google-docs/providers/google/cloudidentity/client_states/index.md b/docs/google-docs/providers/google/cloudidentity/client_states/index.md index fd8ea06111..7252638d73 100644 --- a/docs/google-docs/providers/google/cloudidentity/client_states/index.md +++ b/docs/google-docs/providers/google/cloudidentity/client_states/index.md @@ -27,11 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results. Empty if there are no more results. | -| `clientStates` | `array` | Client states meeting the list restrictions. | +| `name` | `string` | Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device}/deviceUsers/{device_user}/clientState/{partner}`, where partner corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form: `{customer}-suffix`, where `customer` is your customer ID. The *suffix* is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: `GET https://www.googleapis.com/admin/directory/v1/customers/my_customer` The `id` field in the response contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is the string after the letter 'C' (not including 'C') | +| `createTime` | `string` | Output only. The time the client state data was created. | +| `managed` | `string` | The management state of the resource as specified by the API client. | +| `lastUpdateTime` | `string` | Output only. The time the client state data was last updated. | +| `ownerType` | `string` | Output only. The owner of the ClientState | +| `scoreReason` | `string` | A descriptive cause of the health score. | +| `healthScore` | `string` | The Health score of the resource. The Health score is the callers specification of the condition of the device from a usability point of view. For example, a third-party device management provider may specify a health score based on its compliance with organizational policies. | +| `keyValuePairs` | `object` | The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes in a map. | +| `customId` | `string` | This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field. | +| `assetTags` | `array` | The caller can specify asset tags for this resource | +| `complianceState` | `string` | The compliance state of the resource as specified by the API client. | +| `etag` | `string` | The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `clientStatesId, deviceUsersId, devicesId` | Gets the client state for the device user | | `list` | `SELECT` | `deviceUsersId, devicesId` | Lists the client states for the given search query. | +| `_list` | `EXEC` | `deviceUsersId, devicesId` | Lists the client states for the given search query. | | `patch` | `EXEC` | `clientStatesId, deviceUsersId, devicesId` | Updates the client state for the device user **Note**: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium | diff --git a/docs/google-docs/providers/google/cloudidentity/device_users/index.md b/docs/google-docs/providers/google/cloudidentity/device_users/index.md index 5794593f77..e98b654969 100644 --- a/docs/google-docs/providers/google/cloudidentity/device_users/index.md +++ b/docs/google-docs/providers/google/cloudidentity/device_users/index.md @@ -27,14 +27,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results. Empty if there are no more results. | -| `deviceUsers` | `array` | Devices meeting the list restrictions. | +| `name` | `string` | Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device}/deviceUsers/{device_user}`, where `device_user` uniquely identifies a user's use of a device. | +| `createTime` | `string` | When the user first signed in to the device | +| `compromisedState` | `string` | Compromised State of the DeviceUser object | +| `managementState` | `string` | Output only. Management state of the user on the device. | +| `userAgent` | `string` | Output only. User agent on the device for this specific user | +| `userEmail` | `string` | Email address of the user registered on the device. | +| `languageCode` | `string` | Output only. Default locale used on device, in IETF BCP-47 format. | +| `lastSyncTime` | `string` | Output only. Last time when user synced with policies. | +| `firstSyncTime` | `string` | Output only. Most recent time when user registered with this service. | +| `passwordState` | `string` | Password state of the DeviceUser object | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `deviceUsersId, devicesId` | Retrieves the specified DeviceUser | | `list` | `SELECT` | `devicesId` | Lists/Searches DeviceUsers. | | `delete` | `DELETE` | `deviceUsersId, devicesId` | Deletes the specified DeviceUser. This also revokes the user's access to device data. | +| `_list` | `EXEC` | `devicesId` | Lists/Searches DeviceUsers. | | `approve` | `EXEC` | `deviceUsersId, devicesId` | Approves device to access user data. | | `block` | `EXEC` | `deviceUsersId, devicesId` | Blocks device from accessing user data | | `cancel_wipe` | `EXEC` | `deviceUsersId, devicesId` | Cancels an unfinished user account wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. | diff --git a/docs/google-docs/providers/google/cloudidentity/devices/index.md b/docs/google-docs/providers/google/cloudidentity/devices/index.md index cdd7376f2f..4c43ed5f35 100644 --- a/docs/google-docs/providers/google/cloudidentity/devices/index.md +++ b/docs/google-docs/providers/google/cloudidentity/devices/index.md @@ -27,8 +27,36 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `devices` | `array` | Devices meeting the list restrictions. | -| `nextPageToken` | `string` | Token to retrieve the next page of results. Empty if there are no more results. | +| `name` | `string` | Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device}`, where device is the unique id assigned to the Device. | +| `deviceId` | `string` | Unique identifier for the device. | +| `wifiMacAddresses` | `array` | WiFi MAC addresses of device. | +| `hostname` | `string` | Host name of the device. | +| `securityPatchTime` | `string` | Output only. OS security patch update time on device. | +| `manufacturer` | `string` | Output only. Device manufacturer. Example: Motorola. | +| `imei` | `string` | Output only. IMEI number of device if GSM device; empty otherwise. | +| `meid` | `string` | Output only. MEID number of device if CDMA device; empty otherwise. | +| `kernelVersion` | `string` | Output only. Kernel version of the device. | +| `lastSyncTime` | `string` | Most recent time when device synced with this service. | +| `brand` | `string` | Output only. Device brand. Example: Samsung. | +| `releaseVersion` | `string` | Output only. OS release version. Example: 6.0. | +| `serialNumber` | `string` | Serial Number of device. Example: HT82V1A01076. | +| `buildNumber` | `string` | Output only. Build number of the device. | +| `deviceType` | `string` | Output only. Type of device. | +| `enabledUsbDebugging` | `boolean` | Output only. Whether USB debugging is enabled on device. | +| `managementState` | `string` | Output only. Management state of the device | +| `basebandVersion` | `string` | Output only. Baseband version of the device. | +| `assetTag` | `string` | Asset tag of the device. | +| `compromisedState` | `string` | Output only. Represents whether the Device is compromised. | +| `ownerType` | `string` | Output only. Whether the device is owned by the company or an individual | +| `createTime` | `string` | Output only. When the Company-Owned device was imported. This field is empty for BYOD devices. | +| `osVersion` | `string` | Output only. OS version of the device. Example: Android 8.1.0. | +| `otherAccounts` | `array` | Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if \|ownership_privilege\| is \|PROFILE_OWNER\| or \|DEVICE_OWNER\|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com". | +| `encryptionState` | `string` | Output only. Device encryption state. | +| `bootloaderVersion` | `string` | Output only. Device bootloader version. Example: 0.6.7. | +| `androidSpecificAttributes` | `object` | Resource representing the Android specific attributes of a Device. | +| `enabledDeveloperOptions` | `boolean` | Output only. Whether developer options is enabled on device. | +| `networkOperator` | `string` | Output only. Mobile or network operator of device, if available. | +| `model` | `string` | Output only. Model name of device. Example: Pixel 3. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +64,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | | Lists/Searches devices. | | `create` | `INSERT` | | Creates a device. Only company-owned device may be created. **Note**: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium | | `delete` | `DELETE` | `devicesId` | Deletes the specified device. | +| `_list` | `EXEC` | | Lists/Searches devices. | | `cancel_wipe` | `EXEC` | `devicesId` | Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. This operation is possible when the device is in a "pending wipe" state. The device enters the "pending wipe" state when a wipe device command is issued, but has not yet been sent to the device. The cancel wipe will fail if the wipe command has already been issued to the device. | | `wipe` | `EXEC` | `devicesId` | Wipes all data on the specified device. | diff --git a/docs/google-docs/providers/google/cloudidentity/groups/index.md b/docs/google-docs/providers/google/cloudidentity/groups/index.md index 1a61d97f21..ce9e5e2fc9 100644 --- a/docs/google-docs/providers/google/cloudidentity/groups/index.md +++ b/docs/google-docs/providers/google/cloudidentity/groups/index.md @@ -27,8 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `groups` | `array` | Groups returned in response to list request. The results are not sorted. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results available for listing. | +| `name` | `string` | Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group}`. | +| `description` | `string` | An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters. | +| `labels` | `object` | Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. | +| `dynamicGroupMetadata` | `object` | Dynamic group metadata like queries and status. | +| `groupKey` | `object` | A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. | +| `parent` | `string` | Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source}` for external [identity-mapped groups](https://support.google.com/a/answer/9039510) or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). [Find your customer ID.] (https://support.google.com/cloudidentity/answer/10070793) | +| `createTime` | `string` | Output only. The time when the `Group` was created. | +| `additionalGroupKeys` | `array` | Output only. Additional group keys associated with the Group. | +| `displayName` | `string` | The display name of the `Group`. | +| `updateTime` | `string` | Output only. The time when the `Group` was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +44,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | | Lists the `Group` resources under a customer or namespace. | | `create` | `INSERT` | | Creates a Group. | | `delete` | `DELETE` | `groupsId` | Deletes a `Group`. | +| `_list` | `EXEC` | | Lists the `Group` resources under a customer or namespace. | | `lookup` | `EXEC` | | Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`. | | `patch` | `EXEC` | `groupsId` | Updates a `Group`. | | `search` | `EXEC` | | Searches for `Group` resources matching a specified query. | diff --git a/docs/google-docs/providers/google/cloudidentity/idp_credentials/index.md b/docs/google-docs/providers/google/cloudidentity/idp_credentials/index.md index 5a0b02cf08..3d98a33790 100644 --- a/docs/google-docs/providers/google/cloudidentity/idp_credentials/index.md +++ b/docs/google-docs/providers/google/cloudidentity/idp_credentials/index.md @@ -27,12 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `idpCredentials` | `array` | The IdpCredentials from the specified InboundSamlSsoProfile. | +| `name` | `string` | Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the credential. | +| `rsaKeyInfo` | `object` | Information of a RSA public key. | +| `updateTime` | `string` | Output only. Time when the `IdpCredential` was last updated. | +| `dsaKeyInfo` | `object` | Information of a DSA public key. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `idpCredentialsId, inboundSamlSsoProfilesId` | Gets an IdpCredential. | | `list` | `SELECT` | `inboundSamlSsoProfilesId` | Returns a list of IdpCredentials in an InboundSamlSsoProfile. | | `delete` | `DELETE` | `idpCredentialsId, inboundSamlSsoProfilesId` | Deletes an IdpCredential. | +| `_list` | `EXEC` | `inboundSamlSsoProfilesId` | Returns a list of IdpCredentials in an InboundSamlSsoProfile. | | `add` | `EXEC` | `inboundSamlSsoProfilesId` | Adds an IdpCredential. Up to 2 credentials are allowed. | diff --git a/docs/google-docs/providers/google/cloudidentity/inbound_saml_sso_profiles/index.md b/docs/google-docs/providers/google/cloudidentity/inbound_saml_sso_profiles/index.md index 9e87f87670..c4e204173e 100644 --- a/docs/google-docs/providers/google/cloudidentity/inbound_saml_sso_profiles/index.md +++ b/docs/google-docs/providers/google/cloudidentity/inbound_saml_sso_profiles/index.md @@ -39,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | | Lists InboundSamlSsoProfiles for a customer. | | `create` | `INSERT` | | Creates an InboundSamlSsoProfile for a customer. | | `delete` | `DELETE` | `inboundSamlSsoProfilesId` | Deletes an InboundSamlSsoProfile. | +| `_list` | `EXEC` | | Lists InboundSamlSsoProfiles for a customer. | | `patch` | `EXEC` | `inboundSamlSsoProfilesId` | Updates an InboundSamlSsoProfile. | diff --git a/docs/google-docs/providers/google/cloudidentity/inbound_sso_assignments/index.md b/docs/google-docs/providers/google/cloudidentity/inbound_sso_assignments/index.md index 797d680ecd..b01d512279 100644 --- a/docs/google-docs/providers/google/cloudidentity/inbound_sso_assignments/index.md +++ b/docs/google-docs/providers/google/cloudidentity/inbound_sso_assignments/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Inbound SSO Assignment. | +| `ssoMode` | `string` | Inbound SSO behavior. | +| `targetGroup` | `string` | Immutable. Must be of the form `groups/{group}`. | | `targetOrgUnit` | `string` | Immutable. Must be of the form `orgUnits/{org_unit}`. | | `customer` | `string` | Immutable. The customer. For example: `customers/C0123abc`. | | `rank` | `integer` | Must be zero (which is the default value so it can be omitted) for assignments with `target_org_unit` set and must be greater-than-or-equal-to one for assignments with `target_group` set. | | `samlSsoInfo` | `object` | Details that are applicable when `sso_mode` == `SAML_SSO`. | | `signInBehavior` | `object` | Controls sign-in behavior. | -| `ssoMode` | `string` | Inbound SSO behavior. | -| `targetGroup` | `string` | Immutable. Must be of the form `groups/{group}`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -42,4 +42,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | | Lists the InboundSsoAssignments for a `Customer`. | | `create` | `INSERT` | | Creates an InboundSsoAssignment for users and devices in a `Customer` under a given `Group` or `OrgUnit`. | | `delete` | `DELETE` | `inboundSsoAssignmentsId` | Deletes an InboundSsoAssignment. To disable SSO, Create (or Update) an assignment that has `sso_mode` == `SSO_OFF`. | +| `_list` | `EXEC` | | Lists the InboundSsoAssignments for a `Customer`. | | `patch` | `EXEC` | `inboundSsoAssignmentsId` | Updates an InboundSsoAssignment. The body of this request is the `inbound_sso_assignment` field and the `update_mask` is relative to that. For example: a PATCH to `/v1/inboundSsoAssignments/0abcdefg1234567&update_mask=rank` with a body of `{ "rank": 1 }` moves that (presumably group-targeted) SSO assignment to the highest priority and shifts any other group-targeted assignments down in priority. | diff --git a/docs/google-docs/providers/google/cloudidentity/index.md b/docs/google-docs/providers/google/cloudidentity/index.md index 1c104c8780..5b823949ac 100644 --- a/docs/google-docs/providers/google/cloudidentity/index.md +++ b/docs/google-docs/providers/google/cloudidentity/index.md @@ -21,7 +21,7 @@ API For Provisioning And Managing Identity Resources.
total resources: 11
total selectable resources: 10
-total methods: 56
+total methods: 65
@@ -33,7 +33,7 @@ API For Provisioning And Managing Identity Resources. TypeService TitleCloud Identity API DescriptionAPI For Provisioning And Managing Identity Resources. -Idcloudidentity:v23.08.00155 +Idcloudidentity:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/cloudidentity/memberships/index.md b/docs/google-docs/providers/google/cloudidentity/memberships/index.md index 683a9fc9c2..21452ca687 100644 --- a/docs/google-docs/providers/google/cloudidentity/memberships/index.md +++ b/docs/google-docs/providers/google/cloudidentity/memberships/index.md @@ -27,8 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `memberships` | `array` | The `Membership`s under the specified `parent`. | -| `nextPageToken` | `string` | A continuation token to retrieve the next page of results, or empty if there are no more results available. | +| `name` | `string` | Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership`. Shall be of the form `groups/{group}/memberships/{membership}`. | +| `type` | `string` | Output only. The type of the membership. | +| `updateTime` | `string` | Output only. The time when the `Membership` was last updated. | +| `createTime` | `string` | Output only. The time when the `Membership` was created. | +| `deliverySetting` | `string` | Output only. Delivery setting associated with the membership. | +| `preferredMemberKey` | `object` | A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. | +| `roles` | `array` | The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate `MembershipRole`s with the same `name`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +41,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `groupsId` | Lists the `Membership`s within a `Group`. | | `create` | `INSERT` | `groupsId` | Creates a `Membership`. | | `delete` | `DELETE` | `groupsId, membershipsId` | Deletes a `Membership`. | +| `_list` | `EXEC` | `groupsId` | Lists the `Membership`s within a `Group`. | | `check_transitive_membership` | `EXEC` | `groupsId` | Check a potential member for membership in a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must have view permissions to at least one transitive membership between the member and group. | | `lookup` | `EXEC` | `groupsId` | Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`. | | `modify_membership_roles` | `EXEC` | `groupsId, membershipsId` | Modifies the `MembershipRole`s of a `Membership`. | diff --git a/docs/google-docs/providers/google/cloudidentity/userinvitations/index.md b/docs/google-docs/providers/google/cloudidentity/userinvitations/index.md index a7deca1944..3fc753e214 100644 --- a/docs/google-docs/providers/google/cloudidentity/userinvitations/index.md +++ b/docs/google-docs/providers/google/cloudidentity/userinvitations/index.md @@ -36,6 +36,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `customersId, userinvitationsId` | Retrieves a UserInvitation resource. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains. | | `list` | `SELECT` | `customersId` | Retrieves a list of UserInvitation resources. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains. | +| `_list` | `EXEC` | `customersId` | Retrieves a list of UserInvitation resources. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains. | | `cancel` | `EXEC` | `customersId, userinvitationsId` | Cancels a UserInvitation that was already sent. | | `is_invitable_user` | `EXEC` | `customersId, userinvitationsId` | Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account). Eligibility is based on the following criteria: * the email address is a consumer account and it's the primary email address of the account, and * the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain If both conditions are met, the user is eligible. **Note:** This method is not supported for Workspace Essentials customers. | | `send` | `EXEC` | `customersId, userinvitationsId` | Sends a UserInvitation to email. If the `UserInvitation` does not exist for this request and it is a valid request, the request creates a `UserInvitation`. **Note:** The `get` and `list` methods have a 48-hour delay where newly-created consumer accounts will not appear in the results. You can still send a `UserInvitation` to those accounts if you know the unmanaged email address and IsInvitableUser==True. | diff --git a/docs/google-docs/providers/google/cloudkms/crypto_key_versions/index.md b/docs/google-docs/providers/google/cloudkms/crypto_key_versions/index.md index cec9a0e836..3b59f45c8c 100644 --- a/docs/google-docs/providers/google/cloudkms/crypto_key_versions/index.md +++ b/docs/google-docs/providers/google/cloudkms/crypto_key_versions/index.md @@ -27,15 +27,29 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `cryptoKeyVersions` | `array` | The list of CryptoKeyVersions. | -| `nextPageToken` | `string` | A token to retrieve next page of results. Pass this value in ListCryptoKeyVersionsRequest.page_token to retrieve the next page of results. | -| `totalSize` | `integer` | The total number of CryptoKeyVersions that matched the query. | +| `name` | `string` | Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. | +| `importJob` | `string` | Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. | +| `destroyTime` | `string` | Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. | +| `externalDestructionFailureReason` | `string` | Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. | +| `algorithm` | `string` | Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. | +| `destroyEventTime` | `string` | Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. | +| `generationFailureReason` | `string` | Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. | +| `createTime` | `string` | Output only. The time at which this CryptoKeyVersion was created. | +| `externalProtectionLevelOptions` | `object` | ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. | +| `state` | `string` | The current state of the CryptoKeyVersion. | +| `importFailureReason` | `string` | Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. | +| `importTime` | `string` | Output only. The time at which this CryptoKeyVersion's key material was most recently imported. | +| `attestation` | `object` | Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). | +| `generateTime` | `string` | Output only. The time this CryptoKeyVersion's key material was generated. | +| `reimportEligible` | `boolean` | Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. | +| `protectionLevel` | `string` | Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `cryptoKeyVersionsId, cryptoKeysId, keyRingsId, locationsId, projectsId` | Returns metadata for a given CryptoKeyVersion. | | `list` | `SELECT` | `cryptoKeysId, keyRingsId, locationsId, projectsId` | Lists CryptoKeyVersions. | | `create` | `INSERT` | `cryptoKeysId, keyRingsId, locationsId, projectsId` | Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED. | +| `_list` | `EXEC` | `cryptoKeysId, keyRingsId, locationsId, projectsId` | Lists CryptoKeyVersions. | | `asymmetric_decrypt` | `EXEC` | `cryptoKeyVersionsId, cryptoKeysId, keyRingsId, locationsId, projectsId` | Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT. | | `asymmetric_sign` | `EXEC` | `cryptoKeyVersionsId, cryptoKeysId, keyRingsId, locationsId, projectsId` | Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey. | | `destroy` | `EXEC` | `cryptoKeyVersionsId, cryptoKeysId, keyRingsId, locationsId, projectsId` | Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process. | diff --git a/docs/google-docs/providers/google/cloudkms/crypto_key_versions_public_key/index.md b/docs/google-docs/providers/google/cloudkms/crypto_key_versions_public_key/index.md index 37ba680a16..8eea8b229b 100644 --- a/docs/google-docs/providers/google/cloudkms/crypto_key_versions_public_key/index.md +++ b/docs/google-docs/providers/google/cloudkms/crypto_key_versions_public_key/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name of the CryptoKeyVersion public key. Provided here for verification. NOTE: This field is in Beta. | +| `pem` | `string` | The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). | | `pemCrc32c` | `string` | Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta. | | `protectionLevel` | `string` | The ProtectionLevel of the CryptoKeyVersion public key. | | `algorithm` | `string` | The Algorithm associated with this key. | -| `pem` | `string` | The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/cloudkms/crypto_keys/index.md b/docs/google-docs/providers/google/cloudkms/crypto_keys/index.md index 2cd403be8f..f5293163c5 100644 --- a/docs/google-docs/providers/google/cloudkms/crypto_keys/index.md +++ b/docs/google-docs/providers/google/cloudkms/crypto_keys/index.md @@ -27,15 +27,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `cryptoKeys` | `array` | The list of CryptoKeys. | -| `nextPageToken` | `string` | A token to retrieve next page of results. Pass this value in ListCryptoKeysRequest.page_token to retrieve the next page of results. | -| `totalSize` | `integer` | The total number of CryptoKeys that matched the query. | +| `name` | `string` | Output only. The resource name for this CryptoKey in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. | +| `destroyScheduledDuration` | `string` | Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 24 hours. | +| `rotationPeriod` | `string` | next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. | +| `versionTemplate` | `object` | A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation. | +| `labels` | `object` | Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). | +| `cryptoKeyBackend` | `string` | Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC, with the resource name in the format `projects/*/locations/*/ekmConnections/*`. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future. | +| `primary` | `object` | A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS. | +| `createTime` | `string` | Output only. The time at which this CryptoKey was created. | +| `importOnly` | `boolean` | Immutable. Whether this key may contain imported versions only. | +| `nextRotationTime` | `string` | At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. | +| `purpose` | `string` | Immutable. The immutable purpose of this CryptoKey. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `cryptoKeysId, keyRingsId, locationsId, projectsId` | Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion. | | `list` | `SELECT` | `keyRingsId, locationsId, projectsId` | Lists CryptoKeys. | | `create` | `INSERT` | `keyRingsId, locationsId, projectsId` | Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required. | +| `_list` | `EXEC` | `keyRingsId, locationsId, projectsId` | Lists CryptoKeys. | | `decrypt` | `EXEC` | `cryptoKeysId, keyRingsId, locationsId, projectsId` | Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT. | | `encrypt` | `EXEC` | `cryptoKeysId, keyRingsId, locationsId, projectsId` | Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT. | | `patch` | `EXEC` | `cryptoKeysId, keyRingsId, locationsId, projectsId` | Update a CryptoKey. | diff --git a/docs/google-docs/providers/google/cloudkms/crypto_keys_iam_policies/index.md b/docs/google-docs/providers/google/cloudkms/crypto_keys_iam_policies/index.md index 762ad69f4e..fbf7da0c67 100644 --- a/docs/google-docs/providers/google/cloudkms/crypto_keys_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudkms/crypto_keys_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudkms/ekm_connections/index.md b/docs/google-docs/providers/google/cloudkms/ekm_connections/index.md index 2059caa7ea..96b8127b6d 100644 --- a/docs/google-docs/providers/google/cloudkms/ekm_connections/index.md +++ b/docs/google-docs/providers/google/cloudkms/ekm_connections/index.md @@ -39,5 +39,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `get` | `SELECT` | `ekmConnectionsId, locationsId, projectsId` | Returns metadata for a given EkmConnection. | | `list` | `SELECT` | `locationsId, projectsId` | Lists EkmConnections. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new EkmConnection in a given Project and Location. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists EkmConnections. | | `patch` | `EXEC` | `ekmConnectionsId, locationsId, projectsId` | Updates an EkmConnection's metadata. | | `verify_connectivity` | `EXEC` | `ekmConnectionsId, locationsId, projectsId` | Verifies that Cloud KMS can successfully connect to the external key manager specified by an EkmConnection. If there is an error connecting to the EKM, this method returns a FAILED_PRECONDITION status containing structured information as described at https://cloud.google.com/kms/docs/reference/ekm_errors. | diff --git a/docs/google-docs/providers/google/cloudkms/ekm_connections_iam_policies/index.md b/docs/google-docs/providers/google/cloudkms/ekm_connections_iam_policies/index.md index 34bdf2dda9..6ce005f8b9 100644 --- a/docs/google-docs/providers/google/cloudkms/ekm_connections_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudkms/ekm_connections_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudkms/import_jobs/index.md b/docs/google-docs/providers/google/cloudkms/import_jobs/index.md index 4ce3918c73..b788351739 100644 --- a/docs/google-docs/providers/google/cloudkms/import_jobs/index.md +++ b/docs/google-docs/providers/google/cloudkms/import_jobs/index.md @@ -28,18 +28,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name for this ImportJob in the format `projects/*/locations/*/keyRings/*/importJobs/*`. | +| `createTime` | `string` | Output only. The time at which this ImportJob was created. | +| `attestation` | `object` | Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). | | `state` | `string` | Output only. The current state of the ImportJob, indicating if it can be used. | -| `importMethod` | `string` | Required. Immutable. The wrapping method to be used for incoming key material. | | `protectionLevel` | `string` | Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. | -| `publicKey` | `object` | The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. | -| `createTime` | `string` | Output only. The time at which this ImportJob was created. | | `expireTime` | `string` | Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material. | -| `attestation` | `object` | Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). | | `generateTime` | `string` | Output only. The time this ImportJob's key material was generated. | +| `importMethod` | `string` | Required. Immutable. The wrapping method to be used for incoming key material. | | `expireEventTime` | `string` | Output only. The time this ImportJob expired. Only present if state is EXPIRED. | +| `publicKey` | `object` | The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `importJobsId, keyRingsId, locationsId, projectsId` | Returns metadata for a given ImportJob. | | `list` | `SELECT` | `keyRingsId, locationsId, projectsId` | Lists ImportJobs. | | `create` | `INSERT` | `keyRingsId, locationsId, projectsId` | Create a new ImportJob within a KeyRing. ImportJob.import_method is required. | +| `_list` | `EXEC` | `keyRingsId, locationsId, projectsId` | Lists ImportJobs. | diff --git a/docs/google-docs/providers/google/cloudkms/import_jobs_iam_policies/index.md b/docs/google-docs/providers/google/cloudkms/import_jobs_iam_policies/index.md index fc8ccb04af..f7280d3ecc 100644 --- a/docs/google-docs/providers/google/cloudkms/import_jobs_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudkms/import_jobs_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudkms/index.md b/docs/google-docs/providers/google/cloudkms/index.md index 8b7cdcb492..5a598c3a02 100644 --- a/docs/google-docs/providers/google/cloudkms/index.md +++ b/docs/google-docs/providers/google/cloudkms/index.md @@ -21,7 +21,7 @@ Manages Keys And Performs Cryptographic Operations In A Central Cloud Service, F
total resources: 14
total selectable resources: 13
-total methods: 52
+total methods: 58
@@ -33,7 +33,7 @@ Manages Keys And Performs Cryptographic Operations In A Central Cloud Service, F TypeService TitleCloud Key Management Service (KMS) API DescriptionManages Keys And Performs Cryptographic Operations In A Central Cloud Service, For Direct Use By Other Cloud Resources And Applications. -Idcloudkms:v23.08.00155 +Idcloudkms:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/cloudkms/key_rings/index.md b/docs/google-docs/providers/google/cloudkms/key_rings/index.md index 074690540d..b9bc7406f2 100644 --- a/docs/google-docs/providers/google/cloudkms/key_rings/index.md +++ b/docs/google-docs/providers/google/cloudkms/key_rings/index.md @@ -35,3 +35,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `get` | `SELECT` | `keyRingsId, locationsId, projectsId` | Returns metadata for a given KeyRing. | | `list` | `SELECT` | `locationsId, projectsId` | Lists KeyRings. | | `create` | `INSERT` | `locationsId, projectsId` | Create a new KeyRing in a given Project and Location. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists KeyRings. | diff --git a/docs/google-docs/providers/google/cloudkms/locations/index.md b/docs/google-docs/providers/google/cloudkms/locations/index.md index a37101297a..0d08d66f5b 100644 --- a/docs/google-docs/providers/google/cloudkms/locations/index.md +++ b/docs/google-docs/providers/google/cloudkms/locations/index.md @@ -27,11 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `generate_random_bytes` | `EXEC` | `locationsId, projectsId` | Generate random bytes using the Cloud KMS randomness source in the provided location. | diff --git a/docs/google-docs/providers/google/cloudprofiler/index.md b/docs/google-docs/providers/google/cloudprofiler/index.md index 0f5699b355..ea22058ad6 100644 --- a/docs/google-docs/providers/google/cloudprofiler/index.md +++ b/docs/google-docs/providers/google/cloudprofiler/index.md @@ -33,7 +33,7 @@ Manages Continuous Profiling Information. TypeService TitleCloud Profiler API DescriptionManages Continuous Profiling Information. -Idcloudprofiler:v23.08.00155 +Idcloudprofiler:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/cloudresourcemanager/effective_tags/index.md b/docs/google-docs/providers/google/cloudresourcemanager/effective_tags/index.md index 00d9616fc7..5769e32280 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/effective_tags/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/effective_tags/index.md @@ -27,9 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `effectiveTags` | `array` | A possibly paginated list of effective tags for the specified resource. | -| `nextPageToken` | `string` | Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. | +| `inherited` | `boolean` | Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource, inherited will be false. | +| `namespacedTagKey` | `string` | The namespaced name of the TagKey. Can be in the form `{organization_id}/{tag_key_short_name}` or `{project_id}/{tag_key_short_name}` or `{project_number}/{tag_key_short_name}`. | +| `namespacedTagValue` | `string` | The namespaced name of the TagValue. Can be in the form `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_number}/{tag_key_short_name}/{tag_value_short_name}`. | +| `tagKey` | `string` | The name of the TagKey, in the format `tagKeys/{id}`, such as `tagKeys/123`. | +| `tagKeyParentName` | `string` | The parent name of the tag key. Must be in the format `organizations/{organization_id}` or `projects/{project_number}` | +| `tagValue` | `string` | Resource name for TagValue in the format `tagValues/456`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | | +| `_list` | `EXEC` | | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/folders/index.md b/docs/google-docs/providers/google/cloudresourcemanager/folders/index.md index 676dfdc2ce..56e9902a34 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/folders/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/folders/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the folder. Its format is `folders/{folder_id}`, for example: "folders/1234". | -| `displayName` | `string` | The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: `[\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?`. | -| `etag` | `string` | Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | -| `parent` | `string` | Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder. | | `state` | `string` | Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder. | | `updateTime` | `string` | Output only. Timestamp when the folder was last modified. | | `createTime` | `string` | Output only. Timestamp when the folder was created. | | `deleteTime` | `string` | Output only. Timestamp when the folder was requested to be deleted. | +| `displayName` | `string` | The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: `[\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?`. | +| `etag` | `string` | Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `parent` | `string` | Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -42,6 +42,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | | Lists the folders that are direct descendants of supplied parent resource. `list()` provides a strongly consistent view of the folders underneath the specified parent resource. `list()` returns folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have `resourcemanager.folders.list` permission on the identified parent. | | `create` | `INSERT` | | Creates a folder in the resource hierarchy. Returns an `Operation` which can be used to track the progress of the folder creation workflow. Upon success, the `Operation.response` field will be populated with the created Folder. In order to succeed, the addition of this new folder must not violate the folder naming, height, or fanout constraints. + The folder's `display_name` must be distinct from all other folders that share its parent. + The addition of the folder must not cause the active folder hierarchy to exceed a height of 10. Note, the full active + deleted folder hierarchy is allowed to reach a height of 20; this provides additional headroom when moving folders that contain deleted folders. + The addition of the folder must not cause the total number of folders under its parent to exceed 300. If the operation fails due to a folder constraint violation, some errors may be returned by the `CreateFolder` request, with status code `FAILED_PRECONDITION` and an error description. Other folder constraint violations will be communicated in the `Operation`, with the specific `PreconditionFailure` returned in the details list in the `Operation.error` field. The caller must have `resourcemanager.folders.create` permission on the identified parent. | | `delete` | `DELETE` | `foldersId` | Requests deletion of a folder. The folder is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on an empty folder, where a folder is empty if it doesn't contain any folders or projects in the ACTIVE state. If called on a folder in DELETE_REQUESTED state the operation will result in a no-op success. The caller must have `resourcemanager.folders.delete` permission on the identified folder. | +| `_list` | `EXEC` | | Lists the folders that are direct descendants of supplied parent resource. `list()` provides a strongly consistent view of the folders underneath the specified parent resource. `list()` returns folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have `resourcemanager.folders.list` permission on the identified parent. | | `move` | `EXEC` | `foldersId` | Moves a folder under a new resource parent. Returns an `Operation` which can be used to track the progress of the folder move workflow. Upon success, the `Operation.response` field will be populated with the moved folder. Upon failure, a `FolderOperationError` categorizing the failure cause will be returned - if the failure occurs synchronously then the `FolderOperationError` will be returned in the `Status.details` field. If it occurs asynchronously, then the FolderOperation will be returned in the `Operation.error` field. In addition, the `Operation.metadata` field will be populated with a `FolderOperation` message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height, or fanout constraints described in the CreateFolder documentation. The caller must have `resourcemanager.folders.move` permission on the folder's current and proposed new parent. | | `patch` | `EXEC` | `foldersId` | Updates a folder, changing its `display_name`. Changes to the folder `display_name` will be rejected if they violate either the `display_name` formatting rules or the naming constraints described in the CreateFolder documentation. The folder's `display_name` must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is captured by the regular expression: `\p{L}\p{N}{1,28}[\p{L}\p{N}]`. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a `PreconditionFailure` explaining this violation will be returned in the Status.details field. | | `search` | `EXEC` | | Search for folders that match specific filter criteria. `search()` provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission `resourcemanager.folders.get`. | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/folders_iam_policies/index.md b/docs/google-docs/providers/google/cloudresourcemanager/folders_iam_policies/index.md index 5918cd8ebc..0ef76575a2 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/folders_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/folders_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `foldersId` | Gets the access control policy for a folder. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the folder's resource name, for example: "folders/1234". The caller must have `resourcemanager.folders.getIamPolicy` permission on the identified folder. | +| `get_iam_policy` | `SELECT` | `foldersId` | Gets the access control policy for a folder. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the folder's resource name, for example: "folders/1234". The caller must have `resourcemanager.folders.getIamPolicy` permission on the identified folder. | | `set_iam_policy` | `EXEC` | `foldersId` | Sets the access control policy on a folder, replacing any existing policy. The `resource` field should be the folder's resource name, for example: "folders/1234". The caller must have `resourcemanager.folders.setIamPolicy` permission on the identified folder. | | `test_iam_permissions` | `EXEC` | `foldersId` | Returns permissions that a caller has on the specified folder. The `resource` field should be the folder's resource name, for example: "folders/1234". There are no permissions required for making this API call. | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/index.md b/docs/google-docs/providers/google/cloudresourcemanager/index.md index e0cde507b9..2b94675ae0 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/index.md @@ -20,8 +20,8 @@ Creates, Reads, And Updates Metadata For Google Cloud Platform Resource Containe
total resources: 17
-total selectable resources: 10
-total methods: 57
+total selectable resources: 15
+total methods: 65
@@ -33,7 +33,7 @@ Creates, Reads, And Updates Metadata For Google Cloud Platform Resource Containe TypeService TitleCloud Resource Manager API DescriptionCreates, Reads, And Updates Metadata For Google Cloud Platform Resource Containers. -Idcloudresourcemanager:v23.08.00155 +Idcloudresourcemanager:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/cloudresourcemanager/liens/index.md b/docs/google-docs/providers/google/cloudresourcemanager/liens/index.md index 37dc0c214d..fff86c191f 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/liens/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/liens/index.md @@ -27,8 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `liens` | `array` | A list of Liens. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | A system-generated unique identifier for this Lien. Example: `liens/1234abcd` | +| `origin` | `string` | A stable, user-visible/meaningful string identifying the origin of the Lien, intended to be inspected programmatically. Maximum length of 200 characters. Example: 'compute.googleapis.com' | +| `parent` | `string` | A reference to the resource this Lien is attached to. The server will validate the parent against those for which Liens are supported. Example: `projects/1234` | +| `reason` | `string` | Concise user-visible strings indicating why an action cannot be performed on a resource. Maximum length of 200 characters. Example: 'Holds production API key' | +| `restrictions` | `array` | The types of operations which should be blocked as a result of this Lien. Each value should correspond to an IAM permission. The server will validate the permissions against those for which Liens are supported. An empty list is meaningless and will be rejected. Example: ['resourcemanager.projects.delete'] | +| `createTime` | `string` | The creation time of this Lien. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,3 +40,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | | List all Liens applied to the `parent` resource. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`. | | `create` | `INSERT` | | Create a Lien which applies to the resource denoted by the `parent` field. Callers of this method will require permission on the `parent` resource. For example, applying to `projects/1234` requires permission `resourcemanager.projects.updateLiens`. NOTE: Some resources may limit the number of Liens which may be applied. | | `delete` | `DELETE` | `liensId` | Delete a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.updateLiens`. | +| `_list` | `EXEC` | | List all Liens applied to the `parent` resource. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`. | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/organizations/index.md b/docs/google-docs/providers/google/cloudresourcemanager/organizations/index.md index 5a4ee424af..d13b540656 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/organizations/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/organizations/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234". | -| `state` | `string` | Output only. The organization's current lifecycle state. | | `updateTime` | `string` | Output only. Timestamp when the Organization was last modified. | | `createTime` | `string` | Output only. Timestamp when the Organization was created. | | `deleteTime` | `string` | Output only. Timestamp when the Organization was requested for deletion. | | `directoryCustomerId` | `string` | Immutable. The G Suite / Workspace customer id used in the Directory API. | | `displayName` | `string` | Output only. A human-readable string that refers to the organization in the Google Cloud Console. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, "google.com") of the Google Workspace customer that owns the organization. | | `etag` | `string` | Output only. A checksum computed by the server based on the current value of the Organization resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `state` | `string` | Output only. The organization's current lifecycle state. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/organizations_iam_policies/index.md b/docs/google-docs/providers/google/cloudresourcemanager/organizations_iam_policies/index.md index 1fc1c17c24..2019d91098 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/organizations_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/organizations_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `organizationsId` | Gets the access control policy for an organization resource. The policy may be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, for example: "organizations/123". Authorization requires the IAM permission `resourcemanager.organizations.getIamPolicy` on the specified organization. | +| `get_iam_policy` | `SELECT` | `organizationsId` | Gets the access control policy for an organization resource. The policy may be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, for example: "organizations/123". Authorization requires the IAM permission `resourcemanager.organizations.getIamPolicy` on the specified organization. | | `set_iam_policy` | `EXEC` | `organizationsId` | Sets the access control policy on an organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, for example: "organizations/123". Authorization requires the IAM permission `resourcemanager.organizations.setIamPolicy` on the specified organization. | | `test_iam_permissions` | `EXEC` | `organizationsId` | Returns the permissions that a caller has on the specified organization. The `resource` field should be the organization's resource name, for example: "organizations/123". There are no permissions required for making this API call. | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/projects/index.md b/docs/google-docs/providers/google/cloudresourcemanager/projects/index.md index 253c7628aa..36d9760979 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/projects/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/projects/index.md @@ -27,8 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. | -| `projects` | `array` | The list of Projects under the parent. This list can be paginated. | +| `name` | `string` | Output only. The unique resource name of the project. It is an int64 generated number prefixed by "projects/". Example: `projects/415104041262` | +| `state` | `string` | Output only. The project lifecycle state. | +| `labels` | `object` | Optional. The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 64 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"myBusinessDimension" : "businessValue"` | +| `createTime` | `string` | Output only. Creation time. | +| `displayName` | `string` | Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project` | +| `parent` | `string` | Optional. A reference to a parent Resource. eg., `organizations/123` or `folders/876`. | +| `updateTime` | `string` | Output only. The most recent time this resource was modified. | +| `etag` | `string` | Output only. A checksum computed by the server based on the current value of the Project resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `projectId` | `string` | Immutable. The unique, user-assigned id of the project. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `tokyo-rain-123` | +| `deleteTime` | `string` | Output only. The time at which this resource was requested for deletion. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +44,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | | Lists projects that are direct children of the specified folder or organization resource. `list()` provides a strongly consistent view of the projects underneath the specified parent resource. `list()` returns projects sorted based upon the (ascending) lexical ordering of their `display_name`. The caller must have `resourcemanager.projects.list` permission on the identified parent. | | `create` | `INSERT` | | Request that a new project be created. The result is an `Operation` which can be used to track the creation process. This process usually takes a few seconds, but can sometimes take much longer. The tracking `Operation` is automatically deleted after a few hours, so there is no need to call `DeleteOperation`. | | `delete` | `DELETE` | `projectsId` | Marks the project identified by the specified `name` (for example, `projects/415104041262`) for deletion. This method will only affect the project if it has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the Project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with GetProject, and the project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the project is not retrievable by the GetProject, ListProjects, and SearchProjects methods. This method behaves idempotently, such that deleting a `DELETE_REQUESTED` project will not cause an error, but also won't do anything. The caller must have `resourcemanager.projects.delete` permissions for this project. | +| `_list` | `EXEC` | | Lists projects that are direct children of the specified folder or organization resource. `list()` provides a strongly consistent view of the projects underneath the specified parent resource. `list()` returns projects sorted based upon the (ascending) lexical ordering of their `display_name`. The caller must have `resourcemanager.projects.list` permission on the identified parent. | | `move` | `EXEC` | `projectsId` | Move a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the project move workflow. Upon success, the `Operation.response` field will be populated with the moved project. The caller must have `resourcemanager.projects.move` permission on the project, on the project's current and proposed new parent. If project has no current parent, or it currently does not have an associated organization resource, you will also need the `resourcemanager.projects.setIamPolicy` permission in the project. | | `patch` | `EXEC` | `projectsId` | Updates the `display_name` and labels of the project identified by the specified `name` (for example, `projects/415104041262`). Deleting all labels requires an update mask for labels field. The caller must have `resourcemanager.projects.update` permission for this project. | | `search` | `EXEC` | | Search for projects that the caller has both `resourcemanager.projects.get` permission on, and also satisfy the specified query. This method returns projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method. | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/projects_iam_policies/index.md b/docs/google-docs/providers/google/cloudresourcemanager/projects_iam_policies/index.md index c0d044e7ae..f2e3170880 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/projects_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/projects_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `projectsId` | Returns the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. Permission is denied if the policy or the resource do not exist. | +| `get_iam_policy` | `SELECT` | `projectsId` | Returns the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. Permission is denied if the policy or the resource do not exist. | | `set_iam_policy` | `EXEC` | `projectsId` | Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible. | | `test_iam_permissions` | `EXEC` | `projectsId` | Returns permissions that a caller has on the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123.. | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_bindings/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_bindings/index.md index 1c94a680ce..40c4d3e558 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_bindings/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/tag_bindings/index.md @@ -27,11 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `tagBindings` | `array` | A possibly paginated list of TagBindings for the specified resource. | -| `nextPageToken` | `string` | Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. | +| `name` | `string` | Output only. The name of the TagBinding. This is a String of the form: `tagBindings/{full-resource-name}/{tag-value-name}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`). | +| `parent` | `string` | The full resource name of the resource the TagValue is bound to. E.g. `//cloudresourcemanager.googleapis.com/projects/123` | +| `tagValue` | `string` | The TagValue of the TagBinding. Must be of the form `tagValues/456`. | +| `tagValueNamespacedName` | `string` | The namespaced name for the TagValue of the TagBinding. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`. For methods that support TagValue namespaced name, only one of tag_value_namespaced_name or tag_value may be filled. Requests with both fields will be rejected. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `list` | `SELECT` | | Lists the TagBindings for the given Google Cloud resource, as specified with `parent`. NOTE: The `parent` field is expected to be a full resource name: https://cloud.google.com/apis/design/resource_names#full_resource_name | | `create` | `INSERT` | | Creates a TagBinding between a TagValue and a Google Cloud resource. | | `delete` | `DELETE` | `tagBindingsId` | Deletes a TagBinding. | +| `_list` | `EXEC` | | Lists the TagBindings for the given Google Cloud resource, as specified with `parent`. NOTE: The `parent` field is expected to be a full resource name: https://cloud.google.com/apis/design/resource_names#full_resource_name | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_holds/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_holds/index.md index cef71866aa..1bbcbb60b3 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_holds/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/tag_holds/index.md @@ -27,11 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. | -| `tagHolds` | `array` | A possibly paginated list of TagHolds. | +| `name` | `string` | Output only. The resource name of a TagHold. This is a String of the form: `tagValues/{tag-value-id}/tagHolds/{tag-hold-id}` (e.g. `tagValues/123/tagHolds/456`). This resource name is generated by the server. | +| `holder` | `string` | Required. The name of the resource where the TagValue is being used. Must be less than 200 characters. E.g. `//compute.googleapis.com/compute/projects/myproject/regions/us-east-1/instanceGroupManagers/instance-group` | +| `origin` | `string` | Optional. An optional string representing the origin of this request. This field should include human-understandable information to distinguish origins from each other. Must be less than 200 characters. E.g. `migs-35678234` | +| `createTime` | `string` | Output only. The time this TagHold was created. | +| `helpLink` | `string` | Optional. A URL where an end user can learn more about removing this hold. E.g. `https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `list` | `SELECT` | `tagValuesId` | Lists TagHolds under a TagValue. | | `create` | `INSERT` | `tagValuesId` | Creates a TagHold. Returns ALREADY_EXISTS if a TagHold with the same resource and origin exists under the same TagValue. | | `delete` | `DELETE` | `tagHoldsId, tagValuesId` | Deletes a TagHold. | +| `_list` | `EXEC` | `tagValuesId` | Lists TagHolds under a TagValue. | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_keys/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_keys/index.md index bd8d5ac046..116bfbfbb1 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_keys/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/tag_keys/index.md @@ -27,8 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A pagination token returned from a previous call to `ListTagKeys` that indicates from where listing should continue. | -| `tagKeys` | `array` | List of TagKeys that live under the specified parent in the request. | +| `name` | `string` | Immutable. The resource name for a TagKey. Must be in the format `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for the TagKey. | +| `description` | `string` | Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write. | +| `purposeData` | `object` | Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for `Purpose` for formatting of this field. Purpose data cannot be changed once set. | +| `updateTime` | `string` | Output only. Update time. | +| `namespacedName` | `string` | Output only. Immutable. Namespaced name of the TagKey. | +| `parent` | `string` | Immutable. The resource name of the TagKey's parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form `organizations/{org_id}`. For a TagKey parented by a Project, its parent can be in the form `projects/{project_id}` or `projects/{project_number}`. | +| `shortName` | `string` | Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. | +| `etag` | `string` | Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details. | +| `createTime` | `string` | Output only. Creation time. | +| `purpose` | `string` | Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | | Lists all TagKeys for a parent resource. | | `create` | `INSERT` | | Creates a new TagKey. If another request with the same parameters is sent while the original request is in process, the second request will receive an error. A maximum of 1000 TagKeys can exist under a parent at any given time. | | `delete` | `DELETE` | `tagKeysId` | Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues. | +| `_list` | `EXEC` | | Lists all TagKeys for a parent resource. | | `patch` | `EXEC` | `tagKeysId` | Updates the attributes of the TagKey resource. | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_iam_policies/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_iam_policies/index.md index 581f8ee459..f127325863 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `tagKeysId` | Gets the access control policy for a TagKey. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have `cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy` permission on the specified TagKey. | +| `get_iam_policy` | `SELECT` | `tagKeysId` | Gets the access control policy for a TagKey. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have `cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy` permission on the specified TagKey. | | `set_iam_policy` | `EXEC` | `tagKeysId` | Sets the access control policy on a TagKey, replacing any existing policy. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have `resourcemanager.tagKeys.setIamPolicy` permission on the identified tagValue. | | `test_iam_permissions` | `EXEC` | `tagKeysId` | Returns permissions that a caller has on the specified TagKey. The `resource` field should be the TagKey's resource name. For example, "tagKeys/1234". There are no permissions required for making this API call. | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_values/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_values/index.md index 937825b742..40af15d359 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_values/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/tag_values/index.md @@ -27,8 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A pagination token returned from a previous call to `ListTagValues` that indicates from where listing should continue. This is currently not used, but the server may at any point start supplying a valid token. | -| `tagValues` | `array` | A possibly paginated list of TagValues that are direct descendants of the specified parent TagKey. | +| `name` | `string` | Immutable. Resource name for TagValue in the format `tagValues/456`. | +| `description` | `string` | Optional. User-assigned description of the TagValue. Must not exceed 256 characters. Read-write. | +| `updateTime` | `string` | Output only. Update time. | +| `createTime` | `string` | Output only. Creation time. | +| `etag` | `string` | Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagValueRequest for details. | +| `namespacedName` | `string` | Output only. The namespaced name of the TagValue. Can be in the form `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_number}/{tag_key_short_name}/{tag_value_short_name}`. | +| `parent` | `string` | Immutable. The resource name of the new TagValue's parent TagKey. Must be of the form `tagKeys/{tag_key_id}`. | +| `shortName` | `string` | Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey. The short name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +42,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | | Lists all TagValues for a specific TagKey. | | `create` | `INSERT` | | Creates a TagValue as a child of the specified TagKey. If a another request with the same parameters is sent while the original request is in process the second request will receive an error. A maximum of 1000 TagValues can exist under a TagKey at any given time. | | `delete` | `DELETE` | `tagValuesId` | Deletes a TagValue. The TagValue cannot have any bindings when it is deleted. | +| `_list` | `EXEC` | | Lists all TagValues for a specific TagKey. | | `patch` | `EXEC` | `tagValuesId` | Updates the attributes of the TagValue resource. | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_values_iam_policies/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_values_iam_policies/index.md index cfc1d45c03..99fbd6521f 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_values_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/tag_values_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `tagValuesId` | Gets the access control policy for a TagValue. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the TagValue's resource name. For example: `tagValues/1234`. The caller must have the `cloudresourcemanager.googleapis.com/tagValues.getIamPolicy` permission on the identified TagValue to get the access control policy. | +| `get_iam_policy` | `SELECT` | `tagValuesId` | Gets the access control policy for a TagValue. The returned policy may be empty if no such policy or resource exists. The `resource` field should be the TagValue's resource name. For example: `tagValues/1234`. The caller must have the `cloudresourcemanager.googleapis.com/tagValues.getIamPolicy` permission on the identified TagValue to get the access control policy. | | `set_iam_policy` | `EXEC` | `tagValuesId` | Sets the access control policy on a TagValue, replacing any existing policy. The `resource` field should be the TagValue's resource name. For example: `tagValues/1234`. The caller must have `resourcemanager.tagValues.setIamPolicy` permission on the identified tagValue. | | `test_iam_permissions` | `EXEC` | `tagValuesId` | Returns permissions that a caller has on the specified TagValue. The `resource` field should be the TagValue's resource name. For example: `tagValues/1234`. There are no permissions required for making this API call. | diff --git a/docs/google-docs/providers/google/cloudscheduler/index.md b/docs/google-docs/providers/google/cloudscheduler/index.md index 9fd7377cc5..ca1d6f3449 100644 --- a/docs/google-docs/providers/google/cloudscheduler/index.md +++ b/docs/google-docs/providers/google/cloudscheduler/index.md @@ -21,7 +21,7 @@ Creates And Manages Jobs Run On A Regular Recurring Schedule.
total resources: 2
total selectable resources: 2
-total methods: 10
+total methods: 12
@@ -33,7 +33,7 @@ Creates And Manages Jobs Run On A Regular Recurring Schedule. TypeService TitleCloud Scheduler API DescriptionCreates And Manages Jobs Run On A Regular Recurring Schedule. -Idcloudscheduler:v23.08.00155 +Idcloudscheduler:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/cloudscheduler/jobs/index.md b/docs/google-docs/providers/google/cloudscheduler/jobs/index.md index ef3802e6fd..8d83d7f91c 100644 --- a/docs/google-docs/providers/google/cloudscheduler/jobs/index.md +++ b/docs/google-docs/providers/google/cloudscheduler/jobs/index.md @@ -29,18 +29,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. | | `description` | `string` | Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters. | +| `status` | `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). | +| `pubsubTarget` | `object` | Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. | | `timeZone` | `string` | Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT). | -| `scheduleTime` | `string` | Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule. | -| `attemptDeadline` | `string` | The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The default and the allowed values depend on the type of target: * For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. * For Pub/Sub targets, this field is ignored. | -| `lastAttemptTime` | `string` | Output only. The time the last job attempt started. | -| `userUpdateTime` | `string` | Output only. The creation time of the job. | -| `state` | `string` | Output only. State of the job. | | `retryConfig` | `object` | Settings that determine the retry behavior. By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. | -| `appEngineHttpTarget` | `object` | App Engine target. The job will be pushed to a job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. Error 503 is considered an App Engine system error instead of an application error. Requests returning error 503 will be retried regardless of retry configuration and not counted against retry counts. Any other response code, or a failure to receive a response before the deadline, constitutes a failed attempt. | -| `pubsubTarget` | `object` | Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. | | `httpTarget` | `object` | Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. | +| `attemptDeadline` | `string` | The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The default and the allowed values depend on the type of target: * For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. * For Pub/Sub targets, this field is ignored. | +| `appEngineHttpTarget` | `object` | App Engine target. The job will be pushed to a job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. Error 503 is considered an App Engine system error instead of an application error. Requests returning error 503 will be retried regardless of retry configuration and not counted against retry counts. Any other response code, or a failure to receive a response before the deadline, constitutes a failed attempt. | +| `state` | `string` | Output only. State of the job. | +| `scheduleTime` | `string` | Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule. | +| `lastAttemptTime` | `string` | Output only. The time the last job attempt started. | | `schedule` | `string` | Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. | -| `status` | `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). | +| `userUpdateTime` | `string` | Output only. The creation time of the job. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -48,6 +48,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists jobs. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a job. | | `delete` | `DELETE` | `jobsId, locationsId, projectsId` | Deletes a job. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists jobs. | | `patch` | `EXEC` | `jobsId, locationsId, projectsId` | Updates a job. If successful, the updated Job is returned. If the job does not exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received. | | `pause` | `EXEC` | `jobsId, locationsId, projectsId` | Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused. | | `resume` | `EXEC` | `jobsId, locationsId, projectsId` | Resume a job. This method reenables a job after it has been Job.State.PAUSED. The state of a job is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed. | diff --git a/docs/google-docs/providers/google/cloudscheduler/locations/index.md b/docs/google-docs/providers/google/cloudscheduler/locations/index.md index cd1c482b60..1d6c29037c 100644 --- a/docs/google-docs/providers/google/cloudscheduler/locations/index.md +++ b/docs/google-docs/providers/google/cloudscheduler/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/cloudshell/environments/index.md b/docs/google-docs/providers/google/cloudshell/environments/index.md index 0439911b49..e9de5524e2 100644 --- a/docs/google-docs/providers/google/cloudshell/environments/index.md +++ b/docs/google-docs/providers/google/cloudshell/environments/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Output only. The environment's identifier, unique among the user's environments. | | `name` | `string` | Immutable. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the email address of the user to whom this environment belongs, and `{environment_id}` is the identifier of this environment. For example, `users/someone@example.com/environments/default`. | -| `dockerImage` | `string` | Required. Immutable. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest". | -| `webHost` | `string` | Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment. | | `sshPort` | `integer` | Output only. Port to which clients can connect to initiate SSH sessions with the environment. | -| `publicKeys` | `array` | Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the AddPublicKey and RemovePublicKey methods. | | `sshUsername` | `string` | Output only. Username that clients should use when initiating SSH sessions with the environment. | -| `sshHost` | `string` | Output only. Host to which clients can connect to initiate SSH sessions with the environment. | +| `publicKeys` | `array` | Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the AddPublicKey and RemovePublicKey methods. | +| `dockerImage` | `string` | Required. Immutable. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest". | | `state` | `string` | Output only. Current execution state of this environment. | +| `webHost` | `string` | Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment. | +| `sshHost` | `string` | Output only. Host to which clients can connect to initiate SSH sessions with the environment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudshell/index.md b/docs/google-docs/providers/google/cloudshell/index.md index 07ab909055..bbf5a58810 100644 --- a/docs/google-docs/providers/google/cloudshell/index.md +++ b/docs/google-docs/providers/google/cloudshell/index.md @@ -21,7 +21,7 @@ Allows Users To Start, Configure, And Connect To Interactive Shell Sessions Runn
total resources: 3
total selectable resources: 2
-total methods: 9
+total methods: 10
@@ -33,7 +33,7 @@ Allows Users To Start, Configure, And Connect To Interactive Shell Sessions Runn TypeService TitleCloud Shell API DescriptionAllows Users To Start, Configure, And Connect To Interactive Shell Sessions Running In The Cloud. -Idcloudshell:v23.08.00155 +Idcloudshell:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/cloudshell/operations/index.md b/docs/google-docs/providers/google/cloudshell/operations/index.md index 043bd68df0..33a72f9cd0 100644 --- a/docs/google-docs/providers/google/cloudshell/operations/index.md +++ b/docs/google-docs/providers/google/cloudshell/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `metadata` | `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. | +| `response` | `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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operationsId` | 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. | | `list` | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `operationsId` | 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`. | +| `_list` | `EXEC` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `operationsId` | 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`. | diff --git a/docs/google-docs/providers/google/cloudsupport/attachments/index.md b/docs/google-docs/providers/google/cloudsupport/attachments/index.md index 08c48e64d1..072f104412 100644 --- a/docs/google-docs/providers/google/cloudsupport/attachments/index.md +++ b/docs/google-docs/providers/google/cloudsupport/attachments/index.md @@ -27,9 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `attachments` | `array` | The list of attachments associated with the given case. | -| `nextPageToken` | `string` | A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `cases.attachments.list` requests. If unspecified, there are no more results to retrieve. | +| `name` | `string` | Output only. The resource name of the attachment. | +| `sizeBytes` | `string` | Output only. The size of the attachment in bytes. | +| `createTime` | `string` | Output only. The time at which the attachment was created. | +| `creator` | `object` | An object containing information about the effective user and authenticated principal responsible for an action. | +| `filename` | `string` | The filename of the attachment (e.g. `"graph.jpg"`). | +| `mimeType` | `string` | Output only. The MIME type of the attachment (e.g. text/plain). | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `parent` | +| `_list` | `EXEC` | `parent` | diff --git a/docs/google-docs/providers/google/cloudsupport/cases/index.md b/docs/google-docs/providers/google/cloudsupport/cases/index.md index c5298d37fd..2fb1acd27d 100644 --- a/docs/google-docs/providers/google/cloudsupport/cases/index.md +++ b/docs/google-docs/providers/google/cloudsupport/cases/index.md @@ -25,27 +25,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The resource name for the case. | -| `description` | `string` | A broad description of the issue. | -| `languageCode` | `string` | The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `"en"`, `"zh-CN"`, `"zh-TW"`, `"ja"`, `"ko"`). If no language or an unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours | -| `escalated` | `boolean` | Whether the case is currently escalated. | -| `testCase` | `boolean` | Whether this case was created for internal API testing and should not be acted on by the support team. | -| `creator` | `object` | An object containing information about the effective user and authenticated principal responsible for an action. | -| `priority` | `string` | The priority of this case. | -| `classification` | `object` | A classification object with a product type and value. | -| `subscriberEmailAddresses` | `array` | The email addresses to receive updates on this case. | -| `timeZone` | `string` | The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API. | -| `createTime` | `string` | Output only. The time this case was created. | -| `displayName` | `string` | The short summary of the issue reported in this case. | -| `contactEmail` | `string` | A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. | -| `state` | `string` | Output only. The current status of the support case. | -| `updateTime` | `string` | Output only. The time this case was last updated. | +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `name` | Retrieve the specified case. Here is an example of calling this endpoint using cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case" ``` | | `create` | `INSERT` | `parent` | Create a new case and associate it with the given Google Cloud Resource. The case object must have the following fields set: `display_name`, `description`, `classification`, and `priority`. Here is an example of calling this endpoint using 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" ``` | | `close` | `EXEC` | `name` | Close the specified case. Here is an example of calling this endpoint using cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case:close" ``` | | `patch` | `EXEC` | `name` | Update the specified case. Only a subset of fields can be updated. Here is an example of calling this endpoint using 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" ``` | diff --git a/docs/google-docs/providers/google/cloudsupport/comments/index.md b/docs/google-docs/providers/google/cloudsupport/comments/index.md index 73c0aa187d..35da5dcafc 100644 --- a/docs/google-docs/providers/google/cloudsupport/comments/index.md +++ b/docs/google-docs/providers/google/cloudsupport/comments/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `ListCommentsRequest` message that is issued. If unspecified, there are no more results to retrieve. | -| `comments` | `array` | The list of Comments associated with the given Case. | +| `name` | `string` | Output only. The resource name for the comment. | +| `plainTextBody` | `string` | Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped. | +| `body` | `string` | The full comment body. Maximum of 12800 characters. This can contain rich text syntax. | +| `createTime` | `string` | Output only. The time when this comment was created. | +| `creator` | `object` | An object containing information about the effective user and authenticated principal responsible for an action. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `list` | `SELECT` | `parent` | Retrieve all comments associated with the Case object. Here is an example of calling this endpoint using cURL: ```shell case="projects/cloud-support-qa-premium/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` | | `create` | `INSERT` | `parent` | Add a new comment to the specified Case. The comment object must have the following fields set: body. Here is an example of calling this endpoint using cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` | +| `_list` | `EXEC` | `parent` | Retrieve all comments associated with the Case object. Here is an example of calling this endpoint using cURL: ```shell case="projects/cloud-support-qa-premium/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` | diff --git a/docs/google-docs/providers/google/cloudsupport/index.md b/docs/google-docs/providers/google/cloudsupport/index.md index 0be36c2bf2..515874c082 100644 --- a/docs/google-docs/providers/google/cloudsupport/index.md +++ b/docs/google-docs/providers/google/cloudsupport/index.md @@ -20,8 +20,8 @@ Manages Google Cloud Technical Support Cases For Customer Care Support Offerings
total resources: 5
-total selectable resources: 3
-total methods: 10
+total selectable resources: 2
+total methods: 12
@@ -33,7 +33,7 @@ Manages Google Cloud Technical Support Cases For Customer Care Support Offerings TypeService TitleGoogle Cloud Support API DescriptionManages Google Cloud Technical Support Cases For Customer Care Support Offerings. -Idcloudsupport:v23.08.00155 +Idcloudsupport:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/cloudsupport/media/index.md b/docs/google-docs/providers/google/cloudsupport/media/index.md index 70deff5cf6..c6b81d5eda 100644 --- a/docs/google-docs/providers/google/cloudsupport/media/index.md +++ b/docs/google-docs/providers/google/cloudsupport/media/index.md @@ -27,6 +27,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields `SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `upload` | `EXEC` | `parent` | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `download` | `EXEC` | `name` | Download a file attachment on a case. Note: HTTP requests must append "?alt=media" to the URL. Here is an example of calling this endpoint using 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" ``` | +| `upload` | `EXEC` | `parent` | Create a file attachment on a case or Cloud resource. The attachment object must have the following fields set: filename. Here is an example of calling this endpoint using 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" ``` | diff --git a/docs/google-docs/providers/google/cloudtasks/index.md b/docs/google-docs/providers/google/cloudtasks/index.md index f2433d57ea..cb84702092 100644 --- a/docs/google-docs/providers/google/cloudtasks/index.md +++ b/docs/google-docs/providers/google/cloudtasks/index.md @@ -20,8 +20,8 @@ Manages The Execution Of Large Numbers Of Distributed Requests.
total resources: 4
-total selectable resources: 3
-total methods: 18
+total selectable resources: 4
+total methods: 21
@@ -33,7 +33,7 @@ Manages The Execution Of Large Numbers Of Distributed Requests. TypeService TitleCloud Tasks API DescriptionManages The Execution Of Large Numbers Of Distributed Requests. -Idcloudtasks:v23.08.00155 +Idcloudtasks:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/cloudtasks/locations/index.md b/docs/google-docs/providers/google/cloudtasks/locations/index.md index 2ba39c5d3a..71c78c21c3 100644 --- a/docs/google-docs/providers/google/cloudtasks/locations/index.md +++ b/docs/google-docs/providers/google/cloudtasks/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/cloudtasks/queues/index.md b/docs/google-docs/providers/google/cloudtasks/queues/index.md index 5c60282776..501fd05373 100644 --- a/docs/google-docs/providers/google/cloudtasks/queues/index.md +++ b/docs/google-docs/providers/google/cloudtasks/queues/index.md @@ -41,6 +41,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists queues. Queues are returned in lexicographical order. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. | | `delete` | `DELETE` | `locationsId, projectsId, queuesId` | Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists queues. Queues are returned in lexicographical order. | | `patch` | `EXEC` | `locationsId, projectsId, queuesId` | Updates a queue. This method creates the queue if it does not exist and updates the queue if it does exist. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. | | `pause` | `EXEC` | `locationsId, projectsId, queuesId` | Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED. | | `purge` | `EXEC` | `locationsId, projectsId, queuesId` | Purges a queue by deleting all of its tasks. All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible. | diff --git a/docs/google-docs/providers/google/cloudtasks/queues_iam_policies/index.md b/docs/google-docs/providers/google/cloudtasks/queues_iam_policies/index.md index f31ee253d7..c9712204b2 100644 --- a/docs/google-docs/providers/google/cloudtasks/queues_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudtasks/queues_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `locationsId, projectsId, queuesId` | Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.getIamPolicy` | +| `get_iam_policy` | `SELECT` | `locationsId, projectsId, queuesId` | Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.getIamPolicy` | | `set_iam_policy` | `EXEC` | `locationsId, projectsId, queuesId` | Sets the access control policy for a Queue. Replaces any existing policy. Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.setIamPolicy` | | `test_iam_permissions` | `EXEC` | `locationsId, projectsId, queuesId` | Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | diff --git a/docs/google-docs/providers/google/cloudtasks/tasks/index.md b/docs/google-docs/providers/google/cloudtasks/tasks/index.md index 125565af72..e2241dd8e6 100644 --- a/docs/google-docs/providers/google/cloudtasks/tasks/index.md +++ b/docs/google-docs/providers/google/cloudtasks/tasks/index.md @@ -27,8 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to retrieve next page of results. To return the next page of results, call ListTasks with this value as the page_token. If the next_page_token is empty, there are no more results. | -| `tasks` | `array` | The list of tasks. | +| `name` | `string` | Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. | +| `firstAttempt` | `object` | The status of a task attempt. | +| `appEngineHttpRequest` | `object` | App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. | +| `httpRequest` | `object` | HTTP request. The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([`200` - `299`]), the task will be removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following: * User-specified throttling: retry configuration, rate limits, and the queue's state. * System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed. System throttling happens because: * Cloud Tasks backs off on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns `429` (Too Many Requests), `503` (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the `Retry-After` HTTP response header is considered. * To prevent traffic spikes and to smooth sudden increases in traffic, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time). | +| `dispatchDeadline` | `string` | The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the [scaling type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's `dispatch_deadline`, the app handler will not run for longer than than the service's timeout. We recommend setting the `dispatch_deadline` to at most a few seconds more than the app handler's timeout. For more information see [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts). `dispatch_deadline` will be truncated to the nearest millisecond. The deadline is an approximate deadline. | +| `scheduleTime` | `string` | The time when the task is scheduled to be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. | +| `createTime` | `string` | Output only. The time that the task was created. `create_time` will be truncated to the nearest second. | +| `dispatchCount` | `integer` | Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. | +| `view` | `string` | Output only. The view specifies which subset of the Task has been returned. | +| `lastAttempt` | `object` | The status of a task attempt. | +| `responseCount` | `integer` | Output only. The number of attempts which have received a response. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +45,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId, queuesId` | Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time. | | `create` | `INSERT` | `locationsId, projectsId, queuesId` | Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * The maximum task size is 100KB. | | `delete` | `DELETE` | `locationsId, projectsId, queuesId, tasksId` | Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has executed successfully or permanently failed. | +| `_list` | `EXEC` | `locationsId, projectsId, queuesId` | Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time. | | `run` | `EXEC` | `locationsId, projectsId, queuesId, tasksId` | Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed. | diff --git a/docs/google-docs/providers/google/cloudtrace/index.md b/docs/google-docs/providers/google/cloudtrace/index.md index d48fee1f91..477d4a291f 100644 --- a/docs/google-docs/providers/google/cloudtrace/index.md +++ b/docs/google-docs/providers/google/cloudtrace/index.md @@ -33,7 +33,7 @@ Sends Application Trace Data To Cloud Trace For Viewing. Trace Data Is Collected TypeService TitleCloud Trace API DescriptionSends Application Trace Data To Cloud Trace For Viewing. Trace Data Is Collected For All App Engine Applications By Default. Trace Data From Other Applications Can Be Provided Using This API. This Library Is Used To Interact With The Cloud Trace API Directly. If You Are Looking To Instrument Your Application For Cloud Trace, We Recommend Using OpenTelemetry. -Idcloudtrace:v23.08.00155 +Idcloudtrace:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/composer/environments/index.md b/docs/google-docs/providers/google/composer/environments/index.md index fb2df6b765..1215b07000 100644 --- a/docs/google-docs/providers/google/composer/environments/index.md +++ b/docs/google-docs/providers/google/composer/environments/index.md @@ -27,8 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `environments` | `array` | The list of environments returned by a ListEnvironmentsRequest. | -| `nextPageToken` | `string` | The page token used to query for the next page if one exists. | +| `name` | `string` | The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. | +| `createTime` | `string` | Output only. The time at which this environment was created. | +| `labels` | `object` | Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. | +| `state` | `string` | The current state of the environment. | +| `updateTime` | `string` | Output only. The time at which this environment was last modified. | +| `uuid` | `string` | Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created. | +| `config` | `object` | Configuration information for an environment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +41,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | List environments. | | `create` | `INSERT` | `locationsId, projectsId` | Create a new environment. | | `delete` | `DELETE` | `environmentsId, locationsId, projectsId` | Delete an environment. | +| `_list` | `EXEC` | `locationsId, projectsId` | List environments. | | `database_failover` | `EXEC` | `environmentsId, locationsId, projectsId` | Triggers database failover (only for highly resilient environments). | | `execute_airflow_command` | `EXEC` | `environmentsId, locationsId, projectsId` | Executes Airflow CLI command. | | `load_snapshot` | `EXEC` | `environmentsId, locationsId, projectsId` | Loads a snapshot of a Cloud Composer environment. As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment. | diff --git a/docs/google-docs/providers/google/composer/image_versions/index.md b/docs/google-docs/providers/google/composer/image_versions/index.md index e5d6ea2735..eed66f2d65 100644 --- a/docs/google-docs/providers/google/composer/image_versions/index.md +++ b/docs/google-docs/providers/google/composer/image_versions/index.md @@ -27,9 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The page token used to query for the next page if one exists. | -| `imageVersions` | `array` | The list of supported ImageVersions in a location. | +| `supportedPythonVersions` | `array` | supported python versions | +| `upgradeDisabled` | `boolean` | Whether it is impossible to upgrade an environment running with the image version. | +| `creationDisabled` | `boolean` | Whether it is impossible to create an environment with the image version. | +| `imageVersionId` | `string` | The string identifier of the ImageVersion, in the form: "composer-x.y.z-airflow-a.b.c" | +| `isDefault` | `boolean` | Whether this is the default ImageVersion used by Composer during environment creation if no input ImageVersion is specified. | +| `releaseDate` | `object` | Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `locationsId, projectsId` | +| `_list` | `EXEC` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/composer/index.md b/docs/google-docs/providers/google/composer/index.md index 36e5f008f3..035762920f 100644 --- a/docs/google-docs/providers/google/composer/index.md +++ b/docs/google-docs/providers/google/composer/index.md @@ -21,7 +21,7 @@ Manages Apache Airflow Environments On Google Cloud Platform.
total resources: 4
total selectable resources: 3
-total methods: 16
+total methods: 19
@@ -33,7 +33,7 @@ Manages Apache Airflow Environments On Google Cloud Platform. TypeService TitleCloud Composer API DescriptionManages Apache Airflow Environments On Google Cloud Platform. -Idcomposer:v23.08.00155 +Idcomposer:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/composer/operations/index.md b/docs/google-docs/providers/google/composer/operations/index.md index 944e9f23fe..49c736096d 100644 --- a/docs/google-docs/providers/google/composer/operations/index.md +++ b/docs/google-docs/providers/google/composer/operations/index.md @@ -27,11 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | diff --git a/docs/google-docs/providers/google/compute/accelerator_types/index.md b/docs/google-docs/providers/google/compute/accelerator_types/index.md index bcb3830554..2c68f53a85 100644 --- a/docs/google-docs/providers/google/compute/accelerator_types/index.md +++ b/docs/google-docs/providers/google/compute/accelerator_types/index.md @@ -30,15 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional textual description of the resource. | -| `maximumCardsPerInstance` | `integer` | [Output Only] Maximum number of accelerator cards allowed per instance. | -| `selfLink` | `string` | [Output Only] Server-defined, fully qualified URL for this resource. | | `kind` | `string` | [Output Only] The type of the resource. Always compute#acceleratorType for accelerator types. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | [Output Only] Server-defined, fully qualified URL for this resource. | +| `maximumCardsPerInstance` | `integer` | [Output Only] Maximum number of accelerator cards allowed per instance. | | `deprecated` | `object` | Deprecation status for a public resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `zone` | `string` | [Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `acceleratorType, project, zone` | Returns the specified accelerator type. | | `list` | `SELECT` | `project, zone` | Retrieves a list of accelerator types that are available to the specified project. | +| `_list` | `EXEC` | `project, zone` | Retrieves a list of accelerator types that are available to the specified project. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of accelerator types. | diff --git a/docs/google-docs/providers/google/compute/addresses/index.md b/docs/google-docs/providers/google/compute/addresses/index.md index e506ab601a..c55607984d 100644 --- a/docs/google-docs/providers/google/compute/addresses/index.md +++ b/docs/google-docs/providers/google/compute/addresses/index.md @@ -30,22 +30,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. | | `description` | `string` | An optional description of this resource. Provide this field when you create the resource. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#address for addresses. | -| `ipv6EndpointType` | `string` | The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. | -| `networkTier` | `string` | This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM. | -| `region` | `string` | [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.* | +| `users` | `array` | [Output Only] The URLs of the resources that are using this address. | | `purpose` | `string` | The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `status` | `string` | [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `subnetwork` | `string` | The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose. | +| `prefixLength` | `integer` | The prefix length if the resource represents an IP range. | | `ipVersion` | `string` | The IP version that will be used by this address. Valid options are IPV4 or IPV6. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `status` | `string` | [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. | -| `address` | `string` | The static IP address represented by this resource. | +| `networkTier` | `string` | This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM. | +| `region` | `string` | [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.* | | `addressType` | `string` | The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. | -| `prefixLength` | `integer` | The prefix length if the resource represents an IP range. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `labelFingerprint` | `string` | A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address. | -| `subnetwork` | `string` | The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose. | -| `users` | `array` | [Output Only] The URLs of the resources that are using this address. | +| `ipv6EndpointType` | `string` | The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#address for addresses. | +| `address` | `string` | The static IP address represented by this resource. | | `network` | `string` | The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose. | ## Methods | Name | Accessible by | Required Params | Description | @@ -54,6 +54,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of addresses contained within the specified region. | | `insert` | `INSERT` | `project, region` | Creates an address resource in the specified project by using the data included in the request. | | `delete` | `DELETE` | `address, project, region` | Deletes the specified address resource. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of addresses contained within the specified region. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of addresses. | | `move` | `EXEC` | `address, project, region` | Moves the specified address resource. | | `set_labels` | `EXEC` | `project, region, resource` | Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation. | diff --git a/docs/google-docs/providers/google/compute/autoscalers/index.md b/docs/google-docs/providers/google/compute/autoscalers/index.md index be553018dc..dc7f8ef1f8 100644 --- a/docs/google-docs/providers/google/compute/autoscalers/index.md +++ b/docs/google-docs/providers/google/compute/autoscalers/index.md @@ -30,17 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `target` | `string` | URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. | | `recommendedSize` | `integer` | [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction. | -| `scalingScheduleStatus` | `object` | [Output Only] Status information of existing scaling schedules. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `target` | `string` | URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. | +| `statusDetails` | `array` | [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. | +| `autoscalingPolicy` | `object` | Cloud Autoscaler policy. | | `zone` | `string` | [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). | | `kind` | `string` | [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. | -| `status` | `string` | [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future. | -| `autoscalingPolicy` | `object` | Cloud Autoscaler policy. | +| `scalingScheduleStatus` | `object` | [Output Only] Status information of existing scaling schedules. | | `region` | `string` | [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). | -| `statusDetails` | `array` | [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. | +| `status` | `string` | [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -48,6 +48,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, zone` | Retrieves a list of autoscalers contained within the specified zone. | | `insert` | `INSERT` | `project, zone` | Creates an autoscaler in the specified project using the data included in the request. | | `delete` | `DELETE` | `autoscaler, project, zone` | Deletes the specified autoscaler. | +| `_list` | `EXEC` | `project, zone` | Retrieves a list of autoscalers contained within the specified zone. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of autoscalers. | | `patch` | `EXEC` | `project, zone` | Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `project, zone` | Updates an autoscaler in the specified project using the data included in the request. | diff --git a/docs/google-docs/providers/google/compute/backend_buckets/index.md b/docs/google-docs/providers/google/compute/backend_buckets/index.md index 0057014620..993e4b5529 100644 --- a/docs/google-docs/providers/google/compute/backend_buckets/index.md +++ b/docs/google-docs/providers/google/compute/backend_buckets/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] Unique identifier for the resource; defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional textual description of the resource; provided by the client when the resource is created. | -| `compressionMode` | `string` | Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge security policy associated with this backend bucket. | -| `enableCdn` | `boolean` | If true, enable Cloud CDN for this BackendBucket. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `customResponseHeaders` | `array` | Headers that the Application Load Balancer should add to proxied responses. | +| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a backend bucket. | +| `compressionMode` | `string` | Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. | +| `enableCdn` | `boolean` | If true, enable Cloud CDN for this BackendBucket. | | `kind` | `string` | Type of the resource. | +| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge security policy associated with this backend bucket. | +| `customResponseHeaders` | `array` | Headers that the Application Load Balancer should add to proxied responses. | | `bucketName` | `string` | Cloud Storage bucket name. | -| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a backend bucket. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -46,6 +46,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of BackendBucket resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a BackendBucket resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `backendBucket, project` | Deletes the specified BackendBucket resource. | +| `_list` | `EXEC` | `project` | Retrieves the list of BackendBucket resources available to the specified project. | | `patch` | `EXEC` | `backendBucket, project` | Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `set_edge_security_policy` | `EXEC` | `backendBucket, project` | Sets the edge security policy for the specified backend bucket. | | `update` | `EXEC` | `backendBucket, project` | Updates the specified BackendBucket resource with the data included in the request. | diff --git a/docs/google-docs/providers/google/compute/backend_services/index.md b/docs/google-docs/providers/google/compute/backend_services/index.md index 0fcbca6e8e..ef147b8868 100644 --- a/docs/google-docs/providers/google/compute/backend_services/index.md +++ b/docs/google-docs/providers/google/compute/backend_services/index.md @@ -30,43 +30,43 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `network` | `string` | The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. | -| `healthChecks` | `array` | The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check. | +| `outlierDetection` | `object` | Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. | +| `localityLbPolicy` | `string` | The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. | | `iap` | `object` | Identity-Aware Proxy | -| `serviceBindings` | `array` | URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty. | -| `portName` | `string` | A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge security policy associated with this backend service. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#backendService for backend services. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `securityPolicy` | `string` | [Output Only] The resource URL for the security policy associated with this backend service. | | `region` | `string` | [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `customResponseHeaders` | `array` | Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | -| `connectionTrackingPolicy` | `object` | Connection Tracking configuration for this BackendService. | -| `metadatas` | `object` | Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH | +| `protocol` | `string` | The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. | +| `securitySettings` | `object` | The authentication and authorization settings for a BackendService. | +| `failoverPolicy` | `object` | For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). | | `port` | `integer` | Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. | -| `maxStreamDuration` | `object` | A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. | -| `sessionAffinity` | `string` | Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). | -| `timeoutSec` | `integer` | The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. | -| `compressionMode` | `string` | Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a backend service. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#backendService for backend services. | -| `consistentHash` | `object` | This message defines settings for a consistent hash style load balancer. | -| `localityLbPolicy` | `string` | The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. | +| `metadatas` | `object` | Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH | | `enableCDN` | `boolean` | If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer. | -| `circuitBreakers` | `object` | Settings controlling the volume of requests, connections and retries to this backend service. | -| `outlierDetection` | `object` | Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. | -| `failoverPolicy` | `object` | For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). | -| `securityPolicy` | `string` | [Output Only] The resource URL for the security policy associated with this backend service. | -| `logConfig` | `object` | The available logging options for the load balancer traffic served by this backend service. | +| `backends` | `array` | The list of backends that serve this BackendService. | +| `portName` | `string` | A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. | +| `subsetting` | `object` | Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. | | `connectionDraining` | `object` | Message containing connection draining configuration. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `securitySettings` | `object` | The authentication and authorization settings for a BackendService. | | `customRequestHeaders` | `array` | Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | -| `loadBalancingScheme` | `string` | Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer. | +| `circuitBreakers` | `object` | Settings controlling the volume of requests, connections and retries to this backend service. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService. | -| `subsetting` | `object` | Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. | -| `protocol` | `string` | The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. | -| `backends` | `array` | The list of backends that serve this BackendService. | -| `localityLbPolicies` | `array` | A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration. | +| `serviceBindings` | `array` | URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty. | +| `consistentHash` | `object` | This message defines settings for a consistent hash style load balancer. | +| `maxStreamDuration` | `object` | A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. | +| `logConfig` | `object` | The available logging options for the load balancer traffic served by this backend service. | +| `sessionAffinity` | `string` | Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). | +| `loadBalancingScheme` | `string` | Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer. | +| `timeoutSec` | `integer` | The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. | +| `compressionMode` | `string` | Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. | +| `customResponseHeaders` | `array` | Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | +| `network` | `string` | The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. | | `affinityCookieTtlSec` | `integer` | Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. | +| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge security policy associated with this backend service. | +| `healthChecks` | `array` | The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check. | +| `connectionTrackingPolicy` | `object` | Connection Tracking configuration for this BackendService. | +| `localityLbPolicies` | `array` | A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -74,6 +74,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of BackendService resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview . | | `delete` | `DELETE` | `backendService, project` | Deletes the specified BackendService resource. | +| `_list` | `EXEC` | `project` | Retrieves the list of BackendService resources available to the specified project. | | `patch` | `EXEC` | `backendService, project` | Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `set_edge_security_policy` | `EXEC` | `backendService, project` | Sets the edge security policy for the specified backend service. | | `set_security_policy` | `EXEC` | `backendService, project` | Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview | diff --git a/docs/google-docs/providers/google/compute/backend_services_iam_policies/index.md b/docs/google-docs/providers/google/compute/backend_services_iam_policies/index.md index 8c87528c45..e755486856 100644 --- a/docs/google-docs/providers/google/compute/backend_services_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/backend_services_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/disk_types/index.md b/docs/google-docs/providers/google/compute/disk_types/index.md index 366f70138f..cd9d45c135 100644 --- a/docs/google-docs/providers/google/compute/disk_types/index.md +++ b/docs/google-docs/providers/google/compute/disk_types/index.md @@ -31,16 +31,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional description of this resource. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#diskType for disk types. | | `validDiskSize` | `string` | [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB". | -| `defaultDiskSizeGb` | `string` | [Output Only] Server-defined default disk size in GB. | | `deprecated` | `object` | Deprecation status for a public resource. | -| `region` | `string` | [Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `zone` | `string` | [Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `zone` | `string` | [Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `region` | `string` | [Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `defaultDiskSizeGb` | `string` | [Output Only] Server-defined default disk size in GB. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#diskType for disk types. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `diskType, project, zone` | Returns the specified disk type. | | `list` | `SELECT` | `project, zone` | Retrieves a list of disk types available to the specified project. | +| `_list` | `EXEC` | `project, zone` | Retrieves a list of disk types available to the specified project. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of disk types. | diff --git a/docs/google-docs/providers/google/compute/disks/index.md b/docs/google-docs/providers/google/compute/disks/index.md index 7a8a6af9bb..360b0d2934 100644 --- a/docs/google-docs/providers/google/compute/disks/index.md +++ b/docs/google-docs/providers/google/compute/disks/index.md @@ -30,47 +30,47 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `status` | `string` | [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. | +| `sizeGb` | `string` | Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive. | +| `lastAttachTimestamp` | `string` | [Output Only] Last attach timestamp in RFC3339 text format. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#disk for disks. | +| `sourceImageEncryptionKey` | `object` | | +| `sourceDisk` | `string` | The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk | +| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | +| `resourceStatus` | `object` | | | `sourceSnapshot` | `string` | The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot | -| `provisionedThroughput` | `string` | Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 7,124. | +| `zone` | `string` | [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `sourceConsistencyGroupPolicyId` | `string` | [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | -| `lastAttachTimestamp` | `string` | [Output Only] Last attach timestamp in RFC3339 text format. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `sourceImageId` | `string` | [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. | +| `status` | `string` | [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. | | `diskEncryptionKey` | `object` | | -| `physicalBlockSizeBytes` | `string` | Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. | -| `licenseCodes` | `array` | Integer license codes indicating which licenses are attached to this disk. | -| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | -| `zone` | `string` | [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. | +| `provisionedIops` | `string` | Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. | +| `sourceDiskId` | `string` | [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used. | +| `params` | `object` | Additional disk params. | +| `sourceSnapshotId` | `string` | [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. | | `sourceStorageObject` | `string` | The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead. | -| `sourceDisk` | `string` | The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk | | `region` | `string` | [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#disk for disks. | -| `sourceImageEncryptionKey` | `object` | | -| `sizeGb` | `string` | Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive. | +| `lastDetachTimestamp` | `string` | [Output Only] Last detach timestamp in RFC3339 text format. | +| `asyncPrimaryDisk` | `object` | | +| `asyncSecondaryDisks` | `object` | [Output Only] A list of disks this disk is asynchronously replicated to. | +| `resourcePolicies` | `array` | Resource policies applied to this disk for automatic snapshot creations. | +| `licenseCodes` | `array` | Integer license codes indicating which licenses are attached to this disk. | +| `licenses` | `array` | A list of publicly visible licenses. Reserved for Google's use. | +| `sourceConsistencyGroupPolicy` | `string` | [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | | `replicaZones` | `array` | URLs of the zones where the disk should be replicated to. Only applicable for regional resources. | | `users` | `array` | [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance | -| `labels` | `object` | Labels to apply to this disk. These can be later modified by the setLabels method. | -| `architecture` | `string` | The architecture of the disk. Valid values are ARM64 or X86_64. | -| `resourcePolicies` | `array` | Resource policies applied to this disk for automatic snapshot creations. | | `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `sourceConsistencyGroupPolicy` | `string` | [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | -| `provisionedIops` | `string` | Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. | -| `sourceSnapshotEncryptionKey` | `object` | | -| `sourceSnapshotId` | `string` | [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. | -| `guestOsFeatures` | `array` | A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. | -| `asyncPrimaryDisk` | `object` | | | `sourceImage` | `string` | The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family | -| `resourceStatus` | `object` | | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. | -| `options` | `string` | Internal use only. | -| `sourceDiskId` | `string` | [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used. | | `type` | `string` | URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types. | -| `asyncSecondaryDisks` | `object` | [Output Only] A list of disks this disk is asynchronously replicated to. | -| `licenses` | `array` | A list of publicly visible licenses. Reserved for Google's use. | -| `sourceImageId` | `string` | [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. | +| `guestOsFeatures` | `array` | A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. | +| `sourceSnapshotEncryptionKey` | `object` | | +| `provisionedThroughput` | `string` | Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 7,124. | +| `physicalBlockSizeBytes` | `string` | Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. | +| `architecture` | `string` | The architecture of the disk. Valid values are ARM64 or X86_64. | +| `labels` | `object` | Labels to apply to this disk. These can be later modified by the setLabels method. | | `locationHint` | `string` | An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API. | -| `params` | `object` | Additional disk params. | -| `lastDetachTimestamp` | `string` | [Output Only] Last detach timestamp in RFC3339 text format. | +| `options` | `string` | Internal use only. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -78,6 +78,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, zone` | Retrieves a list of persistent disks contained within the specified zone. | | `insert` | `INSERT` | `project, zone` | Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. | | `delete` | `DELETE` | `disk, project, zone` | Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. | +| `_list` | `EXEC` | `project, zone` | Retrieves a list of persistent disks contained within the specified zone. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of persistent disks. | | `bulk_insert` | `EXEC` | `project, zone` | Bulk create a set of disks. | | `resize` | `EXEC` | `disk, project, zone` | Resizes the specified persistent disk. You can only increase the size of the disk. | diff --git a/docs/google-docs/providers/google/compute/disks_iam_policies/index.md b/docs/google-docs/providers/google/compute/disks_iam_policies/index.md index c86d666126..a991feec2a 100644 --- a/docs/google-docs/providers/google/compute/disks_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/disks_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/external_vpn_gateways/index.md b/docs/google-docs/providers/google/compute/external_vpn_gateways/index.md index 7cfbea6afb..1db8abcc5b 100644 --- a/docs/google-docs/providers/google/compute/external_vpn_gateways/index.md +++ b/docs/google-docs/providers/google/compute/external_vpn_gateways/index.md @@ -30,13 +30,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `redundancyType` | `string` | Indicates the user-supplied redundancy type of this external VPN gateway. | -| `interfaces` | `array` | A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway. | | `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways. | +| `interfaces` | `array` | A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway. | | `labelFingerprint` | `string` | A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways. | +| `redundancyType` | `string` | Indicates the user-supplied redundancy type of this external VPN gateway. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,4 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of ExternalVpnGateway available to the specified project. | | `insert` | `INSERT` | `project` | Creates a ExternalVpnGateway in the specified project using the data included in the request. | | `delete` | `DELETE` | `externalVpnGateway, project` | Deletes the specified externalVpnGateway. | +| `_list` | `EXEC` | `project` | Retrieves the list of ExternalVpnGateway available to the specified project. | | `set_labels` | `EXEC` | `project, resource` | Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. | diff --git a/docs/google-docs/providers/google/compute/firewall_policies/index.md b/docs/google-docs/providers/google/compute/firewall_policies/index.md index f3e62b72fd..2a1ea4c62c 100644 --- a/docs/google-docs/providers/google/compute/firewall_policies/index.md +++ b/docs/google-docs/providers/google/compute/firewall_policies/index.md @@ -30,17 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `shortName` | `string` | User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `displayName` | `string` | Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `region` | `string` | [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `parent` | `string` | [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. | -| `shortName` | `string` | User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | -| `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. | +| `ruleTupleCount` | `integer` | [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | | `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies | -| `ruleTupleCount` | `integer` | [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. | +| `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. | | `associations` | `array` | A list of associations that belong to this firewall policy. | ## Methods | Name | Accessible by | Required Params | Description | @@ -49,6 +49,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | | Lists all the policies that have been configured for the specified folder or organization. | | `insert` | `INSERT` | | Creates a new policy in the specified project using the data included in the request. | | `delete` | `DELETE` | `firewallPolicy` | Deletes the specified policy. | +| `_list` | `EXEC` | | Lists all the policies that have been configured for the specified folder or organization. | | `clone_rules` | `EXEC` | `firewallPolicy` | Copies rules to the specified firewall policy. | | `move` | `EXEC` | `firewallPolicy` | Moves the specified firewall policy. | | `patch` | `EXEC` | `firewallPolicy` | Patches the specified policy with the data included in the request. | diff --git a/docs/google-docs/providers/google/compute/firewall_policies_iam_policies/index.md b/docs/google-docs/providers/google/compute/firewall_policies_iam_policies/index.md index 0aeaf65f77..f287562e59 100644 --- a/docs/google-docs/providers/google/compute/firewall_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/firewall_policies_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `rules` | `array` | This is deprecated and has no effect. Do not use. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `rules` | `array` | This is deprecated and has no effect. Do not use. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/firewall_policies_rule/index.md b/docs/google-docs/providers/google/compute/firewall_policies_rule/index.md index da88517cba..b849a54050 100644 --- a/docs/google-docs/providers/google/compute/firewall_policies_rule/index.md +++ b/docs/google-docs/providers/google/compute/firewall_policies_rule/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `description` | `string` | An optional description for this resource. | | `enableLogging` | `boolean` | Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules | -| `targetServiceAccounts` | `array` | A list of service accounts indicating the sets of instances that are applied with this rule. | -| `priority` | `integer` | An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. | -| `ruleName` | `string` | An optional name for the rule. This field is not a unique identifier and can be updated. | -| `disabled` | `boolean` | Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. | +| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | | `targetSecureTags` | `array` | A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. | +| `priority` | `integer` | An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. | +| `targetResources` | `array` | A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. | | `direction` | `string` | The direction in which this rule applies. | +| `ruleName` | `string` | An optional name for the rule. This field is not a unique identifier and can be updated. | | `action` | `string` | The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". | -| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | | `ruleTupleCount` | `integer` | [Output Only] Calculation of the complexity of a single firewall policy rule. | -| `targetResources` | `array` | A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. | +| `targetServiceAccounts` | `array` | A list of service accounts indicating the sets of instances that are applied with this rule. | +| `disabled` | `boolean` | Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/firewalls/index.md b/docs/google-docs/providers/google/compute/firewalls/index.md index 3e952fc5b2..e6e394f32c 100644 --- a/docs/google-docs/providers/google/compute/firewalls/index.md +++ b/docs/google-docs/providers/google/compute/firewalls/index.md @@ -30,22 +30,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. | | `description` | `string` | An optional description of this resource. Provide this field when you create the resource. | +| `direction` | `string` | Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot specify the sourceTags fields. | +| `priority` | `integer` | Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#firewall for firewall rules. | -| `targetTags` | `array` | A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. | -| `allowed` | `array` | The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. | | `sourceTags` | `array` | If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply. | -| `priority` | `integer` | Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`. | -| `network` | `string` | URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default | -| `destinationRanges` | `array` | If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported. | -| `direction` | `string` | Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot specify the sourceTags fields. | -| `denied` | `array` | The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. | | `sourceServiceAccounts` | `array` | If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. | +| `targetTags` | `array` | A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. | +| `network` | `string` | URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default | | `logConfig` | `object` | The available logging options for a firewall rule. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `disabled` | `boolean` | Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. | +| `allowed` | `array` | The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. | | `sourceRanges` | `array` | If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `disabled` | `boolean` | Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. | +| `destinationRanges` | `array` | If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported. | +| `denied` | `array` | The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. | | `targetServiceAccounts` | `array` | A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -53,5 +53,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of firewall rules available to the specified project. | | `insert` | `INSERT` | `project` | Creates a firewall rule in the specified project using the data included in the request. | | `delete` | `DELETE` | `firewall, project` | Deletes the specified firewall. | +| `_list` | `EXEC` | `project` | Retrieves the list of firewall rules available to the specified project. | | `patch` | `EXEC` | `firewall, project` | Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `firewall, project` | Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead. | diff --git a/docs/google-docs/providers/google/compute/forwarding_rules/index.md b/docs/google-docs/providers/google/compute/forwarding_rules/index.md index fe2098fc29..edb63a1f83 100644 --- a/docs/google-docs/providers/google/compute/forwarding_rules/index.md +++ b/docs/google-docs/providers/google/compute/forwarding_rules/index.md @@ -30,37 +30,37 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. | +| `sourceIpRanges` | `array` | If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). | +| `ports` | `array` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)? | +| `subnetwork` | `string` | This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. | +| `baseForwardingRule` | `string` | [Output Only] The URL for the corresponding base Forwarding Rule. By base Forwarding Rule, we mean the Forwarding Rule that has the same IP address, protocol, and port settings with the current Forwarding Rule, but without sourceIPRanges specified. Always empty if the current Forwarding Rule does not have sourceIPRanges specified. | +| `serviceLabel` | `string` | An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. | | `network` | `string` | This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided. | -| `loadBalancingScheme` | `string` | Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. | -| `isMirroringCollector` | `boolean` | Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. | -| `serviceDirectoryRegistrations` | `array` | Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `allowGlobalAccess` | `boolean` | This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created. | +| `serviceName` | `string` | [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. | +| `IPProtocol` | `string` | The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). | +| `portRange` | `string` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)? | | `region` | `string` | [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `backendService` | `string` | Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. | +| `metadataFilters` | `array` | Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. | +| `serviceDirectoryRegistrations` | `array` | Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. | +| `pscConnectionStatus` | `string` | | | `noAutomateDnsZone` | `boolean` | This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field. Once set, this field is not mutable. | -| `IPProtocol` | `string` | The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). | -| `allowGlobalAccess` | `boolean` | This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. | +| `target` | `string` | The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. | +| `pscConnectionId` | `string` | [Output Only] The PSC connection id of the PSC Forwarding Rule. | +| `ipVersion` | `string` | The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. | | `allowPscGlobalAccess` | `boolean` | This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. | +| `networkTier` | `string` | This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. | -| `target` | `string` | The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. | +| `isMirroringCollector` | `boolean` | Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `backendService` | `string` | Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. | -| `networkTier` | `string` | This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. | -| `portRange` | `string` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)? | +| `allPorts` | `boolean` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | | `IPAddress` | `string` | IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number. | -| `serviceLabel` | `string` | An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. | -| `pscConnectionStatus` | `string` | | -| `ipVersion` | `string` | The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `allPorts` | `boolean` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. | -| `metadataFilters` | `array` | Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. | -| `ports` | `array` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)? | -| `serviceName` | `string` | [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. | -| `baseForwardingRule` | `string` | [Output Only] The URL for the corresponding base Forwarding Rule. By base Forwarding Rule, we mean the Forwarding Rule that has the same IP address, protocol, and port settings with the current Forwarding Rule, but without sourceIPRanges specified. Always empty if the current Forwarding Rule does not have sourceIPRanges specified. | -| `pscConnectionId` | `string` | [Output Only] The PSC connection id of the PSC Forwarding Rule. | -| `subnetwork` | `string` | This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. | -| `sourceIpRanges` | `array` | If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). | +| `loadBalancingScheme` | `string` | Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -68,6 +68,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of ForwardingRule resources available to the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a ForwardingRule resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `forwardingRule, project, region` | Deletes the specified ForwardingRule resource. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of ForwardingRule resources available to the specified project and region. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of forwarding rules. | | `patch` | `EXEC` | `forwardingRule, project, region` | Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. | | `set_labels` | `EXEC` | `project, region, resource` | Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. | diff --git a/docs/google-docs/providers/google/compute/global_addresses/index.md b/docs/google-docs/providers/google/compute/global_addresses/index.md index 2c63ff4e2e..af04abc340 100644 --- a/docs/google-docs/providers/google/compute/global_addresses/index.md +++ b/docs/google-docs/providers/google/compute/global_addresses/index.md @@ -30,23 +30,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. | | `description` | `string` | An optional description of this resource. Provide this field when you create the resource. | -| `networkTier` | `string` | This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM. | -| `subnetwork` | `string` | The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose. | | `addressType` | `string` | The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. | -| `ipv6EndpointType` | `string` | The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#address for addresses. | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | | `prefixLength` | `integer` | The prefix length if the resource represents an IP range. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `networkTier` | `string` | This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM. | +| `status` | `string` | [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. | +| `subnetwork` | `string` | The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose. | +| `users` | `array` | [Output Only] The URLs of the resources that are using this address. | | `region` | `string` | [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.* | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address. | +| `ipv6EndpointType` | `string` | The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. | | `purpose` | `string` | The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. | -| `users` | `array` | [Output Only] The URLs of the resources that are using this address. | -| `ipVersion` | `string` | The IP version that will be used by this address. Valid options are IPV4 or IPV6. | | `address` | `string` | The static IP address represented by this resource. | -| `status` | `string` | [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `ipVersion` | `string` | The IP version that will be used by this address. Valid options are IPV4 or IPV6. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address. | | `network` | `string` | The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#address for addresses. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -54,5 +54,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves a list of global addresses. | | `insert` | `INSERT` | `project` | Creates an address resource in the specified project by using the data included in the request. | | `delete` | `DELETE` | `address, project` | Deletes the specified address resource. | +| `_list` | `EXEC` | `project` | Retrieves a list of global addresses. | | `move` | `EXEC` | `address, project` | Moves the specified address resource from one project to another project. | | `set_labels` | `EXEC` | `project, resource` | Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. | diff --git a/docs/google-docs/providers/google/compute/global_forwarding_rules/index.md b/docs/google-docs/providers/google/compute/global_forwarding_rules/index.md index 5f89b13a76..e248b8e6c8 100644 --- a/docs/google-docs/providers/google/compute/global_forwarding_rules/index.md +++ b/docs/google-docs/providers/google/compute/global_forwarding_rules/index.md @@ -30,37 +30,37 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `IPProtocol` | `string` | The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). | | `isMirroringCollector` | `boolean` | Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. | -| `region` | `string` | [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `metadataFilters` | `array` | Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. | -| `allowPscGlobalAccess` | `boolean` | This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. | +| `ipVersion` | `string` | The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. | +| `pscConnectionStatus` | `string` | | +| `serviceLabel` | `string` | An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. | | `baseForwardingRule` | `string` | [Output Only] The URL for the corresponding base Forwarding Rule. By base Forwarding Rule, we mean the Forwarding Rule that has the same IP address, protocol, and port settings with the current Forwarding Rule, but without sourceIPRanges specified. Always empty if the current Forwarding Rule does not have sourceIPRanges specified. | +| `metadataFilters` | `array` | Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. | +| `loadBalancingScheme` | `string` | Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. | | `IPAddress` | `string` | IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number. | +| `IPProtocol` | `string` | The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. | +| `networkTier` | `string` | This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. | +| `serviceDirectoryRegistrations` | `array` | Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. | +| `ports` | `array` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)? | +| `subnetwork` | `string` | This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. | +| `backendService` | `string` | Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `serviceName` | `string` | [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. | | `labelFingerprint` | `string` | A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. | -| `ipVersion` | `string` | The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. | | `network` | `string` | This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided. | +| `sourceIpRanges` | `array` | If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `region` | `string` | [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `allPorts` | `boolean` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `ports` | `array` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)? | +| `pscConnectionId` | `string` | [Output Only] The PSC connection id of the PSC Forwarding Rule. | +| `portRange` | `string` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)? | | `target` | `string` | The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. | -| `serviceDirectoryRegistrations` | `array` | Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. | -| `backendService` | `string` | Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. | -| `subnetwork` | `string` | This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. | | `noAutomateDnsZone` | `boolean` | This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field. Once set, this field is not mutable. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. | -| `sourceIpRanges` | `array` | If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). | -| `portRange` | `string` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)? | -| `pscConnectionStatus` | `string` | | -| `pscConnectionId` | `string` | [Output Only] The PSC connection id of the PSC Forwarding Rule. | -| `allPorts` | `boolean` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. | -| `loadBalancingScheme` | `string` | Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. | -| `serviceLabel` | `string` | An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. | +| `allowPscGlobalAccess` | `boolean` | This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. | | `allowGlobalAccess` | `boolean` | This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. | -| `networkTier` | `string` | This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. | -| `serviceName` | `string` | [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -68,6 +68,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves a list of GlobalForwardingRule resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a GlobalForwardingRule resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `forwardingRule, project` | Deletes the specified GlobalForwardingRule resource. | +| `_list` | `EXEC` | `project` | Retrieves a list of GlobalForwardingRule resources available to the specified project. | | `patch` | `EXEC` | `forwardingRule, project` | Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. | | `set_labels` | `EXEC` | `project, resource` | Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation. | | `set_target` | `EXEC` | `forwardingRule, project` | Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. | diff --git a/docs/google-docs/providers/google/compute/global_network_endpoint_groups/index.md b/docs/google-docs/providers/google/compute/global_network_endpoint_groups/index.md index d6d0e767a1..61bd1177d0 100644 --- a/docs/google-docs/providers/google/compute/global_network_endpoint_groups/index.md +++ b/docs/google-docs/providers/google/compute/global_network_endpoint_groups/index.md @@ -30,22 +30,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. | +| `network` | `string` | The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. | +| `subnetwork` | `string` | Optional URL of the subnetwork to which all network endpoints in the NEG belong. | +| `defaultPort` | `integer` | The default port used if the port number is not specified in the network endpoint. | +| `region` | `string` | [Output Only] The URL of the region where the network endpoint group is located. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `networkEndpointType` | `string` | Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. | -| `annotations` | `object` | Metadata defined as annotations on the network endpoint group. | +| `cloudFunction` | `object` | Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `pscTargetService` | `string` | The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com" | -| `zone` | `string` | [Output Only] The URL of the zone where the network endpoint group is located. | -| `pscData` | `object` | All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. | | `appEngine` | `object` | Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. | +| `pscData` | `object` | All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. | +| `annotations` | `object` | Metadata defined as annotations on the network endpoint group. | +| `zone` | `string` | [Output Only] The URL of the zone where the network endpoint group is located. | | `cloudRun` | `object` | Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. | -| `defaultPort` | `integer` | The default port used if the port number is not specified in the network endpoint. | -| `cloudFunction` | `object` | Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. | | `size` | `integer` | [Output only] Number of network endpoints in the network endpoint group. | -| `region` | `string` | [Output Only] The URL of the region where the network endpoint group is located. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. | -| `subnetwork` | `string` | Optional URL of the subnetwork to which all network endpoints in the NEG belong. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `network` | `string` | The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. | +| `pscTargetService` | `string` | The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com" | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -53,5 +53,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of network endpoint groups that are located in the specified project. | | `insert` | `INSERT` | `project` | Creates a network endpoint group in the specified project using the parameters that are included in the request. | | `delete` | `DELETE` | `networkEndpointGroup, project` | Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it. | +| `_list` | `EXEC` | `project` | Retrieves the list of network endpoint groups that are located in the specified project. | | `attach_network_endpoints` | `EXEC` | `networkEndpointGroup, project` | Attach a network endpoint to the specified network endpoint group. | | `detach_network_endpoints` | `EXEC` | `networkEndpointGroup, project` | Detach the network endpoint from the specified network endpoint group. | diff --git a/docs/google-docs/providers/google/compute/global_operations/index.md b/docs/google-docs/providers/google/compute/global_operations/index.md index 3694e667a2..8fb42348e2 100644 --- a/docs/google-docs/providers/google/compute/global_operations/index.md +++ b/docs/google-docs/providers/google/compute/global_operations/index.md @@ -30,32 +30,33 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the operation. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the operation. | | `description` | `string` | [Output Only] A textual description of the operation, which is set when the operation is created. | -| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | -| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | -| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | -| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | | `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | -| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | +| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | +| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | +| `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | | `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | -| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | +| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | +| `setCommonInstanceMetadataOperationMetadata` | `object` | | +| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | +| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | +| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | +| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | | `targetLink` | `string` | [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. | -| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | | `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | -| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | +| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | +| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | +| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | +| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | +| `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | | `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | | `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | -| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | -| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | -| `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | -| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | -| `setCommonInstanceMetadataOperationMetadata` | `object` | | -| `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | -| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operation, project` | Retrieves the specified Operations resource. | | `list` | `SELECT` | `project` | Retrieves a list of Operation resources contained within the specified project. | | `delete` | `DELETE` | `operation, project` | Deletes the specified Operations resource. | +| `_list` | `EXEC` | `project` | Retrieves a list of Operation resources contained within the specified project. | | `wait` | `EXEC` | `operation, project` | Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. | diff --git a/docs/google-docs/providers/google/compute/global_organization_operations/index.md b/docs/google-docs/providers/google/compute/global_organization_operations/index.md index 38bf231703..8845203c5a 100644 --- a/docs/google-docs/providers/google/compute/global_organization_operations/index.md +++ b/docs/google-docs/providers/google/compute/global_organization_operations/index.md @@ -30,31 +30,32 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the operation. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the operation. | | `description` | `string` | [Output Only] A textual description of the operation, which is set when the operation is created. | -| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | +| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | +| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | | `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | +| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | | `setCommonInstanceMetadataOperationMetadata` | `object` | | -| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | -| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | -| `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | -| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | | `targetLink` | `string` | [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. | -| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | -| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | | `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | -| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | -| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | -| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | -| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | -| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | -| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | +| `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | | `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | -| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | -| `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | | `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | +| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | +| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | +| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | +| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | +| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | +| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | +| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | +| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | +| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operation` | Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request. | | `list` | `SELECT` | | Retrieves a list of Operation resources contained within the specified organization. | | `delete` | `DELETE` | `operation` | Deletes the specified Operations resource. | +| `_list` | `EXEC` | | Retrieves a list of Operation resources contained within the specified organization. | diff --git a/docs/google-docs/providers/google/compute/global_public_delegated_prefixes/index.md b/docs/google-docs/providers/google/compute/global_public_delegated_prefixes/index.md index 8e8465b395..0584d4faf9 100644 --- a/docs/google-docs/providers/google/compute/global_public_delegated_prefixes/index.md +++ b/docs/google-docs/providers/google/compute/global_public_delegated_prefixes/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource type. The server generates this identifier. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes. | +| `parentPrefix` | `string` | The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix. | | `publicDelegatedSubPrefixs` | `array` | The list of sub public delegated prefixes that exist for this public delegated prefix. | -| `ipCidrRange` | `string` | The IP address range, in CIDR format, represented by this public delegated prefix. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `isLiveMigration` | `boolean` | If true, the prefix will be live migrated. | +| `ipCidrRange` | `string` | The IP address range, in CIDR format, represented by this public delegated prefix. | | `status` | `string` | [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. | -| `parentPrefix` | `string` | The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes. | | `region` | `string` | [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | ## Methods | Name | Accessible by | Required Params | Description | @@ -47,4 +47,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Lists the global PublicDelegatedPrefixes for a project. | | `insert` | `INSERT` | `project` | Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request. | | `delete` | `DELETE` | `project, publicDelegatedPrefix` | Deletes the specified global PublicDelegatedPrefix. | +| `_list` | `EXEC` | `project` | Lists the global PublicDelegatedPrefixes for a project. | | `patch` | `EXEC` | `project, publicDelegatedPrefix` | Patches the specified global PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | diff --git a/docs/google-docs/providers/google/compute/health_checks/index.md b/docs/google-docs/providers/google/compute/health_checks/index.md index 2bf4a3d10f..5378f1dd91 100644 --- a/docs/google-docs/providers/google/compute/health_checks/index.md +++ b/docs/google-docs/providers/google/compute/health_checks/index.md @@ -30,22 +30,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `http2HealthCheck` | `object` | | -| `httpHealthCheck` | `object` | | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in 3339 text format. | | `httpsHealthCheck` | `object` | | -| `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | -| `sslHealthCheck` | `object` | | -| `kind` | `string` | Type of the resource. | +| `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `region` | `string` | [Output Only] Region where the health check resides. Not applicable to global health checks. | | `type` | `string` | Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. | -| `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | | `grpcHealthCheck` | `object` | | +| `sslHealthCheck` | `object` | | | `logConfig` | `object` | Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `timeoutSec` | `integer` | How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. | -| `region` | `string` | [Output Only] Region where the health check resides. Not applicable to global health checks. | -| `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | +| `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | | `tcpHealthCheck` | `object` | | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in 3339 text format. | +| `httpHealthCheck` | `object` | | +| `timeoutSec` | `integer` | How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. | +| `http2HealthCheck` | `object` | | +| `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | +| `kind` | `string` | Type of the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -53,5 +53,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of HealthCheck resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a HealthCheck resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `healthCheck, project` | Deletes the specified HealthCheck resource. | +| `_list` | `EXEC` | `project` | Retrieves the list of HealthCheck resources available to the specified project. | | `patch` | `EXEC` | `healthCheck, project` | Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `healthCheck, project` | Updates a HealthCheck resource in the specified project using the data included in the request. | diff --git a/docs/google-docs/providers/google/compute/http_health_checks/index.md b/docs/google-docs/providers/google/compute/http_health_checks/index.md index 6ea3557df9..9bc9c6dda1 100644 --- a/docs/google-docs/providers/google/compute/http_health_checks/index.md +++ b/docs/google-docs/providers/google/compute/http_health_checks/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | | `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | -| `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `requestPath` | `string` | The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986. | -| `port` | `integer` | The TCP port number for the HTTP health check request. The default value is 80. | | `timeoutSec` | `integer` | How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. | -| `host` | `string` | The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. | +| `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | +| `port` | `integer` | The TCP port number for the HTTP health check request. The default value is 80. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `requestPath` | `string` | The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986. | +| `host` | `string` | The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,5 +47,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of HttpHealthCheck resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a HttpHealthCheck resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `httpHealthCheck, project` | Deletes the specified HttpHealthCheck resource. | +| `_list` | `EXEC` | `project` | Retrieves the list of HttpHealthCheck resources available to the specified project. | | `patch` | `EXEC` | `httpHealthCheck, project` | Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `httpHealthCheck, project` | Updates a HttpHealthCheck resource in the specified project using the data included in the request. | diff --git a/docs/google-docs/providers/google/compute/https_health_checks/index.md b/docs/google-docs/providers/google/compute/https_health_checks/index.md index 419c20c6e4..de91fbfcdd 100644 --- a/docs/google-docs/providers/google/compute/https_health_checks/index.md +++ b/docs/google-docs/providers/google/compute/https_health_checks/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `port` | `integer` | The TCP port number for the HTTPS health check request. The default value is 443. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `kind` | `string` | Type of the resource. | +| `timeoutSec` | `integer` | How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec. | | `host` | `string` | The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. | -| `requestPath` | `string` | The request path of the HTTPS health check request. The default value is "/". Must comply with RFC3986. | +| `kind` | `string` | Type of the resource. | | `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | -| `timeoutSec` | `integer` | How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec. | -| `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | | `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | +| `requestPath` | `string` | The request path of the HTTPS health check request. The default value is "/". Must comply with RFC3986. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `port` | `integer` | The TCP port number for the HTTPS health check request. The default value is 443. | +| `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,5 +47,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of HttpsHealthCheck resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a HttpsHealthCheck resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `httpsHealthCheck, project` | Deletes the specified HttpsHealthCheck resource. | +| `_list` | `EXEC` | `project` | Retrieves the list of HttpsHealthCheck resources available to the specified project. | | `patch` | `EXEC` | `httpsHealthCheck, project` | Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `httpsHealthCheck, project` | Updates a HttpsHealthCheck resource in the specified project using the data included in the request. | diff --git a/docs/google-docs/providers/google/compute/images/index.md b/docs/google-docs/providers/google/compute/images/index.md index fe43b4f878..05c87e7ff1 100644 --- a/docs/google-docs/providers/google/compute/images/index.md +++ b/docs/google-docs/providers/google/compute/images/index.md @@ -30,35 +30,35 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image. | +| `imageEncryptionKey` | `object` | | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#image for images. | +| `sourceSnapshotEncryptionKey` | `object` | | | `archiveSizeBytes` | `string` | Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). | -| `shieldedInstanceInitialState` | `object` | Initial State for shielded instance, these are public keys which are safe to store in public | +| `sourceImageId` | `string` | [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. | +| `deprecated` | `object` | Deprecation status for a public resource. | | `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `rawDisk` | `object` | The parameters of the raw disk image. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#image for images. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `sourceDiskId` | `string` | [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. | +| `family` | `string` | The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. | +| `diskSizeGb` | `string` | Size of the image when restored onto a persistent disk (in GB). | | `sourceSnapshotId` | `string` | [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name. | +| `sourceDisk` | `string` | URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL | +| `shieldedInstanceInitialState` | `object` | Initial State for shielded instance, these are public keys which are safe to store in public | +| `sourceImage` | `string` | URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL | +| `storageLocations` | `array` | Cloud Storage bucket storage location of the image (regional or multi-regional). | +| `guestOsFeatures` | `array` | A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter. | +| `labels` | `object` | Labels to apply to this image. These can be later modified by the setLabels method. | +| `sourceDiskId` | `string` | [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. | +| `licenses` | `array` | Any applicable license URI. | +| `rawDisk` | `object` | The parameters of the raw disk image. | | `status` | `string` | [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. | | `sourceDiskEncryptionKey` | `object` | | | `sourceType` | `string` | The type of the image used to create this disk. The default and only valid value is RAW. | -| `sourceSnapshotEncryptionKey` | `object` | | -| `diskSizeGb` | `string` | Size of the image when restored onto a persistent disk (in GB). | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `sourceSnapshot` | `string` | URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL | | `architecture` | `string` | The architecture of the image. Valid values are ARM64 or X86_64. | -| `licenses` | `array` | Any applicable license URI. | -| `labels` | `object` | Labels to apply to this image. These can be later modified by the setLabels method. | -| `deprecated` | `object` | Deprecation status for a public resource. | -| `guestOsFeatures` | `array` | A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter. | -| `sourceDisk` | `string` | URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL | -| `imageEncryptionKey` | `object` | | -| `sourceImageEncryptionKey` | `object` | | -| `sourceImage` | `string` | URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL | -| `storageLocations` | `array` | Cloud Storage bucket storage location of the image (regional or multi-regional). | | `licenseCodes` | `array` | Integer license codes indicating which licenses are attached to this image. | -| `family` | `string` | The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. | -| `sourceImageId` | `string` | [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image. | +| `sourceImageEncryptionKey` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -66,6 +66,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. | | `insert` | `INSERT` | `project` | Creates an image in the specified project using the data included in the request. | | `delete` | `DELETE` | `image, project` | Deletes the specified image. | +| `_list` | `EXEC` | `project` | Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. | | `deprecate` | `EXEC` | `image, project` | Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. | | `patch` | `EXEC` | `image, project` | Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status. | | `set_labels` | `EXEC` | `project, resource` | Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. | diff --git a/docs/google-docs/providers/google/compute/images_iam_policies/index.md b/docs/google-docs/providers/google/compute/images_iam_policies/index.md index d0700b5b0a..345e67f7da 100644 --- a/docs/google-docs/providers/google/compute/images_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/images_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/index.md b/docs/google-docs/providers/google/compute/index.md index ad0b3096ee..fd58b2068a 100644 --- a/docs/google-docs/providers/google/compute/index.md +++ b/docs/google-docs/providers/google/compute/index.md @@ -19,9 +19,9 @@ Creates And Runs Virtual Machines On Google Cloud Platform.
-total resources: 187
-total selectable resources: 140
-total methods: 711
+total resources: 188
+total selectable resources: 141
+total methods: 801
@@ -33,7 +33,7 @@ Creates And Runs Virtual Machines On Google Cloud Platform. TypeService TitleCompute Engine API DescriptionCreates And Runs Virtual Machines On Google Cloud Platform. -Idcompute:v23.08.00155 +Idcompute:v23.08.00157 ## Resources @@ -184,6 +184,7 @@ Creates And Runs Virtual Machines On Google Cloud Platform. resource_policies
resource_policies_iam_policies
routers
+routers_nat_ip_info
routers_nat_mapping_info
routers_router_status
routes
diff --git a/docs/google-docs/providers/google/compute/instance_group_managers/index.md b/docs/google-docs/providers/google/compute/instance_group_managers/index.md index 64a3dcbcaf..992726f4e2 100644 --- a/docs/google-docs/providers/google/compute/instance_group_managers/index.md +++ b/docs/google-docs/providers/google/compute/instance_group_managers/index.md @@ -30,27 +30,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] A unique identifier for this resource type. The server generates this identifier. | | `name` | `string` | The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. | | `description` | `string` | An optional description of this resource. | -| `statefulPolicy` | `object` | | -| `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. | -| `fingerprint` | `string` | Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. | -| `instanceTemplate` | `string` | The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. | -| `selfLink` | `string` | [Output Only] The URL for this managed instance group. The server defines this URL. | +| `instanceLifecyclePolicy` | `object` | | +| `versions` | `array` | Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. | +| `region` | `string` | [Output Only] The URL of the region where the managed instance group resides (for regional resources). | +| `status` | `object` | | | `updatePolicy` | `object` | | -| `baseInstanceName` | `string` | The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. | -| `autoHealingPolicies` | `array` | The autohealing policy for this managed instance group. You can specify only one value. | | `zone` | `string` | [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). | +| `statefulPolicy` | `object` | | | `distributionPolicy` | `object` | | | `currentActions` | `object` | | -| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. | -| `instanceLifecyclePolicy` | `object` | | -| `status` | `object` | | -| `targetSize` | `integer` | The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. | -| `listManagedInstancesResults` | `string` | Pagination behavior of the listManagedInstances API method for this managed instance group. | +| `selfLink` | `string` | [Output Only] The URL for this managed instance group. The server defines this URL. | | `instanceGroup` | `string` | [Output Only] The URL of the Instance Group resource. | +| `targetSize` | `integer` | The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. | +| `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. | +| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. | +| `autoHealingPolicies` | `array` | The autohealing policy for this managed instance group. You can specify only one value. | | `namedPorts` | `array` | Named ports configured for the Instance Groups complementary to this Instance Group Manager. | -| `versions` | `array` | Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. | -| `region` | `string` | [Output Only] The URL of the region where the managed instance group resides (for regional resources). | | `targetPools` | `array` | The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. | +| `baseInstanceName` | `string` | The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. | +| `fingerprint` | `string` | Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. | +| `instanceTemplate` | `string` | The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. | +| `listManagedInstancesResults` | `string` | Pagination behavior of the listManagedInstances API method for this managed instance group. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -58,6 +58,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, zone` | Retrieves a list of managed instance groups that are contained within the specified project and zone. | | `insert` | `INSERT` | `project, zone` | Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. | | `delete` | `DELETE` | `instanceGroupManager, project, zone` | Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. | +| `_list` | `EXEC` | `project, zone` | Retrieves a list of managed instance groups that are contained within the specified project and zone. | | `abandon_instances` | `EXEC` | `instanceGroupManager, project, zone` | Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. | | `aggregated_list` | `EXEC` | `project` | Retrieves the list of managed instance groups and groups them by zone. | | `apply_updates_to_instances` | `EXEC` | `instanceGroupManager, project, zone` | Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. | diff --git a/docs/google-docs/providers/google/compute/instance_group_managers_errors/index.md b/docs/google-docs/providers/google/compute/instance_group_managers_errors/index.md index 5b5350ae42..741ee1bad1 100644 --- a/docs/google-docs/providers/google/compute/instance_group_managers_errors/index.md +++ b/docs/google-docs/providers/google/compute/instance_group_managers_errors/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `timestamp` | `string` | [Output Only] The time that this error occurred. This value is in RFC3339 text format. | | `error` | `object` | | | `instanceActionDetails` | `object` | | -| `timestamp` | `string` | [Output Only] The time that this error occurred. This value is in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/instance_groups/index.md b/docs/google-docs/providers/google/compute/instance_groups/index.md index 7a052a5d7e..9f94a0e867 100644 --- a/docs/google-docs/providers/google/compute/instance_groups/index.md +++ b/docs/google-docs/providers/google/compute/instance_groups/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] A unique identifier for this instance group, generated by the server. | | `name` | `string` | The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `fingerprint` | `string` | [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. | -| `network` | `string` | [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0). | -| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this instance group in RFC3339 text format. | -| `region` | `string` | [Output Only] The URL of the region where the instance group is located (for regional resources). | -| `size` | `integer` | [Output Only] The total number of instances in the instance group. | | `namedPorts` | `array` | Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. | | `selfLink` | `string` | [Output Only] The URL for this instance group. The server generates this URL. | +| `size` | `integer` | [Output Only] The total number of instances in the instance group. | +| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this instance group in RFC3339 text format. | | `subnetwork` | `string` | [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0). | -| `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroup for instance groups. | | `zone` | `string` | [Output Only] The URL of the zone where the instance group is located (for zonal resources). | +| `fingerprint` | `string` | [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. | +| `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroup for instance groups. | +| `region` | `string` | [Output Only] The URL of the region where the instance group is located (for regional resources). | +| `network` | `string` | [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,5 +47,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, zone` | Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead. | | `insert` | `INSERT` | `project, zone` | Creates an instance group in the specified project using the parameters that are included in the request. | | `delete` | `DELETE` | `instanceGroup, project, zone` | Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. | +| `_list` | `EXEC` | `project, zone` | Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead. | | `aggregated_list` | `EXEC` | `project` | Retrieves the list of instance groups and sorts them by zone. | | `set_named_ports` | `EXEC` | `instanceGroup, project, zone` | Sets the named ports for the specified instance group. | diff --git a/docs/google-docs/providers/google/compute/instance_templates/index.md b/docs/google-docs/providers/google/compute/instance_templates/index.md index d5bdbadd17..ee9e9fdede 100644 --- a/docs/google-docs/providers/google/compute/instance_templates/index.md +++ b/docs/google-docs/providers/google/compute/instance_templates/index.md @@ -30,13 +30,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] A unique identifier for this instance template. The server defines this identifier. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `region` | `string` | [Output Only] URL of the region where the instance template resides. Only applicable for regional resources. | | `selfLink` | `string` | [Output Only] The URL for this instance template. The server defines this URL. | -| `sourceInstanceParams` | `object` | A specification of the parameters to use when creating the instance template from a source instance. | | `creationTimestamp` | `string` | [Output Only] The creation timestamp for this instance template in RFC3339 text format. | -| `region` | `string` | [Output Only] URL of the region where the instance template resides. Only applicable for regional resources. | -| `sourceInstance` | `string` | The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance | | `kind` | `string` | [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. | | `properties` | `object` | | +| `sourceInstance` | `string` | The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance | +| `sourceInstanceParams` | `object` | A specification of the parameters to use when creating the instance template from a source instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,3 +44,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves a list of instance templates that are contained within the specified project. | | `insert` | `INSERT` | `project` | Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. | | `delete` | `DELETE` | `instanceTemplate, project` | Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. | +| `_list` | `EXEC` | `project` | Retrieves a list of instance templates that are contained within the specified project. | diff --git a/docs/google-docs/providers/google/compute/instance_templates_iam_policies/index.md b/docs/google-docs/providers/google/compute/instance_templates_iam_policies/index.md index 907e62aa57..e143672c13 100644 --- a/docs/google-docs/providers/google/compute/instance_templates_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/instance_templates_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/instances/index.md b/docs/google-docs/providers/google/compute/instances/index.md index f04107b6aa..0d9c560bb4 100644 --- a/docs/google-docs/providers/google/compute/instances/index.md +++ b/docs/google-docs/providers/google/compute/instances/index.md @@ -30,48 +30,48 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `minCpuPlatform` | `string` | Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". | +| `statusMessage` | `string` | [Output Only] An optional, human-readable explanation of the status. | +| `metadata` | `object` | A metadata key/value entry. | +| `canIpForward` | `boolean` | Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding . | +| `advancedMachineFeatures` | `object` | Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). | +| `shieldedInstanceConfig` | `object` | A set of Shielded Instance options. | +| `zone` | `string` | [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `displayDevice` | `object` | A set of Display Device options | +| `confidentialInstanceConfig` | `object` | A set of Confidential Instance options. | +| `disks` | `array` | Array of disks associated with this instance. Persistent disks must be created before you can assign them. | | `resourceStatus` | `object` | Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. | -| `status` | `string` | [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle. | +| `reservationAffinity` | `object` | Specifies the reservations that this instance can consume from. | +| `labelFingerprint` | `string` | A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance. | +| `resourcePolicies` | `array` | Resource policies applied to this instance. | | `networkPerformanceConfig` | `object` | | +| `serviceAccounts` | `array` | A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information. | +| `status` | `string` | [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle. | | `startRestricted` | `boolean` | [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `lastStopTimestamp` | `string` | [Output Only] Last stop timestamp in RFC3339 text format. | | `privateIpv6GoogleAccess` | `string` | The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#instance for instances. | -| `resourcePolicies` | `array` | Resource policies applied to this instance. | | `hostname` | `string` | Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. | -| `lastSuspendedTimestamp` | `string` | [Output Only] Last suspended timestamp in RFC3339 text format. | -| `keyRevocationActionType` | `string` | KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. | -| `scheduling` | `object` | Sets the scheduling options for an Instance. | -| `canIpForward` | `boolean` | Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding . | -| `displayDevice` | `object` | A set of Display Device options | -| `labels` | `object` | Labels to apply to this instance. These can be later modified by the setLabels method. | +| `lastStopTimestamp` | `string` | [Output Only] Last stop timestamp in RFC3339 text format. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#instance for instances. | +| `minCpuPlatform` | `string` | Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". | +| `tags` | `object` | A set of instance tags. | +| `selfLink` | `string` | [Output Only] Server-defined URL for this resource. | | `networkInterfaces` | `array` | An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. | -| `instanceEncryptionKey` | `object` | | -| `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance. | -| `params` | `object` | Additional instance params. | -| `statusMessage` | `string` | [Output Only] An optional, human-readable explanation of the status. | +| `sourceMachineImage` | `string` | Source machine image | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | | `machineType` | `string` | Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `sourceMachineImageEncryptionKey` | `object` | | -| `shieldedInstanceConfig` | `object` | A set of Shielded Instance options. | -| `deletionProtection` | `boolean` | Whether the resource should be protected against deletion. | +| `instanceEncryptionKey` | `object` | | | `guestAccelerators` | `array` | A list of the type and count of accelerator cards attached to the instance. | -| `serviceAccounts` | `array` | A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information. | +| `sourceMachineImageEncryptionKey` | `object` | | +| `params` | `object` | Additional instance params. | +| `keyRevocationActionType` | `string` | KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. | +| `labels` | `object` | Labels to apply to this instance. These can be later modified by the setLabels method. | +| `lastStartTimestamp` | `string` | [Output Only] Last start timestamp in RFC3339 text format. | +| `scheduling` | `object` | Sets the scheduling options for an Instance. | +| `lastSuspendedTimestamp` | `string` | [Output Only] Last suspended timestamp in RFC3339 text format. | +| `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance. | | `shieldedInstanceIntegrityPolicy` | `object` | The policy describes the baseline against which Instance boot integrity is measured. | -| `selfLink` | `string` | [Output Only] Server-defined URL for this resource. | -| `labelFingerprint` | `string` | A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance. | -| `tags` | `object` | A set of instance tags. | -| `disks` | `array` | Array of disks associated with this instance. Persistent disks must be created before you can assign them. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `cpuPlatform` | `string` | [Output Only] The CPU platform used by this instance. | -| `confidentialInstanceConfig` | `object` | A set of Confidential Instance options. | -| `lastStartTimestamp` | `string` | [Output Only] Last start timestamp in RFC3339 text format. | -| `metadata` | `object` | A metadata key/value entry. | -| `zone` | `string` | [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `advancedMachineFeatures` | `object` | Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). | -| `reservationAffinity` | `object` | Specifies the reservations that this instance can consume from. | -| `sourceMachineImage` | `string` | Source machine image | +| `deletionProtection` | `boolean` | Whether the resource should be protected against deletion. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -79,6 +79,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, zone` | Retrieves the list of instances contained within the specified zone. | | `insert` | `INSERT` | `project, zone` | Creates an instance resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `instance, project, zone` | Deletes the specified Instance resource. For more information, see Deleting an instance. | +| `_list` | `EXEC` | `project, zone` | Retrieves the list of instances contained within the specified zone. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances. | | `attach_disk` | `EXEC` | `instance, project, zone` | Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. | | `bulk_insert` | `EXEC` | `project, zone` | Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs. | diff --git a/docs/google-docs/providers/google/compute/instances_effective_firewalls/index.md b/docs/google-docs/providers/google/compute/instances_effective_firewalls/index.md index 975649b3ed..38e9f20cdf 100644 --- a/docs/google-docs/providers/google/compute/instances_effective_firewalls/index.md +++ b/docs/google-docs/providers/google/compute/instances_effective_firewalls/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `firewallPolicys` | `array` | Effective firewalls from firewall policies. | | `firewalls` | `array` | Effective firewalls on the instance. | +| `firewallPolicys` | `array` | Effective firewalls from firewall policies. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/instances_guest_attributes/index.md b/docs/google-docs/providers/google/compute/instances_guest_attributes/index.md index 3ae953ba04..979afbbf57 100644 --- a/docs/google-docs/providers/google/compute/instances_guest_attributes/index.md +++ b/docs/google-docs/providers/google/compute/instances_guest_attributes/index.md @@ -27,12 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `variableValue` | `string` | [Output Only] The value found for the requested key. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry. | | `queryPath` | `string` | The path to be queried. This can be the default namespace ('') or a nested namespace ('\/') or a specified key ('\/\'). | | `queryValue` | `object` | Array of guest attribute namespace/key/value tuples. | | `selfLink` | `string` | [Output Only] Server-defined URL for this resource. | | `variableKey` | `string` | The key to search for. | -| `variableValue` | `string` | [Output Only] The value found for the requested key. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/instances_iam_policies/index.md b/docs/google-docs/providers/google/compute/instances_iam_policies/index.md index b2ce062818..08ebac30a8 100644 --- a/docs/google-docs/providers/google/compute/instances_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/instances_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/instances_referrers/index.md b/docs/google-docs/providers/google/compute/instances_referrers/index.md index 67eb1c1660..5d0f82da82 100644 --- a/docs/google-docs/providers/google/compute/instances_referrers/index.md +++ b/docs/google-docs/providers/google/compute/instances_referrers/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `referenceType` | `string` | A description of the reference type with no implied semantics. Possible values include: 1. MEMBER_OF | -| `referrer` | `string` | URL of the resource which refers to the target. | | `target` | `string` | URL of the resource to which this reference points. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#reference for references. | +| `referenceType` | `string` | A description of the reference type with no implied semantics. Possible values include: 1. MEMBER_OF | +| `referrer` | `string` | URL of the resource which refers to the target. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/instances_serial_port_output/index.md b/docs/google-docs/providers/google/compute/instances_serial_port_output/index.md index 4a7a1d43af..6093f91062 100644 --- a/docs/google-docs/providers/google/compute/instances_serial_port_output/index.md +++ b/docs/google-docs/providers/google/compute/instances_serial_port_output/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `selfLink` | `string` | [Output Only] Server-defined URL for this resource. | +| `start` | `string` | The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the `start` value that was specified in the request. | | `contents` | `string` | [Output Only] The contents of the console output. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output. | | `next` | `string` | [Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the `contents` property. Use this value in the next request as the start parameter. | -| `selfLink` | `string` | [Output Only] Server-defined URL for this resource. | -| `start` | `string` | The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the `start` value that was specified in the request. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/interconnect_attachments/index.md b/docs/google-docs/providers/google/compute/interconnect_attachments/index.md index 4901a06976..00130368b1 100644 --- a/docs/google-docs/providers/google/compute/interconnect_attachments/index.md +++ b/docs/google-docs/providers/google/compute/interconnect_attachments/index.md @@ -30,43 +30,43 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. | -| `customerRouterIpv6Address` | `string` | [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. | -| `customerRouterIpAddress` | `string` | [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. | -| `edgeAvailabilityDomain` | `string` | Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. | -| `partnerMetadata` | `object` | Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. | -| `region` | `string` | [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `stackType` | `string` | The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. | -| `bandwidth` | `string` | Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s | +| `encryption` | `string` | Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option. | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. | +| `remoteService` | `string` | [Output Only] If the attachment is on a Cross-Cloud Interconnect connection, this field contains the interconnect's remote location service provider. Example values: "Amazon Web Services" "Microsoft Azure". The field is set only for attachments on Cross-Cloud Interconnect connections. Its value is copied from the InterconnectRemoteLocation remoteService field. | +| `interconnect` | `string` | URL of the underlying Interconnect object that this attachment's traffic will traverse through. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment. | +| `pairingKey` | `string` | [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain" | +| `vlanTag8021q` | `integer` | The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time. | +| `adminEnabled` | `boolean` | Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. | +| `googleReferenceId` | `string` | [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used. | | `ipsecInternalAddresses` | `array` | A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool. | -| `type` | `string` | The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. | -| `privateInterconnectInfo` | `object` | Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `configurationConstraints` | `object` | | +| `cloudRouterIpAddress` | `string` | [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. | +| `dataplaneVersion` | `integer` | [Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1. | | `mtu` | `integer` | Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440. | +| `router` | `string` | URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. | +| `region` | `string` | [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `subnetLength` | `integer` | Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility. | -| `partnerAsn` | `string` | Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. | -| `googleReferenceId` | `string` | [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used. | -| `pairingKey` | `string` | [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain" | | `candidateIpv6Subnets` | `array` | This field is not available. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `state` | `string` | [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `operationalStatus` | `string` | [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. | -| `cloudRouterIpAddress` | `string` | [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. | -| `remoteService` | `string` | [Output Only] If the attachment is on a Cross-Cloud Interconnect connection, this field contains the interconnect's remote location service provider. Example values: "Amazon Web Services" "Microsoft Azure". The field is set only for attachments on Cross-Cloud Interconnect connections. Its value is copied from the InterconnectRemoteLocation remoteService field. | -| `adminEnabled` | `boolean` | Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. | | `customerRouterIpv6InterfaceId` | `string` | This field is not available. | -| `configurationConstraints` | `object` | | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment. | +| `customerRouterIpv6Address` | `string` | [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. | | `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | +| `candidateSubnets` | `array` | Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `type` | `string` | The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. | +| `partnerMetadata` | `object` | Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. | | `cloudRouterIpv6Address` | `string` | [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. | +| `state` | `string` | [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. | +| `privateInterconnectInfo` | `object` | Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. | +| `bandwidth` | `string` | Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s | +| `customerRouterIpAddress` | `string` | [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. | +| `stackType` | `string` | The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. | +| `operationalStatus` | `string` | [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. | | `cloudRouterIpv6InterfaceId` | `string` | This field is not available. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. | -| `dataplaneVersion` | `integer` | [Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1. | -| `vlanTag8021q` | `integer` | The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time. | -| `encryption` | `string` | Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option. | -| `candidateSubnets` | `array` | Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. | -| `router` | `string` | URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | -| `interconnect` | `string` | URL of the underlying Interconnect object that this attachment's traffic will traverse through. | +| `edgeAvailabilityDomain` | `string` | Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. | +| `partnerAsn` | `string` | Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -74,6 +74,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of interconnect attachments contained within the specified region. | | `insert` | `INSERT` | `project, region` | Creates an InterconnectAttachment in the specified project using the data included in the request. | | `delete` | `DELETE` | `interconnectAttachment, project, region` | Deletes the specified interconnect attachment. | +| `_list` | `EXEC` | `project, region` | Retrieves the list of interconnect attachments contained within the specified region. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of interconnect attachments. | | `patch` | `EXEC` | `interconnectAttachment, project, region` | Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `set_labels` | `EXEC` | `project, region, resource` | Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation. | diff --git a/docs/google-docs/providers/google/compute/interconnect_locations/index.md b/docs/google-docs/providers/google/compute/interconnect_locations/index.md index 1d83f1f36f..bc6162ea4f 100644 --- a/docs/google-docs/providers/google/compute/interconnect_locations/index.md +++ b/docs/google-docs/providers/google/compute/interconnect_locations/index.md @@ -30,21 +30,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional description of the resource. | -| `peeringdbFacilityId` | `string` | [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `address` | `string` | [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. | | `facilityProvider` | `string` | [Output Only] The name of the provider for this facility (e.g., EQUINIX). | -| `city` | `string` | [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". | | `status` | `string` | [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. | -| `supportsPzs` | `boolean` | [Output Only] Reserved for future use. | -| `regionInfos` | `array` | [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `city` | `string` | [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". | | `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations. | -| `address` | `string` | [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. | -| `facilityProviderFacilityId` | `string` | [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `regionInfos` | `array` | [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions. | +| `peeringdbFacilityId` | `string` | [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). | +| `supportsPzs` | `boolean` | [Output Only] Reserved for future use. | | `continent` | `string` | [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA | | `availabilityZone` | `string` | [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2". | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `facilityProviderFacilityId` | `string` | [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `interconnectLocation, project` | Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. | | `list` | `SELECT` | `project` | Retrieves the list of interconnect locations available to the specified project. | +| `_list` | `EXEC` | `project` | Retrieves the list of interconnect locations available to the specified project. | diff --git a/docs/google-docs/providers/google/compute/interconnect_remote_locations/index.md b/docs/google-docs/providers/google/compute/interconnect_remote_locations/index.md index 32f2c530e8..f06e1342fb 100644 --- a/docs/google-docs/providers/google/compute/interconnect_remote_locations/index.md +++ b/docs/google-docs/providers/google/compute/interconnect_remote_locations/index.md @@ -30,25 +30,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional description of the resource. | -| `lacp` | `string` | [Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED | +| `maxLagSize10Gbps` | `integer` | [Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps. | | `peeringdbFacilityId` | `string` | [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). | -| `permittedConnections` | `array` | [Output Only] Permitted connections. | +| `continent` | `string` | [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA | | `attachmentConfigurationConstraints` | `object` | | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `permittedConnections` | `array` | [Output Only] Permitted connections. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnectRemoteLocation for interconnect remote locations. | +| `facilityProviderFacilityId` | `string` | [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). | +| `remoteService` | `string` | [Output Only] Indicates the service provider present at the remote location. Example values: "Amazon Web Services", "Microsoft Azure". | | `status` | `string` | [Output Only] The status of this InterconnectRemoteLocation, which can take one of the following values: - CLOSED: The InterconnectRemoteLocation is closed and is unavailable for provisioning new Cross-Cloud Interconnects. - AVAILABLE: The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects. | -| `facilityProvider` | `string` | [Output Only] The name of the provider for this facility (e.g., EQUINIX). | -| `continent` | `string` | [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `address` | `string` | [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `constraints` | `object` | | -| `maxLagSize10Gbps` | `integer` | [Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps. | +| `facilityProvider` | `string` | [Output Only] The name of the provider for this facility (e.g., EQUINIX). | +| `lacp` | `string` | [Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED | | `city` | `string` | [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `maxLagSize100Gbps` | `integer` | [Output Only] The maximum number of 100 Gbps ports supported in a link aggregation group (LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed max_lag_size_100_gbps. | -| `address` | `string` | [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnectRemoteLocation for interconnect remote locations. | -| `remoteService` | `string` | [Output Only] Indicates the service provider present at the remote location. Example values: "Amazon Web Services", "Microsoft Azure". | -| `facilityProviderFacilityId` | `string` | [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `interconnectRemoteLocation, project` | Returns the details for the specified interconnect remote location. Gets a list of available interconnect remote locations by making a list() request. | | `list` | `SELECT` | `project` | Retrieves the list of interconnect remote locations available to the specified project. | +| `_list` | `EXEC` | `project` | Retrieves the list of interconnect remote locations available to the specified project. | diff --git a/docs/google-docs/providers/google/compute/interconnects/index.md b/docs/google-docs/providers/google/compute/interconnects/index.md index 13244866b2..3d319ab30a 100644 --- a/docs/google-docs/providers/google/compute/interconnects/index.md +++ b/docs/google-docs/providers/google/compute/interconnects/index.md @@ -30,29 +30,29 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `googleIpAddress` | `string` | [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Interconnect. | | `location` | `string` | URL of the InterconnectLocation object that represents where this connection is to be provisioned. | -| `circuitInfos` | `array` | [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. | -| `interconnectAttachments` | `array` | [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. | -| `expectedOutages` | `array` | [Output Only] A list of outages expected for this Interconnect. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `interconnectType` | `string` | Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. | -| `googleReferenceId` | `string` | [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. | | `peerIpAddress` | `string` | [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. | | `remoteLocation` | `string` | Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to. | -| `googleIpAddress` | `string` | [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. | +| `nocContactEmail` | `string` | Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation. | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `adminEnabled` | `boolean` | Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. | +| `interconnectType` | `string` | Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `circuitInfos` | `array` | [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. | | `customerName` | `string` | Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. | -| `operationalStatus` | `string` | [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. | | `provisionedLinkCount` | `integer` | [Output Only] Number of links actually provisioned in this interconnect. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Interconnect. | +| `interconnectAttachments` | `array` | [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. | +| `expectedOutages` | `array` | [Output Only] A list of outages expected for this Interconnect. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnect for interconnects. | | `linkType` | `string` | Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. | -| `adminEnabled` | `boolean` | Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. | -| `nocContactEmail` | `string` | Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `operationalStatus` | `string` | [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. | | `requestedLinkCount` | `integer` | Target number of physical links in the link bundle, as requested by the customer. | +| `googleReferenceId` | `string` | [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. | | `state` | `string` | [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnect for interconnects. | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -60,5 +60,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of Interconnects available to the specified project. | | `insert` | `INSERT` | `project` | Creates an Interconnect in the specified project using the data included in the request. | | `delete` | `DELETE` | `interconnect, project` | Deletes the specified Interconnect. | +| `_list` | `EXEC` | `project` | Retrieves the list of Interconnects available to the specified project. | | `patch` | `EXEC` | `interconnect, project` | Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `set_labels` | `EXEC` | `project, resource` | Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. | diff --git a/docs/google-docs/providers/google/compute/license_codes/index.md b/docs/google-docs/providers/google/compute/license_codes/index.md index 51a2fba0e3..96428ea83a 100644 --- a/docs/google-docs/providers/google/compute/license_codes/index.md +++ b/docs/google-docs/providers/google/compute/license_codes/index.md @@ -30,12 +30,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer. | | `description` | `string` | [Output Only] Description of this License Code. | -| `transferable` | `boolean` | [Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `state` | `string` | [Output Only] Current state of this License Code. | | `kind` | `string` | [Output Only] Type of resource. Always compute#licenseCode for licenses. | -| `licenseAlias` | `array` | [Output Only] URL and description aliases of Licenses with the same License Code. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `transferable` | `boolean` | [Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred. | +| `licenseAlias` | `array` | [Output Only] URL and description aliases of Licenses with the same License Code. | +| `state` | `string` | [Output Only] Current state of this License Code. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/licenses/index.md b/docs/google-docs/providers/google/compute/licenses/index.md index 009090dc20..74b82bb330 100644 --- a/docs/google-docs/providers/google/compute/licenses/index.md +++ b/docs/google-docs/providers/google/compute/licenses/index.md @@ -30,13 +30,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. The name must be 1-63 characters long and comply with RFC1035. | | `description` | `string` | An optional textual description of the resource; provided by the client when the resource is created. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#license for licenses. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `transferable` | `boolean` | If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk. | -| `licenseCode` | `string` | [Output Only] The unique code used to attach this license to images, snapshots, and disks. | | `chargesUseFee` | `boolean` | [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee. | -| `resourceRequirements` | `object` | | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#license for licenses. | +| `resourceRequirements` | `object` | | +| `licenseCode` | `string` | [Output Only] The unique code used to attach this license to images, snapshots, and disks. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,3 +44,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. | | `insert` | `INSERT` | `project` | Create a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. | | `delete` | `DELETE` | `license, project` | Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. | +| `_list` | `EXEC` | `project` | Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. | diff --git a/docs/google-docs/providers/google/compute/machine_images/index.md b/docs/google-docs/providers/google/compute/machine_images/index.md index 1c8654be41..c21e3020d5 100644 --- a/docs/google-docs/providers/google/compute/machine_images/index.md +++ b/docs/google-docs/providers/google/compute/machine_images/index.md @@ -30,20 +30,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] A unique identifier for this machine image. The server defines this identifier. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `totalStorageBytes` | `string` | [Output Only] Total size of the storage used by the machine image. | +| `machineImageEncryptionKey` | `object` | | | `guestFlush` | `boolean` | [Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process. | -| `savedDisks` | `array` | An array of Machine Image specific properties for disks attached to the source instance | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `sourceDiskEncryptionKeys` | `array` | [Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key. | -| `storageLocations` | `array` | The regional or multi-regional Cloud Storage bucket location where the machine image is stored. | -| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this machine image in RFC3339 text format. | -| `sourceInstanceProperties` | `object` | DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field. | | `sourceInstance` | `string` | The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance | | `status` | `string` | [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | | `kind` | `string` | [Output Only] The resource type, which is always compute#machineImage for machine image. | -| `totalStorageBytes` | `string` | [Output Only] Total size of the storage used by the machine image. | -| `machineImageEncryptionKey` | `object` | | -| `selfLink` | `string` | [Output Only] The URL for this machine image. The server defines this URL. | +| `savedDisks` | `array` | An array of Machine Image specific properties for disks attached to the source instance | +| `storageLocations` | `array` | The regional or multi-regional Cloud Storage bucket location where the machine image is stored. | | `instanceProperties` | `object` | | +| `sourceDiskEncryptionKeys` | `array` | [Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key. | +| `sourceInstanceProperties` | `object` | DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field. | +| `selfLink` | `string` | [Output Only] The URL for this machine image. The server defines this URL. | +| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this machine image in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -51,3 +51,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves a list of machine images that are contained within the specified project. | | `insert` | `INSERT` | `project` | Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance. | | `delete` | `DELETE` | `machineImage, project` | Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone. | +| `_list` | `EXEC` | `project` | Retrieves a list of machine images that are contained within the specified project. | diff --git a/docs/google-docs/providers/google/compute/machine_images_iam_policies/index.md b/docs/google-docs/providers/google/compute/machine_images_iam_policies/index.md index 048dac0b51..9799ba481a 100644 --- a/docs/google-docs/providers/google/compute/machine_images_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/machine_images_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/machine_types/index.md b/docs/google-docs/providers/google/compute/machine_types/index.md index 962e97c54d..6ee62951e8 100644 --- a/docs/google-docs/providers/google/compute/machine_types/index.md +++ b/docs/google-docs/providers/google/compute/machine_types/index.md @@ -30,22 +30,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional textual description of the resource. | -| `maximumPersistentDisks` | `integer` | [Output Only] Maximum persistent disks allowed. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `kind` | `string` | [Output Only] The type of the resource. Always compute#machineType for machine types. | | `zone` | `string` | [Output Only] The name of the zone where the machine type resides, such as us-central1-a. | -| `memoryMb` | `integer` | [Output Only] The amount of physical memory available to the instance, defined in MB. | +| `maximumPersistentDisksSizeGb` | `string` | [Output Only] Maximum total persistent disks size (GB) allowed. | | `accelerators` | `array` | [Output Only] A list of accelerator configurations assigned to this machine type. | -| `isSharedCpu` | `boolean` | [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information. | -| `imageSpaceGb` | `integer` | [Deprecated] This property is deprecated and will never be populated with any relevant values. | -| `guestCpus` | `integer` | [Output Only] The number of virtual CPUs that are available to the instance. | +| `scratchDisks` | `array` | [Output Only] A list of extended scratch disks assigned to the instance. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `deprecated` | `object` | Deprecation status for a public resource. | +| `maximumPersistentDisks` | `integer` | [Output Only] Maximum persistent disks allowed. | +| `imageSpaceGb` | `integer` | [Deprecated] This property is deprecated and will never be populated with any relevant values. | +| `isSharedCpu` | `boolean` | [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `scratchDisks` | `array` | [Output Only] A list of extended scratch disks assigned to the instance. | -| `kind` | `string` | [Output Only] The type of the resource. Always compute#machineType for machine types. | -| `maximumPersistentDisksSizeGb` | `string` | [Output Only] Maximum total persistent disks size (GB) allowed. | +| `guestCpus` | `integer` | [Output Only] The number of virtual CPUs that are available to the instance. | +| `memoryMb` | `integer` | [Output Only] The amount of physical memory available to the instance, defined in MB. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `machineType, project, zone` | Returns the specified machine type. | | `list` | `SELECT` | `project, zone` | Retrieves a list of machine types available to the specified project. | +| `_list` | `EXEC` | `project, zone` | Retrieves a list of machine types available to the specified project. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of machine types. | diff --git a/docs/google-docs/providers/google/compute/network_attachments/index.md b/docs/google-docs/providers/google/compute/network_attachments/index.md index 0721523a97..0d08274555 100644 --- a/docs/google-docs/providers/google/compute/network_attachments/index.md +++ b/docs/google-docs/providers/google/compute/network_attachments/index.md @@ -31,16 +31,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | | `subnetworks` | `array` | An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment. | -| `connectionEndpoints` | `array` | [Output Only] An array of connections for all the producers connected to this network attachment. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch. | -| `network` | `string` | [Output Only] The URL of the network which the Network Attachment belongs to. Practically it is inferred by fetching the network of the first subnetwork associated. Because it is required that all the subnetworks must be from the same network, it is assured that the Network Attachment belongs to the same network as all the subnetworks. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `region` | `string` | [Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `network` | `string` | [Output Only] The URL of the network which the Network Attachment belongs to. Practically it is inferred by fetching the network of the first subnetwork associated. Because it is required that all the subnetworks must be from the same network, it is assured that the Network Attachment belongs to the same network as all the subnetworks. | | `producerRejectLists` | `array` | Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number. | +| `producerAcceptLists` | `array` | Projects that are allowed to connect to this network attachment. The project can be specified using its id or number. | +| `kind` | `string` | [Output Only] Type of the resource. | +| `region` | `string` | [Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `connectionEndpoints` | `array` | [Output Only] An array of connections for all the producers connected to this network attachment. | | `connectionPreference` | `string` | | -| `kind` | `string` | [Output Only] Type of the resource. | -| `producerAcceptLists` | `array` | Projects that are allowed to connect to this network attachment. The project can be specified using its id or number. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch. | | `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource's resource id. | ## Methods | Name | Accessible by | Required Params | Description | @@ -49,4 +49,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Lists the NetworkAttachments for a project in the given scope. | | `insert` | `INSERT` | `project, region` | Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request. | | `delete` | `DELETE` | `networkAttachment, project, region` | Deletes the specified NetworkAttachment in the given scope | +| `_list` | `EXEC` | `project, region` | Lists the NetworkAttachments for a project in the given scope. | | `aggregated_list` | `EXEC` | `project` | Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project. | diff --git a/docs/google-docs/providers/google/compute/network_attachments_iam_policies/index.md b/docs/google-docs/providers/google/compute/network_attachments_iam_policies/index.md index 7d9d09687d..d43279000e 100644 --- a/docs/google-docs/providers/google/compute/network_attachments_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/network_attachments_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/network_edge_security_services/index.md b/docs/google-docs/providers/google/compute/network_edge_security_services/index.md index 03159a604e..5a8f949041 100644 --- a/docs/google-docs/providers/google/compute/network_edge_security_services/index.md +++ b/docs/google-docs/providers/google/compute/network_edge_security_services/index.md @@ -30,13 +30,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `region` | `string` | [Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices | -| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | | `securityPolicy` | `string` | The resource URL for the network edge security service associated with this network edge security service. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `region` | `string` | [Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/network_endpoint_groups/index.md b/docs/google-docs/providers/google/compute/network_endpoint_groups/index.md index fbcc9856c2..aca261b696 100644 --- a/docs/google-docs/providers/google/compute/network_endpoint_groups/index.md +++ b/docs/google-docs/providers/google/compute/network_endpoint_groups/index.md @@ -31,21 +31,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | | `subnetwork` | `string` | Optional URL of the subnetwork to which all network endpoints in the NEG belong. | -| `pscTargetService` | `string` | The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com" | -| `cloudRun` | `object` | Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `cloudFunction` | `object` | Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. | -| `network` | `string` | The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. | +| `region` | `string` | [Output Only] The URL of the region where the network endpoint group is located. | +| `pscData` | `object` | All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `appEngine` | `object` | Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. | +| `zone` | `string` | [Output Only] The URL of the zone where the network endpoint group is located. | +| `size` | `integer` | [Output only] Number of network endpoints in the network endpoint group. | +| `networkEndpointType` | `string` | Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. | +| `network` | `string` | The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. | +| `cloudRun` | `object` | Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. | +| `pscTargetService` | `string` | The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com" | | `kind` | `string` | [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. | -| `pscData` | `object` | All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. | | `defaultPort` | `integer` | The default port used if the port number is not specified in the network endpoint. | -| `networkEndpointType` | `string` | Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. | -| `size` | `integer` | [Output only] Number of network endpoints in the network endpoint group. | +| `cloudFunction` | `object` | Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. | +| `appEngine` | `object` | Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. | | `annotations` | `object` | Metadata defined as annotations on the network endpoint group. | -| `zone` | `string` | [Output Only] The URL of the zone where the network endpoint group is located. | -| `region` | `string` | [Output Only] The URL of the region where the network endpoint group is located. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -53,6 +53,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, zone` | Retrieves the list of network endpoint groups that are located in the specified project and zone. | | `insert` | `INSERT` | `project, zone` | Creates a network endpoint group in the specified project using the parameters that are included in the request. | | `delete` | `DELETE` | `networkEndpointGroup, project, zone` | Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. | +| `_list` | `EXEC` | `project, zone` | Retrieves the list of network endpoint groups that are located in the specified project and zone. | | `aggregated_list` | `EXEC` | `project` | Retrieves the list of network endpoint groups and sorts them by zone. | | `attach_network_endpoints` | `EXEC` | `networkEndpointGroup, project, zone` | Attach a list of network endpoints to the specified network endpoint group. | | `detach_network_endpoints` | `EXEC` | `networkEndpointGroup, project, zone` | Detach a list of network endpoints from the specified network endpoint group. | diff --git a/docs/google-docs/providers/google/compute/network_firewall_policies/index.md b/docs/google-docs/providers/google/compute/network_firewall_policies/index.md index 6ec5c16416..84ad70c86f 100644 --- a/docs/google-docs/providers/google/compute/network_firewall_policies/index.md +++ b/docs/google-docs/providers/google/compute/network_firewall_policies/index.md @@ -31,17 +31,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | | `ruleTupleCount` | `integer` | [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies | -| `shortName` | `string` | User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | -| `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `associations` | `array` | A list of associations that belong to this firewall policy. | -| `region` | `string` | [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `parent` | `string` | [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. | +| `shortName` | `string` | User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `displayName` | `string` | Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `region` | `string` | [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. | | `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. | -| `parent` | `string` | [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -49,6 +49,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Lists all the policies that have been configured for the specified project. | | `insert` | `INSERT` | `project` | Creates a new policy in the specified project using the data included in the request. | | `delete` | `DELETE` | `firewallPolicy, project` | Deletes the specified policy. | +| `_list` | `EXEC` | `project` | Lists all the policies that have been configured for the specified project. | | `clone_rules` | `EXEC` | `firewallPolicy, project` | Copies rules to the specified firewall policy. | | `patch` | `EXEC` | `firewallPolicy, project` | Patches the specified policy with the data included in the request. | | `patch_rule` | `EXEC` | `firewallPolicy, project` | Patches a rule of the specified priority. | diff --git a/docs/google-docs/providers/google/compute/network_firewall_policies_iam_policies/index.md b/docs/google-docs/providers/google/compute/network_firewall_policies_iam_policies/index.md index 5edef80123..17dfbeaf83 100644 --- a/docs/google-docs/providers/google/compute/network_firewall_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/network_firewall_policies_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `rules` | `array` | This is deprecated and has no effect. Do not use. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/network_firewall_policies_rule/index.md b/docs/google-docs/providers/google/compute/network_firewall_policies_rule/index.md index 3464b2d147..b45dda99e0 100644 --- a/docs/google-docs/providers/google/compute/network_firewall_policies_rule/index.md +++ b/docs/google-docs/providers/google/compute/network_firewall_policies_rule/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `description` | `string` | An optional description for this resource. | | `targetResources` | `array` | A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. | -| `targetServiceAccounts` | `array` | A list of service accounts indicating the sets of instances that are applied with this rule. | -| `targetSecureTags` | `array` | A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. | -| `disabled` | `boolean` | Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. | | `enableLogging` | `boolean` | Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. | -| `priority` | `integer` | An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. | -| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | +| `targetSecureTags` | `array` | A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. | +| `targetServiceAccounts` | `array` | A list of service accounts indicating the sets of instances that are applied with this rule. | | `ruleTupleCount` | `integer` | [Output Only] Calculation of the complexity of a single firewall policy rule. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules | -| `direction` | `string` | The direction in which this rule applies. | +| `disabled` | `boolean` | Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. | | `ruleName` | `string` | An optional name for the rule. This field is not a unique identifier and can be updated. | | `action` | `string` | The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". | +| `direction` | `string` | The direction in which this rule applies. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules | +| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | +| `priority` | `integer` | An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/networks/index.md b/docs/google-docs/providers/google/compute/networks/index.md index ae02e9b848..5b8415023f 100644 --- a/docs/google-docs/providers/google/compute/networks/index.md +++ b/docs/google-docs/providers/google/compute/networks/index.md @@ -30,21 +30,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. | | `description` | `string` | An optional description of this resource. Provide this field when you create the resource. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `routingConfig` | `object` | A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. | +| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `autoCreateSubnetworks` | `boolean` | Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method. | | `enableUlaInternalIpv6` | `boolean` | Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. . | -| `peerings` | `array` | [Output Only] A list of network peerings for the resource. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#network for networks. | +| `internalIpv6Range` | `string` | When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. . | | `IPv4Range` | `string` | Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. | | `gatewayIPv4` | `string` | [Output Only] The gateway address for default routing out of the network, selected by Google Cloud. | +| `peerings` | `array` | [Output Only] A list of network peerings for the resource. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `subnetworks` | `array` | [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. | | `firewallPolicy` | `string` | [Output Only] URL of the firewall policy the network is associated with. | -| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#network for networks. | -| `networkFirewallPolicyEnforcementOrder` | `string` | The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified. | -| `internalIpv6Range` | `string` | When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. . | | `mtu` | `integer` | Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460. | -| `subnetworks` | `array` | [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. | -| `routingConfig` | `object` | A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. | +| `autoCreateSubnetworks` | `boolean` | Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method. | +| `networkFirewallPolicyEnforcementOrder` | `string` | The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -52,5 +52,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of networks available to the specified project. | | `insert` | `INSERT` | `project` | Creates a network in the specified project using the data included in the request. | | `delete` | `DELETE` | `network, project` | Deletes the specified network. | +| `_list` | `EXEC` | `project` | Retrieves the list of networks available to the specified project. | | `patch` | `EXEC` | `network, project` | Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. | | `switch_to_custom_mode` | `EXEC` | `network, project` | Switches the network mode from auto subnet mode to custom subnet mode. | diff --git a/docs/google-docs/providers/google/compute/node_groups/index.md b/docs/google-docs/providers/google/compute/node_groups/index.md index f0273503b7..0ad8c618da 100644 --- a/docs/google-docs/providers/google/compute/node_groups/index.md +++ b/docs/google-docs/providers/google/compute/node_groups/index.md @@ -30,19 +30,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `shareSettings` | `object` | The share setting for reservations and sole tenancy node groups. | -| `zone` | `string` | [Output Only] The name of the zone where the node group resides, such as us-central1-a. | | `size` | `integer` | [Output Only] The total number of nodes in the node group. | -| `maintenancePolicy` | `string` | Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies. | -| `status` | `string` | | | `nodeTemplate` | `string` | URL of the node template to create the node group from. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `autoscalingPolicy` | `object` | | -| `kind` | `string` | [Output Only] The type of the resource. Always compute#nodeGroup for node group. | +| `locationHint` | `string` | An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate. | | `fingerprint` | `string` | | +| `autoscalingPolicy` | `object` | | | `maintenanceWindow` | `object` | Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window. | -| `locationHint` | `string` | An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `status` | `string` | | +| `maintenancePolicy` | `string` | Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies. | +| `zone` | `string` | [Output Only] The name of the zone where the node group resides, such as us-central1-a. | +| `shareSettings` | `object` | The share setting for reservations and sole tenancy node groups. | +| `kind` | `string` | [Output Only] The type of the resource. Always compute#nodeGroup for node group. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -50,6 +50,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, zone` | Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. | | `insert` | `INSERT` | `initialNodeCount, project, zone` | Creates a NodeGroup resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `nodeGroup, project, zone` | Deletes the specified NodeGroup resource. | +| `_list` | `EXEC` | `project, zone` | Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. | | `patch` | `EXEC` | `nodeGroup, project, zone` | Updates the specified node group. | | `set_node_template` | `EXEC` | `nodeGroup, project, zone` | Updates the node template of the node group. | diff --git a/docs/google-docs/providers/google/compute/node_groups_iam_policies/index.md b/docs/google-docs/providers/google/compute/node_groups_iam_policies/index.md index 4c8b22d3b0..1f4f33ae5b 100644 --- a/docs/google-docs/providers/google/compute/node_groups_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/node_groups_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/node_templates/index.md b/docs/google-docs/providers/google/compute/node_templates/index.md index c952acf983..735d7f817e 100644 --- a/docs/google-docs/providers/google/compute/node_templates/index.md +++ b/docs/google-docs/providers/google/compute/node_templates/index.md @@ -30,19 +30,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `statusMessage` | `string` | [Output Only] An optional, human-readable explanation of the status. | | `status` | `string` | [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. | -| `nodeType` | `string` | The node type to use for nodes group that are created from this template. | | `cpuOvercommitType` | `string` | CPU overcommit. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `nodeTypeFlexibility` | `object` | | | `accelerators` | `array` | | | `region` | `string` | [Output Only] The name of the region where the node template resides, such as us-central1. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `disks` | `array` | | -| `serverBinding` | `object` | | +| `nodeTypeFlexibility` | `object` | | | `kind` | `string` | [Output Only] The type of the resource. Always compute#nodeTemplate for node templates. | -| `statusMessage` | `string` | [Output Only] An optional, human-readable explanation of the status. | +| `serverBinding` | `object` | | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `nodeAffinityLabels` | `object` | Labels to use for node affinity, which will be used in instance scheduling. | +| `nodeType` | `string` | The node type to use for nodes group that are created from this template. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -50,4 +50,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of node templates available to the specified project. | | `insert` | `INSERT` | `project, region` | Creates a NodeTemplate resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `nodeTemplate, project, region` | Deletes the specified NodeTemplate resource. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of node templates available to the specified project. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of node templates. | diff --git a/docs/google-docs/providers/google/compute/node_templates_iam_policies/index.md b/docs/google-docs/providers/google/compute/node_templates_iam_policies/index.md index d54dcae0bf..ef38099a36 100644 --- a/docs/google-docs/providers/google/compute/node_templates_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/node_templates_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `rules` | `array` | This is deprecated and has no effect. Do not use. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/node_types/index.md b/docs/google-docs/providers/google/compute/node_types/index.md index 225e4637df..be1f348b48 100644 --- a/docs/google-docs/providers/google/compute/node_types/index.md +++ b/docs/google-docs/providers/google/compute/node_types/index.md @@ -30,18 +30,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional textual description of the resource. | -| `cpuPlatform` | `string` | [Output Only] The CPU platform used by this node type. | -| `deprecated` | `object` | Deprecation status for a public resource. | -| `memoryMb` | `integer` | [Output Only] The amount of physical memory available to the node type, defined in MB. | | `zone` | `string` | [Output Only] The name of the zone where the node type resides, such as us-central1-a. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `cpuPlatform` | `string` | [Output Only] The CPU platform used by this node type. | | `guestCpus` | `integer` | [Output Only] The number of virtual CPUs that are available to the node type. | +| `memoryMb` | `integer` | [Output Only] The amount of physical memory available to the node type, defined in MB. | | `kind` | `string` | [Output Only] The type of the resource. Always compute#nodeType for node types. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `localSsdGb` | `integer` | [Output Only] Local SSD available to the node type, defined in GB. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `deprecated` | `object` | Deprecation status for a public resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `nodeType, project, zone` | Returns the specified node type. | | `list` | `SELECT` | `project, zone` | Retrieves a list of node types available to the specified project. | +| `_list` | `EXEC` | `project, zone` | Retrieves a list of node types available to the specified project. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of node types. | diff --git a/docs/google-docs/providers/google/compute/packet_mirrorings/index.md b/docs/google-docs/providers/google/compute/packet_mirrorings/index.md index 448110ecf8..05a16806bd 100644 --- a/docs/google-docs/providers/google/compute/packet_mirrorings/index.md +++ b/docs/google-docs/providers/google/compute/packet_mirrorings/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `priority` | `integer` | The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535. | +| `collectorIlb` | `object` | | +| `filter` | `object` | | | `network` | `object` | | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings. | | `region` | `string` | [Output Only] URI of the region where the packetMirroring resides. | -| `enable` | `string` | Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE. | -| `filter` | `object` | | -| `collectorIlb` | `object` | | | `mirroredResources` | `object` | | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `enable` | `string` | Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `priority` | `integer` | The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,5 +47,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of PacketMirroring resources available to the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a PacketMirroring resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `packetMirroring, project, region` | Deletes the specified PacketMirroring resource. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of PacketMirroring resources available to the specified project and region. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of packetMirrorings. | | `patch` | `EXEC` | `packetMirroring, project, region` | Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | diff --git a/docs/google-docs/providers/google/compute/projects/index.md b/docs/google-docs/providers/google/compute/projects/index.md index b9526fc8a0..0e012fe168 100644 --- a/docs/google-docs/providers/google/compute/projects/index.md +++ b/docs/google-docs/providers/google/compute/projects/index.md @@ -30,17 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is *not* the project ID, and is just a unique ID used by Compute Engine to identify resources. | | `name` | `string` | The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. | | `description` | `string` | An optional textual description of the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `defaultNetworkTier` | `string` | This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. | -| `enabledFeatures` | `array` | Restricted features enabled for use on this project. | | `xpnProjectStatus` | `string` | [Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated. | -| `usageExportLocation` | `object` | The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `quotas` | `array` | [Output Only] Quotas assigned to this project. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#project for projects. | +| `defaultNetworkTier` | `string` | This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. | | `commonInstanceMetadata` | `object` | A metadata key/value entry. | -| `defaultServiceAccount` | `string` | [Output Only] Default service account used by VMs running in this project. | | `vmDnsSetting` | `string` | [Output Only] Default internal DNS setting used by VMs running in this project. | +| `quotas` | `array` | [Output Only] Quotas assigned to this project. | +| `enabledFeatures` | `array` | Restricted features enabled for use on this project. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `defaultServiceAccount` | `string` | [Output Only] Default service account used by VMs running in this project. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `usageExportLocation` | `object` | The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/public_advertised_prefixes/index.md b/docs/google-docs/providers/google/compute/public_advertised_prefixes/index.md index ac11e1bb85..7538d4c8dc 100644 --- a/docs/google-docs/providers/google/compute/public_advertised_prefixes/index.md +++ b/docs/google-docs/providers/google/compute/public_advertised_prefixes/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource type. The server generates this identifier. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `ipCidrRange` | `string` | The address range, in CIDR format, represented by this public advertised prefix. | -| `publicDelegatedPrefixs` | `array` | [Output Only] The list of public delegated prefixes that exist for this public advertised prefix. | -| `dnsVerificationIp` | `string` | The address to be used for reverse DNS verification. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes. | +| `ipCidrRange` | `string` | The address range, in CIDR format, represented by this public advertised prefix. | +| `status` | `string` | The status of the public advertised prefix. Possible values include: - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User has configured the PTR. - `VALIDATED`: Reverse DNS lookup is successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix. | -| `sharedSecret` | `string` | [Output Only] The shared secret to be used for reverse DNS verification. | +| `dnsVerificationIp` | `string` | The address to be used for reverse DNS verification. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `status` | `string` | The status of the public advertised prefix. Possible values include: - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User has configured the PTR. - `VALIDATED`: Reverse DNS lookup is successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed. | +| `sharedSecret` | `string` | [Output Only] The shared secret to be used for reverse DNS verification. | +| `publicDelegatedPrefixs` | `array` | [Output Only] The list of public delegated prefixes that exist for this public advertised prefix. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -46,4 +46,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Lists the PublicAdvertisedPrefixes for a project. | | `insert` | `INSERT` | `project` | Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request. | | `delete` | `DELETE` | `project, publicAdvertisedPrefix` | Deletes the specified PublicAdvertisedPrefix | +| `_list` | `EXEC` | `project` | Lists the PublicAdvertisedPrefixes for a project. | | `patch` | `EXEC` | `project, publicAdvertisedPrefix` | Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | diff --git a/docs/google-docs/providers/google/compute/public_delegated_prefixes/index.md b/docs/google-docs/providers/google/compute/public_delegated_prefixes/index.md index 2a01ce1c84..a0aca4468c 100644 --- a/docs/google-docs/providers/google/compute/public_delegated_prefixes/index.md +++ b/docs/google-docs/providers/google/compute/public_delegated_prefixes/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource type. The server generates this identifier. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `status` | `string` | [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes. | -| `ipCidrRange` | `string` | The IP address range, in CIDR format, represented by this public delegated prefix. | -| `region` | `string` | [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `isLiveMigration` | `boolean` | If true, the prefix will be live migrated. | +| `ipCidrRange` | `string` | The IP address range, in CIDR format, represented by this public delegated prefix. | | `parentPrefix` | `string` | The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. | +| `status` | `string` | [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes. | | `publicDelegatedSubPrefixs` | `array` | The list of sub public delegated prefixes that exist for this public delegated prefix. | +| `region` | `string` | [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,5 +47,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Lists the PublicDelegatedPrefixes for a project in the given region. | | `insert` | `INSERT` | `project, region` | Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request. | | `delete` | `DELETE` | `project, publicDelegatedPrefix, region` | Deletes the specified PublicDelegatedPrefix in the given region. | +| `_list` | `EXEC` | `project, region` | Lists the PublicDelegatedPrefixes for a project in the given region. | | `aggregated_list` | `EXEC` | `project` | Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. | | `patch` | `EXEC` | `project, publicDelegatedPrefix, region` | Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | diff --git a/docs/google-docs/providers/google/compute/region_autoscalers/index.md b/docs/google-docs/providers/google/compute/region_autoscalers/index.md index f40a9a9276..07df945e47 100644 --- a/docs/google-docs/providers/google/compute/region_autoscalers/index.md +++ b/docs/google-docs/providers/google/compute/region_autoscalers/index.md @@ -30,17 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `scalingScheduleStatus` | `object` | [Output Only] Status information of existing scaling schedules. | -| `zone` | `string` | [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). | -| `target` | `string` | URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. | -| `recommendedSize` | `integer` | [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. | | `autoscalingPolicy` | `object` | Cloud Autoscaler policy. | | `status` | `string` | [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `target` | `string` | URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. | | `statusDetails` | `array` | [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `zone` | `string` | [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). | +| `scalingScheduleStatus` | `object` | [Output Only] Status information of existing scaling schedules. | | `region` | `string` | [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. | +| `recommendedSize` | `integer` | [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -48,5 +48,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of autoscalers contained within the specified region. | | `insert` | `INSERT` | `project, region` | Creates an autoscaler in the specified project using the data included in the request. | | `delete` | `DELETE` | `autoscaler, project, region` | Deletes the specified autoscaler. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of autoscalers contained within the specified region. | | `patch` | `EXEC` | `project, region` | Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `project, region` | Updates an autoscaler in the specified project using the data included in the request. | diff --git a/docs/google-docs/providers/google/compute/region_backend_services/index.md b/docs/google-docs/providers/google/compute/region_backend_services/index.md index dd8bab9344..166cc55011 100644 --- a/docs/google-docs/providers/google/compute/region_backend_services/index.md +++ b/docs/google-docs/providers/google/compute/region_backend_services/index.md @@ -30,43 +30,43 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `localityLbPolicies` | `array` | A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration. | -| `loadBalancingScheme` | `string` | Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer. | -| `protocol` | `string` | The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. | -| `connectionDraining` | `object` | Message containing connection draining configuration. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `securityPolicy` | `string` | [Output Only] The resource URL for the security policy associated with this backend service. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#backendService for backend services. | +| `failoverPolicy` | `object` | For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). | | `portName` | `string` | A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. | -| `consistentHash` | `object` | This message defines settings for a consistent hash style load balancer. | -| `logConfig` | `object` | The available logging options for the load balancer traffic served by this backend service. | -| `enableCDN` | `boolean` | If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer. | -| `circuitBreakers` | `object` | Settings controlling the volume of requests, connections and retries to this backend service. | -| `serviceBindings` | `array` | URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty. | | `compressionMode` | `string` | Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. | -| `customRequestHeaders` | `array` | Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | -| `timeoutSec` | `integer` | The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. | -| `metadatas` | `object` | Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH | -| `network` | `string` | The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. | -| `failoverPolicy` | `object` | For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). | -| `localityLbPolicy` | `string` | The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. | -| `maxStreamDuration` | `object` | A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. | -| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge security policy associated with this backend service. | -| `backends` | `array` | The list of backends that serve this BackendService. | -| `connectionTrackingPolicy` | `object` | Connection Tracking configuration for this BackendService. | | `outlierDetection` | `object` | Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. | -| `healthChecks` | `array` | The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check. | +| `affinityCookieTtlSec` | `integer` | Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. | +| `serviceBindings` | `array` | URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty. | +| `sessionAffinity` | `string` | Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). | +| `metadatas` | `object` | Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH | | `securitySettings` | `object` | The authentication and authorization settings for a BackendService. | -| `subsetting` | `object` | Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. | -| `customResponseHeaders` | `array` | Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | +| `protocol` | `string` | The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. | +| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge security policy associated with this backend service. | +| `port` | `integer` | Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. | +| `maxStreamDuration` | `object` | A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `sessionAffinity` | `string` | Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService. | +| `securityPolicy` | `string` | [Output Only] The resource URL for the security policy associated with this backend service. | +| `healthChecks` | `array` | The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check. | +| `loadBalancingScheme` | `string` | Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `connectionTrackingPolicy` | `object` | Connection Tracking configuration for this BackendService. | | `region` | `string` | [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a backend service. | -| `affinityCookieTtlSec` | `integer` | Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. | +| `logConfig` | `object` | The available logging options for the load balancer traffic served by this backend service. | +| `localityLbPolicies` | `array` | A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration. | +| `timeoutSec` | `integer` | The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. | +| `customResponseHeaders` | `array` | Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | +| `backends` | `array` | The list of backends that serve this BackendService. | | `iap` | `object` | Identity-Aware Proxy | -| `port` | `integer` | Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. | +| `enableCDN` | `boolean` | If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer. | +| `subsetting` | `object` | Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. | +| `customRequestHeaders` | `array` | Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | +| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a backend service. | +| `circuitBreakers` | `object` | Settings controlling the volume of requests, connections and retries to this backend service. | +| `localityLbPolicy` | `string` | The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. | +| `network` | `string` | The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#backendService for backend services. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService. | +| `consistentHash` | `object` | This message defines settings for a consistent hash style load balancer. | +| `connectionDraining` | `object` | Message containing connection draining configuration. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -74,5 +74,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of regional BackendService resources available to the specified project in the given region. | | `insert` | `INSERT` | `project, region` | Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview. | | `delete` | `DELETE` | `backendService, project, region` | Deletes the specified regional BackendService resource. | +| `_list` | `EXEC` | `project, region` | Retrieves the list of regional BackendService resources available to the specified project in the given region. | | `patch` | `EXEC` | `backendService, project, region` | Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `backendService, project, region` | Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview . | diff --git a/docs/google-docs/providers/google/compute/region_backend_services_iam_policies/index.md b/docs/google-docs/providers/google/compute/region_backend_services_iam_policies/index.md index a06164f452..30134d9707 100644 --- a/docs/google-docs/providers/google/compute/region_backend_services_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/region_backend_services_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `rules` | `array` | This is deprecated and has no effect. Do not use. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `rules` | `array` | This is deprecated and has no effect. Do not use. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_commitments/index.md b/docs/google-docs/providers/google/compute/region_commitments/index.md index 06bab869be..a966776ba3 100644 --- a/docs/google-docs/providers/google/compute/region_commitments/index.md +++ b/docs/google-docs/providers/google/compute/region_commitments/index.md @@ -30,28 +30,29 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `licenseResource` | `object` | Commitment for a particular license resource. | -| `reservations` | `array` | List of reservations in this commitment. | -| `resources` | `array` | A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. | -| `splitSourceCommitment` | `string` | Source commitment to be split into a new commitment. | -| `statusMessage` | `string` | [Output Only] An optional, human-readable explanation of the status. | -| `type` | `string` | The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. | -| `category` | `string` | The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. | +| `plan` | `string` | The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). | +| `startTimestamp` | `string` | [Output Only] Commitment start time in RFC3339 text format. | +| `region` | `string` | [Output Only] URL of the region where this commitment may be used. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#commitment for commitments. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `resources` | `array` | A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. | | `status` | `string` | [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. | -| `endTimestamp` | `string` | [Output Only] Commitment end time in RFC3339 text format. | +| `licenseResource` | `object` | Commitment for a particular license resource. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `region` | `string` | [Output Only] URL of the region where this commitment may be used. | +| `type` | `string` | The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. | | `autoRenew` | `boolean` | Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. | | `mergeSourceCommitments` | `array` | List of source commitments to be merged into a new commitment. | -| `startTimestamp` | `string` | [Output Only] Commitment start time in RFC3339 text format. | -| `plan` | `string` | The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#commitment for commitments. | +| `reservations` | `array` | List of reservations in this commitment. | +| `splitSourceCommitment` | `string` | Source commitment to be split into a new commitment. | +| `category` | `string` | The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. | +| `statusMessage` | `string` | [Output Only] An optional, human-readable explanation of the status. | +| `endTimestamp` | `string` | [Output Only] Commitment end time in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `commitment, project, region` | Returns the specified commitment resource. | | `list` | `SELECT` | `project, region` | Retrieves a list of commitments contained within the specified region. | | `insert` | `INSERT` | `project, region` | Creates a commitment in the specified project using the data included in the request. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of commitments contained within the specified region. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of commitments by region. | | `update` | `EXEC` | `commitment, project, region` | Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew. | diff --git a/docs/google-docs/providers/google/compute/region_disk_types/index.md b/docs/google-docs/providers/google/compute/region_disk_types/index.md index 3f13f1fd67..d32bee8029 100644 --- a/docs/google-docs/providers/google/compute/region_disk_types/index.md +++ b/docs/google-docs/providers/google/compute/region_disk_types/index.md @@ -30,16 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional description of this resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `zone` | `string` | [Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `defaultDiskSizeGb` | `string` | [Output Only] Server-defined default disk size in GB. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#diskType for disk types. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `validDiskSize` | `string` | [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB". | | `deprecated` | `object` | Deprecation status for a public resource. | | `region` | `string` | [Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `defaultDiskSizeGb` | `string` | [Output Only] Server-defined default disk size in GB. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `validDiskSize` | `string` | [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `diskType, project, region` | Returns the specified regional disk type. | | `list` | `SELECT` | `project, region` | Retrieves a list of regional disk types available to the specified project. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of regional disk types available to the specified project. | diff --git a/docs/google-docs/providers/google/compute/region_disks/index.md b/docs/google-docs/providers/google/compute/region_disks/index.md index 8a9dbf4b05..2aa00b9204 100644 --- a/docs/google-docs/providers/google/compute/region_disks/index.md +++ b/docs/google-docs/providers/google/compute/region_disks/index.md @@ -30,47 +30,47 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `provisionedIops` | `string` | Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. | -| `provisionedThroughput` | `string` | Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 7,124. | -| `sourceImage` | `string` | The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family | | `sourceSnapshot` | `string` | The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot | -| `sourceDisk` | `string` | The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk | -| `sourceStorageObject` | `string` | The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead. | -| `sourceDiskId` | `string` | [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used. | -| `resourcePolicies` | `array` | Resource policies applied to this disk for automatic snapshot creations. | | `licenses` | `array` | A list of publicly visible licenses. Reserved for Google's use. | -| `labels` | `object` | Labels to apply to this disk. These can be later modified by the setLabels method. | -| `sourceSnapshotId` | `string` | [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. | -| `asyncSecondaryDisks` | `object` | [Output Only] A list of disks this disk is asynchronously replicated to. | +| `region` | `string` | [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `provisionedThroughput` | `string` | Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 7,124. | +| `licenseCodes` | `array` | Integer license codes indicating which licenses are attached to this disk. | | `sizeGb` | `string` | Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive. | -| `physicalBlockSizeBytes` | `string` | Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. | -| `diskEncryptionKey` | `object` | | -| `asyncPrimaryDisk` | `object` | | +| `sourceImageEncryptionKey` | `object` | | +| `asyncSecondaryDisks` | `object` | [Output Only] A list of disks this disk is asynchronously replicated to. | +| `architecture` | `string` | The architecture of the disk. Valid values are ARM64 or X86_64. | +| `sourceImageId` | `string` | [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#disk for disks. | +| `type` | `string` | URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types. | | `resourceStatus` | `object` | | +| `sourceSnapshotEncryptionKey` | `object` | | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | +| `guestOsFeatures` | `array` | A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. | +| `sourceDiskId` | `string` | [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used. | | `sourceConsistencyGroupPolicy` | `string` | [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | -| `sourceConsistencyGroupPolicyId` | `string` | [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | +| `labels` | `object` | Labels to apply to this disk. These can be later modified by the setLabels method. | +| `asyncPrimaryDisk` | `object` | | | `lastAttachTimestamp` | `string` | [Output Only] Last attach timestamp in RFC3339 text format. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#disk for disks. | -| `status` | `string` | [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. | +| `sourceImage` | `string` | The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family | | `params` | `object` | Additional disk params. | -| `options` | `string` | Internal use only. | -| `lastDetachTimestamp` | `string` | [Output Only] Last detach timestamp in RFC3339 text format. | +| `replicaZones` | `array` | URLs of the zones where the disk should be replicated to. Only applicable for regional resources. | +| `users` | `array` | [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance | +| `physicalBlockSizeBytes` | `string` | Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. | +| `sourceDisk` | `string` | The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk | | `locationHint` | `string` | An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API. | -| `licenseCodes` | `array` | Integer license codes indicating which licenses are attached to this disk. | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `region` | `string` | [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `sourceConsistencyGroupPolicyId` | `string` | [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | +| `lastDetachTimestamp` | `string` | [Output Only] Last detach timestamp in RFC3339 text format. | +| `sourceSnapshotId` | `string` | [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. | +| `diskEncryptionKey` | `object` | | | `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | -| `sourceImageEncryptionKey` | `object` | | -| `architecture` | `string` | The architecture of the disk. Valid values are ARM64 or X86_64. | -| `users` | `array` | [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance | +| `resourcePolicies` | `array` | Resource policies applied to this disk for automatic snapshot creations. | +| `provisionedIops` | `string` | Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `zone` | `string` | [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `sourceImageId` | `string` | [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. | -| `type` | `string` | URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types. | -| `guestOsFeatures` | `array` | A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. | -| `replicaZones` | `array` | URLs of the zones where the disk should be replicated to. Only applicable for regional resources. | -| `sourceSnapshotEncryptionKey` | `object` | | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. | +| `sourceStorageObject` | `string` | The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead. | +| `options` | `string` | Internal use only. | +| `status` | `string` | [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -78,6 +78,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of persistent disks contained within the specified region. | | `insert` | `INSERT` | `project, region` | Creates a persistent regional disk in the specified project using the data included in the request. | | `delete` | `DELETE` | `disk, project, region` | Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. | +| `_list` | `EXEC` | `project, region` | Retrieves the list of persistent disks contained within the specified region. | | `bulk_insert` | `EXEC` | `project, region` | Bulk create a set of disks. | | `resize` | `EXEC` | `disk, project, region` | Resizes the specified regional persistent disk. | | `set_labels` | `EXEC` | `project, region, resource` | Sets the labels on the target regional disk. | diff --git a/docs/google-docs/providers/google/compute/region_disks_iam_policies/index.md b/docs/google-docs/providers/google/compute/region_disks_iam_policies/index.md index 896f0303c8..966c6e51e0 100644 --- a/docs/google-docs/providers/google/compute/region_disks_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/region_disks_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_health_check_services/index.md b/docs/google-docs/providers/google/compute/region_health_check_services/index.md index 09426eaa45..730092b205 100644 --- a/docs/google-docs/providers/google/compute/region_health_check_services/index.md +++ b/docs/google-docs/providers/google/compute/region_health_check_services/index.md @@ -31,14 +31,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | | `healthStatusAggregationPolicy` | `string` | Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#healthCheckServicefor health check services. | +| `networkEndpointGroups` | `array` | A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT. | +| `region` | `string` | [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#healthCheckServicefor health check services. | | `healthChecks` | `array` | A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `notificationEndpoints` | `array` | A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global. | -| `region` | `string` | [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `networkEndpointGroups` | `array` | A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -46,4 +46,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Lists all the HealthCheckService resources that have been configured for the specified project in the given region. | | `insert` | `INSERT` | `project, region` | Creates a regional HealthCheckService resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `healthCheckService, project, region` | Deletes the specified regional HealthCheckService. | +| `_list` | `EXEC` | `project, region` | Lists all the HealthCheckService resources that have been configured for the specified project in the given region. | | `patch` | `EXEC` | `healthCheckService, project, region` | Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | diff --git a/docs/google-docs/providers/google/compute/region_health_checks/index.md b/docs/google-docs/providers/google/compute/region_health_checks/index.md index 2d80c01e81..acf8b20221 100644 --- a/docs/google-docs/providers/google/compute/region_health_checks/index.md +++ b/docs/google-docs/providers/google/compute/region_health_checks/index.md @@ -30,22 +30,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `http2HealthCheck` | `object` | | -| `sslHealthCheck` | `object` | | -| `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | | `logConfig` | `object` | Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. | -| `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | -| `type` | `string` | Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. | -| `region` | `string` | [Output Only] Region where the health check resides. Not applicable to global health checks. | -| `httpsHealthCheck` | `object` | | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in 3339 text format. | | `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | | `httpHealthCheck` | `object` | | +| `type` | `string` | Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. | | `kind` | `string` | Type of the resource. | -| `timeoutSec` | `integer` | How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. | -| `grpcHealthCheck` | `object` | | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `tcpHealthCheck` | `object` | | +| `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | +| `httpsHealthCheck` | `object` | | +| `http2HealthCheck` | `object` | | +| `sslHealthCheck` | `object` | | +| `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | +| `grpcHealthCheck` | `object` | | +| `region` | `string` | [Output Only] Region where the health check resides. Not applicable to global health checks. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in 3339 text format. | +| `timeoutSec` | `integer` | How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -53,5 +53,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of HealthCheck resources available to the specified project. | | `insert` | `INSERT` | `project, region` | Creates a HealthCheck resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `healthCheck, project, region` | Deletes the specified HealthCheck resource. | +| `_list` | `EXEC` | `project, region` | Retrieves the list of HealthCheck resources available to the specified project. | | `patch` | `EXEC` | `healthCheck, project, region` | Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `healthCheck, project, region` | Updates a HealthCheck resource in the specified project using the data included in the request. | diff --git a/docs/google-docs/providers/google/compute/region_instance_group_managers/index.md b/docs/google-docs/providers/google/compute/region_instance_group_managers/index.md index 36ff670176..b3019a581c 100644 --- a/docs/google-docs/providers/google/compute/region_instance_group_managers/index.md +++ b/docs/google-docs/providers/google/compute/region_instance_group_managers/index.md @@ -30,27 +30,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] A unique identifier for this resource type. The server generates this identifier. | | `name` | `string` | The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. | | `description` | `string` | An optional description of this resource. | +| `status` | `object` | | +| `namedPorts` | `array` | Named ports configured for the Instance Groups complementary to this Instance Group Manager. | +| `listManagedInstancesResults` | `string` | Pagination behavior of the listManagedInstances API method for this managed instance group. | | `targetSize` | `integer` | The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. | -| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. | -| `region` | `string` | [Output Only] The URL of the region where the managed instance group resides (for regional resources). | | `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. | -| `selfLink` | `string` | [Output Only] The URL for this managed instance group. The server defines this URL. | -| `versions` | `array` | Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. | -| `updatePolicy` | `object` | | -| `instanceTemplate` | `string` | The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. | -| `fingerprint` | `string` | Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. | | `baseInstanceName` | `string` | The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. | -| `status` | `object` | | -| `targetPools` | `array` | The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. | -| `statefulPolicy` | `object` | | +| `region` | `string` | [Output Only] The URL of the region where the managed instance group resides (for regional resources). | +| `updatePolicy` | `object` | | | `autoHealingPolicies` | `array` | The autohealing policy for this managed instance group. You can specify only one value. | +| `statefulPolicy` | `object` | | +| `instanceTemplate` | `string` | The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. | | `zone` | `string` | [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). | -| `instanceLifecyclePolicy` | `object` | | -| `listManagedInstancesResults` | `string` | Pagination behavior of the listManagedInstances API method for this managed instance group. | -| `namedPorts` | `array` | Named ports configured for the Instance Groups complementary to this Instance Group Manager. | -| `distributionPolicy` | `object` | | +| `fingerprint` | `string` | Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. | | `instanceGroup` | `string` | [Output Only] The URL of the Instance Group resource. | +| `distributionPolicy` | `object` | | +| `selfLink` | `string` | [Output Only] The URL for this managed instance group. The server defines this URL. | +| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. | | `currentActions` | `object` | | +| `versions` | `array` | Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. | +| `instanceLifecyclePolicy` | `object` | | +| `targetPools` | `array` | The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -58,6 +58,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of managed instance groups that are contained within the specified region. | | `insert` | `INSERT` | `project, region` | Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. | | `delete` | `DELETE` | `instanceGroupManager, project, region` | Deletes the specified managed instance group and all of the instances in that group. | +| `_list` | `EXEC` | `project, region` | Retrieves the list of managed instance groups that are contained within the specified region. | | `abandon_instances` | `EXEC` | `instanceGroupManager, project, region` | Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. | | `apply_updates_to_instances` | `EXEC` | `instanceGroupManager, project, region` | Apply updates to selected instances the managed instance group. | | `patch` | `EXEC` | `instanceGroupManager, project, region` | Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. | diff --git a/docs/google-docs/providers/google/compute/region_instance_group_managers_errors/index.md b/docs/google-docs/providers/google/compute/region_instance_group_managers_errors/index.md index 7547283c40..d7d16e2907 100644 --- a/docs/google-docs/providers/google/compute/region_instance_group_managers_errors/index.md +++ b/docs/google-docs/providers/google/compute/region_instance_group_managers_errors/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `instanceActionDetails` | `object` | | | `timestamp` | `string` | [Output Only] The time that this error occurred. This value is in RFC3339 text format. | | `error` | `object` | | -| `instanceActionDetails` | `object` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/region_instance_groups/index.md b/docs/google-docs/providers/google/compute/region_instance_groups/index.md index cb3837f3c0..60229bcdba 100644 --- a/docs/google-docs/providers/google/compute/region_instance_groups/index.md +++ b/docs/google-docs/providers/google/compute/region_instance_groups/index.md @@ -30,19 +30,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] A unique identifier for this instance group, generated by the server. | | `name` | `string` | The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `zone` | `string` | [Output Only] The URL of the zone where the instance group is located (for zonal resources). | +| `size` | `integer` | [Output Only] The total number of instances in the instance group. | +| `subnetwork` | `string` | [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0). | +| `fingerprint` | `string` | [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. | | `namedPorts` | `array` | Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. | +| `region` | `string` | [Output Only] The URL of the region where the instance group is located (for regional resources). | +| `selfLink` | `string` | [Output Only] The URL for this instance group. The server generates this URL. | | `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroup for instance groups. | | `creationTimestamp` | `string` | [Output Only] The creation timestamp for this instance group in RFC3339 text format. | -| `selfLink` | `string` | [Output Only] The URL for this instance group. The server generates this URL. | -| `region` | `string` | [Output Only] The URL of the region where the instance group is located (for regional resources). | -| `zone` | `string` | [Output Only] The URL of the zone where the instance group is located (for zonal resources). | -| `fingerprint` | `string` | [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. | | `network` | `string` | [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0). | -| `subnetwork` | `string` | [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0). | -| `size` | `integer` | [Output Only] The total number of instances in the instance group. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `instanceGroup, project, region` | Returns the specified instance group resource. | | `list` | `SELECT` | `project, region` | Retrieves the list of instance group resources contained within the specified region. | +| `_list` | `EXEC` | `project, region` | Retrieves the list of instance group resources contained within the specified region. | | `set_named_ports` | `EXEC` | `instanceGroup, project, region` | Sets the named ports for the specified regional instance group. | diff --git a/docs/google-docs/providers/google/compute/region_instance_templates/index.md b/docs/google-docs/providers/google/compute/region_instance_templates/index.md index 852e13c066..c6a6181d03 100644 --- a/docs/google-docs/providers/google/compute/region_instance_templates/index.md +++ b/docs/google-docs/providers/google/compute/region_instance_templates/index.md @@ -33,9 +33,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `creationTimestamp` | `string` | [Output Only] The creation timestamp for this instance template in RFC3339 text format. | | `region` | `string` | [Output Only] URL of the region where the instance template resides. Only applicable for regional resources. | | `sourceInstance` | `string` | The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance | -| `sourceInstanceParams` | `object` | A specification of the parameters to use when creating the instance template from a source instance. | -| `selfLink` | `string` | [Output Only] The URL for this instance template. The server defines this URL. | | `kind` | `string` | [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. | +| `selfLink` | `string` | [Output Only] The URL for this instance template. The server defines this URL. | +| `sourceInstanceParams` | `object` | A specification of the parameters to use when creating the instance template from a source instance. | | `properties` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | @@ -44,3 +44,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of instance templates that are contained within the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates an instance template in the specified project and region using the global instance template whose URL is included in the request. | | `delete` | `DELETE` | `instanceTemplate, project, region` | Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of instance templates that are contained within the specified project and region. | diff --git a/docs/google-docs/providers/google/compute/region_network_endpoint_groups/index.md b/docs/google-docs/providers/google/compute/region_network_endpoint_groups/index.md index 7aa13cb7ea..fe497d0a4f 100644 --- a/docs/google-docs/providers/google/compute/region_network_endpoint_groups/index.md +++ b/docs/google-docs/providers/google/compute/region_network_endpoint_groups/index.md @@ -30,22 +30,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `region` | `string` | [Output Only] The URL of the region where the network endpoint group is located. | | `annotations` | `object` | Metadata defined as annotations on the network endpoint group. | +| `zone` | `string` | [Output Only] The URL of the zone where the network endpoint group is located. | +| `cloudFunction` | `object` | Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. | | `pscTargetService` | `string` | The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com" | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `size` | `integer` | [Output only] Number of network endpoints in the network endpoint group. | | `network` | `string` | The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. | -| `cloudRun` | `object` | Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. | +| `appEngine` | `object` | Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. | | `networkEndpointType` | `string` | Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. | -| `zone` | `string` | [Output Only] The URL of the zone where the network endpoint group is located. | +| `cloudRun` | `object` | Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. | +| `defaultPort` | `integer` | The default port used if the port number is not specified in the network endpoint. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `pscData` | `object` | All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. | -| `cloudFunction` | `object` | Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. | -| `appEngine` | `object` | Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. | -| `defaultPort` | `integer` | The default port used if the port number is not specified in the network endpoint. | +| `size` | `integer` | [Output only] Number of network endpoints in the network endpoint group. | | `subnetwork` | `string` | Optional URL of the subnetwork to which all network endpoints in the NEG belong. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. | -| `region` | `string` | [Output Only] The URL of the region where the network endpoint group is located. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -53,3 +53,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of regional network endpoint groups available to the specified project in the given region. | | `insert` | `INSERT` | `project, region` | Creates a network endpoint group in the specified project using the parameters that are included in the request. | | `delete` | `DELETE` | `networkEndpointGroup, project, region` | Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service. | +| `_list` | `EXEC` | `project, region` | Retrieves the list of regional network endpoint groups available to the specified project in the given region. | diff --git a/docs/google-docs/providers/google/compute/region_network_firewall_policies/index.md b/docs/google-docs/providers/google/compute/region_network_firewall_policies/index.md index 7510288618..dfce51fab5 100644 --- a/docs/google-docs/providers/google/compute/region_network_firewall_policies/index.md +++ b/docs/google-docs/providers/google/compute/region_network_firewall_policies/index.md @@ -30,18 +30,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. | -| `parent` | `string` | [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. | +| `displayName` | `string` | Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `region` | `string` | [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `ruleTupleCount` | `integer` | [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. | | `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | +| `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. | | `associations` | `array` | A list of associations that belong to this firewall policy. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies | +| `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. | +| `parent` | `string` | [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. | | `shortName` | `string` | User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | -| `ruleTupleCount` | `integer` | [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. | -| `displayName` | `string` | Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -49,6 +49,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Lists all the network firewall policies that have been configured for the specified project in the given region. | | `insert` | `INSERT` | `project, region` | Creates a new network firewall policy in the specified project and region. | | `delete` | `DELETE` | `firewallPolicy, project, region` | Deletes the specified network firewall policy. | +| `_list` | `EXEC` | `project, region` | Lists all the network firewall policies that have been configured for the specified project in the given region. | | `clone_rules` | `EXEC` | `firewallPolicy, project, region` | Copies rules to the specified network firewall policy. | | `patch` | `EXEC` | `firewallPolicy, project, region` | Patches the specified network firewall policy. | | `patch_rule` | `EXEC` | `firewallPolicy, project, region` | Patches a rule of the specified priority. | diff --git a/docs/google-docs/providers/google/compute/region_network_firewall_policies_iam_policies/index.md b/docs/google-docs/providers/google/compute/region_network_firewall_policies_iam_policies/index.md index 3e66b78651..bbcc090625 100644 --- a/docs/google-docs/providers/google/compute/region_network_firewall_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/region_network_firewall_policies_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_network_firewall_policies_rule/index.md b/docs/google-docs/providers/google/compute/region_network_firewall_policies_rule/index.md index f9751b74f3..6f57e576ab 100644 --- a/docs/google-docs/providers/google/compute/region_network_firewall_policies_rule/index.md +++ b/docs/google-docs/providers/google/compute/region_network_firewall_policies_rule/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `description` | `string` | An optional description for this resource. | -| `disabled` | `boolean` | Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules | -| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | | `ruleName` | `string` | An optional name for the rule. This field is not a unique identifier and can be updated. | -| `ruleTupleCount` | `integer` | [Output Only] Calculation of the complexity of a single firewall policy rule. | -| `targetResources` | `array` | A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. | -| `action` | `string` | The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". | +| `direction` | `string` | The direction in which this rule applies. | +| `targetSecureTags` | `array` | A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. | | `targetServiceAccounts` | `array` | A list of service accounts indicating the sets of instances that are applied with this rule. | +| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | | `enableLogging` | `boolean` | Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. | -| `targetSecureTags` | `array` | A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. | -| `direction` | `string` | The direction in which this rule applies. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules | | `priority` | `integer` | An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. | +| `targetResources` | `array` | A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. | +| `action` | `string` | The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". | +| `disabled` | `boolean` | Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. | +| `ruleTupleCount` | `integer` | [Output Only] Calculation of the complexity of a single firewall policy rule. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_notification_endpoints/index.md b/docs/google-docs/providers/google/compute/region_notification_endpoints/index.md index 25bd0cadf8..2d2fdddb76 100644 --- a/docs/google-docs/providers/google/compute/region_notification_endpoints/index.md +++ b/docs/google-docs/providers/google/compute/region_notification_endpoints/index.md @@ -42,3 +42,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Lists the NotificationEndpoints for a project in the given region. | | `insert` | `INSERT` | `project, region` | Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request. | | `delete` | `DELETE` | `notificationEndpoint, project, region` | Deletes the specified NotificationEndpoint in the given region | +| `_list` | `EXEC` | `project, region` | Lists the NotificationEndpoints for a project in the given region. | diff --git a/docs/google-docs/providers/google/compute/region_operations/index.md b/docs/google-docs/providers/google/compute/region_operations/index.md index bb5163af32..b857cfc55a 100644 --- a/docs/google-docs/providers/google/compute/region_operations/index.md +++ b/docs/google-docs/providers/google/compute/region_operations/index.md @@ -30,32 +30,33 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the operation. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the operation. | | `description` | `string` | [Output Only] A textual description of the operation, which is set when the operation is created. | -| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | -| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | -| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | -| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | +| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | | `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | +| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | +| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | +| `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | | `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | +| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | +| `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | +| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | +| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | | `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | -| `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | -| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | +| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | +| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | | `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | +| `targetLink` | `string` | [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. | | `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | -| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | +| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | | `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | -| `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | +| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `setCommonInstanceMetadataOperationMetadata` | `object` | | | `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | -| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | -| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | -| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | -| `targetLink` | `string` | [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. | -| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operation, project, region` | Retrieves the specified region-specific Operations resource. | | `list` | `SELECT` | `project, region` | Retrieves a list of Operation resources contained within the specified region. | | `delete` | `DELETE` | `operation, project, region` | Deletes the specified region-specific Operations resource. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of Operation resources contained within the specified region. | | `wait` | `EXEC` | `operation, project, region` | Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. | diff --git a/docs/google-docs/providers/google/compute/region_security_policies/index.md b/docs/google-docs/providers/google/compute/region_security_policies/index.md index ad27aa0ac3..be07a20c3f 100644 --- a/docs/google-docs/providers/google/compute/region_security_policies/index.md +++ b/docs/google-docs/providers/google/compute/region_security_policies/index.md @@ -30,19 +30,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `type` | `string` | The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. | -| `ddosProtectionConfig` | `object` | | -| `advancedOptionsConfig` | `object` | | -| `recaptchaOptionsConfig` | `object` | | -| `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy. | | `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | -| `region` | `string` | [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies. | | `kind` | `string` | [Output only] Type of the resource. Always compute#securityPolicyfor security policies | +| `ddosProtectionConfig` | `object` | | | `adaptiveProtectionConfig` | `object` | Configuration options for Cloud Armor Adaptive Protection (CAAP). | -| `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "*" for srcIpRanges and for the networkMatch condition every field must be either match "*" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy. | | `labelFingerprint` | `string` | A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy. | +| `advancedOptionsConfig` | `object` | | +| `type` | `string` | The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "*" for srcIpRanges and for the networkMatch condition every field must be either match "*" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. | +| `recaptchaOptionsConfig` | `object` | | +| `region` | `string` | [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -50,4 +50,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | List all the policies that have been configured for the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a new policy in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, region, securityPolicy` | Deletes the specified policy. | +| `_list` | `EXEC` | `project, region` | List all the policies that have been configured for the specified project and region. | | `patch` | `EXEC` | `project, region, securityPolicy` | Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead. | diff --git a/docs/google-docs/providers/google/compute/region_ssl_certificates/index.md b/docs/google-docs/providers/google/compute/region_ssl_certificates/index.md index 7e90831b0f..19c5fab605 100644 --- a/docs/google-docs/providers/google/compute/region_ssl_certificates/index.md +++ b/docs/google-docs/providers/google/compute/region_ssl_certificates/index.md @@ -30,17 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `region` | `string` | [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate. | -| `expireTime` | `string` | [Output Only] Expire time of the certificate. RFC3339 | -| `privateKey` | `string` | A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field. | -| `selfManaged` | `object` | Configuration and status of a self-managed SSL certificate. | -| `type` | `string` | (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. | +| `managed` | `object` | Configuration and status of a managed SSL certificate. | | `selfLink` | `string` | [Output only] Server-defined URL for the resource. | +| `expireTime` | `string` | [Output Only] Expire time of the certificate. RFC3339 | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `certificate` | `string` | A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. | +| `region` | `string` | [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. | | `subjectAlternativeNames` | `array` | [Output Only] Domains associated with the certificate via Subject Alternative Name. | -| `certificate` | `string` | A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. | -| `managed` | `object` | Configuration and status of a managed SSL certificate. | +| `type` | `string` | (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. | +| `selfManaged` | `object` | Configuration and status of a self-managed SSL certificate. | +| `privateKey` | `string` | A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -48,3 +48,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of SslCertificate resources available to the specified project in the specified region. | | `insert` | `INSERT` | `project, region` | Creates a SslCertificate resource in the specified project and region using the data included in the request | | `delete` | `DELETE` | `project, region, sslCertificate` | Deletes the specified SslCertificate resource in the region. | +| `_list` | `EXEC` | `project, region` | Retrieves the list of SslCertificate resources available to the specified project in the specified region. | diff --git a/docs/google-docs/providers/google/compute/region_ssl_policies/index.md b/docs/google-docs/providers/google/compute/region_ssl_policies/index.md index 6fc5f7a342..34fa663cd6 100644 --- a/docs/google-docs/providers/google/compute/region_ssl_policies/index.md +++ b/docs/google-docs/providers/google/compute/region_ssl_policies/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `warnings` | `array` | [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. | +| `customFeatures` | `array` | A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. | +| `enabledFeatures` | `array` | [Output Only] The list of features enabled in the SSL policy. | | `kind` | `string` | [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. | | `region` | `string` | [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `minTlsVersion` | `string` | The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2. | -| `profile` | `string` | Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `warnings` | `array` | [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `customFeatures` | `array` | A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. | -| `enabledFeatures` | `array` | [Output Only] The list of features enabled in the SSL policy. | +| `profile` | `string` | Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,4 +47,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Lists all the SSL policies that have been configured for the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a new policy in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, sslPolicy` | Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. | +| `_list` | `EXEC` | `project, region` | Lists all the SSL policies that have been configured for the specified project and region. | | `patch` | `EXEC` | `project, region, sslPolicy` | Patches the specified SSL policy with the data included in the request. | diff --git a/docs/google-docs/providers/google/compute/region_target_http_proxies/index.md b/docs/google-docs/providers/google/compute/region_target_http_proxies/index.md index 14d3bc19f0..bfe57cc815 100644 --- a/docs/google-docs/providers/google/compute/region_target_http_proxies/index.md +++ b/docs/google-docs/providers/google/compute/region_target_http_proxies/index.md @@ -30,14 +30,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. | -| `region` | `string` | [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | +| `httpKeepAliveTimeoutSec` | `integer` | Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For Global external HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For Global external HTTP(S) load balancer (classic), this option is not available publicly. | | `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. | +| `region` | `string` | [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | | `urlMap` | `string` | URL to the UrlMap resource that defines the mapping from URL to the BackendService. | -| `httpKeepAliveTimeoutSec` | `integer` | Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For Global external HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For Global external HTTP(S) load balancer (classic), this option is not available publicly. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -45,4 +45,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. | | `insert` | `INSERT` | `project, region` | Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, targetHttpProxy` | Deletes the specified TargetHttpProxy resource. | +| `_list` | `EXEC` | `project, region` | Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. | | `set_url_map` | `EXEC` | `project, region, targetHttpProxy` | Changes the URL map for TargetHttpProxy. | diff --git a/docs/google-docs/providers/google/compute/region_target_https_proxies/index.md b/docs/google-docs/providers/google/compute/region_target_https_proxies/index.md index 753c8d8b27..372bc29b45 100644 --- a/docs/google-docs/providers/google/compute/region_target_https_proxies/index.md +++ b/docs/google-docs/providers/google/compute/region_target_https_proxies/index.md @@ -30,20 +30,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `quicOverride` | `string` | Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. | +| `authorizationPolicy` | `string` | Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy. | | `serverTlsPolicy` | `string` | Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted. | -| `httpKeepAliveTimeoutSec` | `integer` | Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For Global external HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For Global external HTTP(S) load balancer (classic), this option is not available publicly. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `certificateMap` | `string` | URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. | | `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | -| `authorizationPolicy` | `string` | Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact. | -| `region` | `string` | [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. | -| `urlMap` | `string` | A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map | -| `sslCertificates` | `array` | URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. | | `sslPolicy` | `string` | URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. | -| `certificateMap` | `string` | URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `sslCertificates` | `array` | URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. | +| `urlMap` | `string` | A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. | +| `httpKeepAliveTimeoutSec` | `integer` | Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For Global external HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For Global external HTTP(S) load balancer (classic), this option is not available publicly. | +| `quicOverride` | `string` | Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. | +| `region` | `string` | [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -51,6 +51,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. | | `insert` | `INSERT` | `project, region` | Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, targetHttpsProxy` | Deletes the specified TargetHttpsProxy resource. | +| `_list` | `EXEC` | `project, region` | Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. | | `patch` | `EXEC` | `project, region, targetHttpsProxy` | Patches the specified regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | | `set_ssl_certificates` | `EXEC` | `project, region, targetHttpsProxy` | Replaces SslCertificates for TargetHttpsProxy. | | `set_url_map` | `EXEC` | `project, region, targetHttpsProxy` | Changes the URL map for TargetHttpsProxy. | diff --git a/docs/google-docs/providers/google/compute/region_target_tcp_proxies/index.md b/docs/google-docs/providers/google/compute/region_target_tcp_proxies/index.md index e56851e566..511509a256 100644 --- a/docs/google-docs/providers/google/compute/region_target_tcp_proxies/index.md +++ b/docs/google-docs/providers/google/compute/region_target_tcp_proxies/index.md @@ -31,12 +31,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. | +| `service` | `string` | URL to the BackendService resource. | | `proxyHeader` | `string` | Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. | | `region` | `string` | [Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy. | -| `service` | `string` | URL to the BackendService resource. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. | -| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,3 +44,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of TargetTcpProxy resources available to the specified project in a given region. | | `insert` | `INSERT` | `project, region` | Creates a TargetTcpProxy resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, targetTcpProxy` | Deletes the specified TargetTcpProxy resource. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of TargetTcpProxy resources available to the specified project in a given region. | diff --git a/docs/google-docs/providers/google/compute/region_url_maps/index.md b/docs/google-docs/providers/google/compute/region_url_maps/index.md index 81d8dba272..2b8a8d0301 100644 --- a/docs/google-docs/providers/google/compute/region_url_maps/index.md +++ b/docs/google-docs/providers/google/compute/region_url_maps/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `defaultUrlRedirect` | `object` | Specifies settings for an HTTP redirect. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. | +| `defaultService` | `string` | The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. | | `tests` | `array` | The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#urlMaps for url maps. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `defaultRouteAction` | `object` | | -| `headerAction` | `object` | The request and response header transformations that take effect before the request is passed along to the selected backendService. | | `hostRules` | `array` | The list of host rules to use against the URL. | -| `defaultService` | `string` | The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. | | `region` | `string` | [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. | +| `defaultRouteAction` | `object` | | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#urlMaps for url maps. | +| `headerAction` | `object` | The request and response header transformations that take effect before the request is passed along to the selected backendService. | +| `defaultUrlRedirect` | `object` | Specifies settings for an HTTP redirect. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `pathMatchers` | `array` | The list of named PathMatchers to use against the URL. | ## Methods @@ -49,6 +49,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of UrlMap resources available to the specified project in the specified region. | | `insert` | `INSERT` | `project, region` | Creates a UrlMap resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, region, urlMap` | Deletes the specified UrlMap resource. | +| `_list` | `EXEC` | `project, region` | Retrieves the list of UrlMap resources available to the specified project in the specified region. | | `patch` | `EXEC` | `project, region, urlMap` | Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | | `update` | `EXEC` | `project, region, urlMap` | Updates the specified UrlMap resource with the data included in the request. | | `validate` | `EXEC` | `project, region, urlMap` | Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. | diff --git a/docs/google-docs/providers/google/compute/regions/index.md b/docs/google-docs/providers/google/compute/regions/index.md index ffa180d468..2a618ab6b3 100644 --- a/docs/google-docs/providers/google/compute/regions/index.md +++ b/docs/google-docs/providers/google/compute/regions/index.md @@ -30,16 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] Textual description of the resource. | -| `quotas` | `array` | [Output Only] Quotas assigned to this region. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#region for regions. | | `supportsPzs` | `boolean` | [Output Only] Reserved for future use. | -| `deprecated` | `object` | Deprecation status for a public resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `zones` | `array` | [Output Only] A list of zones available in this region, in the form of resource URLs. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `quotas` | `array` | [Output Only] Quotas assigned to this region. | | `status` | `string` | [Output Only] Status of the region, either UP or DOWN. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `deprecated` | `object` | Deprecation status for a public resource. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#region for regions. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `project, region` | Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. | | `list` | `SELECT` | `project` | Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. | +| `_list` | `EXEC` | `project` | Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. | diff --git a/docs/google-docs/providers/google/compute/reservations/index.md b/docs/google-docs/providers/google/compute/reservations/index.md index ade9d9f02c..cefd7bb69c 100644 --- a/docs/google-docs/providers/google/compute/reservations/index.md +++ b/docs/google-docs/providers/google/compute/reservations/index.md @@ -30,18 +30,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `resourcePolicies` | `object` | Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation. | | `commitment` | `string` | [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment. | +| `specificReservationRequired` | `boolean` | Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | | `status` | `string` | [Output Only] The status of the reservation. | -| `resourceStatus` | `object` | [Output Only] Contains output only fields. | +| `resourcePolicies` | `object` | Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `zone` | `string` | Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#reservations for reservations. | +| `shareSettings` | `object` | The share setting for reservations and sole tenancy node groups. | +| `resourceStatus` | `object` | [Output Only] Contains output only fields. | | `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | | `specificReservation` | `object` | This reservation type allows to pre allocate specific instance configuration. Next ID: 6 | -| `specificReservationRequired` | `boolean` | Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `shareSettings` | `object` | The share setting for reservations and sole tenancy node groups. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -49,6 +49,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, zone` | A list of all the reservations that have been configured for the specified project in specified zone. | | `insert` | `INSERT` | `project, zone` | Creates a new reservation. For more information, read Reserving zonal resources. | | `delete` | `DELETE` | `project, reservation, zone` | Deletes the specified reservation. | +| `_list` | `EXEC` | `project, zone` | A list of all the reservations that have been configured for the specified project in specified zone. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of reservations. | | `resize` | `EXEC` | `project, reservation, zone` | Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. | | `update` | `EXEC` | `project, reservation, zone` | Update share settings of the reservation. | diff --git a/docs/google-docs/providers/google/compute/reservations_iam_policies/index.md b/docs/google-docs/providers/google/compute/reservations_iam_policies/index.md index 560e3f7fd6..7d4142ea71 100644 --- a/docs/google-docs/providers/google/compute/reservations_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/reservations_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `rules` | `array` | This is deprecated and has no effect. Do not use. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `rules` | `array` | This is deprecated and has no effect. Do not use. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/resource_policies/index.md b/docs/google-docs/providers/google/compute/resource_policies/index.md index 5ccaeed775..696e82d144 100644 --- a/docs/google-docs/providers/google/compute/resource_policies/index.md +++ b/docs/google-docs/providers/google/compute/resource_policies/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | | -| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | -| `resourceStatus` | `object` | Contains output only fields. Use this sub-message for all output fields set on ResourcePolicy. The internal structure of this "status" field should mimic the structure of ResourcePolicy proto specification. | -| `instanceSchedulePolicy` | `object` | An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance. | +| `diskConsistencyGroupPolicy` | `object` | Resource policy for disk consistency groups. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `groupPlacementPolicy` | `object` | A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality | -| `status` | `string` | [Output Only] The status of resource policy creation. | -| `diskConsistencyGroupPolicy` | `object` | Resource policy for disk consistency groups. | -| `snapshotSchedulePolicy` | `object` | A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#resource_policies for resource policies. | +| `resourceStatus` | `object` | Contains output only fields. Use this sub-message for all output fields set on ResourcePolicy. The internal structure of this "status" field should mimic the structure of ResourcePolicy proto specification. | +| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | | `region` | `string` | | +| `snapshotSchedulePolicy` | `object` | A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained. | +| `status` | `string` | [Output Only] The status of resource policy creation. | +| `instanceSchedulePolicy` | `object` | An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,5 +47,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | A list all the resource policies that have been configured for the specified project in specified region. | | `insert` | `INSERT` | `project, region` | Creates a new resource policy. | | `delete` | `DELETE` | `project, region, resourcePolicy` | Deletes the specified resource policy. | +| `_list` | `EXEC` | `project, region` | A list all the resource policies that have been configured for the specified project in specified region. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of resource policies. | | `patch` | `EXEC` | `project, region, resourcePolicy` | Modify the specified resource policy. | diff --git a/docs/google-docs/providers/google/compute/resource_policies_iam_policies/index.md b/docs/google-docs/providers/google/compute/resource_policies_iam_policies/index.md index 8a2bfa72c4..ceff0fda6f 100644 --- a/docs/google-docs/providers/google/compute/resource_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/resource_policies_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/routers/index.md b/docs/google-docs/providers/google/compute/routers/index.md index 356297f2cf..a0f6e8dbaa 100644 --- a/docs/google-docs/providers/google/compute/routers/index.md +++ b/docs/google-docs/providers/google/compute/routers/index.md @@ -30,17 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `encryptedInterconnectRouter` | `boolean` | Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments). | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `interfaces` | `array` | Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. | | `network` | `string` | URI of the network to which this router belongs. | +| `md5AuthenticationKeys` | `array` | Keys used for MD5 authentication. | +| `region` | `string` | [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `interfaces` | `array` | Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. | | `bgpPeers` | `array` | BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#router for routers. | +| `encryptedInterconnectRouter` | `boolean` | Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments). | | `nats` | `array` | A list of NAT services created in this router. | -| `bgp` | `object` | | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `region` | `string` | [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `md5AuthenticationKeys` | `array` | Keys used for MD5 authentication. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#router for routers. | +| `bgp` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -48,6 +48,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of Router resources available to the specified project. | | `insert` | `INSERT` | `project, region` | Creates a Router resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, router` | Deletes the specified Router resource. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of Router resources available to the specified project. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of routers. | | `patch` | `EXEC` | `project, region, router` | Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | | `preview` | `EXEC` | `project, region, router` | Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. | diff --git a/docs/google-docs/providers/google/compute/routers_nat_ip_info/index.md b/docs/google-docs/providers/google/compute/routers_nat_ip_info/index.md new file mode 100644 index 0000000000..d71ddfeda5 --- /dev/null +++ b/docs/google-docs/providers/google/compute/routers_nat_ip_info/index.md @@ -0,0 +1,31 @@ +--- +title: routers_nat_ip_info +hide_title: false +hide_table_of_contents: false +keywords: + - routers_nat_ip_info + - compute + - 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 +--- + + + +## Overview + + + + +
Namerouters_nat_ip_info
TypeResource
Idgoogle.compute.routers_nat_ip_info
+ +## Fields +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `get_nat_ip_info` | `SELECT` | `project, region, router` | diff --git a/docs/google-docs/providers/google/compute/routers_nat_mapping_info/index.md b/docs/google-docs/providers/google/compute/routers_nat_mapping_info/index.md index a7af20d6b0..e127b062c8 100644 --- a/docs/google-docs/providers/google/compute/routers_nat_mapping_info/index.md +++ b/docs/google-docs/providers/google/compute/routers_nat_mapping_info/index.md @@ -27,13 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | -| `nextPageToken` | `string` | [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. | -| `result` | `array` | [Output Only] A list of Nat mapping information of VM endpoints. | -| `selfLink` | `string` | [Output Only] Server-defined URL for this resource. | -| `warning` | `object` | [Output Only] Informational warning message. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints. | +| `interfaceNatMappings` | `array` | | +| `instanceName` | `string` | Name of the VM instance which the endpoint belongs to | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `get_nat_mapping_info` | `SELECT` | `project, region, router` | +| `_get_nat_mapping_info` | `EXEC` | `project, region, router` | diff --git a/docs/google-docs/providers/google/compute/routers_router_status/index.md b/docs/google-docs/providers/google/compute/routers_router_status/index.md index 9748e1bde5..4b27051b62 100644 --- a/docs/google-docs/providers/google/compute/routers_router_status/index.md +++ b/docs/google-docs/providers/google/compute/routers_router_status/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `result` | `object` | | | `kind` | `string` | Type of resource. | +| `result` | `object` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/routes/index.md b/docs/google-docs/providers/google/compute/routes/index.md index 4e210c509e..7bc813e58f 100644 --- a/docs/google-docs/providers/google/compute/routes/index.md +++ b/docs/google-docs/providers/google/compute/routes/index.md @@ -30,25 +30,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. | | `description` | `string` | An optional description of this resource. Provide this field when you create the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `nextHopIp` | `string` | The network IP address of an instance that should handle matching packets. Only IPv4 is supported. | | `nextHopNetwork` | `string` | The URL of the local network if it should handle matching packets. | -| `nextHopIlb` | `string` | The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule | -| `nextHopGateway` | `string` | The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway | -| `kind` | `string` | [Output Only] Type of this resource. Always compute#routes for Route resources. | +| `routeType` | `string` | [Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route | +| `routeStatus` | `string` | [Output only] The status of the route. | | `destRange` | `string` | The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. | -| `priority` | `integer` | The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive. | -| `nextHopIp` | `string` | The network IP address of an instance that should handle matching packets. Only IPv4 is supported. | +| `nextHopHub` | `string` | [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets. | +| `nextHopIlb` | `string` | The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule | | `warnings` | `array` | [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. | | `nextHopVpnTunnel` | `string` | The URL to a VpnTunnel that should handle matching packets. | +| `network` | `string` | Fully-qualified URL of the network that this route applies to. | +| `priority` | `integer` | The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive. | +| `asPaths` | `array` | [Output Only] AS path. | +| `kind` | `string` | [Output Only] Type of this resource. Always compute#routes for Route resources. | | `tags` | `array` | A list of instance tags to which this route applies. | -| `routeType` | `string` | [Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route | | `nextHopPeering` | `string` | [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. | -| `routeStatus` | `string` | [Output only] The status of the route. | -| `asPaths` | `array` | [Output Only] AS path. | -| `nextHopHub` | `string` | [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets. | -| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | | `nextHopInstance` | `string` | The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ | -| `network` | `string` | Fully-qualified URL of the network that this route applies to. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | +| `nextHopGateway` | `string` | The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -56,3 +56,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of Route resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a Route resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, route` | Deletes the specified Route resource. | +| `_list` | `EXEC` | `project` | Retrieves the list of Route resources available to the specified project. | diff --git a/docs/google-docs/providers/google/compute/security_policies/index.md b/docs/google-docs/providers/google/compute/security_policies/index.md index e127d2f8da..61341162cd 100644 --- a/docs/google-docs/providers/google/compute/security_policies/index.md +++ b/docs/google-docs/providers/google/compute/security_policies/index.md @@ -31,18 +31,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | | `ddosProtectionConfig` | `object` | | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy. | -| `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "*" for srcIpRanges and for the networkMatch condition every field must be either match "*" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | -| `adaptiveProtectionConfig` | `object` | Configuration options for Cloud Armor Adaptive Protection (CAAP). | | `advancedOptionsConfig` | `object` | | -| `kind` | `string` | [Output only] Type of the resource. Always compute#securityPolicyfor security policies | | `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy. | | `type` | `string` | The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. | | `region` | `string` | [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `recaptchaOptionsConfig` | `object` | | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#securityPolicyfor security policies | +| `adaptiveProtectionConfig` | `object` | Configuration options for Cloud Armor Adaptive Protection (CAAP). | +| `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "*" for srcIpRanges and for the networkMatch condition every field must be either match "*" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -50,6 +50,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | List all the policies that have been configured for the specified project. | | `insert` | `INSERT` | `project` | Creates a new policy in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, securityPolicy` | Deletes the specified policy. | +| `_list` | `EXEC` | `project` | List all the policies that have been configured for the specified project. | | `patch` | `EXEC` | `project, securityPolicy` | Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead. | | `patch_rule` | `EXEC` | `project, securityPolicy` | Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask. | | `set_labels` | `EXEC` | `project, resource` | Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation. | diff --git a/docs/google-docs/providers/google/compute/security_policies_rule/index.md b/docs/google-docs/providers/google/compute/security_policies_rule/index.md index 5899cc65a4..2774d9b8a4 100644 --- a/docs/google-docs/providers/google/compute/security_policies_rule/index.md +++ b/docs/google-docs/providers/google/compute/security_policies_rule/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | +| `headerAction` | `object` | | | `preview` | `boolean` | If set to true, the specified action is not enforced. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules | -| `preconfiguredWafConfig` | `object` | | | `priority` | `integer` | An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. | +| `preconfiguredWafConfig` | `object` | | | `rateLimitOptions` | `object` | | -| `action` | `string` | The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. | -| `headerAction` | `object` | | | `redirectOptions` | `object` | | +| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules | +| `action` | `string` | The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/service_attachments/index.md b/docs/google-docs/providers/google/compute/service_attachments/index.md index 179656e93a..10e6ea31ef 100644 --- a/docs/google-docs/providers/google/compute/service_attachments/index.md +++ b/docs/google-docs/providers/google/compute/service_attachments/index.md @@ -30,22 +30,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource type. The server generates this identifier. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `consumerRejectLists` | `array` | Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment. | +| `producerForwardingRule` | `string` | The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment. | | `targetService` | `string` | The URL of a service serving the endpoint identified by this service attachment. | -| `connectionPreference` | `string` | The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules. | | `connectedEndpoints` | `array` | [Output Only] An array of connections for all the consumers connected to this service attachment. | -| `region` | `string` | [Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `domainNames` | `array` | If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. | -| `enableProxyProtocol` | `boolean` | If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment. | -| `consumerAcceptLists` | `array` | Projects that are allowed to connect to this service attachment. | -| `natSubnets` | `array` | An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `natSubnets` | `array` | An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment. | +| `consumerRejectLists` | `array` | Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number. | | `reconcileConnections` | `boolean` | This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to true. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `connectionPreference` | `string` | The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules. | +| `region` | `string` | [Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `pscServiceAttachmentId` | `object` | | -| `producerForwardingRule` | `string` | The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment. | +| `enableProxyProtocol` | `boolean` | If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#serviceAttachment for service attachments. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `consumerAcceptLists` | `array` | Projects that are allowed to connect to this service attachment. | +| `domainNames` | `array` | If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -53,5 +53,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Lists the ServiceAttachments for a project in the given scope. | | `insert` | `INSERT` | `project, region` | Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request. | | `delete` | `DELETE` | `project, region, serviceAttachment` | Deletes the specified ServiceAttachment in the given scope | +| `_list` | `EXEC` | `project, region` | Lists the ServiceAttachments for a project in the given scope. | | `aggregated_list` | `EXEC` | `project` | Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project. | | `patch` | `EXEC` | `project, region, serviceAttachment` | Patches the specified ServiceAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | diff --git a/docs/google-docs/providers/google/compute/service_attachments_iam_policies/index.md b/docs/google-docs/providers/google/compute/service_attachments_iam_policies/index.md index 848d2a29aa..01ddc415cc 100644 --- a/docs/google-docs/providers/google/compute/service_attachments_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/service_attachments_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/snapshots/index.md b/docs/google-docs/providers/google/compute/snapshots/index.md index 3bdf0f8f5f..30dd36da14 100644 --- a/docs/google-docs/providers/google/compute/snapshots/index.md +++ b/docs/google-docs/providers/google/compute/snapshots/index.md @@ -30,32 +30,32 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `storageBytesStatus` | `string` | [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. | -| `status` | `string` | [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. | -| `chainName` | `string` | Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. | -| `sourceSnapshotSchedulePolicyId` | `string` | [Output Only] ID of the resource policy which created this scheduled snapshot. | +| `creationSizeBytes` | `string` | [Output Only] Size in bytes of the snapshot at creation time. | +| `storageBytes` | `string` | [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. | | `diskSizeGb` | `string` | [Output Only] Size of the source disk, specified in GB. | -| `sourceDisk` | `string` | The source disk used to create this snapshot. | -| `locationHint` | `string` | An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API. | -| `downloadBytes` | `string` | [Output Only] Number of bytes downloaded to restore a snapshot to a disk. | | `snapshotEncryptionKey` | `object` | | -| `labels` | `object` | Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. | -| `licenseCodes` | `array` | [Output Only] Integer license codes indicating which licenses are attached to this snapshot. | -| `architecture` | `string` | [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. | -| `licenses` | `array` | [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). | | `labelFingerprint` | `string` | A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `creationSizeBytes` | `string` | [Output Only] Size in bytes of the snapshot at creation time. | -| `snapshotType` | `string` | Indicates the type of the snapshot. | -| `autoCreated` | `boolean` | [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. | -| `storageLocations` | `array` | Cloud Storage bucket storage location of the snapshot (regional or multi-regional). | +| `sourceDiskId` | `string` | [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. | +| `licenses` | `array` | [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). | | `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `storageBytes` | `string` | [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. | +| `chainName` | `string` | Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. | +| `snapshotType` | `string` | Indicates the type of the snapshot. | | `sourceDiskEncryptionKey` | `object` | | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. | -| `sourceDiskId` | `string` | [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. | +| `downloadBytes` | `string` | [Output Only] Number of bytes downloaded to restore a snapshot to a disk. | | `sourceSnapshotSchedulePolicy` | `string` | [Output Only] URL of the resource policy which created this scheduled snapshot. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. | +| `architecture` | `string` | [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. | +| `labels` | `object` | Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. | +| `autoCreated` | `boolean` | [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. | +| `licenseCodes` | `array` | [Output Only] Integer license codes indicating which licenses are attached to this snapshot. | +| `storageBytesStatus` | `string` | [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. | +| `locationHint` | `string` | An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API. | +| `storageLocations` | `array` | Cloud Storage bucket storage location of the snapshot (regional or multi-regional). | +| `sourceSnapshotSchedulePolicyId` | `string` | [Output Only] ID of the resource policy which created this scheduled snapshot. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `sourceDisk` | `string` | The source disk used to create this snapshot. | +| `status` | `string` | [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -63,4 +63,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of Snapshot resources contained within the specified project. | | `insert` | `INSERT` | `project` | Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project. | | `delete` | `DELETE` | `project, snapshot` | Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. | +| `_list` | `EXEC` | `project` | Retrieves the list of Snapshot resources contained within the specified project. | | `set_labels` | `EXEC` | `project, resource` | Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. | diff --git a/docs/google-docs/providers/google/compute/snapshots_iam_policies/index.md b/docs/google-docs/providers/google/compute/snapshots_iam_policies/index.md index cb76bd21de..c5562c2953 100644 --- a/docs/google-docs/providers/google/compute/snapshots_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/snapshots_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/ssl_certificates/index.md b/docs/google-docs/providers/google/compute/ssl_certificates/index.md index 891aa3e87a..43f2b3ec5b 100644 --- a/docs/google-docs/providers/google/compute/ssl_certificates/index.md +++ b/docs/google-docs/providers/google/compute/ssl_certificates/index.md @@ -30,17 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `selfLink` | `string` | [Output only] Server-defined URL for the resource. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. | -| `subjectAlternativeNames` | `array` | [Output Only] Domains associated with the certificate via Subject Alternative Name. | | `certificate` | `string` | A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. | +| `selfLink` | `string` | [Output only] Server-defined URL for the resource. | +| `privateKey` | `string` | A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field. | | `type` | `string` | (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. | -| `region` | `string` | [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate. | +| `subjectAlternativeNames` | `array` | [Output Only] Domains associated with the certificate via Subject Alternative Name. | | `selfManaged` | `object` | Configuration and status of a self-managed SSL certificate. | +| `expireTime` | `string` | [Output Only] Expire time of the certificate. RFC3339 | +| `region` | `string` | [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. | | `managed` | `object` | Configuration and status of a managed SSL certificate. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `expireTime` | `string` | [Output Only] Expire time of the certificate. RFC3339 | -| `privateKey` | `string` | A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -48,3 +48,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of SslCertificate resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a SslCertificate resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, sslCertificate` | Deletes the specified SslCertificate resource. | +| `_list` | `EXEC` | `project` | Retrieves the list of SslCertificate resources available to the specified project. | diff --git a/docs/google-docs/providers/google/compute/ssl_policies/index.md b/docs/google-docs/providers/google/compute/ssl_policies/index.md index 9f5259f074..c294a7b157 100644 --- a/docs/google-docs/providers/google/compute/ssl_policies/index.md +++ b/docs/google-docs/providers/google/compute/ssl_policies/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. | | `enabledFeatures` | `array` | [Output Only] The list of features enabled in the SSL policy. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `profile` | `string` | Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. | +| `warnings` | `array` | [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `customFeatures` | `array` | A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. | -| `profile` | `string` | Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. | | `minTlsVersion` | `string` | The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2. | -| `warnings` | `array` | [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. | | `region` | `string` | [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,4 +47,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Lists all the SSL policies that have been configured for the specified project. | | `insert` | `INSERT` | `project` | Returns the specified SSL policy resource. | | `delete` | `DELETE` | `project, sslPolicy` | Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. | +| `_list` | `EXEC` | `project` | Lists all the SSL policies that have been configured for the specified project. | | `patch` | `EXEC` | `project, sslPolicy` | Patches the specified SSL policy with the data included in the request. | diff --git a/docs/google-docs/providers/google/compute/subnetworks/index.md b/docs/google-docs/providers/google/compute/subnetworks/index.md index 228f7ffcca..4a5887cb62 100644 --- a/docs/google-docs/providers/google/compute/subnetworks/index.md +++ b/docs/google-docs/providers/google/compute/subnetworks/index.md @@ -30,27 +30,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. | -| `purpose` | `string` | The purpose of the resource. This field can be either PRIVATE, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or INTERNAL_HTTPS_LOAD_BALANCER. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. A subnet with purpose set to REGIONAL_MANAGED_PROXY is a user-created subnetwork that is reserved for regional Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a proxy-only subnet that can be used only by regional internal HTTP(S) load balancers. Note that REGIONAL_MANAGED_PROXY is the preferred setting for all regional Envoy load balancers. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `role` | `string` | The role of subnetwork. Currently, this field is only used when purpose = REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `gatewayAddress` | `string` | [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork. | +| `logConfig` | `object` | The available logging options for this subnetwork. | | `ipv6AccessType` | `string` | The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. | +| `privateIpGoogleAccess` | `boolean` | Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. | +| `internalIpv6Prefix` | `string` | [Output Only] The internal IPv6 address range that is assigned to this subnetwork. | | `enableFlowLogs` | `boolean` | Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `role` | `string` | The role of subnetwork. Currently, this field is only used when purpose = REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. | +| `ipCidrRange` | `string` | The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. | | `stackType` | `string` | The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch. | -| `logConfig` | `object` | The available logging options for this subnetwork. | -| `internalIpv6Prefix` | `string` | [Output Only] The internal IPv6 address range that is assigned to this subnetwork. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `externalIpv6Prefix` | `string` | The external IPv6 address range that is owned by this subnetwork. | +| `state` | `string` | [Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY | +| `ipv6CidrRange` | `string` | [Output Only] This field is for internal use. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. | -| `gatewayAddress` | `string` | [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. | -| `ipCidrRange` | `string` | The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. | -| `region` | `string` | URL of the region where the Subnetwork resides. This field can be set only at resource creation time. | +| `purpose` | `string` | The purpose of the resource. This field can be either PRIVATE, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or INTERNAL_HTTPS_LOAD_BALANCER. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. A subnet with purpose set to REGIONAL_MANAGED_PROXY is a user-created subnetwork that is reserved for regional Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a proxy-only subnet that can be used only by regional internal HTTP(S) load balancers. Note that REGIONAL_MANAGED_PROXY is the preferred setting for all regional Envoy load balancers. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY. | +| `privateIpv6GoogleAccess` | `string` | This field is for internal use. This field can be both set at resource creation time and updated using patch. | | `network` | `string` | The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. | -| `ipv6CidrRange` | `string` | [Output Only] This field is for internal use. | -| `state` | `string` | [Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY | -| `externalIpv6Prefix` | `string` | The external IPv6 address range that is owned by this subnetwork. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork. | -| `privateIpGoogleAccess` | `boolean` | Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. | | `secondaryIpRanges` | `array` | An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request. | -| `privateIpv6GoogleAccess` | `string` | This field is for internal use. This field can be both set at resource creation time and updated using patch. | +| `region` | `string` | URL of the region where the Subnetwork resides. This field can be set only at resource creation time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -58,6 +58,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of subnetworks available to the specified project. | | `insert` | `INSERT` | `project, region` | Creates a subnetwork in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, region, subnetwork` | Deletes the specified subnetwork. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of subnetworks available to the specified project. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of subnetworks. | | `expand_ip_cidr_range` | `EXEC` | `project, region, subnetwork` | Expands the IP CIDR range of the subnetwork to a specified value. | | `patch` | `EXEC` | `project, region, subnetwork` | Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched. | diff --git a/docs/google-docs/providers/google/compute/subnetworks_iam_policies/index.md b/docs/google-docs/providers/google/compute/subnetworks_iam_policies/index.md index f0f17c6130..a5614eecdb 100644 --- a/docs/google-docs/providers/google/compute/subnetworks_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/subnetworks_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `rules` | `array` | This is deprecated and has no effect. Do not use. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `rules` | `array` | This is deprecated and has no effect. Do not use. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/subnetworks_usable/index.md b/docs/google-docs/providers/google/compute/subnetworks_usable/index.md index b626d4b956..3093f6d012 100644 --- a/docs/google-docs/providers/google/compute/subnetworks_usable/index.md +++ b/docs/google-docs/providers/google/compute/subnetworks_usable/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `ipCidrRange` | `string` | The range of internal addresses that are owned by this subnetwork. | -| `subnetwork` | `string` | Subnetwork URL. | -| `ipv6AccessType` | `string` | The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. | -| `purpose` | `string` | The purpose of the resource. This field can be either PRIVATE, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or INTERNAL_HTTPS_LOAD_BALANCER. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. A subnet with purpose set to REGIONAL_MANAGED_PROXY is a user-created subnetwork that is reserved for regional Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a proxy-only subnet that can be used only by regional internal HTTP(S) load balancers. Note that REGIONAL_MANAGED_PROXY is the preferred setting for all regional Envoy load balancers. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY. | -| `stackType` | `string` | The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch. | -| `network` | `string` | Network URL. | +| `internalIpv6Prefix` | `string` | [Output Only] The internal IPv6 address range that is assigned to this subnetwork. | | `externalIpv6Prefix` | `string` | [Output Only] The external IPv6 address range that is assigned to this subnetwork. | +| `stackType` | `string` | The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch. | | `role` | `string` | The role of subnetwork. Currently, this field is only used when purpose = REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. | +| `subnetwork` | `string` | Subnetwork URL. | +| `network` | `string` | Network URL. | +| `purpose` | `string` | The purpose of the resource. This field can be either PRIVATE, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or INTERNAL_HTTPS_LOAD_BALANCER. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. A subnet with purpose set to REGIONAL_MANAGED_PROXY is a user-created subnetwork that is reserved for regional Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a proxy-only subnet that can be used only by regional internal HTTP(S) load balancers. Note that REGIONAL_MANAGED_PROXY is the preferred setting for all regional Envoy load balancers. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY. | | `secondaryIpRanges` | `array` | Secondary IP ranges. | -| `internalIpv6Prefix` | `string` | [Output Only] The internal IPv6 address range that is assigned to this subnetwork. | +| `ipv6AccessType` | `string` | The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/target_grpc_proxies/index.md b/docs/google-docs/providers/google/compute/target_grpc_proxies/index.md index b02716e195..3301e36244 100644 --- a/docs/google-docs/providers/google/compute/target_grpc_proxies/index.md +++ b/docs/google-docs/providers/google/compute/target_grpc_proxies/index.md @@ -30,12 +30,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource type. The server generates this identifier. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `validateForProxyless` | `boolean` | If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetGrpcProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetGrpcProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetGrpcProxy. | +| `urlMap` | `string` | URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC. | +| `validateForProxyless` | `boolean` | If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `selfLinkWithId` | `string` | [Output Only] Server-defined URL with id for the resource. | -| `urlMap` | `string` | URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies. | ## Methods | Name | Accessible by | Required Params | Description | @@ -44,4 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Lists the TargetGrpcProxies for a project in the given scope. | | `insert` | `INSERT` | `project` | Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request. | | `delete` | `DELETE` | `project, targetGrpcProxy` | Deletes the specified TargetGrpcProxy in the given scope | +| `_list` | `EXEC` | `project` | Lists the TargetGrpcProxies for a project in the given scope. | | `patch` | `EXEC` | `project, targetGrpcProxy` | Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | diff --git a/docs/google-docs/providers/google/compute/target_http_proxies/index.md b/docs/google-docs/providers/google/compute/target_http_proxies/index.md index 328f600b79..5bf3e4008b 100644 --- a/docs/google-docs/providers/google/compute/target_http_proxies/index.md +++ b/docs/google-docs/providers/google/compute/target_http_proxies/index.md @@ -30,14 +30,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. | +| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `urlMap` | `string` | URL to the UrlMap resource that defines the mapping from URL to the BackendService. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. | | `httpKeepAliveTimeoutSec` | `integer` | Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For Global external HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For Global external HTTP(S) load balancer (classic), this option is not available publicly. | -| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | | `region` | `string` | [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. | -| `urlMap` | `string` | URL to the UrlMap resource that defines the mapping from URL to the BackendService. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -45,5 +45,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of TargetHttpProxy resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a TargetHttpProxy resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, targetHttpProxy` | Deletes the specified TargetHttpProxy resource. | +| `_list` | `EXEC` | `project` | Retrieves the list of TargetHttpProxy resources available to the specified project. | | `patch` | `EXEC` | `project, targetHttpProxy` | Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | | `set_url_map` | `EXEC` | `project, targetHttpProxy` | Changes the URL map for TargetHttpProxy. | diff --git a/docs/google-docs/providers/google/compute/target_https_proxies/index.md b/docs/google-docs/providers/google/compute/target_https_proxies/index.md index fc46acde0d..8613d7f013 100644 --- a/docs/google-docs/providers/google/compute/target_https_proxies/index.md +++ b/docs/google-docs/providers/google/compute/target_https_proxies/index.md @@ -30,20 +30,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `sslPolicy` | `string` | URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. | +| `region` | `string` | [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy. | +| `sslCertificates` | `array` | URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. | +| `certificateMap` | `string` | URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. | | `httpKeepAliveTimeoutSec` | `integer` | Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For Global external HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For Global external HTTP(S) load balancer (classic), this option is not available publicly. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. | | `quicOverride` | `string` | Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. | -| `certificateMap` | `string` | URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. | -| `region` | `string` | [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. | +| `serverTlsPolicy` | `string` | Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted. | +| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | | `authorizationPolicy` | `string` | Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact. | -| `sslCertificates` | `array` | URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. | +| `sslPolicy` | `string` | URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. | | `urlMap` | `string` | A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy. | -| `serverTlsPolicy` | `string` | Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -51,6 +51,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of TargetHttpsProxy resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a TargetHttpsProxy resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, targetHttpsProxy` | Deletes the specified TargetHttpsProxy resource. | +| `_list` | `EXEC` | `project` | Retrieves the list of TargetHttpsProxy resources available to the specified project. | | `patch` | `EXEC` | `project, targetHttpsProxy` | Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | | `set_certificate_map` | `EXEC` | `project, targetHttpsProxy` | Changes the Certificate Map for TargetHttpsProxy. | | `set_quic_override` | `EXEC` | `project, targetHttpsProxy` | Sets the QUIC override policy for TargetHttpsProxy. | diff --git a/docs/google-docs/providers/google/compute/target_instances/index.md b/docs/google-docs/providers/google/compute/target_instances/index.md index f9f7a7979d..252d39d0ed 100644 --- a/docs/google-docs/providers/google/compute/target_instances/index.md +++ b/docs/google-docs/providers/google/compute/target_instances/index.md @@ -30,13 +30,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `kind` | `string` | [Output Only] The type of the resource. Always compute#targetInstance for target instances. | -| `zone` | `string` | [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `instance` | `string` | A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance | | `natPolicy` | `string` | Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance. | | `network` | `string` | The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `instance` | `string` | A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `zone` | `string` | [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,4 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, zone` | Retrieves a list of TargetInstance resources available to the specified project and zone. | | `insert` | `INSERT` | `project, zone` | Creates a TargetInstance resource in the specified project and zone using the data included in the request. | | `delete` | `DELETE` | `project, targetInstance, zone` | Deletes the specified TargetInstance resource. | +| `_list` | `EXEC` | `project, zone` | Retrieves a list of TargetInstance resources available to the specified project and zone. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of target instances. | diff --git a/docs/google-docs/providers/google/compute/target_pools/index.md b/docs/google-docs/providers/google/compute/target_pools/index.md index e6ac3cc1a4..673dbf198d 100644 --- a/docs/google-docs/providers/google/compute/target_pools/index.md +++ b/docs/google-docs/providers/google/compute/target_pools/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `region` | `string` | [Output Only] URL of the region where the target pool resides. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `sessionAffinity` | `string` | Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `healthChecks` | `array` | The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified. | -| `instances` | `array` | A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool. | | `failoverRatio` | `number` | This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. | +| `region` | `string` | [Output Only] URL of the region where the target pool resides. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `backupPool` | `string` | The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#targetPool for target pools. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `sessionAffinity` | `string` | Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy. | +| `instances` | `array` | A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -46,5 +46,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of target pools available to the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a target pool in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, targetPool` | Deletes the specified target pool. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of target pools available to the specified project and region. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of target pools. | | `set_backup` | `EXEC` | `project, region, targetPool` | Changes a backup target pool's configurations. | diff --git a/docs/google-docs/providers/google/compute/target_ssl_proxies/index.md b/docs/google-docs/providers/google/compute/target_ssl_proxies/index.md index bdcfe4dda6..45ac7040e1 100644 --- a/docs/google-docs/providers/google/compute/target_ssl_proxies/index.md +++ b/docs/google-docs/providers/google/compute/target_ssl_proxies/index.md @@ -30,14 +30,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `certificateMap` | `string` | URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. | | `proxyHeader` | `string` | Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. | -| `sslCertificates` | `array` | URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. | -| `sslPolicy` | `string` | URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured. | -| `service` | `string` | URL to the BackendService resource. | +| `certificateMap` | `string` | URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `service` | `string` | URL to the BackendService resource. | +| `sslPolicy` | `string` | URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `sslCertificates` | `array` | URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -45,6 +45,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of TargetSslProxy resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a TargetSslProxy resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, targetSslProxy` | Deletes the specified TargetSslProxy resource. | +| `_list` | `EXEC` | `project` | Retrieves the list of TargetSslProxy resources available to the specified project. | | `set_backend_service` | `EXEC` | `project, targetSslProxy` | Changes the BackendService for TargetSslProxy. | | `set_certificate_map` | `EXEC` | `project, targetSslProxy` | Changes the Certificate Map for TargetSslProxy. | | `set_proxy_header` | `EXEC` | `project, targetSslProxy` | Changes the ProxyHeaderType for TargetSslProxy. | diff --git a/docs/google-docs/providers/google/compute/target_tcp_proxies/index.md b/docs/google-docs/providers/google/compute/target_tcp_proxies/index.md index 4a45d9e707..9f4c93cfda 100644 --- a/docs/google-docs/providers/google/compute/target_tcp_proxies/index.md +++ b/docs/google-docs/providers/google/compute/target_tcp_proxies/index.md @@ -30,13 +30,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. | | `service` | `string` | URL to the BackendService resource. | | `proxyHeader` | `string` | Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `region` | `string` | [Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,5 +44,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of TargetTcpProxy resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a TargetTcpProxy resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, targetTcpProxy` | Deletes the specified TargetTcpProxy resource. | +| `_list` | `EXEC` | `project` | Retrieves the list of TargetTcpProxy resources available to the specified project. | | `set_backend_service` | `EXEC` | `project, targetTcpProxy` | Changes the BackendService for TargetTcpProxy. | | `set_proxy_header` | `EXEC` | `project, targetTcpProxy` | Changes the ProxyHeaderType for TargetTcpProxy. | diff --git a/docs/google-docs/providers/google/compute/target_vpn_gateways/index.md b/docs/google-docs/providers/google/compute/target_vpn_gateways/index.md index 160408a784..8d2d1ebd0f 100644 --- a/docs/google-docs/providers/google/compute/target_vpn_gateways/index.md +++ b/docs/google-docs/providers/google/compute/target_vpn_gateways/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `status` | `string` | [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway. | | `kind` | `string` | [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. | +| `forwardingRules` | `array` | [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `tunnels` | `array` | [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway. | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway. | +| `status` | `string` | [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. | +| `region` | `string` | [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `forwardingRules` | `array` | [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway. | | `network` | `string` | URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. | -| `region` | `string` | [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,5 +47,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of target VPN gateways available to the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a target VPN gateway in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, targetVpnGateway` | Deletes the specified target VPN gateway. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of target VPN gateways available to the specified project and region. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of target VPN gateways. | | `set_labels` | `EXEC` | `project, region, resource` | Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation. | diff --git a/docs/google-docs/providers/google/compute/url_maps/index.md b/docs/google-docs/providers/google/compute/url_maps/index.md index 55c291640d..018c627e90 100644 --- a/docs/google-docs/providers/google/compute/url_maps/index.md +++ b/docs/google-docs/providers/google/compute/url_maps/index.md @@ -30,18 +30,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `defaultUrlRedirect` | `object` | Specifies settings for an HTTP redirect. | -| `defaultService` | `string` | The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `tests` | `array` | The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. | -| `hostRules` | `array` | The list of host rules to use against the URL. | -| `defaultRouteAction` | `object` | | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `pathMatchers` | `array` | The list of named PathMatchers to use against the URL. | -| `region` | `string` | [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `headerAction` | `object` | The request and response header transformations that take effect before the request is passed along to the selected backendService. | +| `defaultService` | `string` | The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `defaultUrlRedirect` | `object` | Specifies settings for an HTTP redirect. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#urlMaps for url maps. | +| `defaultRouteAction` | `object` | | +| `region` | `string` | [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `tests` | `array` | The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. | +| `hostRules` | `array` | The list of host rules to use against the URL. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -49,6 +49,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of UrlMap resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a UrlMap resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, urlMap` | Deletes the specified UrlMap resource. | +| `_list` | `EXEC` | `project` | Retrieves the list of UrlMap resources available to the specified project. | | `invalidate_cache` | `EXEC` | `project, urlMap` | Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content). | | `patch` | `EXEC` | `project, urlMap` | Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `project, urlMap` | Updates the specified UrlMap resource with the data included in the request. | diff --git a/docs/google-docs/providers/google/compute/vpn_gateways/index.md b/docs/google-docs/providers/google/compute/vpn_gateways/index.md index d2b1528daf..5a240b500b 100644 --- a/docs/google-docs/providers/google/compute/vpn_gateways/index.md +++ b/docs/google-docs/providers/google/compute/vpn_gateways/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `stackType` | `string` | The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnGateway. | +| `region` | `string` | [Output Only] URL of the region where the VPN gateway resides. | +| `network` | `string` | URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. | | `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `vpnInterfaces` | `array` | The list of VPN interfaces associated with this VPN gateway. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `kind` | `string` | [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. | -| `region` | `string` | [Output Only] URL of the region where the VPN gateway resides. | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnGateway. | -| `network` | `string` | URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. | -| `stackType` | `string` | The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -46,5 +46,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of VPN gateways available to the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a VPN gateway in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, vpnGateway` | Deletes the specified VPN gateway. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of VPN gateways available to the specified project and region. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of VPN gateways. | | `set_labels` | `EXEC` | `project, region, resource` | Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. | diff --git a/docs/google-docs/providers/google/compute/vpn_tunnels/index.md b/docs/google-docs/providers/google/compute/vpn_tunnels/index.md index c67166f714..df52d310d9 100644 --- a/docs/google-docs/providers/google/compute/vpn_tunnels/index.md +++ b/docs/google-docs/providers/google/compute/vpn_tunnels/index.md @@ -30,27 +30,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `targetVpnGateway` | `string` | URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. | -| `peerExternalGateway` | `string` | URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `sharedSecretHash` | `string` | Hash of the shared secret. | -| `peerGcpGateway` | `string` | URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway. | +| `vpnGateway` | `string` | URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. | +| `region` | `string` | [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `status` | `string` | [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. | | `ikeVersion` | `integer` | IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2. | | `peerIp` | `string` | IP address of the peer VPN gateway. Only IPv4 is supported. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `peerExternalGatewayInterface` | `integer` | The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. | | `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | -| `router` | `string` | URL of the router resource to be used for dynamic routing. | +| `sharedSecret` | `string` | Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. | +| `localTrafficSelector` | `array` | Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. | +| `peerGcpGateway` | `string` | URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway. | | `labelFingerprint` | `string` | A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. | | `vpnGatewayInterface` | `integer` | The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. | -| `vpnGateway` | `string` | URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. | -| `status` | `string` | [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `detailedStatus` | `string` | [Output Only] Detailed status message for the VPN tunnel. | -| `region` | `string` | [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `sharedSecret` | `string` | Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. | +| `router` | `string` | URL of the router resource to be used for dynamic routing. | +| `targetVpnGateway` | `string` | URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. | | `remoteTrafficSelector` | `array` | Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. | -| `peerExternalGatewayInterface` | `integer` | The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. | -| `localTrafficSelector` | `array` | Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `peerExternalGateway` | `string` | URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -58,5 +58,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of VpnTunnel resources contained in the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a VpnTunnel resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, vpnTunnel` | Deletes the specified VpnTunnel resource. | +| `_list` | `EXEC` | `project, region` | Retrieves a list of VpnTunnel resources contained in the specified project and region. | | `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of VPN tunnels. | | `set_labels` | `EXEC` | `project, region, resource` | Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation. | diff --git a/docs/google-docs/providers/google/compute/xpn_host/index.md b/docs/google-docs/providers/google/compute/xpn_host/index.md index aa9599ae4e..ea8ae3c007 100644 --- a/docs/google-docs/providers/google/compute/xpn_host/index.md +++ b/docs/google-docs/providers/google/compute/xpn_host/index.md @@ -30,17 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is *not* the project ID, and is just a unique ID used by Compute Engine to identify resources. | | `name` | `string` | The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. | | `description` | `string` | An optional textual description of the resource. | -| `defaultServiceAccount` | `string` | [Output Only] Default service account used by VMs running in this project. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `xpnProjectStatus` | `string` | [Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated. | -| `quotas` | `array` | [Output Only] Quotas assigned to this project. | -| `commonInstanceMetadata` | `object` | A metadata key/value entry. | | `vmDnsSetting` | `string` | [Output Only] Default internal DNS setting used by VMs running in this project. | -| `enabledFeatures` | `array` | Restricted features enabled for use on this project. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#project for projects. | -| `defaultNetworkTier` | `string` | This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `usageExportLocation` | `object` | The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. | +| `commonInstanceMetadata` | `object` | A metadata key/value entry. | +| `xpnProjectStatus` | `string` | [Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `defaultNetworkTier` | `string` | This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. | +| `enabledFeatures` | `array` | Restricted features enabled for use on this project. | +| `defaultServiceAccount` | `string` | [Output Only] Default service account used by VMs running in this project. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `quotas` | `array` | [Output Only] Quotas assigned to this project. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/xpn_resources/index.md b/docs/google-docs/providers/google/compute/xpn_resources/index.md index 2b322c8be1..721817c446 100644 --- a/docs/google-docs/providers/google/compute/xpn_resources/index.md +++ b/docs/google-docs/providers/google/compute/xpn_resources/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `resources` | `array` | Service resources (a.k.a service projects) attached to this project as their shared VPC host. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects) | -| `nextPageToken` | `string` | [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. | +| `id` | `string` | The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678). | +| `type` | `string` | The type of the service resource. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `get_xpn_resources` | `SELECT` | `project` | +| `_get_xpn_resources` | `EXEC` | `project` | diff --git a/docs/google-docs/providers/google/compute/zone_operations/index.md b/docs/google-docs/providers/google/compute/zone_operations/index.md index c3dbc2912e..4bc968d526 100644 --- a/docs/google-docs/providers/google/compute/zone_operations/index.md +++ b/docs/google-docs/providers/google/compute/zone_operations/index.md @@ -30,32 +30,33 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the operation. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the operation. | | `description` | `string` | [Output Only] A textual description of the operation, which is set when the operation is created. | -| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | -| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | -| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | -| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | -| `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | -| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | -| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | -| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | -| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | -| `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | -| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | -| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | | `targetLink` | `string` | [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. | +| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | +| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | | `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | -| `setCommonInstanceMetadataOperationMetadata` | `object` | | -| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | | `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | +| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | +| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | +| `setCommonInstanceMetadataOperationMetadata` | `object` | | +| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | +| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | +| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | | `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | +| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | | `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | +| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | +| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | | `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | +| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | +| `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | +| `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operation, project, zone` | Retrieves the specified zone-specific Operations resource. | | `list` | `SELECT` | `project, zone` | Retrieves a list of Operation resources contained within the specified zone. | | `delete` | `DELETE` | `operation, project, zone` | Deletes the specified zone-specific Operations resource. | +| `_list` | `EXEC` | `project, zone` | Retrieves a list of Operation resources contained within the specified zone. | | `wait` | `EXEC` | `operation, project, zone` | Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. | diff --git a/docs/google-docs/providers/google/compute/zones/index.md b/docs/google-docs/providers/google/compute/zones/index.md index f4a617c46f..4b6e27330a 100644 --- a/docs/google-docs/providers/google/compute/zones/index.md +++ b/docs/google-docs/providers/google/compute/zones/index.md @@ -30,16 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] Textual description of the resource. | +| `availableCpuPlatforms` | `array` | [Output Only] Available cpu/platform selections for the zone. | +| `supportsPzs` | `boolean` | [Output Only] Reserved for future use. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#zone for zones. | | `deprecated` | `object` | Deprecation status for a public resource. | +| `region` | `string` | [Output Only] Full URL reference to the region which hosts the zone. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `status` | `string` | [Output Only] Status of the zone, either UP or DOWN. | -| `region` | `string` | [Output Only] Full URL reference to the region which hosts the zone. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `availableCpuPlatforms` | `array` | [Output Only] Available cpu/platform selections for the zone. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#zone for zones. | -| `supportsPzs` | `boolean` | [Output Only] Reserved for future use. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `project, zone` | Returns the specified Zone resource. | | `list` | `SELECT` | `project` | Retrieves the list of Zone resources available to the specified project. | +| `_list` | `EXEC` | `project` | Retrieves the list of Zone resources available to the specified project. | diff --git a/docs/google-docs/providers/google/connectors/actions/index.md b/docs/google-docs/providers/google/connectors/actions/index.md index 970b0bda67..69ce0801b3 100644 --- a/docs/google-docs/providers/google/connectors/actions/index.md +++ b/docs/google-docs/providers/google/connectors/actions/index.md @@ -27,11 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Next page token if more actions available. | -| `unsupportedActionNames` | `array` | List of actions which contain unsupported Datatypes. Check datatype.proto for more information. | -| `actions` | `array` | List of action metadata. | +| `name` | `string` | Name of the action. | +| `inputParameters` | `array` | List containing input parameter metadata. | +| `resultMetadata` | `array` | List containing the metadata of result fields. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `list` | `SELECT` | `connectionsId, locationsId, projectsId` | Gets the schema of all the actions supported by the connector. | +| `_list` | `EXEC` | `connectionsId, locationsId, projectsId` | Gets the schema of all the actions supported by the connector. | | `execute` | `EXEC` | `actionsId, connectionsId, locationsId, projectsId` | Executes an action with the name specified in the request. The input parameters for executing the action are passed through the body of the ExecuteAction request. | diff --git a/docs/google-docs/providers/google/connectors/entities/index.md b/docs/google-docs/providers/google/connectors/entities/index.md index 345d809023..d36e4f43bd 100644 --- a/docs/google-docs/providers/google/connectors/entities/index.md +++ b/docs/google-docs/providers/google/connectors/entities/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `entities` | `array` | List containing entity rows. | -| `nextPageToken` | `string` | Next page token if more records are available. | +| `name` | `string` | Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} | +| `fields` | `object` | Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +36,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `connectionsId, entityTypesId, locationsId, projectsId` | Lists entity rows of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors. | | `create` | `INSERT` | `connectionsId, entityTypesId, locationsId, projectsId` | Creates a new entity row of the specified entity type in the external system. The field values for creating the row are contained in the body of the request. The response message contains a `Entity` message object returned as a response by the external system. | | `delete` | `DELETE` | `connectionsId, entitiesId, entityTypesId, locationsId, projectsId` | Deletes an existing entity row matching the entity type and entity id specified in the request. | +| `_list` | `EXEC` | `connectionsId, entityTypesId, locationsId, projectsId` | Lists entity rows of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors. | | `patch` | `EXEC` | `connectionsId, entitiesId, entityTypesId, locationsId, projectsId` | Updates an existing entity row matching the entity type and entity id specified in the request. The fields in the entity row that need to be modified are contained in the body of the request. All unspecified fields are left unchanged. The response message contains a `Entity` message object returned as a response by the external system. | diff --git a/docs/google-docs/providers/google/connectors/entity_types/index.md b/docs/google-docs/providers/google/connectors/entity_types/index.md index 199d7c5c9f..cb02a2f3e5 100644 --- a/docs/google-docs/providers/google/connectors/entity_types/index.md +++ b/docs/google-docs/providers/google/connectors/entity_types/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `types` | `array` | List of metadata related to all entity types. | -| `unsupportedTypeNames` | `array` | List of entity type names which contain unsupported Datatypes. Check datatype.proto for more information. | -| `nextPageToken` | `string` | Next page token if more entity types available. | +| `name` | `string` | The name of the entity type. | +| `fields` | `array` | List containing metadata information about each field of the entity type. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `connectionsId, locationsId, projectsId` | +| `_list` | `EXEC` | `connectionsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/connectors/index.md b/docs/google-docs/providers/google/connectors/index.md index 1a43858fda..fbad1e4e02 100644 --- a/docs/google-docs/providers/google/connectors/index.md +++ b/docs/google-docs/providers/google/connectors/index.md @@ -21,7 +21,7 @@ Enables Users To Create And Manage Connections To Google Cloud Services And Thir
total resources: 5
total selectable resources: 3
-total methods: 11
+total methods: 14
@@ -33,7 +33,7 @@ Enables Users To Create And Manage Connections To Google Cloud Services And Thir TypeService TitleConnectors API DescriptionEnables Users To Create And Manage Connections To Google Cloud Services And Third-Party Business Applications Using The Connectors Interface. -Idconnectors:v23.08.00155 +Idconnectors:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/contactcenteraiplatform/contact_centers/index.md b/docs/google-docs/providers/google/contactcenteraiplatform/contact_centers/index.md index 2a7c973d61..38c2d62adb 100644 --- a/docs/google-docs/providers/google/contactcenteraiplatform/contact_centers/index.md +++ b/docs/google-docs/providers/google/contactcenteraiplatform/contact_centers/index.md @@ -27,9 +27,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `contactCenters` | `array` | The list of ContactCenter | -| `nextPageToken` | `string` | A token identifying a page of results the server should return. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | name of resource | +| `updateTime` | `string` | Output only. [Output only] Update time stamp | +| `userEmail` | `string` | Optional. Email address of the first admin user. | +| `createTime` | `string` | Output only. [Output only] Create time stamp | +| `ccaipManagedUsers` | `boolean` | Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity | +| `labels` | `object` | Labels as key value pairs | +| `state` | `string` | Output only. The state of this contact center. | +| `customerDomainPrefix` | `string` | Required. Immutable. At least 2 and max 16 char long, must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). | +| `displayName` | `string` | Required. A user friendly name for the ContactCenter. | +| `adminUser` | `object` | Message storing info about the first admin user. Next ID: 3 | +| `instanceConfig` | `object` | Message storing the instance configuration. | +| `samlParams` | `object` | Message storing SAML params to enable Google as IDP. | +| `kmsKey` | `string` | Immutable. The KMS key name to encrypt the user input (`ContactCenter`). | +| `uris` | `object` | Message storing the URIs of the ContactCenter. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +48,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists ContactCenters in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new ContactCenter in a given project and location. | | `delete` | `DELETE` | `contactCentersId, locationsId, projectsId` | Deletes a single ContactCenter. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists ContactCenters in a given project and location. | | `patch` | `EXEC` | `contactCentersId, locationsId, projectsId` | Updates the parameters of a single ContactCenter. | diff --git a/docs/google-docs/providers/google/contactcenteraiplatform/index.md b/docs/google-docs/providers/google/contactcenteraiplatform/index.md index eef6827478..852813de0f 100644 --- a/docs/google-docs/providers/google/contactcenteraiplatform/index.md +++ b/docs/google-docs/providers/google/contactcenteraiplatform/index.md @@ -19,9 +19,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
-total resources: 4
-total selectable resources: 4
-total methods: 14
+total resources: 3
+total selectable resources: 3
+total methods: 15
@@ -33,17 +33,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleContact Center AI Platform API Description -Idcontactcenteraiplatform:v23.08.00155 +Idcontactcenteraiplatform:v23.08.00157 ## Resources
-authentication_config
contact_centers
+locations
-locations
operations
diff --git a/docs/google-docs/providers/google/contactcenteraiplatform/locations/index.md b/docs/google-docs/providers/google/contactcenteraiplatform/locations/index.md index 44437f9019..b1e4857ba3 100644 --- a/docs/google-docs/providers/google/contactcenteraiplatform/locations/index.md +++ b/docs/google-docs/providers/google/contactcenteraiplatform/locations/index.md @@ -27,11 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `query_contact_center_quota` | `EXEC` | `locationsId, projectsId` | Queries the contact center quota, an aggregation over all the projects, that belongs to the billing account, which the input project belongs to. | diff --git a/docs/google-docs/providers/google/contactcenteraiplatform/operations/index.md b/docs/google-docs/providers/google/contactcenteraiplatform/operations/index.md index 7746ca104b..5961487ea8 100644 --- a/docs/google-docs/providers/google/contactcenteraiplatform/operations/index.md +++ b/docs/google-docs/providers/google/contactcenteraiplatform/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/contactcenterinsights/analyses/index.md b/docs/google-docs/providers/google/contactcenterinsights/analyses/index.md index 6dc5a1ce8c..80ba960dae 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/analyses/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/analyses/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `analyses` | `array` | The analyses that match the request. | +| `name` | `string` | Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} | +| `analysisResult` | `object` | The result of an analysis. | +| `annotatorSelector` | `object` | Selector of all available annotators and phrase matchers to run. | +| `createTime` | `string` | Output only. The time at which the analysis was created, which occurs when the long-running operation completes. | +| `requestTime` | `string` | Output only. The time at which the analysis was requested. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,3 +39,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `conversationsId, locationsId, projectsId` | Lists analyses. | | `create` | `INSERT` | `conversationsId, locationsId, projectsId` | Creates an analysis. The long running operation is done when the analysis has completed. | | `delete` | `DELETE` | `analysesId, conversationsId, locationsId, projectsId` | Deletes an analysis. | +| `_list` | `EXEC` | `conversationsId, locationsId, projectsId` | Lists analyses. | diff --git a/docs/google-docs/providers/google/contactcenterinsights/conversations/index.md b/docs/google-docs/providers/google/contactcenterinsights/conversations/index.md index 4044fe6c93..724e9d9728 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/conversations/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/conversations/index.md @@ -27,8 +27,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `conversations` | `array` | The conversations that match the request. | -| `nextPageToken` | `string` | A token which can be sent as `page_token` to retrieve the next page. If this field is set, it means there is another page available. If it is not set, it means no other pages are available. | +| `name` | `string` | Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} | +| `medium` | `string` | Immutable. The conversation medium, if unspecified will default to PHONE_CALL. | +| `runtimeAnnotations` | `array` | Output only. The annotations that were generated during the customer and agent interaction. | +| `ttl` | `string` | Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. | +| `transcript` | `object` | A message representing the transcript of a conversation. | +| `dialogflowIntents` | `object` | Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} | +| `dataSource` | `object` | The conversation source, which is a combination of transcript and audio. | +| `agentId` | `string` | An opaque, user-specified string representing the human agent who handled the conversation. | +| `createTime` | `string` | Output only. The time at which the conversation was created. | +| `latestAnalysis` | `object` | The analysis resource. | +| `turnCount` | `integer` | Output only. The number of turns in the conversation. | +| `obfuscatedUserId` | `string` | Obfuscated user ID which the customer sent to us. | +| `latestSummary` | `object` | Conversation summarization suggestion data. | +| `languageCode` | `string` | A user-specified language code for the conversation. | +| `labels` | `object` | A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry. | +| `duration` | `string` | Output only. The duration of the conversation. | +| `callMetadata` | `object` | Call-specific metadata. | +| `updateTime` | `string` | Output only. The most recent time at which the conversation was updated. | +| `expireTime` | `string` | The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. | +| `startTime` | `string` | The time at which the conversation started. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +54,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists conversations. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a conversation. | | `delete` | `DELETE` | `conversationsId, locationsId, projectsId` | Deletes a conversation. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists conversations. | | `bulk_analyze` | `EXEC` | `locationsId, projectsId` | Analyzes multiple conversations in a single request. | | `calculate_stats` | `EXEC` | `locationsId, projectsId` | Gets conversation statistics. | | `ingest` | `EXEC` | `locationsId, projectsId` | Imports conversations and processes them according to the user's configuration. | diff --git a/docs/google-docs/providers/google/contactcenterinsights/index.md b/docs/google-docs/providers/google/contactcenterinsights/index.md index e52cddc50b..b07fedf8b3 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 9
total selectable resources: 7
-total methods: 41
+total methods: 46
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleContact Center AI Insights API Description -Idcontactcenterinsights:v23.08.00155 +Idcontactcenterinsights:v23.08.00157 ## Resources 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 03636f2e38..e57fd4c8b2 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/issue_models/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/issue_models/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model} | | `state` | `string` | Output only. State of the model. | -| `languageCode` | `string` | Language of the model. | -| `modelType` | `string` | Type of the model. | -| `trainingStats` | `object` | Aggregated statistics about an issue model. | | `createTime` | `string` | Output only. The time at which this issue model was created. | -| `issueCount` | `string` | Output only. Number of issues in this issue model. | -| `displayName` | `string` | The representative name for the issue model. | | `updateTime` | `string` | Output only. The most recent time at which the issue model was updated. | +| `displayName` | `string` | The representative name for the issue model. | +| `modelType` | `string` | Type of the model. | +| `languageCode` | `string` | Language of the model. | +| `issueCount` | `string` | Output only. Number of issues in this issue model. | | `inputDataConfig` | `object` | Configs for the input data used to create the issue model. | +| `trainingStats` | `object` | Aggregated statistics about an issue model. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contactcenterinsights/issues/index.md b/docs/google-docs/providers/google/contactcenterinsights/issues/index.md index 1718a82447..2cf39045fd 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/issues/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/issues/index.md @@ -25,6 +25,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} | +| `sampleUtterances` | `array` | Output only. Resource names of the sample representative utterances that match to this issue. | +| `updateTime` | `string` | Output only. The most recent time that this issue was updated. | +| `createTime` | `string` | Output only. The time at which this issue was created. | +| `displayName` | `string` | The representative name for the issue. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contactcenterinsights/operations/index.md b/docs/google-docs/providers/google/contactcenterinsights/operations/index.md index 756ccce66c..503dd3d3f6 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/operations/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/operations/index.md @@ -27,11 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `metadata` | `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. | +| `response` | `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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | 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 88a8e70fc4..4aa317fe00 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/phrase_matchers/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/phrase_matchers/index.md @@ -27,8 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `phraseMatchers` | `array` | The phrase matchers that match the request. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} | +| `active` | `boolean` | Applies the phrase matcher only when it is active. | +| `revisionCreateTime` | `string` | Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added. | +| `updateTime` | `string` | Output only. The most recent time at which the phrase matcher was updated. | +| `versionTag` | `string` | The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`. | +| `activationUpdateTime` | `string` | Output only. The most recent time at which the activation status was updated. | +| `roleMatch` | `string` | The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript. | +| `type` | `string` | Required. The type of this phrase matcher. | +| `displayName` | `string` | The human-readable name of the phrase matcher. | +| `phraseMatchRuleGroups` | `array` | A list of phase match rule groups that are included in this matcher. | +| `revisionId` | `string` | Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567 | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +45,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists phrase matchers. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a phrase matcher. | | `delete` | `DELETE` | `locationsId, phraseMatchersId, projectsId` | Deletes a phrase matcher. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists phrase matchers. | | `patch` | `EXEC` | `locationsId, phraseMatchersId, projectsId` | Updates a phrase matcher. | diff --git a/docs/google-docs/providers/google/contactcenterinsights/views/index.md b/docs/google-docs/providers/google/contactcenterinsights/views/index.md index 5d85199de1..f19fd0fac9 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/views/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/views/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `views` | `array` | The views that match the request. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view} | +| `updateTime` | `string` | Output only. The most recent time at which the view was updated. | +| `value` | `string` | String with specific view properties, must be non-empty. | +| `createTime` | `string` | Output only. The time at which this view was created. | +| `displayName` | `string` | The human-readable display name of the view. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists views. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a view. | | `delete` | `DELETE` | `locationsId, projectsId, viewsId` | Deletes a view. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists views. | | `patch` | `EXEC` | `locationsId, projectsId, viewsId` | Updates a view. | diff --git a/docs/google-docs/providers/google/container/index.md b/docs/google-docs/providers/google/container/index.md index 1a00239237..eaf79c4dea 100644 --- a/docs/google-docs/providers/google/container/index.md +++ b/docs/google-docs/providers/google/container/index.md @@ -21,7 +21,7 @@ Builds And Manages Container-Based Applications, Powered By The Open Source Kube
total resources: 10
total selectable resources: 8
-total methods: 65
+total methods: 66
@@ -33,7 +33,7 @@ Builds And Manages Container-Based Applications, Powered By The Open Source Kube TypeService TitleKubernetes Engine API DescriptionBuilds And Manages Container-Based Applications, Powered By The Open Source Kubernetes Technology. -Idcontainer:v23.08.00155 +Idcontainer:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/container/node_pools/index.md b/docs/google-docs/providers/google/container/node_pools/index.md index 399b4db381..49becf5797 100644 --- a/docs/google-docs/providers/google/container/node_pools/index.md +++ b/docs/google-docs/providers/google/container/node_pools/index.md @@ -28,25 +28,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name of the node pool. | +| `config` | `object` | Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. | +| `podIpv4CidrSize` | `integer` | [Output only] The pod CIDR block size per node in this node pool. | +| `instanceGroupUrls` | `array` | [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. | +| `maxPodsConstraint` | `object` | Constraints applied to pods. | +| `management` | `object` | NodeManagement defines the set of node management services turned on for the node pool. | +| `locations` | `array` | The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. | | `selfLink` | `string` | [Output only] Server-defined URL for the resource. | -| `statusMessage` | `string` | [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. | -| `autoscaling` | `object` | NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. | | `initialNodeCount` | `integer` | The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. | -| `updateInfo` | `object` | UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. | -| `networkConfig` | `object` | Parameters for node pool-level network config. | -| `management` | `object` | NodeManagement defines the set of node management services turned on for the node pool. | | `bestEffortProvisioning` | `object` | Best effort provisioning. | +| `status` | `string` | [Output only] The status of the nodes in this pool instance. | +| `placementPolicy` | `object` | PlacementPolicy defines the placement policy used by the node pool. | | `etag` | `string` | This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. | | `conditions` | `array` | Which conditions caused the current node pool state. | -| `locations` | `array` | The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. | -| `version` | `string` | The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). | -| `podIpv4CidrSize` | `integer` | [Output only] The pod CIDR block size per node in this node pool. | -| `instanceGroupUrls` | `array` | [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. | -| `placementPolicy` | `object` | PlacementPolicy defines the placement policy used by the node pool. | +| `statusMessage` | `string` | [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. | | `upgradeSettings` | `object` | These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. | -| `maxPodsConstraint` | `object` | Constraints applied to pods. | -| `config` | `object` | Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. | -| `status` | `string` | [Output only] The status of the nodes in this pool instance. | +| `version` | `string` | The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). | +| `networkConfig` | `object` | Parameters for node pool-level network config. | +| `updateInfo` | `object` | UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. | +| `autoscaling` | `object` | NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/container/operations/index.md b/docs/google-docs/providers/google/container/operations/index.md index dfd2e8f358..f678a6374a 100644 --- a/docs/google-docs/providers/google/container/operations/index.md +++ b/docs/google-docs/providers/google/container/operations/index.md @@ -28,20 +28,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned ID for the operation. | -| `status` | `string` | The current status of the operation. | -| `operationType` | `string` | The operation type. | -| `progress` | `object` | Information about operation (or operation stage) progress. | -| `clusterConditions` | `array` | Which conditions caused the current cluster state. Deprecated. Use field error instead. | -| `endTime` | `string` | [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | | `error` | `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). | -| `targetLink` | `string` | Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` | | `statusMessage` | `string` | Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. | | `zone` | `string` | The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. | -| `detail` | `string` | Detailed operation progress, if available. | +| `clusterConditions` | `array` | Which conditions caused the current cluster state. Deprecated. Use field error instead. | | `selfLink` | `string` | Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. | +| `location` | `string` | [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. | +| `status` | `string` | The current status of the operation. | +| `detail` | `string` | Detailed operation progress, if available. | +| `targetLink` | `string` | Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` | +| `progress` | `object` | Information about operation (or operation stage) progress. | +| `endTime` | `string` | [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | | `startTime` | `string` | [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | | `nodepoolConditions` | `array` | Which conditions caused the current node pool state. Deprecated. Use field error instead. | -| `location` | `string` | [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. | +| `operationType` | `string` | The operation type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/container/server_config/index.md b/docs/google-docs/providers/google/container/server_config/index.md index 7ba5c4c183..29be125126 100644 --- a/docs/google-docs/providers/google/container/server_config/index.md +++ b/docs/google-docs/providers/google/container/server_config/index.md @@ -27,12 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `defaultClusterVersion` | `string` | Version of Kubernetes the service deploys by default. | -| `defaultImageType` | `string` | Default image type. | | `validImageTypes` | `array` | List of valid image types. | | `validMasterVersions` | `array` | List of valid master versions, in descending order. | | `validNodeVersions` | `array` | List of valid node upgrade target versions, in descending order. | | `channels` | `array` | List of release channel configurations. | +| `defaultClusterVersion` | `string` | Version of Kubernetes the service deploys by default. | +| `defaultImageType` | `string` | Default image type. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/container/usable_subnetworks/index.md b/docs/google-docs/providers/google/container/usable_subnetworks/index.md index fbb1adcccc..fd909a2dfe 100644 --- a/docs/google-docs/providers/google/container/usable_subnetworks/index.md +++ b/docs/google-docs/providers/google/container/usable_subnetworks/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | This token allows you to get the next page of results for list requests. If the number of results is larger than `page_size`, use the `next_page_token` as a value for the query parameter `page_token` in the next request. The value will become empty when there are no more pages. | -| `subnetworks` | `array` | A list of usable subnetworks in the specified network project. | +| `network` | `string` | Network Name. Example: projects/my-project/global/networks/my-network | +| `secondaryIpRanges` | `array` | Secondary IP ranges. | +| `statusMessage` | `string` | A human readable status message representing the reasons for cases where the caller cannot use the secondary ranges under the subnet. For example if the secondary_ip_ranges is empty due to a permission issue, an insufficient permission message will be given by status_message. | +| `subnetwork` | `string` | Subnetwork Name. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet | +| `ipCidrRange` | `string` | The range of internal addresses that are owned by this subnetwork. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_aggregated_usable_subnetworks_list` | `SELECT` | `projectsId` | +| `_projects_aggregated_usable_subnetworks_list` | `EXEC` | `projectsId` | diff --git a/docs/google-docs/providers/google/container/zones_serverconfig/index.md b/docs/google-docs/providers/google/container/zones_serverconfig/index.md index 1e76e5e501..a302e3c1c0 100644 --- a/docs/google-docs/providers/google/container/zones_serverconfig/index.md +++ b/docs/google-docs/providers/google/container/zones_serverconfig/index.md @@ -27,12 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `channels` | `array` | List of release channel configurations. | +| `defaultClusterVersion` | `string` | Version of Kubernetes the service deploys by default. | | `defaultImageType` | `string` | Default image type. | | `validImageTypes` | `array` | List of valid image types. | | `validMasterVersions` | `array` | List of valid master versions, in descending order. | | `validNodeVersions` | `array` | List of valid node upgrade target versions, in descending order. | -| `channels` | `array` | List of release channel configurations. | -| `defaultClusterVersion` | `string` | Version of Kubernetes the service deploys by default. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/containeranalysis/index.md b/docs/google-docs/providers/google/containeranalysis/index.md index 2c085cd63b..55e1fe760b 100644 --- a/docs/google-docs/providers/google/containeranalysis/index.md +++ b/docs/google-docs/providers/google/containeranalysis/index.md @@ -20,8 +20,8 @@ An Implementation Of The Grafeas API, Which Stores, And Enables Querying And Ret
total resources: 6
-total selectable resources: 4
-total methods: 21
+total selectable resources: 6
+total methods: 24
@@ -33,7 +33,7 @@ An Implementation Of The Grafeas API, Which Stores, And Enables Querying And Ret TypeService TitleContainer Analysis API DescriptionAn Implementation Of The Grafeas API, Which Stores, And Enables Querying And Retrieval Of Critical Metadata About All Of Your Software Artifacts. -Idcontaineranalysis:v23.08.00155 +Idcontaineranalysis:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/containeranalysis/notes/index.md b/docs/google-docs/providers/google/containeranalysis/notes/index.md index 0b091ea974..d80dbafaed 100644 --- a/docs/google-docs/providers/google/containeranalysis/notes/index.md +++ b/docs/google-docs/providers/google/containeranalysis/notes/index.md @@ -28,26 +28,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. | -| `createTime` | `string` | Output only. The time this note was created. This field can be used as a filter in list requests. | -| `vulnerabilityAssessment` | `object` | A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. | -| `image` | `object` | Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g., a tag of the resource_url. | -| `deployment` | `object` | An artifact that can be deployed in some runtime. | -| `expirationTime` | `string` | Time of expiration for this note. Empty if note does not expire. | | `package` | `object` | PackageNote represents a particular package version. | -| `upgrade` | `object` | An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. | -| `kind` | `string` | Output only. The type of analysis. This field can be used as a filter in list requests. | -| `attestation` | `object` | Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. | -| `discovery` | `object` | A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. | -| `compliance` | `object` | | -| `shortDescription` | `string` | A one sentence description of this note. | -| `relatedNoteNames` | `array` | Other notes related to this note. | | `relatedUrl` | `array` | URLs associated with this note. | -| `updateTime` | `string` | Output only. The time this note was last updated. This field can be used as a filter in list requests. | +| `attestation` | `object` | Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. | +| `image` | `object` | Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g., a tag of the resource_url. | | `sbomReference` | `object` | The note representing an SBOM reference. | +| `vulnerabilityAssessment` | `object` | A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. | +| `kind` | `string` | Output only. The type of analysis. This field can be used as a filter in list requests. | | `dsseAttestation` | `object` | | +| `createTime` | `string` | Output only. The time this note was created. This field can be used as a filter in list requests. | +| `updateTime` | `string` | Output only. The time this note was last updated. This field can be used as a filter in list requests. | +| `relatedNoteNames` | `array` | Other notes related to this note. | +| `deployment` | `object` | An artifact that can be deployed in some runtime. | +| `discovery` | `object` | A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. | +| `shortDescription` | `string` | A one sentence description of this note. | | `vulnerability` | `object` | A security vulnerability that can be found in resources. | +| `upgrade` | `object` | An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. | | `longDescription` | `string` | A detailed description of this note. | +| `compliance` | `object` | | | `build` | `object` | Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. | +| `expirationTime` | `string` | Time of expiration for this note. Empty if note does not expire. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -55,5 +55,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_notes_list` | `SELECT` | `projectsId` | Lists notes for the specified project. | | `projects_notes_create` | `INSERT` | `projectsId` | Creates a new note. | | `projects_notes_delete` | `DELETE` | `notesId, projectsId` | Deletes the specified note. | +| `_projects_notes_list` | `EXEC` | `projectsId` | Lists notes for the specified project. | | `projects_notes_batch_create` | `EXEC` | `projectsId` | Creates new notes in batch. | | `projects_notes_patch` | `EXEC` | `notesId, projectsId` | Updates the specified note. | diff --git a/docs/google-docs/providers/google/containeranalysis/notes_iam_policies/index.md b/docs/google-docs/providers/google/containeranalysis/notes_iam_policies/index.md index ec76a97e86..c52ebf92a5 100644 --- a/docs/google-docs/providers/google/containeranalysis/notes_iam_policies/index.md +++ b/docs/google-docs/providers/google/containeranalysis/notes_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_notes_get_iam_policy` | `EXEC` | `notesId, projectsId` | Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. | +| `projects_notes_get_iam_policy` | `SELECT` | `notesId, projectsId` | Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. | | `projects_notes_set_iam_policy` | `EXEC` | `notesId, projectsId` | Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. | | `projects_notes_test_iam_permissions` | `EXEC` | `notesId, projectsId` | Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. | diff --git a/docs/google-docs/providers/google/containeranalysis/occurrences/index.md b/docs/google-docs/providers/google/containeranalysis/occurrences/index.md index c142e17258..2ab158bda9 100644 --- a/docs/google-docs/providers/google/containeranalysis/occurrences/index.md +++ b/docs/google-docs/providers/google/containeranalysis/occurrences/index.md @@ -28,24 +28,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. | -| `upgrade` | `object` | An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. | -| `resourceUri` | `string` | Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image. | +| `image` | `object` | Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . | | `remediation` | `string` | A description of actions that can be taken to remedy the note. | -| `attestation` | `object` | Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. | -| `compliance` | `object` | An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. | | `kind` | `string` | Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests. | -| `updateTime` | `string` | Output only. The time this occurrence was last updated. | -| `sbomReference` | `object` | The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. | -| `package` | `object` | Details on how a particular software package was installed on a system. | +| `dsseAttestation` | `object` | Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. | +| `upgrade` | `object` | An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. | | `vulnerability` | `object` | An occurrence of a severity vulnerability on a resource. | | `createTime` | `string` | Output only. The time this occurrence was created. | +| `updateTime` | `string` | Output only. The time this occurrence was last updated. | +| `noteName` | `string` | Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests. | +| `deployment` | `object` | The period during which some deployable was active in a runtime. | | `envelope` | `object` | MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. | +| `resourceUri` | `string` | Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image. | +| `compliance` | `object` | An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. | +| `attestation` | `object` | Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. | | `build` | `object` | Details of a build occurrence. | +| `sbomReference` | `object` | The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. | +| `package` | `object` | Details on how a particular software package was installed on a system. | | `discovery` | `object` | Provides information about the analysis status of a discovered resource. | -| `image` | `object` | Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . | -| `dsseAttestation` | `object` | Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. | -| `noteName` | `string` | Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests. | -| `deployment` | `object` | The period during which some deployable was active in a runtime. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -54,5 +54,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_occurrences_list` | `SELECT` | `projectsId` | Lists occurrences for the specified project. | | `projects_occurrences_create` | `INSERT` | `projectsId` | Creates a new occurrence. | | `projects_occurrences_delete` | `DELETE` | `occurrencesId, projectsId` | Deletes the specified occurrence. For example, use this method to delete an occurrence when the occurrence is no longer applicable for the given resource. | +| `_projects_notes_occurrences_list` | `EXEC` | `notesId, projectsId` | Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note. | +| `_projects_occurrences_list` | `EXEC` | `projectsId` | Lists occurrences for the specified project. | | `projects_occurrences_batch_create` | `EXEC` | `projectsId` | Creates new occurrences in batch. | | `projects_occurrences_patch` | `EXEC` | `occurrencesId, projectsId` | Updates the specified occurrence. | diff --git a/docs/google-docs/providers/google/containeranalysis/occurrences_iam_policies/index.md b/docs/google-docs/providers/google/containeranalysis/occurrences_iam_policies/index.md index 405f6db53d..a0140ec43e 100644 --- a/docs/google-docs/providers/google/containeranalysis/occurrences_iam_policies/index.md +++ b/docs/google-docs/providers/google/containeranalysis/occurrences_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_occurrences_get_iam_policy` | `EXEC` | `occurrencesId, projectsId` | Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. | +| `projects_occurrences_get_iam_policy` | `SELECT` | `occurrencesId, projectsId` | Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. | | `projects_occurrences_set_iam_policy` | `EXEC` | `occurrencesId, projectsId` | Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. | | `projects_occurrences_test_iam_permissions` | `EXEC` | `occurrencesId, projectsId` | Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. | diff --git a/docs/google-docs/providers/google/containeranalysis/occurrences_notes/index.md b/docs/google-docs/providers/google/containeranalysis/occurrences_notes/index.md index ed1a822184..230ec199ff 100644 --- a/docs/google-docs/providers/google/containeranalysis/occurrences_notes/index.md +++ b/docs/google-docs/providers/google/containeranalysis/occurrences_notes/index.md @@ -28,26 +28,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. | -| `relatedNoteNames` | `array` | Other notes related to this note. | -| `updateTime` | `string` | Output only. The time this note was last updated. This field can be used as a filter in list requests. | -| `vulnerability` | `object` | A security vulnerability that can be found in resources. | +| `vulnerabilityAssessment` | `object` | A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. | | `build` | `object` | Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. | -| `longDescription` | `string` | A detailed description of this note. | -| `image` | `object` | Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g., a tag of the resource_url. | -| `kind` | `string` | Output only. The type of analysis. This field can be used as a filter in list requests. | -| `expirationTime` | `string` | Time of expiration for this note. Empty if note does not expire. | -| `upgrade` | `object` | An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. | | `attestation` | `object` | Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. | -| `sbomReference` | `object` | The note representing an SBOM reference. | -| `dsseAttestation` | `object` | | -| `compliance` | `object` | | -| `createTime` | `string` | Output only. The time this note was created. This field can be used as a filter in list requests. | -| `deployment` | `object` | An artifact that can be deployed in some runtime. | | `relatedUrl` | `array` | URLs associated with this note. | -| `vulnerabilityAssessment` | `object` | A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. | | `shortDescription` | `string` | A one sentence description of this note. | +| `updateTime` | `string` | Output only. The time this note was last updated. This field can be used as a filter in list requests. | +| `compliance` | `object` | | +| `image` | `object` | Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g., a tag of the resource_url. | +| `upgrade` | `object` | An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. | | `discovery` | `object` | A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. | +| `expirationTime` | `string` | Time of expiration for this note. Empty if note does not expire. | +| `longDescription` | `string` | A detailed description of this note. | +| `vulnerability` | `object` | A security vulnerability that can be found in resources. | +| `createTime` | `string` | Output only. The time this note was created. This field can be used as a filter in list requests. | +| `deployment` | `object` | An artifact that can be deployed in some runtime. | +| `sbomReference` | `object` | The note representing an SBOM reference. | +| `kind` | `string` | Output only. The type of analysis. This field can be used as a filter in list requests. | +| `relatedNoteNames` | `array` | Other notes related to this note. | | `package` | `object` | PackageNote represents a particular package version. | +| `dsseAttestation` | `object` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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 bc13a1bb50..6e5b8f71a0 100644 --- a/docs/google-docs/providers/google/contentwarehouse/document_schemas/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/document_schemas/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema. | | `description` | `string` | Schema description. | +| `propertyDefinitions` | `array` | Document details. | +| `updateTime` | `string` | Output only. The time when the document schema is last updated. | | `createTime` | `string` | Output only. The time when the document schema is created. | | `displayName` | `string` | Required. Name of the schema given by the user. Must be unique per project. | | `documentIsFolder` | `boolean` | Document Type, true refers the document is a folder, otherwise it is a typical document. | -| `propertyDefinitions` | `array` | Document details. | -| `updateTime` | `string` | Output only. The time when the document schema is last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -41,4 +41,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists document schemas. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a document schema. | | `delete` | `DELETE` | `documentSchemasId, locationsId, projectsId` | Deletes a document schema. Returns NOT_FOUND if the document schema does not exist. Returns BAD_REQUEST if the document schema has documents depending on it. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists document schemas. | | `patch` | `EXEC` | `documentSchemasId, locationsId, projectsId` | Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the EnumTypeOptions.validation_check_disabled flag for ENUM possible values. Updating existing properties will result into INVALID_ARGUMENT. | diff --git a/docs/google-docs/providers/google/contentwarehouse/index.md b/docs/google-docs/providers/google/contentwarehouse/index.md index 3e0dade404..472906f856 100644 --- a/docs/google-docs/providers/google/contentwarehouse/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 12
total selectable resources: 4
-total methods: 35
+total methods: 39
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleDocument AI Warehouse API Description -Idcontentwarehouse:v23.08.00155 +Idcontentwarehouse:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/contentwarehouse/locations/index.md b/docs/google-docs/providers/google/contentwarehouse/locations/index.md index 3630520020..4849bb9305 100644 --- a/docs/google-docs/providers/google/contentwarehouse/locations/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/locations/index.md @@ -27,6 +27,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields `SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `initialize` | `EXEC` | `locationsId, projectsId` | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `initialize` | `EXEC` | `locationsId, projectsId` | Provisions resources for given tenant project. Returns a long running operation. | +| `run_pipeline` | `EXEC` | `locationsId, projectsId` | Run a predefined pipeline. | 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 0a61068891..1b54832179 100644 --- a/docs/google-docs/providers/google/contentwarehouse/rule_sets/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/rule_sets/index.md @@ -29,8 +29,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the rule set. Managed internally. Format: projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. The name is ignored when creating a rule set. | | `description` | `string` | Short description of the rule-set. | -| `rules` | `array` | List of rules given by the customer. | | `source` | `string` | Source of the rules i.e., customer name. | +| `rules` | `array` | List of rules given by the customer. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,4 +38,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists rulesets. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a ruleset. | | `delete` | `DELETE` | `locationsId, projectsId, ruleSetsId` | Deletes a ruleset. Returns NOT_FOUND if the document does not exist. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists rulesets. | | `patch` | `EXEC` | `locationsId, projectsId, ruleSetsId` | Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name. | diff --git a/docs/google-docs/providers/google/contentwarehouse/status/index.md b/docs/google-docs/providers/google/contentwarehouse/status/index.md index a7daa6ce57..f2ec4dd9c9 100644 --- a/docs/google-docs/providers/google/contentwarehouse/status/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/status/index.md @@ -27,12 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `state` | `string` | State of the project. | | `accessControlMode` | `string` | Access control mode. | | `databaseType` | `string` | Database type. | | `documentCreatorDefaultRole` | `string` | The default role for the person who create a document. | | `location` | `string` | The location of the queried project. | | `qaEnabled` | `boolean` | If the qa is enabled on this project. | +| `state` | `string` | State of the project. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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 fbe180cbf1..a8f2c3ba01 100644 --- a/docs/google-docs/providers/google/contentwarehouse/synonym_sets/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/synonym_sets/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}. | -| `context` | `string` | This is a freeform field. Example contexts can be "sales," "engineering," "real estate," "accounting," etc. The context can be supplied during search requests. | | `synonyms` | `array` | List of Synonyms for the context. | +| `context` | `string` | This is a freeform field. Example contexts can be "sales," "engineering," "real estate," "accounting," etc. The context can be supplied during search requests. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +37,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Returns all SynonymSets (for all contexts) for the specified location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS exception if a synonymset already exists for the context. | | `delete` | `DELETE` | `locationsId, projectsId, synonymSetsId` | Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception if the SynonymSet is not found. | +| `_list` | `EXEC` | `locationsId, projectsId` | Returns all SynonymSets (for all contexts) for the specified location. | | `patch` | `EXEC` | `locationsId, projectsId, synonymSetsId` | Remove the existing SynonymSet for the context and replaces it with a new one. Throws a NOT_FOUND exception if the SynonymSet is not found. | diff --git a/docs/google-docs/providers/google/datacatalog/entries/index.md b/docs/google-docs/providers/google/datacatalog/entries/index.md index a61a418a1e..b3e49fc8c0 100644 --- a/docs/google-docs/providers/google/datacatalog/entries/index.md +++ b/docs/google-docs/providers/google/datacatalog/entries/index.md @@ -27,14 +27,40 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `entries` | `array` | Entry details. | -| `nextPageToken` | `string` | Pagination token of the next results page. Empty if there are no more items in results. | +| `name` | `string` | Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. | +| `description` | `string` | Entry description that can consist of several sentences or paragraphs that describe entry contents. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string. | +| `userSpecifiedType` | `string` | Custom entry type that doesn't match any of the values allowed for input and listed in the `EntryType` enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, `my_special_type`. The `user_specified_type` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. | +| `dataSource` | `object` | Physical location of an entry. | +| `businessContext` | `object` | Business Context of the entry. | +| `usageSignal` | `object` | The set of all usage signals that Data Catalog stores. Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day. | +| `bigqueryDateShardedSpec` | `object` | Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). | +| `type` | `string` | The type of the entry. For details, see [`EntryType`](#entrytype). | +| `dataSourceConnectionSpec` | `object` | Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. Only one of internal specs can be set at the time, and cannot be changed later. | +| `fullyQualifiedName` | `string` | [Fully Qualified Name (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries. | +| `personalDetails` | `object` | Entry metadata relevant only to the user and private to them. | +| `databaseTableSpec` | `object` | Specification that applies to a table resource. Valid only for entries with the `TABLE` type. | +| `sqlDatabaseSystemSpec` | `object` | Specification that applies to entries that are part `SQL_DATABASE` system (user_specified_type) | +| `serviceSpec` | `object` | Specification that applies to a Service resource. Valid only for entries with the `SERVICE` type. | +| `sourceSystemTimestamps` | `object` | Timestamps associated with this resource in a particular system. | +| `labels` | `object` | Cloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system. | +| `filesetSpec` | `object` | Specification that applies to a fileset. Valid only for entries with the 'FILESET' type. | +| `lookerSystemSpec` | `object` | Specification that applies to entries that are part `LOOKER` system (user_specified_type) | +| `integratedSystem` | `string` | Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. | +| `userSpecifiedSystem` | `string` | Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The `user_specified_system` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. | +| `gcsFilesetSpec` | `object` | Describes a Cloud Storage fileset entry. | +| `cloudBigtableSystemSpec` | `object` | Specification that applies to all entries that are part of `CLOUD_BIGTABLE` system (user_specified_type) | +| `schema` | `object` | Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema. | +| `routineSpec` | `object` | Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. | +| `bigqueryTableSpec` | `object` | Describes a BigQuery table. | +| `displayName` | `string` | Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string. | +| `linkedResource` | `string` | The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_entry_groups_entries_list` | `SELECT` | `entryGroupsId, locationsId, projectsId` | Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog. | | `projects_locations_entry_groups_entries_create` | `INSERT` | `entryGroupsId, locationsId, projectsId` | Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). An entry group can have a maximum of 100,000 entries. | | `projects_locations_entry_groups_entries_delete` | `DELETE` | `entriesId, entryGroupsId, locationsId, projectsId` | Deletes an existing entry. You can delete only the entries created by the CreateEntry method. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). | +| `_projects_locations_entry_groups_entries_list` | `EXEC` | `entryGroupsId, locationsId, projectsId` | Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog. | | `entries_lookup` | `EXEC` | | Gets an entry by its target resource name. The resource name comes from the source Google Cloud Platform service. | | `projects_locations_entry_groups_entries_get` | `EXEC` | `entriesId, entryGroupsId, locationsId, projectsId` | Gets an entry. | | `projects_locations_entry_groups_entries_import` | `EXEC` | `entryGroupsId, locationsId, projectsId` | Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog. Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog. `ImportEntries` accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of DumpItem type. `ImportEntries` returns a long-running operation resource that can be queried with Operations.GetOperation to return ImportEntriesMetadata and an ImportEntriesResponse message. | diff --git a/docs/google-docs/providers/google/datacatalog/entries_iam_policies/index.md b/docs/google-docs/providers/google/datacatalog/entries_iam_policies/index.md index 0a0a27950a..a7b4510833 100644 --- a/docs/google-docs/providers/google/datacatalog/entries_iam_policies/index.md +++ b/docs/google-docs/providers/google/datacatalog/entries_iam_policies/index.md @@ -25,9 +25,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_locations_entry_groups_entries_get_iam_policy` | `EXEC` | `entriesId, entryGroupsId, locationsId, projectsId` | Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. | +| `projects_locations_entry_groups_entries_get_iam_policy` | `SELECT` | `entriesId, entryGroupsId, locationsId, projectsId` | Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. | | `projects_locations_entry_groups_entries_test_iam_permissions` | `EXEC` | `entriesId, entryGroupsId, locationsId, projectsId` | Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method. | diff --git a/docs/google-docs/providers/google/datacatalog/entry_groups/index.md b/docs/google-docs/providers/google/datacatalog/entry_groups/index.md index 4336ea2bfe..c35f4f623c 100644 --- a/docs/google-docs/providers/google/datacatalog/entry_groups/index.md +++ b/docs/google-docs/providers/google/datacatalog/entry_groups/index.md @@ -29,8 +29,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name. | | `description` | `string` | Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string. | -| `dataCatalogTimestamps` | `object` | Timestamps associated with this resource in a particular system. | | `displayName` | `string` | A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string. | +| `dataCatalogTimestamps` | `object` | Timestamps associated with this resource in a particular system. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,4 +38,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_entry_groups_list` | `SELECT` | `locationsId, projectsId` | Lists entry groups. | | `projects_locations_entry_groups_create` | `INSERT` | `locationsId, projectsId` | Creates an entry group. An entry group contains logically related entries together with [Cloud Identity and Access Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can create, edit, and view entries within entry groups. Data Catalog automatically creates entry groups with names that start with the `@` symbol for the following resources: * BigQuery entries (`@bigquery`) * Pub/Sub topics (`@pubsub`) * Dataproc Metastore services (`@dataproc_metastore_{SERVICE_NAME_HASH}`) You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the `@` symbol, it is reserved for automatically created groups. Entry groups, like entries, can be searched. A maximum of 10,000 entry groups may be created per organization across all locations. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). | | `projects_locations_entry_groups_delete` | `DELETE` | `entryGroupsId, locationsId, projectsId` | Deletes an entry group. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). | +| `_projects_locations_entry_groups_list` | `EXEC` | `locationsId, projectsId` | Lists entry groups. | | `projects_locations_entry_groups_patch` | `EXEC` | `entryGroupsId, locationsId, projectsId` | Updates an entry group. You must enable the Data Catalog API in the project identified by the `entry_group.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). | diff --git a/docs/google-docs/providers/google/datacatalog/entry_groups_iam_policies/index.md b/docs/google-docs/providers/google/datacatalog/entry_groups_iam_policies/index.md index f74d9515e9..044f13f380 100644 --- a/docs/google-docs/providers/google/datacatalog/entry_groups_iam_policies/index.md +++ b/docs/google-docs/providers/google/datacatalog/entry_groups_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_locations_entry_groups_get_iam_policy` | `EXEC` | `entryGroupsId, locationsId, projectsId` | Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. | +| `projects_locations_entry_groups_get_iam_policy` | `SELECT` | `entryGroupsId, locationsId, projectsId` | Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. | | `projects_locations_entry_groups_set_iam_policy` | `EXEC` | `entryGroupsId, locationsId, projectsId` | Sets an access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates - Entry groups Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups. | | `projects_locations_entry_groups_test_iam_permissions` | `EXEC` | `entryGroupsId, locationsId, projectsId` | Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method. | diff --git a/docs/google-docs/providers/google/datacatalog/index.md b/docs/google-docs/providers/google/datacatalog/index.md index c7e78e728c..166035af64 100644 --- a/docs/google-docs/providers/google/datacatalog/index.md +++ b/docs/google-docs/providers/google/datacatalog/index.md @@ -20,8 +20,8 @@ A Fully Managed And Highly Scalable Data Discovery And Metadata Management Servi
total resources: 15
-total selectable resources: 6
-total methods: 66
+total selectable resources: 11
+total methods: 73
@@ -33,7 +33,7 @@ A Fully Managed And Highly Scalable Data Discovery And Metadata Management Servi TypeService TitleGoogle Cloud Data Catalog API DescriptionA Fully Managed And Highly Scalable Data Discovery And Metadata Management Service. -Iddatacatalog:v23.08.00155 +Iddatacatalog:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/datacatalog/operations/index.md b/docs/google-docs/providers/google/datacatalog/operations/index.md index a856377729..027a8e210a 100644 --- a/docs/google-docs/providers/google/datacatalog/operations/index.md +++ b/docs/google-docs/providers/google/datacatalog/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | | `projects_locations_operations_get` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/datacatalog/policy_tags/index.md b/docs/google-docs/providers/google/datacatalog/policy_tags/index.md index 2b991a757b..99b161c186 100644 --- a/docs/google-docs/providers/google/datacatalog/policy_tags/index.md +++ b/docs/google-docs/providers/google/datacatalog/policy_tags/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Pagination token of the next results page. Empty if there are no more results in the list. | -| `policyTags` | `array` | The policy tags that belong to the taxonomy. | +| `name` | `string` | Output only. Resource name of this policy tag in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs. | +| `description` | `string` | Description of this policy tag. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns and page breaks, and be at most 2000 bytes long when encoded in UTF-8. | +| `parentPolicyTag` | `string` | Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string. For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty. | +| `childPolicyTags` | `array` | Output only. Resource names of child policy tags of this policy tag. | +| `displayName` | `string` | Required. User-defined name of this policy tag. The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_taxonomies_policy_tags_list` | `SELECT` | `locationsId, projectsId, taxonomiesId` | Lists all policy tags in a taxonomy. | | `projects_locations_taxonomies_policy_tags_create` | `INSERT` | `locationsId, projectsId, taxonomiesId` | Creates a policy tag in a taxonomy. | | `projects_locations_taxonomies_policy_tags_delete` | `DELETE` | `locationsId, policyTagsId, projectsId, taxonomiesId` | Deletes a policy tag together with the following: * All of its descendant policy tags, if any * Policies associated with the policy tag and its descendants * References from BigQuery table schema of the policy tag and its descendants | +| `_projects_locations_taxonomies_policy_tags_list` | `EXEC` | `locationsId, projectsId, taxonomiesId` | Lists all policy tags in a taxonomy. | | `projects_locations_taxonomies_policy_tags_patch` | `EXEC` | `locationsId, policyTagsId, projectsId, taxonomiesId` | Updates a policy tag, including its display name, description, and parent policy tag. | diff --git a/docs/google-docs/providers/google/datacatalog/policy_tags_iam_policies/index.md b/docs/google-docs/providers/google/datacatalog/policy_tags_iam_policies/index.md index 286a3781ee..39ee629068 100644 --- a/docs/google-docs/providers/google/datacatalog/policy_tags_iam_policies/index.md +++ b/docs/google-docs/providers/google/datacatalog/policy_tags_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_locations_taxonomies_policy_tags_get_iam_policy` | `EXEC` | `locationsId, policyTagsId, projectsId, taxonomiesId` | Gets the IAM policy for a policy tag or a taxonomy. | +| `projects_locations_taxonomies_policy_tags_get_iam_policy` | `SELECT` | `locationsId, policyTagsId, projectsId, taxonomiesId` | Gets the IAM policy for a policy tag or a taxonomy. | | `projects_locations_taxonomies_policy_tags_set_iam_policy` | `EXEC` | `locationsId, policyTagsId, projectsId, taxonomiesId` | Sets the IAM policy for a policy tag or a taxonomy. | | `projects_locations_taxonomies_policy_tags_test_iam_permissions` | `EXEC` | `locationsId, policyTagsId, projectsId, taxonomiesId` | Returns your permissions on a specified policy tag or taxonomy. | diff --git a/docs/google-docs/providers/google/datacatalog/tag_templates_iam_policies/index.md b/docs/google-docs/providers/google/datacatalog/tag_templates_iam_policies/index.md index 41663da606..1b12c765c6 100644 --- a/docs/google-docs/providers/google/datacatalog/tag_templates_iam_policies/index.md +++ b/docs/google-docs/providers/google/datacatalog/tag_templates_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_locations_tag_templates_get_iam_policy` | `EXEC` | `locationsId, projectsId, tagTemplatesId` | Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. | +| `projects_locations_tag_templates_get_iam_policy` | `SELECT` | `locationsId, projectsId, tagTemplatesId` | Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. | | `projects_locations_tag_templates_set_iam_policy` | `EXEC` | `locationsId, projectsId, tagTemplatesId` | Sets an access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates - Entry groups Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups. | | `projects_locations_tag_templates_test_iam_permissions` | `EXEC` | `locationsId, projectsId, tagTemplatesId` | Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method. | diff --git a/docs/google-docs/providers/google/datacatalog/tags/index.md b/docs/google-docs/providers/google/datacatalog/tags/index.md index 40ce6252be..1449151e5e 100644 --- a/docs/google-docs/providers/google/datacatalog/tags/index.md +++ b/docs/google-docs/providers/google/datacatalog/tags/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Pagination token of the next results page. Empty if there are no more items in results. | -| `tags` | `array` | Tag details. | +| `name` | `string` | The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name. | +| `template` | `string` | Required. The resource name of the tag template this tag uses. Example: `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}` This field cannot be modified after creation. | +| `templateDisplayName` | `string` | Output only. The display name of the tag template. | +| `column` | `string` | Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`. | +| `fields` | `object` | Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,6 +41,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_entry_groups_tags_create` | `INSERT` | `entryGroupsId, locationsId, projectsId` | Creates a tag and assigns it to: * An Entry if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or EntryGroupif the method name is `projects.locations.entryGroups.tags.create`. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization. | | `projects_locations_entry_groups_entries_tags_delete` | `DELETE` | `entriesId, entryGroupsId, locationsId, projectsId, tagsId` | Deletes a tag. | | `projects_locations_entry_groups_tags_delete` | `DELETE` | `entryGroupsId, locationsId, projectsId, tagsId` | Deletes a tag. | +| `_projects_locations_entry_groups_entries_tags_list` | `EXEC` | `entriesId, entryGroupsId, locationsId, projectsId` | Lists tags assigned to an Entry. The columns in the response are lowercased. | +| `_projects_locations_entry_groups_tags_list` | `EXEC` | `entryGroupsId, locationsId, projectsId` | Lists tags assigned to an Entry. The columns in the response are lowercased. | | `projects_locations_entry_groups_entries_tags_patch` | `EXEC` | `entriesId, entryGroupsId, locationsId, projectsId, tagsId` | Updates an existing tag. | | `projects_locations_entry_groups_entries_tags_reconcile` | `EXEC` | `entriesId, entryGroupsId, locationsId, projectsId` | `ReconcileTags` creates or updates a list of tags on the entry. If the ReconcileTagsRequest.force_delete_missing parameter is set, the operation deletes tags not included in the input tag list. `ReconcileTags` returns a long-running operation resource that can be queried with Operations.GetOperation to return ReconcileTagsMetadata and a ReconcileTagsResponse message. | | `projects_locations_entry_groups_tags_patch` | `EXEC` | `entryGroupsId, locationsId, projectsId, tagsId` | Updates an existing tag. | diff --git a/docs/google-docs/providers/google/datacatalog/taxonomies/index.md b/docs/google-docs/providers/google/datacatalog/taxonomies/index.md index 1b70eed3d4..04330d01ed 100644 --- a/docs/google-docs/providers/google/datacatalog/taxonomies/index.md +++ b/docs/google-docs/providers/google/datacatalog/taxonomies/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs. | | `description` | `string` | Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8. | -| `policyTagCount` | `integer` | Output only. Number of policy tags in this taxonomy. | -| `service` | `object` | The source system of the Taxonomy. | | `taxonomyTimestamps` | `object` | Timestamps associated with this resource in a particular system. | | `activatedPolicyTypes` | `array` | Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. | | `displayName` | `string` | Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization. | +| `policyTagCount` | `integer` | Output only. Number of policy tags in this taxonomy. | +| `service` | `object` | The source system of the Taxonomy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -41,6 +41,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_taxonomies_list` | `SELECT` | `locationsId, projectsId` | Lists all taxonomies in a project in a particular location that you have a permission to view. | | `projects_locations_taxonomies_create` | `INSERT` | `locationsId, projectsId` | Creates a taxonomy in a specified project. The taxonomy is initially empty, that is, it doesn't contain policy tags. | | `projects_locations_taxonomies_delete` | `DELETE` | `locationsId, projectsId, taxonomiesId` | Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns. | +| `_projects_locations_taxonomies_list` | `EXEC` | `locationsId, projectsId` | Lists all taxonomies in a project in a particular location that you have a permission to view. | | `projects_locations_taxonomies_export` | `EXEC` | `locationsId, projectsId` | Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project. This method generates `SerializedTaxonomy` protocol buffers with nested policy tags that can be used as input for `ImportTaxonomies` calls. | | `projects_locations_taxonomies_import` | `EXEC` | `locationsId, projectsId` | Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources. For a cross-regional source, new taxonomies are created by copying from a source in another region. For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures. | | `projects_locations_taxonomies_patch` | `EXEC` | `locationsId, projectsId, taxonomiesId` | Updates a taxonomy, including its display name, description, and activated policy types. | diff --git a/docs/google-docs/providers/google/datacatalog/taxonomies_iam_policies/index.md b/docs/google-docs/providers/google/datacatalog/taxonomies_iam_policies/index.md index 9a6416e4c1..6a4205d7ff 100644 --- a/docs/google-docs/providers/google/datacatalog/taxonomies_iam_policies/index.md +++ b/docs/google-docs/providers/google/datacatalog/taxonomies_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_locations_taxonomies_get_iam_policy` | `EXEC` | `locationsId, projectsId, taxonomiesId` | Gets the IAM policy for a policy tag or a taxonomy. | +| `projects_locations_taxonomies_get_iam_policy` | `SELECT` | `locationsId, projectsId, taxonomiesId` | Gets the IAM policy for a policy tag or a taxonomy. | | `projects_locations_taxonomies_set_iam_policy` | `EXEC` | `locationsId, projectsId, taxonomiesId` | Sets the IAM policy for a policy tag or a taxonomy. | | `projects_locations_taxonomies_test_iam_permissions` | `EXEC` | `locationsId, projectsId, taxonomiesId` | Returns your permissions on a specified policy tag or taxonomy. | diff --git a/docs/google-docs/providers/google/dataflow/index.md b/docs/google-docs/providers/google/dataflow/index.md index 76c1c838f8..d3ef6a1016 100644 --- a/docs/google-docs/providers/google/dataflow/index.md +++ b/docs/google-docs/providers/google/dataflow/index.md @@ -21,7 +21,7 @@ Manages Google Cloud Dataflow Projects On Google Cloud Platform.
total resources: 13
total selectable resources: 7
-total methods: 41
+total methods: 47
@@ -33,7 +33,7 @@ Manages Google Cloud Dataflow Projects On Google Cloud Platform. TypeService TitleDataflow API DescriptionManages Google Cloud Dataflow Projects On Google Cloud Platform. -Iddataflow:v23.08.00155 +Iddataflow:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/dataflow/jobs/index.md b/docs/google-docs/providers/google/dataflow/jobs/index.md index 140853b406..78b967006f 100644 --- a/docs/google-docs/providers/google/dataflow/jobs/index.md +++ b/docs/google-docs/providers/google/dataflow/jobs/index.md @@ -27,9 +27,32 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `jobs` | `array` | A subset of the requested job information. | -| `nextPageToken` | `string` | Set if there may be more results than fit in this response. | -| `failedLocation` | `array` | Zero or more messages describing the [regional endpoints] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond. | +| `id` | `string` | The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job. | +| `name` | `string` | The user-specified Cloud Dataflow job name. Only one Job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?` | +| `currentStateTime` | `string` | The timestamp associated with the current state. | +| `createdFromSnapshotId` | `string` | If this is specified, the job's initial state is populated from the given snapshot. | +| `steps` | `array` | Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL. | +| `type` | `string` | The type of Cloud Dataflow job. | +| `stepsLocation` | `string` | The Cloud Storage location where the steps are stored. | +| `runtimeUpdatableParams` | `object` | Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. | +| `jobMetadata` | `object` | Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. | +| `transformNameMapping` | `object` | The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. | +| `tempFiles` | `array` | A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} | +| `requestedState` | `string` | The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state. | +| `stageStates` | `array` | This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. | +| `startTime` | `string` | The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service. | +| `satisfiesPzs` | `boolean` | Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. | +| `labels` | `object` | User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. | +| `createTime` | `string` | The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. | +| `currentState` | `string` | The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. | +| `replacedByJobId` | `string` | If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. | +| `replaceJobId` | `string` | If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. | +| `location` | `string` | The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. | +| `executionInfo` | `object` | Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. | +| `environment` | `object` | Describes the environment in which a Dataflow Job runs. | +| `clientRequestId` | `string` | The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it. | +| `pipelineDescription` | `object` | A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. | +| `projectId` | `string` | The ID of the Cloud Platform project that the job belongs to. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +60,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_jobs_list` | `SELECT` | `location, projectId` | List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, because you can only get the list of jobs that are running in `us-central1`. `projects.locations.jobs.list` and `projects.jobs.list` support filtering the list of jobs by name. Filtering by name isn't supported by `projects.jobs.aggregated`. | | `projects_jobs_create` | `INSERT` | `projectId` | Creates a Cloud Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always start in `us-central1`. Do not enter confidential information when you supply string values using the API. | | `projects_locations_jobs_create` | `INSERT` | `location, projectId` | Creates a Cloud Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always start in `us-central1`. Do not enter confidential information when you supply string values using the API. | +| `_projects_jobs_list` | `EXEC` | `projectId` | List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, because you can only get the list of jobs that are running in `us-central1`. `projects.locations.jobs.list` and `projects.jobs.list` support filtering the list of jobs by name. Filtering by name isn't supported by `projects.jobs.aggregated`. | +| `_projects_locations_jobs_list` | `EXEC` | `location, projectId` | List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, because you can only get the list of jobs that are running in `us-central1`. `projects.locations.jobs.list` and `projects.jobs.list` support filtering the list of jobs by name. Filtering by name isn't supported by `projects.jobs.aggregated`. | | `projects_jobs_aggregated` | `EXEC` | `projectId` | List the jobs of a project across all regions. **Note:** This method doesn't support filtering the list of jobs by name. | | `projects_jobs_get` | `EXEC` | `jobId, projectId` | Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.get` is not recommended, as you can only get the state of jobs that are running in `us-central1`. | | `projects_jobs_snapshot` | `EXEC` | `jobId, projectId` | Snapshot the state of a streaming job. | diff --git a/docs/google-docs/providers/google/dataflow/jobs_execution_details/index.md b/docs/google-docs/providers/google/dataflow/jobs_execution_details/index.md index 5b7a53e2f4..a0ee3d50f4 100644 --- a/docs/google-docs/providers/google/dataflow/jobs_execution_details/index.md +++ b/docs/google-docs/providers/google/dataflow/jobs_execution_details/index.md @@ -27,9 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `stages` | `array` | The stages of the job execution. | -| `nextPageToken` | `string` | If present, this response does not contain all requested tasks. To obtain the next page of results, repeat the request with page_token set to this value. | +| `startTime` | `string` | Start time of this stage. | +| `state` | `string` | State of this stage. | +| `stragglerSummary` | `object` | Summarized straggler identification details. | +| `endTime` | `string` | End time of this stage. If the work item is completed, this is the actual end time of the stage. Otherwise, it is the predicted end time. | +| `metrics` | `array` | Metrics for this stage. | +| `progress` | `object` | Information about the progress of some component of job execution. | +| `stageId` | `string` | ID of this stage | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_locations_jobs_get_execution_details` | `SELECT` | `jobId, location, projectId` | +| `_projects_locations_jobs_get_execution_details` | `EXEC` | `jobId, location, projectId` | diff --git a/docs/google-docs/providers/google/dataflow/messages/index.md b/docs/google-docs/providers/google/dataflow/messages/index.md index 15472ff806..0649f5855b 100644 --- a/docs/google-docs/providers/google/dataflow/messages/index.md +++ b/docs/google-docs/providers/google/dataflow/messages/index.md @@ -27,11 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The token to obtain the next page of results if there are more. | -| `autoscalingEvents` | `array` | Autoscaling events in ascending timestamp order. | -| `jobMessages` | `array` | Messages in ascending timestamp order. | +| `id` | `string` | Deprecated. | +| `messageText` | `string` | The text of the message. | +| `time` | `string` | The timestamp of the message. | +| `messageImportance` | `string` | Importance level of the message. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_jobs_messages_list` | `SELECT` | `jobId, projectId` | | `projects_locations_jobs_messages_list` | `SELECT` | `jobId, location, projectId` | +| `_projects_jobs_messages_list` | `EXEC` | `jobId, projectId` | +| `_projects_locations_jobs_messages_list` | `EXEC` | `jobId, location, projectId` | diff --git a/docs/google-docs/providers/google/dataflow/stages_execution_details/index.md b/docs/google-docs/providers/google/dataflow/stages_execution_details/index.md index b001895e99..ecd01c7f3c 100644 --- a/docs/google-docs/providers/google/dataflow/stages_execution_details/index.md +++ b/docs/google-docs/providers/google/dataflow/stages_execution_details/index.md @@ -27,9 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If present, this response does not contain all requested tasks. To obtain the next page of results, repeat the request with page_token set to this value. | -| `workers` | `array` | Workers that have done work on the stage. | +| `workItems` | `array` | Work items processed by this worker, sorted by time. | +| `workerName` | `string` | Name of this worker | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_locations_jobs_stages_get_execution_details` | `SELECT` | `jobId, location, projectId, stageId` | +| `_projects_locations_jobs_stages_get_execution_details` | `EXEC` | `jobId, location, projectId, stageId` | diff --git a/docs/google-docs/providers/google/dataflow/templates/index.md b/docs/google-docs/providers/google/dataflow/templates/index.md index ec17dd2d8b..a0b616abae 100644 --- a/docs/google-docs/providers/google/dataflow/templates/index.md +++ b/docs/google-docs/providers/google/dataflow/templates/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `templateType` | `string` | Template Type. | | `metadata` | `object` | Metadata describing a template. | | `runtimeMetadata` | `object` | RuntimeMetadata describing a runtime environment. | | `status` | `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). | +| `templateType` | `string` | Template Type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataform/compilation_results/index.md b/docs/google-docs/providers/google/dataform/compilation_results/index.md index 20cc439b5e..813ee58a7f 100644 --- a/docs/google-docs/providers/google/dataform/compilation_results/index.md +++ b/docs/google-docs/providers/google/dataform/compilation_results/index.md @@ -28,17 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The compilation result's name. | -| `releaseConfig` | `string` | Immutable. The name of the release config to compile. The release config's 'current_compilation_result' field will be updated to this compilation result. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`. | | `resolvedGitCommitSha` | `string` | Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace. | | `workspace` | `string` | Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`. | | `codeCompilationConfig` | `object` | Configures various aspects of Dataform code compilation. | | `compilationErrors` | `array` | Output only. Errors encountered during project compilation. | | `dataformCoreVersion` | `string` | Output only. The version of `@dataform/core` that was used for compilation. | | `gitCommitish` | `string` | Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` | +| `releaseConfig` | `string` | Immutable. The name of the release config to compile. The release config's 'current_compilation_result' field will be updated to this compilation result. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `compilationResultsId, locationsId, projectsId, repositoriesId` | Fetches a single CompilationResult. | | `list` | `SELECT` | `locationsId, projectsId, repositoriesId` | Lists CompilationResults in a given Repository. | | `create` | `INSERT` | `locationsId, projectsId, repositoriesId` | Creates a new CompilationResult in a given project and location. | +| `_list` | `EXEC` | `locationsId, projectsId, repositoriesId` | Lists CompilationResults in a given Repository. | | `query` | `EXEC` | `compilationResultsId, locationsId, projectsId, repositoriesId` | Returns CompilationResultActions in a given CompilationResult. | diff --git a/docs/google-docs/providers/google/dataform/index.md b/docs/google-docs/providers/google/dataform/index.md index 43277a6da3..84105e5a8a 100644 --- a/docs/google-docs/providers/google/dataform/index.md +++ b/docs/google-docs/providers/google/dataform/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 16
total selectable resources: 9
-total methods: 59
+total methods: 66
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleDataform API Description -Iddataform:v23.08.00155 +Iddataform:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/dataform/locations/index.md b/docs/google-docs/providers/google/dataform/locations/index.md index 83cb7b8072..a33842323a 100644 --- a/docs/google-docs/providers/google/dataform/locations/index.md +++ b/docs/google-docs/providers/google/dataform/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `locations` | `array` | A list of locations that matches the specified filter in the request. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/dataform/release_configs/index.md b/docs/google-docs/providers/google/dataform/release_configs/index.md index b092322261..46f66332ac 100644 --- a/docs/google-docs/providers/google/dataform/release_configs/index.md +++ b/docs/google-docs/providers/google/dataform/release_configs/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The release config's name. | -| `gitCommitish` | `string` | Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` | | `recentScheduledReleaseRecords` | `array` | Output only. Records of the 10 most recent scheduled release attempts, ordered in in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. | | `releaseCompilationResult` | `string` | Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is created from this release config, or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. | | `timeZone` | `string` | Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC. | | `codeCompilationConfig` | `object` | Configures various aspects of Dataform code compilation. | | `cronSchedule` | `string` | Optional. Optional schedule (in cron format) for automatic creation of compilation results. | +| `gitCommitish` | `string` | Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -41,4 +41,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId, repositoriesId` | Lists ReleaseConfigs in a given Repository. | | `create` | `INSERT` | `locationsId, projectsId, repositoriesId` | Creates a new ReleaseConfig in a given Repository. | | `delete` | `DELETE` | `locationsId, projectsId, releaseConfigsId, repositoriesId` | Deletes a single ReleaseConfig. | +| `_list` | `EXEC` | `locationsId, projectsId, repositoriesId` | Lists ReleaseConfigs in a given Repository. | | `patch` | `EXEC` | `locationsId, projectsId, releaseConfigsId, repositoriesId` | Updates a single ReleaseConfig. | diff --git a/docs/google-docs/providers/google/dataform/repositories/index.md b/docs/google-docs/providers/google/dataform/repositories/index.md index a5d6c64dd1..6ce45bbfc6 100644 --- a/docs/google-docs/providers/google/dataform/repositories/index.md +++ b/docs/google-docs/providers/google/dataform/repositories/index.md @@ -27,9 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `repositories` | `array` | List of repositories. | -| `unreachable` | `array` | Locations which could not be reached. | +| `name` | `string` | Output only. The repository's name. | +| `labels` | `object` | Optional. Repository user labels. | +| `npmrcEnvironmentVariablesSecretVersion` | `string` | Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format. | +| `serviceAccount` | `string` | Optional. The service account to run workflow invocations under. | +| `setAuthenticatedUserAdmin` | `boolean` | Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository. To modify access to the created repository later apply setIamPolicy from https://cloud.google.com/dataform/reference/rest#rest-resource:-v1beta1.projects.locations.repositories | +| `workspaceCompilationOverrides` | `object` | Configures workspace compilation overrides for a repository. Primarily used by the UI (`console.cloud.google.com`). `schema_suffix` and `table_prefix` can have a special expression - `${workspaceName}`, which refers to the workspace name from which the compilation results will be created. API callers are expected to resolve the expression in these overrides and provide them explicitly in `code_compilation_config` (https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig) when creating workspace-scoped compilation results. | +| `displayName` | `string` | Optional. The repository's user-friendly name. | +| `gitRemoteSettings` | `object` | Controls Git remote configuration for a repository. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +42,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists Repositories in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new Repository in a given project and location. | | `delete` | `DELETE` | `locationsId, projectsId, repositoriesId` | Deletes a single Repository. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Repositories in a given project and location. | | `commit` | `EXEC` | `locationsId, projectsId, repositoriesId` | Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`. | | `compute_access_token_status` | `EXEC` | `locationsId, projectsId, repositoriesId` | Computes a Repository's Git access token status. | | `patch` | `EXEC` | `locationsId, projectsId, repositoriesId` | Updates a single Repository. | diff --git a/docs/google-docs/providers/google/dataform/workflow_configs/index.md b/docs/google-docs/providers/google/dataform/workflow_configs/index.md index ac29138319..3ed325052a 100644 --- a/docs/google-docs/providers/google/dataform/workflow_configs/index.md +++ b/docs/google-docs/providers/google/dataform/workflow_configs/index.md @@ -27,9 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `unreachable` | `array` | Locations which could not be reached. | -| `workflowConfigs` | `array` | List of workflow configs. | +| `name` | `string` | Output only. The workflow config's name. | +| `recentScheduledExecutionRecords` | `array` | Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. | +| `releaseConfig` | `string` | Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`. | +| `timeZone` | `string` | Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC. | +| `cronSchedule` | `string` | Optional. Optional schedule (in cron format) for automatic execution of this workflow config. | +| `invocationConfig` | `object` | Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +40,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId, repositoriesId` | Lists WorkflowConfigs in a given Repository. | | `create` | `INSERT` | `locationsId, projectsId, repositoriesId` | Creates a new WorkflowConfig in a given Repository. | | `delete` | `DELETE` | `locationsId, projectsId, repositoriesId, workflowConfigsId` | Deletes a single WorkflowConfig. | +| `_list` | `EXEC` | `locationsId, projectsId, repositoriesId` | Lists WorkflowConfigs in a given Repository. | | `patch` | `EXEC` | `locationsId, projectsId, repositoriesId, workflowConfigsId` | Updates a single WorkflowConfig. | diff --git a/docs/google-docs/providers/google/dataform/workflow_invocations/index.md b/docs/google-docs/providers/google/dataform/workflow_invocations/index.md index 2c2b188921..2331a8f73c 100644 --- a/docs/google-docs/providers/google/dataform/workflow_invocations/index.md +++ b/docs/google-docs/providers/google/dataform/workflow_invocations/index.md @@ -27,9 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `unreachable` | `array` | Locations which could not be reached. | -| `workflowInvocations` | `array` | List of workflow invocations. | +| `name` | `string` | Output only. The workflow invocation's name. | +| `state` | `string` | Output only. This workflow invocation's current state. | +| `workflowConfig` | `string` | Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`. | +| `compilationResult` | `string` | Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. | +| `invocationConfig` | `object` | Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. | +| `invocationTiming` | `object` | Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,5 +40,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId, repositoriesId` | Lists WorkflowInvocations in a given Repository. | | `create` | `INSERT` | `locationsId, projectsId, repositoriesId` | Creates a new WorkflowInvocation in a given Repository. | | `delete` | `DELETE` | `locationsId, projectsId, repositoriesId, workflowInvocationsId` | Deletes a single WorkflowInvocation. | +| `_list` | `EXEC` | `locationsId, projectsId, repositoriesId` | Lists WorkflowInvocations in a given Repository. | | `cancel` | `EXEC` | `locationsId, projectsId, repositoriesId, workflowInvocationsId` | Requests cancellation of a running WorkflowInvocation. | | `query` | `EXEC` | `locationsId, projectsId, repositoriesId, workflowInvocationsId` | Returns WorkflowInvocationActions in a given WorkflowInvocation. | diff --git a/docs/google-docs/providers/google/dataform/workspaces/index.md b/docs/google-docs/providers/google/dataform/workspaces/index.md index ee5094e150..7c19144605 100644 --- a/docs/google-docs/providers/google/dataform/workspaces/index.md +++ b/docs/google-docs/providers/google/dataform/workspaces/index.md @@ -25,11 +25,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `unreachable` | `array` | Locations which could not be reached. | -| `workspaces` | `array` | List of workspaces. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +32,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId, repositoriesId` | Lists Workspaces in a given Repository. | | `create` | `INSERT` | `locationsId, projectsId, repositoriesId` | Creates a new Workspace in a given Repository. | | `delete` | `DELETE` | `locationsId, projectsId, repositoriesId, workspacesId` | Deletes a single Workspace. | +| `_list` | `EXEC` | `locationsId, projectsId, repositoriesId` | Lists Workspaces in a given Repository. | | `commit` | `EXEC` | `locationsId, projectsId, repositoriesId, workspacesId` | Applies a Git commit for uncommitted files in a Workspace. | | `install_npm_packages` | `EXEC` | `locationsId, projectsId, repositoriesId, workspacesId` | Installs dependency NPM packages (inside a Workspace). | | `make_directory` | `EXEC` | `locationsId, projectsId, repositoriesId, workspacesId` | Creates a directory inside a Workspace. | diff --git a/docs/google-docs/providers/google/dataform/workspaces_iam_policies/index.md b/docs/google-docs/providers/google/dataform/workspaces_iam_policies/index.md index 56bd0f4a4b..6ff0ad7ea0 100644 --- a/docs/google-docs/providers/google/dataform/workspaces_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataform/workspaces_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datafusion/dns_peerings/index.md b/docs/google-docs/providers/google/datafusion/dns_peerings/index.md index 667d27783a..7bd148cbb1 100644 --- a/docs/google-docs/providers/google/datafusion/dns_peerings/index.md +++ b/docs/google-docs/providers/google/datafusion/dns_peerings/index.md @@ -27,11 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `dnsPeerings` | `array` | List of dns peering. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Required. The resource name of the dns peering zone. Format: projects/{project}/locations/{location}/instances/{instance}/dnsPeerings/{dns_peering} | +| `description` | `string` | Optional. Optional description of the dns zone. | +| `domain` | `string` | Required. The dns name suffix of the zone. | +| `targetNetwork` | `string` | Optional. Optional target network to which dns peering should happen. | +| `targetProject` | `string` | Optional. Optional target project to which dns peering should happen. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `list` | `SELECT` | `instancesId, locationsId, projectsId` | Lists DNS peerings for a given resource. | | `create` | `INSERT` | `instancesId, locationsId, projectsId` | Creates DNS peering on the given resource. | | `delete` | `DELETE` | `dnsPeeringsId, instancesId, locationsId, projectsId` | Deletes DNS peering on the given resource. | +| `_list` | `EXEC` | `instancesId, locationsId, projectsId` | Lists DNS peerings for a given resource. | diff --git a/docs/google-docs/providers/google/datafusion/index.md b/docs/google-docs/providers/google/datafusion/index.md index 3fa7fa531c..6c2e56e23c 100644 --- a/docs/google-docs/providers/google/datafusion/index.md +++ b/docs/google-docs/providers/google/datafusion/index.md @@ -21,7 +21,7 @@ Cloud Data Fusion Is A Fully-Managed, Cloud Native, Enterprise Data Integration
total resources: 6
total selectable resources: 6
-total methods: 19
+total methods: 24
@@ -33,7 +33,7 @@ Cloud Data Fusion Is A Fully-Managed, Cloud Native, Enterprise Data Integration TypeService TitleCloud Data Fusion API DescriptionCloud Data Fusion Is A Fully-Managed, Cloud Native, Enterprise Data Integration Service For Quickly Building And Managing Data Pipelines. It Provides A Graphical Interface To Increase Time Efficiency And Reduce Complexity, And Allows Business Users, Developers, And Data Scientists To Easily And Reliably Build Scalable Data Integration Solutions To Cleanse, Prepare, Blend, Transfer And Transform Data Without Having To Wrestle With Infrastructure. -Iddatafusion:v23.08.00155 +Iddatafusion:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/datafusion/instances/index.md b/docs/google-docs/providers/google/datafusion/instances/index.md index 1f143f7d24..ee860c475c 100644 --- a/docs/google-docs/providers/google/datafusion/instances/index.md +++ b/docs/google-docs/providers/google/datafusion/instances/index.md @@ -27,9 +27,37 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `instances` | `array` | Represents a list of Data Fusion instances. | -| `nextPageToken` | `string` | Token to retrieve the next page of results or empty if there are no more results in the list. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. | +| `description` | `string` | A description of this instance. | +| `enableRbac` | `boolean` | Option to enable granular role-based access control. | +| `availableVersion` | `array` | Output only. Available versions that the instance can be upgraded to using UpdateInstanceRequest. | +| `updateTime` | `string` | Output only. The time the instance was last updated. | +| `p4ServiceAccount` | `string` | Output only. P4 service account for the customer project. | +| `privateInstance` | `boolean` | Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. | +| `apiEndpoint` | `string` | Output only. Endpoint on which the REST APIs is accessible. | +| `networkConfig` | `object` | Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. | +| `labels` | `object` | The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels. | +| `enableStackdriverLogging` | `boolean` | Option to enable Stackdriver Logging. | +| `gcsBucket` | `string` | Output only. Cloud Storage bucket generated by Data Fusion in the customer project. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `version` | `string` | Current version of the Data Fusion. Only specifiable in Update. | +| `type` | `string` | Required. Instance type. | +| `dataprocServiceAccount` | `string` | User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. | +| `cryptoKeyConfig` | `object` | The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. | +| `serviceEndpoint` | `string` | Output only. Endpoint on which the Data Fusion UI is accessible. | +| `tenantProjectId` | `string` | Output only. The name of the tenant project. | +| `displayName` | `string` | Display name for an instance. | +| `options` | `object` | Map of additional options used to configure the behavior of Data Fusion instance. | +| `zone` | `string` | Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. | +| `state` | `string` | Output only. The current state of this Data Fusion instance. | +| `serviceAccount` | `string` | Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID. | +| `accelerators` | `array` | Output only. List of accelerators enabled for this CDF instance. | +| `createTime` | `string` | Output only. The time the instance was created. | +| `enableZoneSeparation` | `boolean` | Option to enable granular zone separation. | +| `enableStackdriverMonitoring` | `boolean` | Option to enable Stackdriver Monitoring. | +| `stateMessage` | `string` | Output only. Additional information about the current state of this Data Fusion instance if available. | +| `disabledReason` | `array` | Output only. If the instance state is DISABLED, the reason for disabling the instance. | +| `eventPublishConfig` | `object` | Confirguration of PubSubEventWriter. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,5 +65,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists Data Fusion instances in the specified project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new Data Fusion instance in the specified project and location. | | `delete` | `DELETE` | `instancesId, locationsId, projectsId` | Deletes a single Date Fusion instance. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Data Fusion instances in the specified project and location. | | `patch` | `EXEC` | `instancesId, locationsId, projectsId` | Updates a single Data Fusion instance. | | `restart` | `EXEC` | `instancesId, locationsId, projectsId` | Restart a single Data Fusion instance. At the end of an operation instance is fully restarted. | diff --git a/docs/google-docs/providers/google/datafusion/instances_iam_policies/index.md b/docs/google-docs/providers/google/datafusion/instances_iam_policies/index.md index c333fd0c3c..f6596d10f0 100644 --- a/docs/google-docs/providers/google/datafusion/instances_iam_policies/index.md +++ b/docs/google-docs/providers/google/datafusion/instances_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datafusion/locations/index.md b/docs/google-docs/providers/google/datafusion/locations/index.md index e2845e49a5..6ea79549bc 100644 --- a/docs/google-docs/providers/google/datafusion/locations/index.md +++ b/docs/google-docs/providers/google/datafusion/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `locations` | `array` | A list of locations that matches the specified filter in the request. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/datafusion/operations/index.md b/docs/google-docs/providers/google/datafusion/operations/index.md index 0febdea513..1a92d228c4 100644 --- a/docs/google-docs/providers/google/datafusion/operations/index.md +++ b/docs/google-docs/providers/google/datafusion/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/datafusion/versions/index.md b/docs/google-docs/providers/google/datafusion/versions/index.md index 5a98662b38..a9641b4bdf 100644 --- a/docs/google-docs/providers/google/datafusion/versions/index.md +++ b/docs/google-docs/providers/google/datafusion/versions/index.md @@ -27,9 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results or empty if there are no more results in the list. | -| `availableVersions` | `array` | Represents a list of versions that are supported. | +| `type` | `string` | Type represents the release availability of the version | +| `versionNumber` | `string` | The version number of the Data Fusion instance, such as '6.0.1.0'. | +| `availableFeatures` | `array` | Represents a list of available feature names for a given version. | +| `defaultVersion` | `boolean` | Whether this is currently the default version for Cloud Data Fusion | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `locationsId, projectsId` | +| `_list` | `EXEC` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/datalabeling/annotated_datasets/index.md b/docs/google-docs/providers/google/datalabeling/annotated_datasets/index.md index beb16f5c28..71cb3c458e 100644 --- a/docs/google-docs/providers/google/datalabeling/annotated_datasets/index.md +++ b/docs/google-docs/providers/google/datalabeling/annotated_datasets/index.md @@ -29,18 +29,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. AnnotatedDataset resource name in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id} | | `description` | `string` | Output only. The description of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 characters. | +| `exampleCount` | `string` | Output only. Number of examples in the annotated dataset. | | `createTime` | `string` | Output only. Time the AnnotatedDataset was created. | -| `blockingResources` | `array` | Output only. The names of any related resources that are blocking changes to the annotated dataset. | +| `labelStats` | `object` | Statistics about annotation specs. | +| `metadata` | `object` | Metadata on AnnotatedDataset. | | `displayName` | `string` | Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters. | -| `annotationSource` | `string` | Output only. Source of the annotation. | -| `exampleCount` | `string` | Output only. Number of examples in the annotated dataset. | | `annotationType` | `string` | Output only. Type of the annotation. It is specified when starting labeling task. | | `completedExampleCount` | `string` | Output only. Number of examples that have annotation in the annotated dataset. | -| `labelStats` | `object` | Statistics about annotation specs. | -| `metadata` | `object` | Metadata on AnnotatedDataset. | +| `annotationSource` | `string` | Output only. Source of the annotation. | +| `blockingResources` | `array` | Output only. The names of any related resources that are blocking changes to the annotated dataset. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_datasets_annotated_datasets_get` | `SELECT` | `annotatedDatasetsId, datasetsId, projectsId` | Gets an annotated dataset by resource name. | | `projects_datasets_annotated_datasets_list` | `SELECT` | `datasetsId, projectsId` | Lists annotated datasets for a dataset. Pagination is supported. | | `projects_datasets_annotated_datasets_delete` | `DELETE` | `annotatedDatasetsId, datasetsId, projectsId` | Deletes an annotated dataset by resource name. | +| `_projects_datasets_annotated_datasets_list` | `EXEC` | `datasetsId, projectsId` | Lists annotated datasets for a dataset. Pagination is supported. | diff --git a/docs/google-docs/providers/google/datalabeling/annotation_spec_sets/index.md b/docs/google-docs/providers/google/datalabeling/annotation_spec_sets/index.md index fff7e44f39..491e844720 100644 --- a/docs/google-docs/providers/google/datalabeling/annotation_spec_sets/index.md +++ b/docs/google-docs/providers/google/datalabeling/annotation_spec_sets/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}" | | `description` | `string` | Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long. | +| `displayName` | `string` | Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters. | | `annotationSpecs` | `array` | Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task. | | `blockingResources` | `array` | Output only. The names of any related resources that are blocking changes to the annotation spec set. | -| `displayName` | `string` | Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -39,3 +39,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_annotation_spec_sets_list` | `SELECT` | `projectsId` | Lists annotation spec sets for a project. Pagination is supported. | | `projects_annotation_spec_sets_create` | `INSERT` | `projectsId` | Creates an annotation spec set by providing a set of labels. | | `projects_annotation_spec_sets_delete` | `DELETE` | `annotationSpecSetsId, projectsId` | Deletes an annotation spec set by resource name. | +| `_projects_annotation_spec_sets_list` | `EXEC` | `projectsId` | Lists annotation spec sets for a project. Pagination is supported. | diff --git a/docs/google-docs/providers/google/datalabeling/data_items/index.md b/docs/google-docs/providers/google/datalabeling/data_items/index.md index 9541ecf630..4905d8ad49 100644 --- a/docs/google-docs/providers/google/datalabeling/data_items/index.md +++ b/docs/google-docs/providers/google/datalabeling/data_items/index.md @@ -27,8 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `dataItems` | `array` | The list of data items to return. | -| `nextPageToken` | `string` | A token to retrieve next page of results. | +| `name` | `string` | Output only. Name of the data item, in format of: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id} | +| `imagePayload` | `object` | Container of information about an image. | +| `textPayload` | `object` | Container of information about a piece of text. | +| `videoPayload` | `object` | Container of information of a video. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,3 +38,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_datasets_annotated_datasets_data_items_list` | `SELECT` | `annotatedDatasetsId, datasetsId, projectsId` | Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported. | | `projects_datasets_data_items_get` | `SELECT` | `dataItemsId, datasetsId, projectsId` | Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset. | | `projects_datasets_data_items_list` | `SELECT` | `datasetsId, projectsId` | Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported. | +| `_projects_datasets_annotated_datasets_data_items_list` | `EXEC` | `annotatedDatasetsId, datasetsId, projectsId` | Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported. | +| `_projects_datasets_data_items_list` | `EXEC` | `datasetsId, projectsId` | Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported. | diff --git a/docs/google-docs/providers/google/datalabeling/datasets/index.md b/docs/google-docs/providers/google/datalabeling/datasets/index.md index a57b96939e..24df7d43f6 100644 --- a/docs/google-docs/providers/google/datalabeling/datasets/index.md +++ b/docs/google-docs/providers/google/datalabeling/datasets/index.md @@ -27,8 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `datasets` | `array` | The list of datasets to return. | -| `nextPageToken` | `string` | A token to retrieve next page of results. | +| `name` | `string` | Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id} | +| `description` | `string` | Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long. | +| `blockingResources` | `array` | Output only. The names of any related resources that are blocking changes to the dataset. | +| `createTime` | `string` | Output only. Time the dataset is created. | +| `dataItemCount` | `string` | Output only. The number of data items in the dataset. | +| `displayName` | `string` | Required. The display name of the dataset. Maximum of 64 characters. | +| `inputConfigs` | `array` | Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset. | +| `lastMigrateTime` | `string` | Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +42,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_datasets_list` | `SELECT` | `projectsId` | Lists datasets under a project. Pagination is supported. | | `projects_datasets_create` | `INSERT` | `projectsId` | Creates dataset. If success return a Dataset resource. | | `projects_datasets_delete` | `DELETE` | `datasetsId, projectsId` | Deletes a dataset by resource name. | +| `_projects_datasets_list` | `EXEC` | `projectsId` | Lists datasets under a project. Pagination is supported. | | `projects_datasets_export_data` | `EXEC` | `datasetsId, projectsId` | Exports data and annotations from dataset. | | `projects_datasets_import_data` | `EXEC` | `datasetsId, projectsId` | Imports data into dataset based on source locations defined in request. It can be called multiple times for the same dataset. Each dataset can only have one long running operation running on it. For example, no labeling task (also long running operation) can be started while importing is still ongoing. Vice versa. | diff --git a/docs/google-docs/providers/google/datalabeling/evaluation_jobs/index.md b/docs/google-docs/providers/google/datalabeling/evaluation_jobs/index.md index a3da215066..cce432f226 100644 --- a/docs/google-docs/providers/google/datalabeling/evaluation_jobs/index.md +++ b/docs/google-docs/providers/google/datalabeling/evaluation_jobs/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format: "projects/{project_id}/evaluationJobs/ {evaluation_job_id}" | | `description` | `string` | Required. Description of the job. The description can be up to 25,000 characters long. | -| `modelVersion` | `string` | Required. The [AI Platform Prediction model version](/ml-engine/docs/prediction-overview) to be evaluated. Prediction input and output is sampled from this model version. When creating an evaluation job, specify the model version in the following format: "projects/{project_id}/models/{model_name}/versions/{version_name}" There can only be one evaluation job per model version. | -| `evaluationJobConfig` | `object` | Configures specific details of how a continuous evaluation job works. Provide this configuration when you create an EvaluationJob. | | `createTime` | `string` | Output only. Timestamp of when this evaluation job was created. | -| `state` | `string` | Output only. Describes the current state of the job. | +| `labelMissingGroundTruth` | `boolean` | Required. Whether you want Data Labeling Service to provide ground truth labels for prediction input. If you want the service to assign human labelers to annotate your data, set this to `true`. If you want to provide your own ground truth labels in the evaluation job's BigQuery table, set this to `false`. | +| `modelVersion` | `string` | Required. The [AI Platform Prediction model version](/ml-engine/docs/prediction-overview) to be evaluated. Prediction input and output is sampled from this model version. When creating an evaluation job, specify the model version in the following format: "projects/{project_id}/models/{model_name}/versions/{version_name}" There can only be one evaluation job per model version. | | `schedule` | `string` | Required. Describes the interval at which the job runs. This interval must be at least 1 day, and it is rounded to the nearest day. For example, if you specify a 50-hour interval, the job runs every 2 days. You can provide the schedule in [crontab format](/scheduler/docs/configuring/cron-job-schedules) or in an [English-like format](/appengine/docs/standard/python/config/cronref#schedule_format). Regardless of what you specify, the job will run at 10:00 AM UTC. Only the interval from this schedule is used, not the specific time of day. | -| `annotationSpecSet` | `string` | Required. Name of the AnnotationSpecSet describing all the labels that your machine learning model outputs. You must create this resource before you create an evaluation job and provide its name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}" | | `attempts` | `array` | Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array. | -| `labelMissingGroundTruth` | `boolean` | Required. Whether you want Data Labeling Service to provide ground truth labels for prediction input. If you want the service to assign human labelers to annotate your data, set this to `true`. If you want to provide your own ground truth labels in the evaluation job's BigQuery table, set this to `false`. | +| `evaluationJobConfig` | `object` | Configures specific details of how a continuous evaluation job works. Provide this configuration when you create an EvaluationJob. | +| `annotationSpecSet` | `string` | Required. Name of the AnnotationSpecSet describing all the labels that your machine learning model outputs. You must create this resource before you create an evaluation job and provide its name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}" | +| `state` | `string` | Output only. Describes the current state of the job. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,6 +44,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_evaluation_jobs_list` | `SELECT` | `projectsId` | Lists all evaluation jobs within a project with possible filters. Pagination is supported. | | `projects_evaluation_jobs_create` | `INSERT` | `projectsId` | Creates an evaluation job. | | `projects_evaluation_jobs_delete` | `DELETE` | `evaluationJobsId, projectsId` | Stops and deletes an evaluation job. | +| `_projects_evaluation_jobs_list` | `EXEC` | `projectsId` | Lists all evaluation jobs within a project with possible filters. Pagination is supported. | | `projects_evaluation_jobs_patch` | `EXEC` | `evaluationJobsId, projectsId` | Updates an evaluation job. You can only update certain fields of the job's EvaluationJobConfig: `humanAnnotationConfig.instruction`, `exampleCount`, and `exampleSamplePercentage`. If you want to change any other aspect of the evaluation job, you must delete the job and create a new one. | | `projects_evaluation_jobs_pause` | `EXEC` | `evaluationJobsId, projectsId` | Pauses an evaluation job. Pausing an evaluation job that is already in a `PAUSED` state is a no-op. | | `projects_evaluation_jobs_resume` | `EXEC` | `evaluationJobsId, projectsId` | Resumes a paused evaluation job. A deleted evaluation job can't be resumed. Resuming a running or scheduled evaluation job is a no-op. | diff --git a/docs/google-docs/providers/google/datalabeling/evaluations/index.md b/docs/google-docs/providers/google/datalabeling/evaluations/index.md index f7bcb0a617..2e8220360b 100644 --- a/docs/google-docs/providers/google/datalabeling/evaluations/index.md +++ b/docs/google-docs/providers/google/datalabeling/evaluations/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of an evaluation. The name has the following format: "projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}' | +| `evaluationMetrics` | `object` | | +| `annotationType` | `string` | Output only. Type of task that the model version being evaluated performs, as defined in the evaluationJobConfig.inputConfig.annotationType field of the evaluation job that created this evaluation. | | `config` | `object` | Configuration details used for calculating evaluation metrics and creating an Evaluation. | | `createTime` | `string` | Output only. Timestamp for when this evaluation was created. | | `evaluatedItemCount` | `string` | Output only. The number of items in the ground truth dataset that were used for this evaluation. Only populated when the evaulation is for certain AnnotationTypes. | | `evaluationJobRunTime` | `string` | Output only. Timestamp for when the evaluation job that created this evaluation ran. | -| `evaluationMetrics` | `object` | | -| `annotationType` | `string` | Output only. Type of task that the model version being evaluated performs, as defined in the evaluationJobConfig.inputConfig.annotationType field of the evaluation job that created this evaluation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datalabeling/examples/index.md b/docs/google-docs/providers/google/datalabeling/examples/index.md index 2f9e13cc88..288aa5ba31 100644 --- a/docs/google-docs/providers/google/datalabeling/examples/index.md +++ b/docs/google-docs/providers/google/datalabeling/examples/index.md @@ -37,3 +37,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:--------------|:----------------|:------------| | `projects_datasets_annotated_datasets_examples_get` | `SELECT` | `annotatedDatasetsId, datasetsId, examplesId, projectsId` | Gets an example by resource name, including both data and annotation. | | `projects_datasets_annotated_datasets_examples_list` | `SELECT` | `annotatedDatasetsId, datasetsId, projectsId` | Lists examples in an annotated dataset. Pagination is supported. | +| `_projects_datasets_annotated_datasets_examples_list` | `EXEC` | `annotatedDatasetsId, datasetsId, projectsId` | Lists examples in an annotated dataset. Pagination is supported. | diff --git a/docs/google-docs/providers/google/datalabeling/feedback_messages/index.md b/docs/google-docs/providers/google/datalabeling/feedback_messages/index.md index d5d195b35c..5c19f3f7b5 100644 --- a/docs/google-docs/providers/google/datalabeling/feedback_messages/index.md +++ b/docs/google-docs/providers/google/datalabeling/feedback_messages/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Name of the feedback message in a feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessage/{feedback_message_id}' | +| `image` | `string` | The image storing this feedback if the feedback is an image representing operator's comments. | | `operatorFeedbackMetadata` | `object` | Metadata describing the feedback from the operator. | | `requesterFeedbackMetadata` | `object` | Metadata describing the feedback from the labeling task requester. | | `body` | `string` | String content of the feedback. Maximum of 10000 characters. | | `createTime` | `string` | Create time. | -| `image` | `string` | The image storing this feedback if the feedback is an image representing operator's comments. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -40,3 +40,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_datasets_annotated_datasets_feedback_threads_feedback_messages_list` | `SELECT` | `annotatedDatasetsId, datasetsId, feedbackThreadsId, projectsId` | List FeedbackMessages with pagination. | | `projects_datasets_annotated_datasets_feedback_threads_feedback_messages_create` | `INSERT` | `annotatedDatasetsId, datasetsId, feedbackThreadsId, projectsId` | Create a FeedbackMessage object. | | `projects_datasets_annotated_datasets_feedback_threads_feedback_messages_delete` | `DELETE` | `annotatedDatasetsId, datasetsId, feedbackMessagesId, feedbackThreadsId, projectsId` | Delete a FeedbackMessage. | +| `_projects_datasets_annotated_datasets_feedback_threads_feedback_messages_list` | `EXEC` | `annotatedDatasetsId, datasetsId, feedbackThreadsId, projectsId` | List FeedbackMessages with pagination. | diff --git a/docs/google-docs/providers/google/datalabeling/feedback_threads/index.md b/docs/google-docs/providers/google/datalabeling/feedback_threads/index.md index 4b77896814..34e4a3448f 100644 --- a/docs/google-docs/providers/google/datalabeling/feedback_threads/index.md +++ b/docs/google-docs/providers/google/datalabeling/feedback_threads/index.md @@ -35,3 +35,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_datasets_annotated_datasets_feedback_threads_get` | `SELECT` | `annotatedDatasetsId, datasetsId, feedbackThreadsId, projectsId` | Get a FeedbackThread object. | | `projects_datasets_annotated_datasets_feedback_threads_list` | `SELECT` | `annotatedDatasetsId, datasetsId, projectsId` | List FeedbackThreads with pagination. | | `projects_datasets_annotated_datasets_feedback_threads_delete` | `DELETE` | `annotatedDatasetsId, datasetsId, feedbackThreadsId, projectsId` | Delete a FeedbackThread. | +| `_projects_datasets_annotated_datasets_feedback_threads_list` | `EXEC` | `annotatedDatasetsId, datasetsId, projectsId` | List FeedbackThreads with pagination. | diff --git a/docs/google-docs/providers/google/datalabeling/index.md b/docs/google-docs/providers/google/datalabeling/index.md index 3e5dc5838b..4489094360 100644 --- a/docs/google-docs/providers/google/datalabeling/index.md +++ b/docs/google-docs/providers/google/datalabeling/index.md @@ -21,7 +21,7 @@ Public API For Google Cloud AI Data Labeling Service.
total resources: 15
total selectable resources: 11
-total methods: 47
+total methods: 58
@@ -33,7 +33,7 @@ Public API For Google Cloud AI Data Labeling Service. TypeService TitleData Labeling API DescriptionPublic API For Google Cloud AI Data Labeling Service. -Iddatalabeling:v23.08.00155 +Iddatalabeling:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/datalabeling/instructions/index.md b/docs/google-docs/providers/google/datalabeling/instructions/index.md index fe4f894890..b5af31df2a 100644 --- a/docs/google-docs/providers/google/datalabeling/instructions/index.md +++ b/docs/google-docs/providers/google/datalabeling/instructions/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} | | `description` | `string` | Optional. User-provided description of the instruction. The description can be up to 10000 characters long. | -| `dataType` | `string` | Required. The data type of this instruction. | +| `csvInstruction` | `object` | Deprecated: this instruction format is not supported any more. Instruction from a CSV file. | | `displayName` | `string` | Required. The display name of the instruction. Maximum of 64 characters. | -| `pdfInstruction` | `object` | Instruction from a PDF file. | | `createTime` | `string` | Output only. Creation time of instruction. | +| `pdfInstruction` | `object` | Instruction from a PDF file. | | `blockingResources` | `array` | Output only. The names of any related resources that are blocking changes to the instruction. | -| `csvInstruction` | `object` | Deprecated: this instruction format is not supported any more. Instruction from a CSV file. | +| `dataType` | `string` | Required. The data type of this instruction. | | `updateTime` | `string` | Output only. Last update time of instruction. | ## Methods | Name | Accessible by | Required Params | Description | @@ -43,3 +43,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_instructions_list` | `SELECT` | `projectsId` | Lists instructions for a project. Pagination is supported. | | `projects_instructions_create` | `INSERT` | `projectsId` | Creates an instruction for how data should be labeled. | | `projects_instructions_delete` | `DELETE` | `instructionsId, projectsId` | Deletes an instruction object by resource name. | +| `_projects_instructions_list` | `EXEC` | `projectsId` | Lists instructions for a project. Pagination is supported. | diff --git a/docs/google-docs/providers/google/datalabeling/operations/index.md b/docs/google-docs/providers/google/datalabeling/operations/index.md index ffcf44414c..3aeb4d1d54 100644 --- a/docs/google-docs/providers/google/datalabeling/operations/index.md +++ b/docs/google-docs/providers/google/datalabeling/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_operations_list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_operations_delete` | `DELETE` | `operationsId, projectsId` | 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`. | +| `_projects_operations_list` | `EXEC` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_operations_cancel` | `EXEC` | `operationsId, projectsId` | 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`. | | `projects_operations_get` | `EXEC` | `operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/datalineage/index.md b/docs/google-docs/providers/google/datalineage/index.md index da5368e834..9201839cba 100644 --- a/docs/google-docs/providers/google/datalineage/index.md +++ b/docs/google-docs/providers/google/datalineage/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 5
total selectable resources: 4
-total methods: 20
+total methods: 24
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleData Lineage API Description -Iddatalineage:v23.08.00155 +Iddatalineage:v23.08.00157 ## Resources 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 77faedd289..19947cd7f0 100644 --- a/docs/google-docs/providers/google/datalineage/lineage_events/index.md +++ b/docs/google-docs/providers/google/datalineage/lineage_events/index.md @@ -38,3 +38,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, processesId, projectsId, runsId` | Lists lineage events in the given project and location. The list order is not defined. | | `create` | `INSERT` | `locationsId, processesId, projectsId, runsId` | Creates a new lineage event. | | `delete` | `DELETE` | `lineageEventsId, locationsId, processesId, projectsId, runsId` | Deletes the lineage event with the specified name. | +| `_list` | `EXEC` | `locationsId, processesId, projectsId, runsId` | Lists lineage events in the given project and location. The list order is not defined. | diff --git a/docs/google-docs/providers/google/datalineage/operations/index.md b/docs/google-docs/providers/google/datalineage/operations/index.md index 4b03310542..1e53719cc8 100644 --- a/docs/google-docs/providers/google/datalineage/operations/index.md +++ b/docs/google-docs/providers/google/datalineage/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/datalineage/processes/index.md b/docs/google-docs/providers/google/datalineage/processes/index.md index 3dda4b8a5c..069d54226a 100644 --- a/docs/google-docs/providers/google/datalineage/processes/index.md +++ b/docs/google-docs/providers/google/datalineage/processes/index.md @@ -27,8 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The token to specify as `page_token` in the next call to get the next page. If this field is omitted, there are no subsequent pages. | -| `processes` | `array` | The processes from the specified project and location. | +| `name` | `string` | Immutable. The resource name of the lineage process. Format: `projects/{project}/locations/{location}/processes/{process}`. Can be specified or auto-assigned. {process} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.` | +| `attributes` | `object` | Optional. The attributes of the process. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the process). Up to 100 attributes are allowed. | +| `displayName` | `string` | Optional. A human-readable name you can set to display in a user interface. Must be not longer than 200 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:&.` | +| `origin` | `object` | Origin of a process. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +38,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | List processes in the given project and location. List order is descending by insertion time. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new process. | | `delete` | `DELETE` | `locationsId, processesId, projectsId` | Deletes the process with the specified name. | +| `_list` | `EXEC` | `locationsId, projectsId` | List processes in the given project and location. List order is descending by insertion time. | | `patch` | `EXEC` | `locationsId, processesId, projectsId` | Updates a process. | diff --git a/docs/google-docs/providers/google/datalineage/runs/index.md b/docs/google-docs/providers/google/datalineage/runs/index.md index fa1c186912..7f13ad53cb 100644 --- a/docs/google-docs/providers/google/datalineage/runs/index.md +++ b/docs/google-docs/providers/google/datalineage/runs/index.md @@ -27,8 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The token to specify as `page_token` in the next call to get the next page. If this field is omitted, there are no subsequent pages. | -| `runs` | `array` | The runs from the specified project and location. | +| `name` | `string` | Immutable. The resource name of the run. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.` | +| `displayName` | `string` | Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:&.` | +| `endTime` | `string` | Optional. The timestamp of the end of the run. | +| `startTime` | `string` | Required. The timestamp of the start of the run. | +| `state` | `string` | Required. The state of the run. | +| `attributes` | `object` | Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +40,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, processesId, projectsId` | Lists runs in the given project and location. List order is descending by `start_time`. | | `create` | `INSERT` | `locationsId, processesId, projectsId` | Creates a new run. | | `delete` | `DELETE` | `locationsId, processesId, projectsId, runsId` | Deletes the run with the specified name. | +| `_list` | `EXEC` | `locationsId, processesId, projectsId` | Lists runs in the given project and location. List order is descending by `start_time`. | | `patch` | `EXEC` | `locationsId, processesId, projectsId, runsId` | Updates a run. | diff --git a/docs/google-docs/providers/google/datamigration/connection_profiles/index.md b/docs/google-docs/providers/google/datamigration/connection_profiles/index.md index 9f9b624669..2d89c6352d 100644 --- a/docs/google-docs/providers/google/datamigration/connection_profiles/index.md +++ b/docs/google-docs/providers/google/datamigration/connection_profiles/index.md @@ -27,9 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `connectionProfiles` | `array` | The response list of connection profiles. | -| `nextPageToken` | `string` | A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. | +| `alloydb` | `object` | Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster. | +| `cloudsql` | `object` | Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". | +| `error` | `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). | +| `labels` | `object` | The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. | +| `mysql` | `object` | Specifies connection parameters required specifically for MySQL databases. | +| `displayName` | `string` | The connection profile display name. | +| `state` | `string` | The current connection profile state (e.g. DRAFT, READY, or FAILED). | +| `provider` | `string` | The database provider. | +| `postgresql` | `object` | Specifies connection parameters required specifically for PostgreSQL databases. | +| `oracle` | `object` | Specifies connection parameters required specifically for Oracle databases. | +| `updateTime` | `string` | Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +47,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Retrieves a list of all connection profiles in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new connection profile in a given project and location. | | `delete` | `DELETE` | `connectionProfilesId, locationsId, projectsId` | Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs. | +| `_list` | `EXEC` | `locationsId, projectsId` | Retrieves a list of all connection profiles in a given project and location. | | `patch` | `EXEC` | `connectionProfilesId, locationsId, projectsId` | Update the configuration of a single connection profile. | diff --git a/docs/google-docs/providers/google/datamigration/connection_profiles_iam_policies/index.md b/docs/google-docs/providers/google/datamigration/connection_profiles_iam_policies/index.md index 45c9fb8e0a..41428a64a0 100644 --- a/docs/google-docs/providers/google/datamigration/connection_profiles_iam_policies/index.md +++ b/docs/google-docs/providers/google/datamigration/connection_profiles_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datamigration/conversion_workspaces/index.md b/docs/google-docs/providers/google/datamigration/conversion_workspaces/index.md index 51947df48b..7b29ec462b 100644 --- a/docs/google-docs/providers/google/datamigration/conversion_workspaces/index.md +++ b/docs/google-docs/providers/google/datamigration/conversion_workspaces/index.md @@ -27,9 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `conversionWorkspaces` | `array` | The list of conversion workspace objects. | -| `nextPageToken` | `string` | A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. | +| `latestCommitTime` | `string` | Output only. The timestamp when the workspace was committed. | +| `displayName` | `string` | Optional. The display name for the workspace. | +| `destination` | `object` | The type and version of a source or destination database. | +| `hasUncommittedChanges` | `boolean` | Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed). | +| `latestCommitId` | `string` | Output only. The latest commit ID. | +| `source` | `object` | The type and version of a source or destination database. | +| `updateTime` | `string` | Output only. The timestamp when the workspace resource was last updated. | +| `createTime` | `string` | Output only. The timestamp when the workspace resource was created. | +| `globalSettings` | `object` | Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +44,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists conversion workspaces in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new conversion workspace in a given project and location. | | `delete` | `DELETE` | `conversionWorkspacesId, locationsId, projectsId` | Deletes a single conversion workspace. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists conversion workspaces in a given project and location. | | `apply` | `EXEC` | `conversionWorkspacesId, locationsId, projectsId` | Applies draft tree onto a specific destination database. | | `commit` | `EXEC` | `conversionWorkspacesId, locationsId, projectsId` | Marks all the data in the conversion workspace as committed. | | `convert` | `EXEC` | `conversionWorkspacesId, locationsId, projectsId` | Creates a draft tree schema for the destination database. | diff --git a/docs/google-docs/providers/google/datamigration/conversion_workspaces_iam_policies/index.md b/docs/google-docs/providers/google/datamigration/conversion_workspaces_iam_policies/index.md index 78446d5fc3..4c9d8f6796 100644 --- a/docs/google-docs/providers/google/datamigration/conversion_workspaces_iam_policies/index.md +++ b/docs/google-docs/providers/google/datamigration/conversion_workspaces_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datamigration/index.md b/docs/google-docs/providers/google/datamigration/index.md index 748e494d63..9f8a4fece2 100644 --- a/docs/google-docs/providers/google/datamigration/index.md +++ b/docs/google-docs/providers/google/datamigration/index.md @@ -21,7 +21,7 @@ Manage Cloud Database Migration Service Resources On Google Cloud Platform.
total resources: 12
total selectable resources: 11
-total methods: 59
+total methods: 66
@@ -33,7 +33,7 @@ Manage Cloud Database Migration Service Resources On Google Cloud Platform. TypeService TitleDatabase Migration API DescriptionManage Cloud Database Migration Service Resources On Google Cloud Platform. -Iddatamigration:v23.08.00155 +Iddatamigration:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/datamigration/locations/index.md b/docs/google-docs/providers/google/datamigration/locations/index.md index 89b4aab08b..5989115392 100644 --- a/docs/google-docs/providers/google/datamigration/locations/index.md +++ b/docs/google-docs/providers/google/datamigration/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `locations` | `array` | A list of locations that matches the specified filter in the request. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/datamigration/mapping_rules/index.md b/docs/google-docs/providers/google/datamigration/mapping_rules/index.md index 7d7609c781..4aabc7b1e3 100644 --- a/docs/google-docs/providers/google/datamigration/mapping_rules/index.md +++ b/docs/google-docs/providers/google/datamigration/mapping_rules/index.md @@ -27,8 +27,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `mappingRules` | `array` | The list of conversion workspace mapping rules. | -| `nextPageToken` | `string` | A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}. | +| `displayName` | `string` | Optional. A human readable name | +| `filter` | `object` | A filter defining the entities that a mapping rule should be applied to. When more than one field is specified, the rule is applied only to entities which match all the fields. | +| `state` | `string` | Optional. The mapping rule state | +| `singleEntityRename` | `object` | Options to configure rule type SingleEntityRename. The rule is used to rename an entity. The rule filter field can refer to only one entity. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT, Synonym | +| `multiEntityRename` | `object` | Options to configure rule type MultiEntityRename. The rule is used to rename multiple entities. The rule filter field can refer to one or more entities. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT | +| `convertRowidColumn` | `object` | Options to configure rule type ConvertROWIDToColumn. The rule is used to add column rowid to destination tables based on an Oracle rowid function/property. The rule filter field can refer to one or more entities. The rule scope can be one of: Table. This rule requires additional filter to be specified beyond the basic rule filter field, which is whether or not to work on tables which already have a primary key defined. | +| `ruleOrder` | `string` | Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden. | +| `revisionId` | `string` | Output only. The revision ID of the mapping rule. A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string. | +| `singleColumnChange` | `object` | Options to configure rule type SingleColumnChange. The rule is used to change the properties of a column. The rule filter field can refer to one entity. The rule scope can be one of: Column. When using this rule, if a field is not specified than the destination column's configuration will be the same as the one in the source column.. | +| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | +| `sourceSqlChange` | `object` | Options to configure rule type SourceSqlChange. The rule is used to alter the sql code for database entities. The rule filter field can refer to one entity. The rule scope can be: StoredProcedure, Function, Trigger, View | +| `ruleScope` | `string` | Required. The rule scope | +| `entityMove` | `object` | Options to configure rule type EntityMove. The rule is used to move an entity to a new schema. The rule filter field can refer to one or more entities. The rule scope can be one of: Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT | +| `singlePackageChange` | `object` | Options to configure rule type SinglePackageChange. The rule is used to alter the sql code for a package entities. The rule filter field can refer to one entity. The rule scope can be: Package | +| `filterTableColumns` | `object` | Options to configure rule type FilterTableColumns. The rule is used to filter the list of columns to include or exclude from a table. The rule filter field can refer to one entity. The rule scope can be: Table Only one of the two lists can be specified for the rule. | +| `multiColumnDataTypeChange` | `object` | Options to configure rule type MultiColumnDatatypeChange. The rule is used to change the data type and associated properties of multiple columns at once. The rule filter field can refer to one or more entities. The rule scope can be one of:Column. This rule requires additional filters to be specified beyond the basic rule filter field, which is the source data type, but the rule supports additional filtering capabilities such as the minimum and maximum field length. All additional filters which are specified are required to be met in order for the rule to be applied (logical AND between the fields). | +| `conditionalColumnSetValue` | `object` | Options to configure rule type ConditionalColumnSetValue. The rule is used to transform the data which is being replicated/migrated. The rule filter field can refer to one or more entities. The rule scope can be one of: Column. | +| `setTablePrimaryKey` | `object` | Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +53,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `conversionWorkspacesId, locationsId, projectsId` | Lists the mapping rules for a specific conversion workspace. | | `create` | `INSERT` | `conversionWorkspacesId, locationsId, projectsId` | Creates a new mapping rule for a given conversion workspace. | | `delete` | `DELETE` | `conversionWorkspacesId, locationsId, mappingRulesId, projectsId` | Deletes a single mapping rule. | +| `_list` | `EXEC` | `conversionWorkspacesId, locationsId, projectsId` | Lists the mapping rules for a specific conversion workspace. | | `import` | `EXEC` | `conversionWorkspacesId, locationsId, projectsId` | Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files. | diff --git a/docs/google-docs/providers/google/datamigration/migration_jobs/index.md b/docs/google-docs/providers/google/datamigration/migration_jobs/index.md index 725286925e..7ed16aa1ce 100644 --- a/docs/google-docs/providers/google/datamigration/migration_jobs/index.md +++ b/docs/google-docs/providers/google/datamigration/migration_jobs/index.md @@ -27,9 +27,30 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `unreachable` | `array` | Locations that could not be reached. | -| `migrationJobs` | `array` | The list of migration jobs objects. | +| `name` | `string` | The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}. | +| `displayName` | `string` | The migration job display name. | +| `destinationDatabase` | `object` | A message defining the database engine and provider. | +| `conversionWorkspace` | `object` | A conversion workspace's version. | +| `dumpPath` | `string` | The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive. | +| `sourceDatabase` | `object` | A message defining the database engine and provider. | +| `performanceConfig` | `object` | Performance configuration definition. | +| `phase` | `string` | Output only. The current migration job phase. | +| `source` | `string` | Required. The resource name (URI) of the source connection profile. | +| `createTime` | `string` | Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". | +| `destination` | `string` | Required. The resource name (URI) of the destination connection profile. | +| `state` | `string` | The current migration job state. | +| `dumpFlags` | `object` | Dump flags definition. | +| `filter` | `string` | This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace. | +| `staticIpConnectivity` | `object` | The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. | +| `updateTime` | `string` | Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". | +| `reverseSshConnectivity` | `object` | The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC. | +| `duration` | `string` | Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". | +| `error` | `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). | +| `labels` | `object` | The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. | +| `cmekKeyName` | `string` | The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME] | +| `endTime` | `string` | Output only. If the migration job is completed, the time when it was completed. | +| `type` | `string` | Required. The migration job type. | +| `vpcPeeringConnectivity` | `object` | The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +58,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists migration jobs in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new migration job in a given project and location. | | `delete` | `DELETE` | `locationsId, migrationJobsId, projectsId` | Deletes a single migration job. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists migration jobs in a given project and location. | | `generate_ssh_script` | `EXEC` | `locationsId, migrationJobsId, projectsId` | Generate a SSH configuration script to configure the reverse SSH connectivity. | | `generate_tcp_proxy_script` | `EXEC` | `locationsId, migrationJobsId, projectsId` | Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy. | | `patch` | `EXEC` | `locationsId, migrationJobsId, projectsId` | Updates the parameters of a single migration job. | diff --git a/docs/google-docs/providers/google/datamigration/operations/index.md b/docs/google-docs/providers/google/datamigration/operations/index.md index 10ee8d3819..57a6e510de 100644 --- a/docs/google-docs/providers/google/datamigration/operations/index.md +++ b/docs/google-docs/providers/google/datamigration/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/datamigration/private_connections/index.md b/docs/google-docs/providers/google/datamigration/private_connections/index.md index 832486c5a3..ced9d75d5e 100644 --- a/docs/google-docs/providers/google/datamigration/private_connections/index.md +++ b/docs/google-docs/providers/google/datamigration/private_connections/index.md @@ -27,9 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `privateConnections` | `array` | List of private connections. | +| `name` | `string` | The name of the resource. | +| `createTime` | `string` | Output only. The create time of the resource. | +| `displayName` | `string` | The private connection display name. | +| `error` | `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). | +| `labels` | `object` | The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. | +| `state` | `string` | Output only. The state of the private connection. | +| `updateTime` | `string` | Output only. The last update time of the resource. | +| `vpcPeeringConfig` | `object` | The VPC peering configuration is used to create VPC peering with the consumer's VPC. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,3 +42,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Retrieves a list of private connections in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new private connection in a given project and location. | | `delete` | `DELETE` | `locationsId, privateConnectionsId, projectsId` | Deletes a single Database Migration Service private connection. | +| `_list` | `EXEC` | `locationsId, projectsId` | Retrieves a list of private connections in a given project and location. | diff --git a/docs/google-docs/providers/google/datamigration/private_connections_iam_policies/index.md b/docs/google-docs/providers/google/datamigration/private_connections_iam_policies/index.md index 6ab8e63c0a..193d5faa8e 100644 --- a/docs/google-docs/providers/google/datamigration/private_connections_iam_policies/index.md +++ b/docs/google-docs/providers/google/datamigration/private_connections_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datapipelines/index.md b/docs/google-docs/providers/google/datapipelines/index.md index e8bbded0e7..1a2d87728e 100644 --- a/docs/google-docs/providers/google/datapipelines/index.md +++ b/docs/google-docs/providers/google/datapipelines/index.md @@ -21,7 +21,7 @@ Data Pipelines Provides An Interface For Creating, Updating, And Managing Recurr
total resources: 2
total selectable resources: 2
-total methods: 8
+total methods: 10
@@ -33,7 +33,7 @@ Data Pipelines Provides An Interface For Creating, Updating, And Managing Recurr TypeService TitleData Pipelines API DescriptionData Pipelines Provides An Interface For Creating, Updating, And Managing Recurring Data Analytics Jobs. -Iddatapipelines:v23.08.00155 +Iddatapipelines:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/datapipelines/jobs/index.md b/docs/google-docs/providers/google/datapipelines/jobs/index.md index 9994b72e96..0cdec67dd9 100644 --- a/docs/google-docs/providers/google/datapipelines/jobs/index.md +++ b/docs/google-docs/providers/google/datapipelines/jobs/index.md @@ -27,9 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `jobs` | `array` | Results that were accessible to the caller. Results are always in descending order of job creation date. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `id` | `string` | Output only. The internal ID for the job. | +| `name` | `string` | Required. The fully qualified resource name for the job. | +| `state` | `string` | The current state of the job. | +| `status` | `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). | +| `createTime` | `string` | Output only. The time of job creation. | +| `dataflowJobDetails` | `object` | Pipeline job details specific to the Dataflow API. This is encapsulated here to allow for more executors to store their specific details separately. | +| `endTime` | `string` | Output only. The time of job termination. This is absent if the job is still running. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `locationsId, pipelinesId, projectsId` | +| `_list` | `EXEC` | `locationsId, pipelinesId, projectsId` | diff --git a/docs/google-docs/providers/google/datapipelines/pipelines/index.md b/docs/google-docs/providers/google/datapipelines/pipelines/index.md index b85a9646d2..ac7f466d3c 100644 --- a/docs/google-docs/providers/google/datapipelines/pipelines/index.md +++ b/docs/google-docs/providers/google/datapipelines/pipelines/index.md @@ -27,8 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `pipelines` | `array` | Results that matched the filter criteria and were accessible to the caller. Results are always in descending order of pipeline creation date. | +| `name` | `string` | The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects). * `LOCATION_ID` is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. | +| `type` | `string` | Required. The type of the pipeline. This field affects the scheduling of the pipeline and the type of metrics to show for the pipeline. | +| `displayName` | `string` | Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). | +| `createTime` | `string` | Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. | +| `scheduleInfo` | `object` | Details of the schedule the pipeline runs on. | +| `state` | `string` | Required. The state of the pipeline. When the pipeline is created, the state is set to 'PIPELINE_STATE_ACTIVE' by default. State changes can be requested by setting the state to stopping, paused, or resuming. State cannot be changed through UpdatePipeline requests. | +| `schedulerServiceAccountEmail` | `string` | Optional. A service account email to be used with the Cloud Scheduler job. If not specified, the default compute engine service account will be used. | +| `jobCount` | `integer` | Output only. Number of jobs. | +| `pipelineSources` | `object` | Immutable. The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation. | +| `lastUpdateTime` | `string` | Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service. | +| `workload` | `object` | Workload details for creating the pipeline jobs. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +45,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a pipeline. For a batch pipeline, you can pass scheduler information. Data Pipelines uses the scheduler information to create an internal scheduler that runs jobs periodically. If the internal scheduler is not configured, you can use RunPipeline to run jobs. | | `delete` | `DELETE` | `locationsId, pipelinesId, projectsId` | Deletes a pipeline. If a scheduler job is attached to the pipeline, it will be deleted. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it. | | `patch` | `EXEC` | `locationsId, pipelinesId, projectsId` | Updates a pipeline. If successful, the updated Pipeline is returned. Returns `NOT_FOUND` if the pipeline doesn't exist. If UpdatePipeline does not return successfully, you can retry the UpdatePipeline request until you receive a successful response. | | `run` | `EXEC` | `locationsId, pipelinesId, projectsId` | Creates a job for the specified pipeline directly. You can use this method when the internal scheduler is not configured and you want to trigger the job directly or through an external system. Returns a "NOT_FOUND" error if the pipeline doesn't exist. Returns a "FORBIDDEN" error if the user doesn't have permission to access the pipeline or run jobs for the pipeline. | | `stop` | `EXEC` | `locationsId, pipelinesId, projectsId` | Freezes pipeline execution permanently. If there's a corresponding scheduler entry, it's deleted, and the pipeline state is changed to "ARCHIVED". However, pipeline metadata is retained. | diff --git a/docs/google-docs/providers/google/dataplex/actions/index.md b/docs/google-docs/providers/google/dataplex/actions/index.md index 227e4f5a31..d4f4887d95 100644 --- a/docs/google-docs/providers/google/dataplex/actions/index.md +++ b/docs/google-docs/providers/google/dataplex/actions/index.md @@ -27,11 +27,28 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `actions` | `array` | Actions under the given parent lake/zone/asset. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Output only. The relative resource name of the action, of the form: projects/{project}/locations/{location}/lakes/{lake}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}/actions/{action}. | +| `failedSecurityPolicyApply` | `object` | Failed to apply security policy to the managed resource(s) under a lake, zone or an asset. For a lake or zone resource, one or more underlying assets has a failure applying security policy to the associated managed resource. | +| `lake` | `string` | Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. | +| `zone` | `string` | Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. | +| `category` | `string` | The category of issue associated with the action. | +| `detectTime` | `string` | The time that the issue was detected. | +| `incompatibleDataSchema` | `object` | Action details for incompatible schemas detected by discovery. | +| `invalidDataPartition` | `object` | Action details for invalid or unsupported partitions detected by discovery. | +| `invalidDataFormat` | `object` | Action details for invalid or unsupported data files detected by discovery. | +| `asset` | `string` | Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. | +| `invalidDataOrganization` | `object` | Action details for invalid data arrangement. | +| `unauthorizedResource` | `object` | Action details for unauthorized resource issues raised to indicate that the service account associated with the lake instance is not authorized to access or manage the resource associated with an asset. | +| `missingData` | `object` | Action details for absence of data detected by discovery. | +| `issue` | `string` | Detailed description of the issue requiring action. | +| `missingResource` | `object` | Action details for resource references in assets that cannot be located. | +| `dataLocations` | `array` | The list of data locations associated with this action. Cloud Storage locations are represented as URI paths(E.g. gs://bucket/table1/year=2020/month=Jan/). BigQuery locations refer to resource names(E.g. bigquery.googleapis.com/projects/project-id/datasets/dataset-id). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_lakes_actions_list` | `SELECT` | `lakesId, locationsId, projectsId` | Lists action resources in a lake. | | `projects_locations_lakes_zones_actions_list` | `SELECT` | `lakesId, locationsId, projectsId, zonesId` | Lists action resources in a zone. | | `projects_locations_lakes_zones_assets_actions_list` | `SELECT` | `assetsId, lakesId, locationsId, projectsId, zonesId` | Lists action resources in an asset. | +| `_projects_locations_lakes_actions_list` | `EXEC` | `lakesId, locationsId, projectsId` | Lists action resources in a lake. | +| `_projects_locations_lakes_zones_actions_list` | `EXEC` | `lakesId, locationsId, projectsId, zonesId` | Lists action resources in a zone. | +| `_projects_locations_lakes_zones_assets_actions_list` | `EXEC` | `assetsId, lakesId, locationsId, projectsId, zonesId` | Lists action resources in an asset. | diff --git a/docs/google-docs/providers/google/dataplex/aspect_types_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/aspect_types_iam_policies/index.md index febeec23ef..16261383b8 100644 --- a/docs/google-docs/providers/google/dataplex/aspect_types_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/aspect_types_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/assets/index.md b/docs/google-docs/providers/google/dataplex/assets/index.md index 8d1804cb5e..51eef7f6bc 100644 --- a/docs/google-docs/providers/google/dataplex/assets/index.md +++ b/docs/google-docs/providers/google/dataplex/assets/index.md @@ -27,13 +27,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `assets` | `array` | Asset under the given parent zone. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. | +| `description` | `string` | Optional. Description of the asset. | +| `uid` | `string` | Output only. System generated globally unique ID for the asset. This ID will be different if the asset is deleted and re-created with the same name. | +| `createTime` | `string` | Output only. The time when the asset was created. | +| `securityStatus` | `object` | Security policy status of the asset. Data security policy, i.e., readers, writers & owners, should be specified in the lake/zone/asset IAM policy. | +| `state` | `string` | Output only. Current state of the asset. | +| `discoverySpec` | `object` | Settings to manage the metadata discovery and publishing for an asset. | +| `resourceSpec` | `object` | Identifies the cloud resource that is referenced by this asset. | +| `resourceStatus` | `object` | Status of the resource referenced by an asset. | +| `labels` | `object` | Optional. User defined labels for the asset. | +| `updateTime` | `string` | Output only. The time when the asset was last updated. | +| `discoveryStatus` | `object` | Status of discovery for an asset. | +| `displayName` | `string` | Optional. User friendly display name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_lakes_zones_assets_list` | `SELECT` | `lakesId, locationsId, projectsId, zonesId` | Lists asset resources in a zone. | | `projects_locations_lakes_zones_assets_create` | `INSERT` | `lakesId, locationsId, projectsId, zonesId` | Creates an asset resource. | | `projects_locations_lakes_zones_assets_delete` | `DELETE` | `assetsId, lakesId, locationsId, projectsId, zonesId` | Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy. | +| `_projects_locations_lakes_zones_assets_list` | `EXEC` | `lakesId, locationsId, projectsId, zonesId` | Lists asset resources in a zone. | | `projects_locations_lakes_zones_assets_get` | `EXEC` | `assetsId, lakesId, locationsId, projectsId, zonesId` | Retrieves an asset resource. | | `projects_locations_lakes_zones_assets_patch` | `EXEC` | `assetsId, lakesId, locationsId, projectsId, zonesId` | Updates an asset resource. | diff --git a/docs/google-docs/providers/google/dataplex/assets_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/assets_iam_policies/index.md index 53d8bdbbc2..19c992cce6 100644 --- a/docs/google-docs/providers/google/dataplex/assets_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/assets_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/attributes/index.md b/docs/google-docs/providers/google/dataplex/attributes/index.md index 3f09c1a2c8..8ab6c579f5 100644 --- a/docs/google-docs/providers/google/dataplex/attributes/index.md +++ b/docs/google-docs/providers/google/dataplex/attributes/index.md @@ -27,14 +27,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `dataAttributes` | `array` | DataAttributes under the given parent DataTaxonomy. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `unreachableLocations` | `array` | Locations that could not be reached. | +| `name` | `string` | Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}. | +| `description` | `string` | Optional. Description of the DataAttribute. | +| `resourceAccessSpec` | `object` | ResourceAccessSpec holds the access control configuration to be enforced on the resources, for example, Cloud Storage bucket, BigQuery dataset, BigQuery table. | +| `dataAccessSpec` | `object` | DataAccessSpec holds the access control configuration to be enforced on data stored within resources (eg: rows, columns in BigQuery Tables). When associated with data, the data is only accessible to principals explicitly granted access through the DataAccessSpec. Principals with access to the containing resource are not implicitly granted access. | +| `displayName` | `string` | Optional. User friendly display name. | +| `updateTime` | `string` | Output only. The time when the DataAttribute was last updated. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `labels` | `object` | Optional. User-defined labels for the DataAttribute. | +| `uid` | `string` | Output only. System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name. | +| `parentId` | `string` | Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4 | +| `attributeCount` | `integer` | Output only. The number of child attributes present for this attribute. | +| `createTime` | `string` | Output only. The time when the DataAttribute was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_data_taxonomies_attributes_list` | `SELECT` | `dataTaxonomiesId, locationsId, projectsId` | Lists Data Attribute resources in a DataTaxonomy. | | `projects_locations_data_taxonomies_attributes_create` | `INSERT` | `dataTaxonomiesId, locationsId, projectsId` | Create a DataAttribute resource. | | `projects_locations_data_taxonomies_attributes_delete` | `DELETE` | `attributesId, dataTaxonomiesId, locationsId, projectsId` | Deletes a Data Attribute resource. | +| `_projects_locations_data_taxonomies_attributes_list` | `EXEC` | `dataTaxonomiesId, locationsId, projectsId` | Lists Data Attribute resources in a DataTaxonomy. | | `projects_locations_data_taxonomies_attributes_get` | `EXEC` | `attributesId, dataTaxonomiesId, locationsId, projectsId` | Retrieves a Data Attribute resource. | | `projects_locations_data_taxonomies_attributes_patch` | `EXEC` | `attributesId, dataTaxonomiesId, locationsId, projectsId` | Updates a DataAttribute resource. | diff --git a/docs/google-docs/providers/google/dataplex/attributes_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/attributes_iam_policies/index.md index 2b00ea8135..9362f6b88e 100644 --- a/docs/google-docs/providers/google/dataplex/attributes_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/attributes_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/content/index.md b/docs/google-docs/providers/google/dataplex/content/index.md index b09c362d28..af419a2f4e 100644 --- a/docs/google-docs/providers/google/dataplex/content/index.md +++ b/docs/google-docs/providers/google/dataplex/content/index.md @@ -27,13 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `content` | `array` | Content under the given parent lake. | +| `name` | `string` | Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} | +| `description` | `string` | Optional. Description of the content. | +| `path` | `string` | Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes. | +| `updateTime` | `string` | Output only. The time when the content was last updated. | +| `sqlScript` | `object` | Configuration for the Sql Script content. | +| `uid` | `string` | Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name. | +| `createTime` | `string` | Output only. Content creation time. | +| `labels` | `object` | Optional. User defined labels for the content. | +| `dataText` | `string` | Required. Content data in string format. | +| `notebook` | `object` | Configuration for Notebook content. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_lakes_content_list` | `SELECT` | `lakesId, locationsId, projectsId` | List content. | | `projects_locations_lakes_content_create` | `INSERT` | `lakesId, locationsId, projectsId` | Create a content. | | `projects_locations_lakes_content_delete` | `DELETE` | `contentId, lakesId, locationsId, projectsId` | Delete a content. | +| `_projects_locations_lakes_content_list` | `EXEC` | `lakesId, locationsId, projectsId` | List content. | | `projects_locations_lakes_content_get` | `EXEC` | `contentId, lakesId, locationsId, projectsId` | Get a content resource. | | `projects_locations_lakes_content_patch` | `EXEC` | `contentId, lakesId, locationsId, projectsId` | Update a content. Only supports full resource update. | diff --git a/docs/google-docs/providers/google/dataplex/contentitems/index.md b/docs/google-docs/providers/google/dataplex/contentitems/index.md index df71948fa7..526569c3f1 100644 --- a/docs/google-docs/providers/google/dataplex/contentitems/index.md +++ b/docs/google-docs/providers/google/dataplex/contentitems/index.md @@ -27,13 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `content` | `array` | Content under the given parent lake. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} | +| `description` | `string` | Optional. Description of the content. | +| `path` | `string` | Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes. | +| `dataText` | `string` | Required. Content data in string format. | +| `updateTime` | `string` | Output only. The time when the content was last updated. | +| `sqlScript` | `object` | Configuration for the Sql Script content. | +| `createTime` | `string` | Output only. Content creation time. | +| `labels` | `object` | Optional. User defined labels for the content. | +| `notebook` | `object` | Configuration for Notebook content. | +| `uid` | `string` | Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_lakes_contentitems_list` | `SELECT` | `lakesId, locationsId, projectsId` | List content. | | `projects_locations_lakes_contentitems_create` | `INSERT` | `lakesId, locationsId, projectsId` | Create a content. | | `projects_locations_lakes_contentitems_delete` | `DELETE` | `contentitemsId, lakesId, locationsId, projectsId` | Delete a content. | +| `_projects_locations_lakes_contentitems_list` | `EXEC` | `lakesId, locationsId, projectsId` | List content. | | `projects_locations_lakes_contentitems_get` | `EXEC` | `contentitemsId, lakesId, locationsId, projectsId` | Get a content resource. | | `projects_locations_lakes_contentitems_patch` | `EXEC` | `contentitemsId, lakesId, locationsId, projectsId` | Update a content. Only supports full resource update. | diff --git a/docs/google-docs/providers/google/dataplex/contentitems_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/contentitems_iam_policies/index.md index 26ee6082d2..7b042c0bd2 100644 --- a/docs/google-docs/providers/google/dataplex/contentitems_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/contentitems_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/data_attribute_bindings/index.md b/docs/google-docs/providers/google/dataplex/data_attribute_bindings/index.md index 73620250e9..ce708db7d9 100644 --- a/docs/google-docs/providers/google/dataplex/data_attribute_bindings/index.md +++ b/docs/google-docs/providers/google/dataplex/data_attribute_bindings/index.md @@ -27,14 +27,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `dataAttributeBindings` | `array` | DataAttributeBindings under the given parent Location. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `unreachableLocations` | `array` | Locations that could not be reached. | +| `name` | `string` | Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id} | +| `description` | `string` | Optional. Description of the DataAttributeBinding. | +| `labels` | `object` | Optional. User-defined labels for the DataAttributeBinding. | +| `paths` | `array` | Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings. | +| `attributes` | `array` | Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id} | +| `displayName` | `string` | Optional. User friendly display name. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method. | +| `createTime` | `string` | Output only. The time when the DataAttributeBinding was created. | +| `resource` | `string` | Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource. | +| `updateTime` | `string` | Output only. The time when the DataAttributeBinding was last updated. | +| `uid` | `string` | Output only. System generated globally unique ID for the DataAttributeBinding. This ID will be different if the DataAttributeBinding is deleted and re-created with the same name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_data_attribute_bindings_list` | `SELECT` | `locationsId, projectsId` | Lists DataAttributeBinding resources in a project and location. | | `projects_locations_data_attribute_bindings_create` | `INSERT` | `locationsId, projectsId` | Create a DataAttributeBinding resource. | | `projects_locations_data_attribute_bindings_delete` | `DELETE` | `dataAttributeBindingsId, locationsId, projectsId` | Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted. | +| `_projects_locations_data_attribute_bindings_list` | `EXEC` | `locationsId, projectsId` | Lists DataAttributeBinding resources in a project and location. | | `projects_locations_data_attribute_bindings_get` | `EXEC` | `dataAttributeBindingsId, locationsId, projectsId` | Retrieves a DataAttributeBinding resource. | | `projects_locations_data_attribute_bindings_patch` | `EXEC` | `dataAttributeBindingsId, locationsId, projectsId` | Updates a DataAttributeBinding resource. | diff --git a/docs/google-docs/providers/google/dataplex/data_scans/index.md b/docs/google-docs/providers/google/dataplex/data_scans/index.md index 0116ecbf9e..908cea1d60 100644 --- a/docs/google-docs/providers/google/dataplex/data_scans/index.md +++ b/docs/google-docs/providers/google/dataplex/data_scans/index.md @@ -27,15 +27,29 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `dataScans` | `array` | DataScans (BASIC view only) under the given parent location. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region. | +| `description` | `string` | Optional. Description of the scan. Must be between 1-1024 characters. | +| `state` | `string` | Output only. Current state of the DataScan. | +| `dataQualityResult` | `object` | The output of a DataQualityScan. | +| `executionSpec` | `object` | DataScan execution settings. | +| `dataProfileResult` | `object` | DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. | +| `uid` | `string` | Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name. | +| `dataProfileSpec` | `object` | DataProfileScan related setting. | +| `labels` | `object` | Optional. User-defined labels for the scan. | +| `displayName` | `string` | Optional. User friendly display name. Must be between 1-256 characters. | +| `createTime` | `string` | Output only. The time when the scan was created. | +| `executionStatus` | `object` | Status of the data scan execution. | +| `data` | `object` | The data source for DataScan. | +| `type` | `string` | Output only. The type of DataScan. | +| `updateTime` | `string` | Output only. The time when the scan was last updated. | +| `dataQualitySpec` | `object` | DataQualityScan related setting. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_data_scans_list` | `SELECT` | `locationsId, projectsId` | Lists DataScans. | | `projects_locations_data_scans_create` | `INSERT` | `locationsId, projectsId` | Creates a DataScan resource. | | `projects_locations_data_scans_delete` | `DELETE` | `dataScansId, locationsId, projectsId` | Deletes a DataScan resource. | +| `_projects_locations_data_scans_list` | `EXEC` | `locationsId, projectsId` | Lists DataScans. | | `projects_locations_data_scans_get` | `EXEC` | `dataScansId, locationsId, projectsId` | Gets a DataScan resource. | | `projects_locations_data_scans_patch` | `EXEC` | `dataScansId, locationsId, projectsId` | Updates a DataScan resource. | | `projects_locations_data_scans_run` | `EXEC` | `dataScansId, locationsId, projectsId` | Runs an on-demand execution of a DataScan | diff --git a/docs/google-docs/providers/google/dataplex/data_scans_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/data_scans_iam_policies/index.md index 18b00089bd..10610ee667 100644 --- a/docs/google-docs/providers/google/dataplex/data_scans_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/data_scans_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/data_taxonomies/index.md b/docs/google-docs/providers/google/dataplex/data_taxonomies/index.md index 8a70255d63..9fa1e6212c 100644 --- a/docs/google-docs/providers/google/dataplex/data_taxonomies/index.md +++ b/docs/google-docs/providers/google/dataplex/data_taxonomies/index.md @@ -27,14 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachableLocations` | `array` | Locations that could not be reached. | -| `dataTaxonomies` | `array` | DataTaxonomies under the given parent location. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}. | +| `description` | `string` | Optional. Description of the DataTaxonomy. | +| `classCount` | `integer` | Output only. The number of classes in the DataTaxonomy. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `updateTime` | `string` | Output only. The time when the DataTaxonomy was last updated. | +| `createTime` | `string` | Output only. The time when the DataTaxonomy was created. | +| `labels` | `object` | Optional. User-defined labels for the DataTaxonomy. | +| `attributeCount` | `integer` | Output only. The number of attributes in the DataTaxonomy. | +| `displayName` | `string` | Optional. User friendly display name. | +| `uid` | `string` | Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_data_taxonomies_list` | `SELECT` | `locationsId, projectsId` | Lists DataTaxonomy resources in a project and location. | | `projects_locations_data_taxonomies_create` | `INSERT` | `locationsId, projectsId` | Create a DataTaxonomy resource. | | `projects_locations_data_taxonomies_delete` | `DELETE` | `dataTaxonomiesId, locationsId, projectsId` | Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted. | +| `_projects_locations_data_taxonomies_list` | `EXEC` | `locationsId, projectsId` | Lists DataTaxonomy resources in a project and location. | | `projects_locations_data_taxonomies_get` | `EXEC` | `dataTaxonomiesId, locationsId, projectsId` | Retrieves a DataTaxonomy resource. | | `projects_locations_data_taxonomies_patch` | `EXEC` | `dataTaxonomiesId, locationsId, projectsId` | Updates a DataTaxonomy resource. | diff --git a/docs/google-docs/providers/google/dataplex/entities/index.md b/docs/google-docs/providers/google/dataplex/entities/index.md index 3239a78adc..d02387c009 100644 --- a/docs/google-docs/providers/google/dataplex/entities/index.md +++ b/docs/google-docs/providers/google/dataplex/entities/index.md @@ -30,21 +30,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters. | | `name` | `string` | Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}. | | `description` | `string` | Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters. | -| `asset` | `string` | Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset. | -| `displayName` | `string` | Optional. Display name must be shorter than or equal to 256 characters. | -| `dataPath` | `string` | Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id. | -| `etag` | `string` | Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests. | +| `createTime` | `string` | Output only. The time when the entity was created. | +| `schema` | `object` | Schema information describing the structure and layout of the data. | +| `type` | `string` | Required. Immutable. The type of entity. | +| `catalogEntry` | `string` | Output only. The name of the associated Data Catalog entry. | | `dataPathPattern` | `string` | Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv. | +| `compatibility` | `object` | Provides compatibility information for various metadata stores. | | `access` | `object` | Describes the access mechanism of the data within its storage location. | | `format` | `object` | Describes the format of the data within its storage location. | +| `asset` | `string` | Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset. | +| `dataPath` | `string` | Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id. | | `system` | `string` | Required. Immutable. Identifies the storage system of the entity data. | | `uid` | `string` | Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name. | -| `createTime` | `string` | Output only. The time when the entity was created. | +| `displayName` | `string` | Optional. Display name must be shorter than or equal to 256 characters. | +| `etag` | `string` | Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests. | | `updateTime` | `string` | Output only. The time when the entity was last updated. | -| `catalogEntry` | `string` | Output only. The name of the associated Data Catalog entry. | -| `schema` | `object` | Schema information describing the structure and layout of the data. | -| `type` | `string` | Required. Immutable. The type of entity. | -| `compatibility` | `object` | Provides compatibility information for various metadata stores. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -52,4 +52,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_lakes_zones_entities_list` | `SELECT` | `lakesId, locationsId, projectsId, zonesId` | List metadata entities in a zone. | | `projects_locations_lakes_zones_entities_create` | `INSERT` | `lakesId, locationsId, projectsId, zonesId` | Create a metadata entity. | | `projects_locations_lakes_zones_entities_delete` | `DELETE` | `entitiesId, lakesId, locationsId, projectsId, zonesId` | Delete a metadata entity. | +| `_projects_locations_lakes_zones_entities_list` | `EXEC` | `lakesId, locationsId, projectsId, zonesId` | List metadata entities in a zone. | | `projects_locations_lakes_zones_entities_update` | `EXEC` | `entitiesId, lakesId, locationsId, projectsId, zonesId` | Update a metadata entity. Only supports full resource update. | diff --git a/docs/google-docs/providers/google/dataplex/entry_groups_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/entry_groups_iam_policies/index.md index 4d969e7b38..945ff5d115 100644 --- a/docs/google-docs/providers/google/dataplex/entry_groups_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/entry_groups_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | -| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/entry_types_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/entry_types_iam_policies/index.md index 1c322b65a8..df6eda792a 100644 --- a/docs/google-docs/providers/google/dataplex/entry_types_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/entry_types_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | -| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/environments/index.md b/docs/google-docs/providers/google/dataplex/environments/index.md index cb63b723a2..a3edcccb9f 100644 --- a/docs/google-docs/providers/google/dataplex/environments/index.md +++ b/docs/google-docs/providers/google/dataplex/environments/index.md @@ -27,13 +27,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `environments` | `array` | Environments under the given parent lake. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id} | +| `description` | `string` | Optional. Description of the environment. | +| `endpoints` | `object` | URI Endpoints to access sessions associated with the Environment. | +| `state` | `string` | Output only. Current state of the environment. | +| `uid` | `string` | Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name. | +| `updateTime` | `string` | Output only. The time when the environment was last updated. | +| `sessionSpec` | `object` | Configuration for sessions created for this environment. | +| `labels` | `object` | Optional. User defined labels for the environment. | +| `createTime` | `string` | Output only. Environment creation time. | +| `infrastructureSpec` | `object` | Configuration for the underlying infrastructure used to run workloads. | +| `sessionStatus` | `object` | Status of sessions created for this environment. | +| `displayName` | `string` | Optional. User friendly display name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_lakes_environments_list` | `SELECT` | `lakesId, locationsId, projectsId` | Lists environments under the given lake. | | `projects_locations_lakes_environments_create` | `INSERT` | `lakesId, locationsId, projectsId` | Create an environment resource. | | `projects_locations_lakes_environments_delete` | `DELETE` | `environmentsId, lakesId, locationsId, projectsId` | Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated. | +| `_projects_locations_lakes_environments_list` | `EXEC` | `lakesId, locationsId, projectsId` | Lists environments under the given lake. | | `projects_locations_lakes_environments_get` | `EXEC` | `environmentsId, lakesId, locationsId, projectsId` | Get environment resource. | | `projects_locations_lakes_environments_patch` | `EXEC` | `environmentsId, lakesId, locationsId, projectsId` | Update the environment resource. | diff --git a/docs/google-docs/providers/google/dataplex/environments_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/environments_iam_policies/index.md index 107d8752dc..91e2e0583f 100644 --- a/docs/google-docs/providers/google/dataplex/environments_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/environments_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/index.md b/docs/google-docs/providers/google/dataplex/index.md index 9c6c35f7d8..d36ca4e57c 100644 --- a/docs/google-docs/providers/google/dataplex/index.md +++ b/docs/google-docs/providers/google/dataplex/index.md @@ -21,7 +21,7 @@ Dataplex API Is Used To Manage The Lifecycle Of Data Lakes.
total resources: 32
total selectable resources: 32
-total methods: 123
+total methods: 144
@@ -33,7 +33,7 @@ Dataplex API Is Used To Manage The Lifecycle Of Data Lakes. TypeService TitleCloud Dataplex API DescriptionDataplex API Is Used To Manage The Lifecycle Of Data Lakes. -Iddataplex:v23.08.00155 +Iddataplex:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/dataplex/jobs/index.md b/docs/google-docs/providers/google/dataplex/jobs/index.md index 81dc739b34..11082dcb76 100644 --- a/docs/google-docs/providers/google/dataplex/jobs/index.md +++ b/docs/google-docs/providers/google/dataplex/jobs/index.md @@ -27,13 +27,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `jobs` | `array` | Jobs under a given task. | +| `name` | `string` | Output only. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a GCP region. | +| `dataQualityResult` | `object` | The output of a DataQualityScan. | +| `message` | `string` | Output only. Additional information about the current state. | +| `dataProfileSpec` | `object` | DataProfileScan related setting. | +| `startTime` | `string` | Output only. The time when the DataScanJob was started. | +| `state` | `string` | Output only. Execution state for the DataScanJob. | +| `dataProfileResult` | `object` | DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. | +| `type` | `string` | Output only. The type of the parent DataScan. | +| `dataQualitySpec` | `object` | DataQualityScan related setting. | +| `endTime` | `string` | Output only. The time when the DataScanJob ended. | +| `uid` | `string` | Output only. System generated globally unique ID for the DataScanJob. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_data_scans_jobs_get` | `SELECT` | `dataScansId, jobsId, locationsId, projectsId` | Gets a DataScanJob resource. | | `projects_locations_data_scans_jobs_list` | `SELECT` | `dataScansId, locationsId, projectsId` | Lists DataScanJobs under the given DataScan. | | `projects_locations_lakes_tasks_jobs_list` | `SELECT` | `lakesId, locationsId, projectsId, tasksId` | Lists Jobs under the given task. | +| `_projects_locations_data_scans_jobs_list` | `EXEC` | `dataScansId, locationsId, projectsId` | Lists DataScanJobs under the given DataScan. | +| `_projects_locations_lakes_tasks_jobs_list` | `EXEC` | `lakesId, locationsId, projectsId, tasksId` | Lists Jobs under the given task. | | `projects_locations_lakes_tasks_jobs_cancel` | `EXEC` | `jobsId, lakesId, locationsId, projectsId, tasksId` | Cancel jobs running for the task resource. | | `projects_locations_lakes_tasks_jobs_get` | `EXEC` | `jobsId, lakesId, locationsId, projectsId, tasksId` | Get job resource. | diff --git a/docs/google-docs/providers/google/dataplex/lakes/index.md b/docs/google-docs/providers/google/dataplex/lakes/index.md index ff5b5e685b..20dce3693a 100644 --- a/docs/google-docs/providers/google/dataplex/lakes/index.md +++ b/docs/google-docs/providers/google/dataplex/lakes/index.md @@ -27,14 +27,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachableLocations` | `array` | Locations that could not be reached. | -| `lakes` | `array` | Lakes under the given parent location. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. | +| `description` | `string` | Optional. Description of the lake. | +| `createTime` | `string` | Output only. The time when the lake was created. | +| `uid` | `string` | Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name. | +| `labels` | `object` | Optional. User-defined labels for the lake. | +| `assetStatus` | `object` | Aggregated status of the underlying assets of a lake or zone. | +| `serviceAccount` | `string` | Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake. | +| `state` | `string` | Output only. Current state of the lake. | +| `updateTime` | `string` | Output only. The time when the lake was last updated. | +| `displayName` | `string` | Optional. User friendly display name. | +| `metastore` | `object` | Settings to manage association of Dataproc Metastore with a lake. | +| `metastoreStatus` | `object` | Status of Lake and Dataproc Metastore service instance association. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_lakes_list` | `SELECT` | `locationsId, projectsId` | Lists lake resources in a project and location. | | `projects_locations_lakes_create` | `INSERT` | `locationsId, projectsId` | Creates a lake resource. | | `projects_locations_lakes_delete` | `DELETE` | `lakesId, locationsId, projectsId` | Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted. | +| `_projects_locations_lakes_list` | `EXEC` | `locationsId, projectsId` | Lists lake resources in a project and location. | | `projects_locations_lakes_get` | `EXEC` | `lakesId, locationsId, projectsId` | Retrieves a lake resource. | | `projects_locations_lakes_patch` | `EXEC` | `lakesId, locationsId, projectsId` | Updates a lake resource. | diff --git a/docs/google-docs/providers/google/dataplex/lakes_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/lakes_iam_policies/index.md index 5d47d57bae..6e69884aa8 100644 --- a/docs/google-docs/providers/google/dataplex/lakes_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/lakes_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/locations/index.md b/docs/google-docs/providers/google/dataplex/locations/index.md index 7c79a270a5..148bb7336a 100644 --- a/docs/google-docs/providers/google/dataplex/locations/index.md +++ b/docs/google-docs/providers/google/dataplex/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1" | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: "us-east1". | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/dataplex/operations/index.md b/docs/google-docs/providers/google/dataplex/operations/index.md index 276585ce08..1992d5d053 100644 --- a/docs/google-docs/providers/google/dataplex/operations/index.md +++ b/docs/google-docs/providers/google/dataplex/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}. | +| `response` | `object` | The normal response of the operation in case of success. 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. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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. | +| `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | | `projects_locations_operations_get` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/dataplex/partitions/index.md b/docs/google-docs/providers/google/dataplex/partitions/index.md index b27c121011..1814f13a75 100644 --- a/docs/google-docs/providers/google/dataplex/partitions/index.md +++ b/docs/google-docs/providers/google/dataplex/partitions/index.md @@ -27,8 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no remaining results in the list. | -| `partitions` | `array` | Partitions under the specified parent entity. | +| `name` | `string` | Output only. Partition values used in the HTTP URL must be double encoded. For example, url_encode(url_encode(value)) can be used to encode "US:CA/CA#Sunnyvale so that the request URL ends with "/partitions/US%253ACA/CA%2523Sunnyvale". The name field in the response retains the encoded format. | +| `values` | `array` | Required. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity. | +| `etag` | `string` | Optional. The etag for this partition. | +| `location` | `string` | Required. Immutable. The location of the entity data within the partition, for example, gs://bucket/path/to/entity/key1=value1/key2=value2. Or projects//datasets//tables/ | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,3 +38,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_lakes_zones_entities_partitions_list` | `SELECT` | `entitiesId, lakesId, locationsId, projectsId, zonesId` | List metadata partitions of an entity. | | `projects_locations_lakes_zones_entities_partitions_create` | `INSERT` | `entitiesId, lakesId, locationsId, projectsId, zonesId` | Create a metadata partition. | | `projects_locations_lakes_zones_entities_partitions_delete` | `DELETE` | `entitiesId, lakesId, locationsId, partitionsId, projectsId, zonesId` | Delete a metadata partition. | +| `_projects_locations_lakes_zones_entities_partitions_list` | `EXEC` | `entitiesId, lakesId, locationsId, projectsId, zonesId` | List metadata partitions of an entity. | diff --git a/docs/google-docs/providers/google/dataplex/sessions/index.md b/docs/google-docs/providers/google/dataplex/sessions/index.md index 80b6b38c7e..71be16816e 100644 --- a/docs/google-docs/providers/google/dataplex/sessions/index.md +++ b/docs/google-docs/providers/google/dataplex/sessions/index.md @@ -27,9 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `sessions` | `array` | Sessions under a given environment. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}/sessions/{session_id} | +| `state` | `string` | Output only. State of Session | +| `userId` | `string` | Output only. Email of user running the session. | +| `createTime` | `string` | Output only. Session start time. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_locations_lakes_environments_sessions_list` | `SELECT` | `environmentsId, lakesId, locationsId, projectsId` | +| `_projects_locations_lakes_environments_sessions_list` | `EXEC` | `environmentsId, lakesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/tasks/index.md b/docs/google-docs/providers/google/dataplex/tasks/index.md index 7065d4e533..087d4174d9 100644 --- a/docs/google-docs/providers/google/dataplex/tasks/index.md +++ b/docs/google-docs/providers/google/dataplex/tasks/index.md @@ -27,15 +27,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `tasks` | `array` | Tasks under the given parent lake. | -| `unreachableLocations` | `array` | Locations that could not be reached. | +| `name` | `string` | Output only. The relative resource name of the task, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}. | +| `description` | `string` | Optional. Description of the task. | +| `executionSpec` | `object` | Execution related settings, like retry and service_account. | +| `executionStatus` | `object` | Status of the task execution (e.g. Jobs). | +| `notebook` | `object` | Config for running scheduled notebooks. | +| `spark` | `object` | User-specified config for running a Spark task. | +| `updateTime` | `string` | Output only. The time when the task was last updated. | +| `triggerSpec` | `object` | Task scheduling and trigger settings. | +| `displayName` | `string` | Optional. User friendly display name. | +| `state` | `string` | Output only. Current state of the task. | +| `uid` | `string` | Output only. System generated globally unique ID for the task. This ID will be different if the task is deleted and re-created with the same name. | +| `createTime` | `string` | Output only. The time when the task was created. | +| `labels` | `object` | Optional. User-defined labels for the task. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_lakes_tasks_list` | `SELECT` | `lakesId, locationsId, projectsId` | Lists tasks under the given lake. | | `projects_locations_lakes_tasks_create` | `INSERT` | `lakesId, locationsId, projectsId` | Creates a task resource within a lake. | | `projects_locations_lakes_tasks_delete` | `DELETE` | `lakesId, locationsId, projectsId, tasksId` | Delete the task resource. | +| `_projects_locations_lakes_tasks_list` | `EXEC` | `lakesId, locationsId, projectsId` | Lists tasks under the given lake. | | `projects_locations_lakes_tasks_get` | `EXEC` | `lakesId, locationsId, projectsId, tasksId` | Get task resource. | | `projects_locations_lakes_tasks_patch` | `EXEC` | `lakesId, locationsId, projectsId, tasksId` | Update the task resource. | | `projects_locations_lakes_tasks_run` | `EXEC` | `lakesId, locationsId, projectsId, tasksId` | Run an on demand execution of a Task. | diff --git a/docs/google-docs/providers/google/dataplex/tasks_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/tasks_iam_policies/index.md index 3c3fe0034e..beea288259 100644 --- a/docs/google-docs/providers/google/dataplex/tasks_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/tasks_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/zones/index.md b/docs/google-docs/providers/google/dataplex/zones/index.md index 6c30d1588c..ed806a6fb6 100644 --- a/docs/google-docs/providers/google/dataplex/zones/index.md +++ b/docs/google-docs/providers/google/dataplex/zones/index.md @@ -27,13 +27,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `zones` | `array` | Zones under the given parent lake. | +| `name` | `string` | Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. | +| `description` | `string` | Optional. Description of the zone. | +| `createTime` | `string` | Output only. The time when the zone was created. | +| `uid` | `string` | Output only. System generated globally unique ID for the zone. This ID will be different if the zone is deleted and re-created with the same name. | +| `updateTime` | `string` | Output only. The time when the zone was last updated. | +| `assetStatus` | `object` | Aggregated status of the underlying assets of a lake or zone. | +| `discoverySpec` | `object` | Settings to manage the metadata discovery and publishing in a zone. | +| `displayName` | `string` | Optional. User friendly display name. | +| `labels` | `object` | Optional. User defined labels for the zone. | +| `type` | `string` | Required. Immutable. The type of the zone. | +| `resourceSpec` | `object` | Settings for resources attached as assets within a zone. | +| `state` | `string` | Output only. Current state of the zone. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_lakes_zones_list` | `SELECT` | `lakesId, locationsId, projectsId` | Lists zone resources in a lake. | | `projects_locations_lakes_zones_create` | `INSERT` | `lakesId, locationsId, projectsId` | Creates a zone resource within a lake. | | `projects_locations_lakes_zones_delete` | `DELETE` | `lakesId, locationsId, projectsId, zonesId` | Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted. | +| `_projects_locations_lakes_zones_list` | `EXEC` | `lakesId, locationsId, projectsId` | Lists zone resources in a lake. | | `projects_locations_lakes_zones_get` | `EXEC` | `lakesId, locationsId, projectsId, zonesId` | Retrieves a zone resource. | | `projects_locations_lakes_zones_patch` | `EXEC` | `lakesId, locationsId, projectsId, zonesId` | Updates a zone resource. | diff --git a/docs/google-docs/providers/google/dataplex/zones_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/zones_iam_policies/index.md index ece8f00cda..34dcb66ccb 100644 --- a/docs/google-docs/providers/google/dataplex/zones_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/zones_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataproc/autoscaling_policies/index.md b/docs/google-docs/providers/google/dataproc/autoscaling_policies/index.md index c13be1ff4b..074bdb5d27 100644 --- a/docs/google-docs/providers/google/dataproc/autoscaling_policies/index.md +++ b/docs/google-docs/providers/google/dataproc/autoscaling_policies/index.md @@ -27,8 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Output only. This token is included in the response if there are more results to fetch. | -| `policies` | `array` | Output only. Autoscaling policies list. | +| `id` | `string` | Required. The policy id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters. | +| `name` | `string` | Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} | +| `workerConfig` | `object` | Configuration for the size bounds of an instance group, including its proportional size to other groups. | +| `basicAlgorithm` | `object` | Basic algorithm for autoscaling. | +| `labels` | `object` | Optional. The labels to associate with this autoscaling policy. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with an autoscaling policy. | +| `secondaryWorkerConfig` | `object` | Configuration for the size bounds of an instance group, including its proportional size to other groups. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,6 +42,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_regions_autoscaling_policies_create` | `INSERT` | `projectsId, regionsId` | Creates new autoscaling policy. | | `projects_locations_autoscaling_policies_delete` | `DELETE` | `autoscalingPoliciesId, locationsId, projectsId` | Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters. | | `projects_regions_autoscaling_policies_delete` | `DELETE` | `autoscalingPoliciesId, projectsId, regionsId` | Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters. | +| `_projects_locations_autoscaling_policies_list` | `EXEC` | `locationsId, projectsId` | Lists autoscaling policies in the project. | +| `_projects_regions_autoscaling_policies_list` | `EXEC` | `projectsId, regionsId` | Lists autoscaling policies in the project. | | `projects_locations_autoscaling_policies_get` | `EXEC` | `autoscalingPoliciesId, locationsId, projectsId` | Retrieves autoscaling policy. | | `projects_locations_autoscaling_policies_update` | `EXEC` | `autoscalingPoliciesId, locationsId, projectsId` | Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements. | | `projects_regions_autoscaling_policies_get` | `EXEC` | `autoscalingPoliciesId, projectsId, regionsId` | Retrieves autoscaling policy. | diff --git a/docs/google-docs/providers/google/dataproc/autoscaling_policies_iam_policies/index.md b/docs/google-docs/providers/google/dataproc/autoscaling_policies_iam_policies/index.md index b4f5a0693e..ecc8e76393 100644 --- a/docs/google-docs/providers/google/dataproc/autoscaling_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataproc/autoscaling_policies_iam_policies/index.md @@ -25,13 +25,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_locations_autoscaling_policies_get_iam_policy` | `EXEC` | `autoscalingPoliciesId, locationsId, projectsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | +| `projects_locations_autoscaling_policies_get_iam_policy` | `SELECT` | `autoscalingPoliciesId, locationsId, projectsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | +| `projects_regions_autoscaling_policies_get_iam_policy` | `SELECT` | `autoscalingPoliciesId, projectsId, regionsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | | `projects_locations_autoscaling_policies_set_iam_policy` | `EXEC` | `autoscalingPoliciesId, locationsId, projectsId` | Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. | | `projects_locations_autoscaling_policies_test_iam_permissions` | `EXEC` | `autoscalingPoliciesId, locationsId, projectsId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | -| `projects_regions_autoscaling_policies_get_iam_policy` | `EXEC` | `autoscalingPoliciesId, projectsId, regionsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | | `projects_regions_autoscaling_policies_set_iam_policy` | `EXEC` | `autoscalingPoliciesId, projectsId, regionsId` | Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. | | `projects_regions_autoscaling_policies_test_iam_permissions` | `EXEC` | `autoscalingPoliciesId, projectsId, regionsId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | diff --git a/docs/google-docs/providers/google/dataproc/batches/index.md b/docs/google-docs/providers/google/dataproc/batches/index.md index b3ece1f564..029dde740a 100644 --- a/docs/google-docs/providers/google/dataproc/batches/index.md +++ b/docs/google-docs/providers/google/dataproc/batches/index.md @@ -27,12 +27,28 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `batches` | `array` | Output only. The batches from the specified collection. | -| `nextPageToken` | `string` | A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Output only. The resource name of the batch. | +| `uuid` | `string` | Output only. A batch UUID (Unique Universal Identifier). The service generates this value when it creates the batch. | +| `operation` | `string` | Output only. The resource name of the operation associated with this batch. | +| `sparkSqlBatch` | `object` | A configuration for running Apache Spark SQL (https://spark.apache.org/sql/) queries as a batch workload. | +| `state` | `string` | Output only. The state of the batch. | +| `sparkBatch` | `object` | A configuration for running an Apache Spark (https://spark.apache.org/) batch workload. | +| `pysparkBatch` | `object` | A configuration for running an Apache PySpark (https://spark.apache.org/docs/latest/api/python/getting_started/quickstart.html) batch workload. | +| `runtimeInfo` | `object` | Runtime information about workload execution. | +| `runtimeConfig` | `object` | Runtime configuration for a workload. | +| `environmentConfig` | `object` | Environment configuration for a workload. | +| `stateHistory` | `array` | Output only. Historical state information for the batch. | +| `createTime` | `string` | Output only. The time when the batch was created. | +| `labels` | `object` | Optional. The labels to associate with this batch. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a batch. | +| `creator` | `string` | Output only. The email address of the user who created the batch. | +| `stateTime` | `string` | Output only. The time when the batch entered a current state. | +| `stateMessage` | `string` | Output only. Batch state details, such as a failure description if the state is FAILED. | +| `sparkRBatch` | `object` | A configuration for running an Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) batch workload. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_batches_list` | `SELECT` | `locationsId, projectsId` | Lists batch workloads. | | `projects_locations_batches_create` | `INSERT` | `locationsId, projectsId` | Creates a batch workload that executes asynchronously. | | `projects_locations_batches_delete` | `DELETE` | `batchesId, locationsId, projectsId` | Deletes the batch workload resource. If the batch is not in a CANCELLED, SUCCEEDED or FAILED State, the delete operation fails and the response returns FAILED_PRECONDITION. | +| `_projects_locations_batches_list` | `EXEC` | `locationsId, projectsId` | Lists batch workloads. | | `projects_locations_batches_get` | `EXEC` | `batchesId, locationsId, projectsId` | Gets the batch workload resource representation. | diff --git a/docs/google-docs/providers/google/dataproc/clusters/index.md b/docs/google-docs/providers/google/dataproc/clusters/index.md index 659105955a..e23133c654 100644 --- a/docs/google-docs/providers/google/dataproc/clusters/index.md +++ b/docs/google-docs/providers/google/dataproc/clusters/index.md @@ -27,14 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListClustersRequest. | -| `clusters` | `array` | Output only. The clusters in the project. | +| `clusterName` | `string` | Required. The cluster name, which must be unique within a project. The name must start with a lowercase letter, and can contain up to 51 lowercase letters, numbers, and hyphens. It cannot end with a hyphen. The name of a deleted cluster can be reused. | +| `clusterUuid` | `string` | Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster. | +| `status` | `object` | The status of a cluster and its instances. | +| `config` | `object` | The cluster config. | +| `projectId` | `string` | Required. The Google Cloud Platform project ID that the cluster belongs to. | +| `virtualClusterConfig` | `object` | The Dataproc cluster config for a cluster that does not directly control the underlying compute resources, such as a Dataproc-on-GKE cluster (https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview). | +| `metrics` | `object` | Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. | +| `labels` | `object` | Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster. | +| `statusHistory` | `array` | Output only. The previous cluster status. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_regions_clusters_list` | `SELECT` | `projectId, region` | Lists all regions/{region}/clusters in a project alphabetically. | | `projects_regions_clusters_create` | `INSERT` | `projectId, region` | Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). | | `projects_regions_clusters_delete` | `DELETE` | `clusterName, projectId, region` | Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). | +| `_projects_regions_clusters_list` | `EXEC` | `projectId, region` | Lists all regions/{region}/clusters in a project alphabetically. | | `projects_regions_clusters_diagnose` | `EXEC` | `clusterName, projectId, region` | Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). After the operation completes, Operation.response contains DiagnoseClusterResults (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults). | | `projects_regions_clusters_get` | `EXEC` | `clusterName, projectId, region` | Gets the resource representation for a cluster in a project. | | `projects_regions_clusters_inject_credentials` | `EXEC` | `clustersId, projectsId, regionsId` | Inject encrypted credentials into all of the VMs in a cluster.The target cluster must be a personal auth cluster assigned to the user who is issuing the RPC. | diff --git a/docs/google-docs/providers/google/dataproc/clusters_iam_policies/index.md b/docs/google-docs/providers/google/dataproc/clusters_iam_policies/index.md index ac560452ce..3fd5f7aebb 100644 --- a/docs/google-docs/providers/google/dataproc/clusters_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataproc/clusters_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_regions_clusters_get_iam_policy` | `EXEC` | `clustersId, projectsId, regionsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | +| `projects_regions_clusters_get_iam_policy` | `SELECT` | `clustersId, projectsId, regionsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | | `projects_regions_clusters_set_iam_policy` | `EXEC` | `clustersId, projectsId, regionsId` | Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. | | `projects_regions_clusters_test_iam_permissions` | `EXEC` | `clustersId, projectsId, regionsId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | diff --git a/docs/google-docs/providers/google/dataproc/index.md b/docs/google-docs/providers/google/dataproc/index.md index 19e44f7b50..293596d897 100644 --- a/docs/google-docs/providers/google/dataproc/index.md +++ b/docs/google-docs/providers/google/dataproc/index.md @@ -20,8 +20,8 @@ Manages Hadoop-Based Clusters And Jobs On Google Cloud Platform.
total resources: 12
-total selectable resources: 6
-total methods: 77
+total selectable resources: 11
+total methods: 86
@@ -33,7 +33,7 @@ Manages Hadoop-Based Clusters And Jobs On Google Cloud Platform. TypeService TitleCloud Dataproc API DescriptionManages Hadoop-Based Clusters And Jobs On Google Cloud Platform. -Iddataproc:v23.08.00155 +Iddataproc:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/dataproc/jobs/index.md b/docs/google-docs/providers/google/dataproc/jobs/index.md index d177a9c8b6..98cfe2f5c0 100644 --- a/docs/google-docs/providers/google/dataproc/jobs/index.md +++ b/docs/google-docs/providers/google/dataproc/jobs/index.md @@ -27,13 +27,34 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `jobs` | `array` | Output only. Jobs list. | -| `nextPageToken` | `string` | Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListJobsRequest. | +| `driverOutputResourceUri` | `string` | Output only. A URI pointing to the location of the stdout of the job's driver program. | +| `sparkSqlJob` | `object` | A Dataproc job for running Apache Spark SQL (https://spark.apache.org/sql/) queries. | +| `driverControlFilesUri` | `string` | Output only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri. | +| `flinkJob` | `object` | A Dataproc job for running Apache Flink (https://flink.apache.org/) applications on YARN. | +| `jobUuid` | `string` | Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time. | +| `driverSchedulingConfig` | `object` | Driver scheduling configuration. | +| `hiveJob` | `object` | A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. | +| `prestoJob` | `object` | A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. | +| `hadoopJob` | `object` | A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). | +| `pigJob` | `object` | A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. | +| `done` | `boolean` | Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled. | +| `yarnApplications` | `array` | Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release. | +| `scheduling` | `object` | Job scheduling options. | +| `statusHistory` | `array` | Output only. The previous job status. | +| `reference` | `object` | Encapsulates the full scoping used to reference a job. | +| `status` | `object` | Dataproc job status. | +| `trinoJob` | `object` | A Dataproc job for running Trino (https://trino.io/) queries. IMPORTANT: The Dataproc Trino Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/trino) must be enabled when the cluster is created to submit a Trino job to the cluster. | +| `pysparkJob` | `object` | A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. | +| `sparkRJob` | `object` | A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. | +| `placement` | `object` | Dataproc job config. | +| `labels` | `object` | Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job. | +| `sparkJob` | `object` | A Dataproc job for running Apache Spark (https://spark.apache.org/) applications on YARN. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_regions_jobs_list` | `SELECT` | `projectId, region` | Lists regions/{region}/jobs in a project. | | `projects_regions_jobs_delete` | `DELETE` | `jobId, projectId, region` | Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION. | +| `_projects_regions_jobs_list` | `EXEC` | `projectId, region` | Lists regions/{region}/jobs in a project. | | `projects_regions_jobs_cancel` | `EXEC` | `jobId, projectId, region` | Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/list) or regions/{region}/jobs.get (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get). | | `projects_regions_jobs_get` | `EXEC` | `jobId, projectId, region` | Gets the resource representation for a job in a project. | | `projects_regions_jobs_patch` | `EXEC` | `jobId, projectId, region` | Updates a job in a project. | diff --git a/docs/google-docs/providers/google/dataproc/jobs_iam_policies/index.md b/docs/google-docs/providers/google/dataproc/jobs_iam_policies/index.md index 9aba29f0ea..1158f59d9d 100644 --- a/docs/google-docs/providers/google/dataproc/jobs_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataproc/jobs_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_regions_jobs_get_iam_policy` | `EXEC` | `jobsId, projectsId, regionsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | +| `projects_regions_jobs_get_iam_policy` | `SELECT` | `jobsId, projectsId, regionsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | | `projects_regions_jobs_set_iam_policy` | `EXEC` | `jobsId, projectsId, regionsId` | Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. | | `projects_regions_jobs_test_iam_permissions` | `EXEC` | `jobsId, projectsId, regionsId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | diff --git a/docs/google-docs/providers/google/dataproc/operations/index.md b/docs/google-docs/providers/google/dataproc/operations/index.md index 1879cdfe08..12d1712575 100644 --- a/docs/google-docs/providers/google/dataproc/operations/index.md +++ b/docs/google-docs/providers/google/dataproc/operations/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +39,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_regions_operations_list` | `SELECT` | `projectsId, regionsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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. | | `projects_regions_operations_delete` | `DELETE` | `operationsId, projectsId, regionsId` | 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. | +| `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | +| `_projects_regions_operations_list` | `EXEC` | `projectsId, regionsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | | `projects_locations_operations_get` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | | `projects_regions_operations_cancel` | `EXEC` | `operationsId, projectsId, regionsId` | 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. | diff --git a/docs/google-docs/providers/google/dataproc/operations_iam_policies/index.md b/docs/google-docs/providers/google/dataproc/operations_iam_policies/index.md index e74ea89175..0a9879fcdf 100644 --- a/docs/google-docs/providers/google/dataproc/operations_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataproc/operations_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | +| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_regions_operations_get_iam_policy` | `EXEC` | `operationsId, projectsId, regionsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | +| `projects_regions_operations_get_iam_policy` | `SELECT` | `operationsId, projectsId, regionsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | | `projects_regions_operations_set_iam_policy` | `EXEC` | `operationsId, projectsId, regionsId` | Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. | | `projects_regions_operations_test_iam_permissions` | `EXEC` | `operationsId, projectsId, regionsId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | diff --git a/docs/google-docs/providers/google/dataproc/workflow_templates/index.md b/docs/google-docs/providers/google/dataproc/workflow_templates/index.md index 81c33cdf54..108b182428 100644 --- a/docs/google-docs/providers/google/dataproc/workflow_templates/index.md +++ b/docs/google-docs/providers/google/dataproc/workflow_templates/index.md @@ -27,8 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `templates` | `array` | Output only. WorkflowTemplates list. | -| `nextPageToken` | `string` | Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListWorkflowTemplatesRequest. | +| `id` | `string` | | +| `name` | `string` | Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} | +| `createTime` | `string` | Output only. The time template was created. | +| `dagTimeout` | `string` | Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted. | +| `jobs` | `array` | Required. The Directed Acyclic Graph of Jobs to submit. | +| `parameters` | `array` | Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. | +| `updateTime` | `string` | Output only. The time template was last updated. | +| `labels` | `object` | Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template. | +| `version` | `integer` | Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request. | +| `placement` | `object` | Specifies workflow execution target.Either managed_cluster or cluster_selector is required. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,6 +46,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_regions_workflow_templates_create` | `INSERT` | `projectsId, regionsId` | Creates new workflow template. | | `projects_locations_workflow_templates_delete` | `DELETE` | `locationsId, projectsId, workflowTemplatesId` | Deletes a workflow template. It does not cancel in-progress workflows. | | `projects_regions_workflow_templates_delete` | `DELETE` | `projectsId, regionsId, workflowTemplatesId` | Deletes a workflow template. It does not cancel in-progress workflows. | +| `_projects_locations_workflow_templates_list` | `EXEC` | `locationsId, projectsId` | Lists workflows that match the specified filter in the request. | +| `_projects_regions_workflow_templates_list` | `EXEC` | `projectsId, regionsId` | Lists workflows that match the specified filter in the request. | | `projects_locations_workflow_templates_get` | `EXEC` | `locationsId, projectsId, workflowTemplatesId` | Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. | | `projects_locations_workflow_templates_instantiate` | `EXEC` | `locationsId, projectsId, workflowTemplatesId` | Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty. | | `projects_locations_workflow_templates_instantiate_inline` | `EXEC` | `locationsId, projectsId` | Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty. | diff --git a/docs/google-docs/providers/google/dataproc/workflow_templates_iam_policies/index.md b/docs/google-docs/providers/google/dataproc/workflow_templates_iam_policies/index.md index 440facea41..afc6294c2e 100644 --- a/docs/google-docs/providers/google/dataproc/workflow_templates_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataproc/workflow_templates_iam_policies/index.md @@ -25,13 +25,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_locations_workflow_templates_get_iam_policy` | `EXEC` | `locationsId, projectsId, workflowTemplatesId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | +| `projects_locations_workflow_templates_get_iam_policy` | `SELECT` | `locationsId, projectsId, workflowTemplatesId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | +| `projects_regions_workflow_templates_get_iam_policy` | `SELECT` | `projectsId, regionsId, workflowTemplatesId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | | `projects_locations_workflow_templates_set_iam_policy` | `EXEC` | `locationsId, projectsId, workflowTemplatesId` | Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. | | `projects_locations_workflow_templates_test_iam_permissions` | `EXEC` | `locationsId, projectsId, workflowTemplatesId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | -| `projects_regions_workflow_templates_get_iam_policy` | `EXEC` | `projectsId, regionsId, workflowTemplatesId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | | `projects_regions_workflow_templates_set_iam_policy` | `EXEC` | `projectsId, regionsId, workflowTemplatesId` | Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. | | `projects_regions_workflow_templates_test_iam_permissions` | `EXEC` | `projectsId, regionsId, workflowTemplatesId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | diff --git a/docs/google-docs/providers/google/datastore/index.md b/docs/google-docs/providers/google/datastore/index.md index f567ce4d52..7024222458 100644 --- a/docs/google-docs/providers/google/datastore/index.md +++ b/docs/google-docs/providers/google/datastore/index.md @@ -21,7 +21,7 @@ Accesses The Schemaless NoSQL Database To Provide Fully Managed, Robust, Scalabl
total resources: 3
total selectable resources: 2
-total methods: 18
+total methods: 20
@@ -33,7 +33,7 @@ Accesses The Schemaless NoSQL Database To Provide Fully Managed, Robust, Scalabl TypeService TitleCloud Datastore API DescriptionAccesses The Schemaless NoSQL Database To Provide Fully Managed, Robust, Scalable Storage For Your Application. -Iddatastore:v23.08.00155 +Iddatastore:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/datastore/indexes/index.md b/docs/google-docs/providers/google/datastore/indexes/index.md index e37ee302c6..b09aea9c0b 100644 --- a/docs/google-docs/providers/google/datastore/indexes/index.md +++ b/docs/google-docs/providers/google/datastore/indexes/index.md @@ -27,12 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `properties` | `array` | Required. An ordered sequence of property names and their index attributes. Requires: * A maximum of 100 properties. | | `state` | `string` | Output only. The state of the index. | | `ancestor` | `string` | Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. | | `indexId` | `string` | Output only. The resource ID of the index. | | `kind` | `string` | Required. The entity kind to which this index applies. | | `projectId` | `string` | Output only. Project ID. | +| `properties` | `array` | Required. An ordered sequence of property names and their index attributes. Requires: * A maximum of 100 properties. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -40,3 +40,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectId` | Lists the indexes that match the specified filters. Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results. | | `create` | `INSERT` | `projectId` | Creates the specified index. A newly created index's initial state is `CREATING`. On completion of the returned google.longrunning.Operation, the state will be `READY`. If the index already exists, the call will return an `ALREADY_EXISTS` status. During index creation, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single property cannot be created. | | `delete` | `DELETE` | `indexId, projectId` | Deletes an existing index. An index can only be deleted if it is in a `READY` or `ERROR` state. On successful execution of the request, the index will be in a `DELETING` state. And on completion of the returned google.longrunning.Operation, the index will be removed. During index deletion, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, followed by calling delete again. | +| `_list` | `EXEC` | `projectId` | Lists the indexes that match the specified filters. Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results. | diff --git a/docs/google-docs/providers/google/datastore/operations/index.md b/docs/google-docs/providers/google/datastore/operations/index.md index ca242254f2..9ee80efc20 100644 --- a/docs/google-docs/providers/google/datastore/operations/index.md +++ b/docs/google-docs/providers/google/datastore/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `metadata` | `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. | +| `response` | `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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operationsId, projectsId` | 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. | | `list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/datastream/connection_profiles/index.md b/docs/google-docs/providers/google/datastream/connection_profiles/index.md index cb95bbd556..0d047fdcf5 100644 --- a/docs/google-docs/providers/google/datastream/connection_profiles/index.md +++ b/docs/google-docs/providers/google/datastream/connection_profiles/index.md @@ -27,9 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `connectionProfiles` | `array` | List of connection profiles. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Output only. The resource's name. | +| `oracleProfile` | `object` | Oracle database profile. | +| `mysqlProfile` | `object` | MySQL database profile. | +| `postgresqlProfile` | `object` | PostgreSQL database profile. | +| `staticServiceIpConnectivity` | `object` | Static IP address connectivity. Used when the source database is configured to allow incoming connections from the Datastream public IP addresses for the region specified in the connection profile. | +| `createTime` | `string` | Output only. The create time of the resource. | +| `privateConnectivity` | `object` | Private Connectivity | +| `updateTime` | `string` | Output only. The update time of the resource. | +| `labels` | `object` | Labels. | +| `displayName` | `string` | Required. Display name. | +| `forwardSshConnectivity` | `object` | Forward SSH Tunnel connectivity. | +| `bigqueryProfile` | `object` | BigQuery warehouse profile. | +| `gcsProfile` | `object` | Cloud Storage bucket profile. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,5 +47,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Use this method to list connection profiles created in a project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Use this method to create a connection profile in a project and location. | | `delete` | `DELETE` | `connectionProfilesId, locationsId, projectsId` | Use this method to delete a connection profile. | +| `_list` | `EXEC` | `locationsId, projectsId` | Use this method to list connection profiles created in a project and location. | | `discover` | `EXEC` | `locationsId, projectsId` | Use this method to discover a connection profile. The discover API call exposes the data objects and metadata belonging to the profile. Typically, a request returns children data objects of a parent data object that's optionally supplied in the request. | | `patch` | `EXEC` | `connectionProfilesId, locationsId, projectsId` | Use this method to update the parameters of a connection profile. | diff --git a/docs/google-docs/providers/google/datastream/index.md b/docs/google-docs/providers/google/datastream/index.md index 07ec133189..ef6eb940f1 100644 --- a/docs/google-docs/providers/google/datastream/index.md +++ b/docs/google-docs/providers/google/datastream/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 8
total selectable resources: 7
-total methods: 32
+total methods: 39
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleDatastream API Description -Iddatastream:v23.08.00155 +Iddatastream:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/datastream/locations/index.md b/docs/google-docs/providers/google/datastream/locations/index.md index 87f6bf9927..cc9fca3976 100644 --- a/docs/google-docs/providers/google/datastream/locations/index.md +++ b/docs/google-docs/providers/google/datastream/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/datastream/objects/index.md b/docs/google-docs/providers/google/datastream/objects/index.md index 89b591ac11..11794b5ad1 100644 --- a/docs/google-docs/providers/google/datastream/objects/index.md +++ b/docs/google-docs/providers/google/datastream/objects/index.md @@ -27,13 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. | -| `streamObjects` | `array` | List of stream objects. | +| `name` | `string` | Output only. The object resource's name. | +| `backfillJob` | `object` | Represents a backfill job on a specific stream object. | +| `createTime` | `string` | Output only. The creation time of the object. | +| `displayName` | `string` | Required. Display name. | +| `errors` | `array` | Output only. Active errors on the object. | +| `sourceObject` | `object` | Represents an identifier of an object in the data source. | +| `updateTime` | `string` | Output only. The last update time of the object. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, objectsId, projectsId, streamsId` | Use this method to get details about a stream object. | | `list` | `SELECT` | `locationsId, projectsId, streamsId` | Use this method to list the objects of a specific stream. | +| `_list` | `EXEC` | `locationsId, projectsId, streamsId` | Use this method to list the objects of a specific stream. | | `lookup` | `EXEC` | `locationsId, projectsId, streamsId` | Use this method to look up a stream object by its source object identifier. | | `start_backfill_job` | `EXEC` | `locationsId, objectsId, projectsId, streamsId` | Use this method to start a backfill job for the specified stream object. | | `stop_backfill_job` | `EXEC` | `locationsId, objectsId, projectsId, streamsId` | Use this method to stop a backfill job for the specified stream object. | diff --git a/docs/google-docs/providers/google/datastream/operations/index.md b/docs/google-docs/providers/google/datastream/operations/index.md index fa0977de69..a8df4c5a5b 100644 --- a/docs/google-docs/providers/google/datastream/operations/index.md +++ b/docs/google-docs/providers/google/datastream/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/datastream/private_connections/index.md b/docs/google-docs/providers/google/datastream/private_connections/index.md index d885e41c1d..ec8402ad9e 100644 --- a/docs/google-docs/providers/google/datastream/private_connections/index.md +++ b/docs/google-docs/providers/google/datastream/private_connections/index.md @@ -27,9 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `privateConnections` | `array` | List of private connectivity configurations. | +| `name` | `string` | Output only. The resource's name. | +| `labels` | `object` | Labels. | +| `state` | `string` | Output only. The state of the Private Connection. | +| `updateTime` | `string` | Output only. The update time of the resource. | +| `vpcPeeringConfig` | `object` | The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. | +| `createTime` | `string` | Output only. The create time of the resource. | +| `displayName` | `string` | Required. Display name. | +| `error` | `object` | Represent a user-facing Error. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,3 +42,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Use this method to list private connectivity configurations in a project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Use this method to create a private connectivity configuration. | | `delete` | `DELETE` | `locationsId, privateConnectionsId, projectsId` | Use this method to delete a private connectivity configuration. | +| `_list` | `EXEC` | `locationsId, projectsId` | Use this method to list private connectivity configurations in a project and location. | diff --git a/docs/google-docs/providers/google/datastream/routes/index.md b/docs/google-docs/providers/google/datastream/routes/index.md index d9465480f3..db3c000933 100644 --- a/docs/google-docs/providers/google/datastream/routes/index.md +++ b/docs/google-docs/providers/google/datastream/routes/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `routes` | `array` | List of Routes. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | Output only. The resource's name. | +| `updateTime` | `string` | Output only. The update time of the resource. | +| `createTime` | `string` | Output only. The create time of the resource. | +| `destinationAddress` | `string` | Required. Destination address for connection | +| `destinationPort` | `integer` | Destination port for connection | +| `displayName` | `string` | Required. Display name. | +| `labels` | `object` | Labels. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,3 +41,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, privateConnectionsId, projectsId` | Use this method to list routes created for a private connectivity configuration in a project and location. | | `create` | `INSERT` | `locationsId, privateConnectionsId, projectsId` | Use this method to create a route for a private connectivity configuration in a project and location. | | `delete` | `DELETE` | `locationsId, privateConnectionsId, projectsId, routesId` | Use this method to delete a route. | +| `_list` | `EXEC` | `locationsId, privateConnectionsId, projectsId` | Use this method to list routes created for a private connectivity configuration in a project and location. | diff --git a/docs/google-docs/providers/google/datastream/streams/index.md b/docs/google-docs/providers/google/datastream/streams/index.md index 1658e7d69a..e2c4ed04da 100644 --- a/docs/google-docs/providers/google/datastream/streams/index.md +++ b/docs/google-docs/providers/google/datastream/streams/index.md @@ -27,9 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `streams` | `array` | List of streams | -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Output only. The stream's name. | +| `backfillNone` | `object` | Backfill strategy to disable automatic backfill for the Stream's objects. | +| `customerManagedEncryptionKey` | `string` | Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS. | +| `destinationConfig` | `object` | The configuration of the stream destination. | +| `errors` | `array` | Output only. Errors on the Stream. | +| `backfillAll` | `object` | Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. | +| `displayName` | `string` | Required. Display name. | +| `createTime` | `string` | Output only. The creation time of the stream. | +| `labels` | `object` | Labels. | +| `updateTime` | `string` | Output only. The last update time of the stream. | +| `state` | `string` | The state of the stream. | +| `sourceConfig` | `object` | The configuration of the stream source. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,5 +46,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Use this method to list streams in a project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Use this method to create a stream. | | `delete` | `DELETE` | `locationsId, projectsId, streamsId` | Use this method to delete a stream. | +| `_list` | `EXEC` | `locationsId, projectsId` | Use this method to list streams in a project and location. | | `patch` | `EXEC` | `locationsId, projectsId, streamsId` | Use this method to update the configuration of a stream. | | `run` | `EXEC` | `locationsId, projectsId, streamsId` | Use this method to start, resume or recover a stream with a non default CDC strategy. | diff --git a/docs/google-docs/providers/google/deploymentmanager/deployments/index.md b/docs/google-docs/providers/google/deploymentmanager/deployments/index.md index c83354b98c..d580614024 100644 --- a/docs/google-docs/providers/google/deploymentmanager/deployments/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/deployments/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional user-provided description of the deployment. | +| `update` | `object` | | +| `updateTime` | `string` | Output only. Update timestamp in RFC3339 text format. | | `labels` | `array` | Map of One Platform labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. | -| `manifest` | `string` | Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent. | | `operation` | `object` | Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. | -| `update` | `object` | | -| `fingerprint` | `string` | Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment. | -| `selfLink` | `string` | Output only. Server defined URL for the resource. | | `target` | `object` | | -| `updateTime` | `string` | Output only. Update timestamp in RFC3339 text format. | +| `manifest` | `string` | Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent. | +| `fingerprint` | `string` | Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment. | | `insertTime` | `string` | Output only. Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | Output only. Server defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -46,6 +46,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Lists all deployments for a given project. | | `insert` | `INSERT` | `project` | Creates a deployment and all of the resources described by the deployment manifest. | | `delete` | `DELETE` | `deployment, project` | Deletes a deployment and all of the resources in the deployment. | +| `_list` | `EXEC` | `project` | Lists all deployments for a given project. | | `cancel_preview` | `EXEC` | `deployment, project` | Cancels and removes the preview currently associated with the deployment. | | `patch` | `EXEC` | `deployment, project` | Patches a deployment and all of the resources described by the deployment manifest. | | `stop` | `EXEC` | `deployment, project` | Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started. | diff --git a/docs/google-docs/providers/google/deploymentmanager/deployments_iam_policies/index.md b/docs/google-docs/providers/google/deploymentmanager/deployments_iam_policies/index.md index ed961425fd..3a61371ad6 100644 --- a/docs/google-docs/providers/google/deploymentmanager/deployments_iam_policies/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/deployments_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/deploymentmanager/index.md b/docs/google-docs/providers/google/deploymentmanager/index.md index a2c6f85668..3af6352186 100644 --- a/docs/google-docs/providers/google/deploymentmanager/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/index.md @@ -21,7 +21,7 @@ The Google Cloud Deployment Manager V2 API Provides Services For Configuring, De
total resources: 6
total selectable resources: 6
-total methods: 18
+total methods: 23
@@ -33,7 +33,7 @@ The Google Cloud Deployment Manager V2 API Provides Services For Configuring, De TypeService TitleCloud Deployment Manager V2 API DescriptionThe Google Cloud Deployment Manager V2 API Provides Services For Configuring, Deploying, And Viewing Google Cloud Services And APIs Via Templates Which Specify Deployments Of Cloud Resources. -Iddeploymentmanager:v23.08.00155 +Iddeploymentmanager:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/deploymentmanager/manifests/index.md b/docs/google-docs/providers/google/deploymentmanager/manifests/index.md index 3188af8735..f6b7e5a0f5 100644 --- a/docs/google-docs/providers/google/deploymentmanager/manifests/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/manifests/index.md @@ -27,10 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Output only. A token used to continue a truncated list request. | -| `manifests` | `array` | Output only. Manifests contained in this list response. | +| `id` | `string` | | +| `name` | `string` | Output only. The name of the manifest. | +| `selfLink` | `string` | Output only. Self link for the manifest. | +| `expandedConfig` | `string` | Output only. The fully-expanded configuration file, including any templates and references. | +| `insertTime` | `string` | Output only. Creation timestamp in RFC3339 text format. | +| `manifestSizeLimitBytes` | `string` | Output only. The size limit for expanded manifests in the project. | +| `imports` | `array` | Output only. The imported files for this manifest. | +| `config` | `object` | | +| `manifestSizeBytes` | `string` | Output only. The computed size of the fully expanded manifest. | +| `layout` | `string` | Output only. The YAML layout for this manifest. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `deployment, manifest, project` | Gets information about a specific manifest. | | `list` | `SELECT` | `deployment, project` | Lists all manifests for a given deployment. | +| `_list` | `EXEC` | `deployment, project` | Lists all manifests for a given deployment. | diff --git a/docs/google-docs/providers/google/deploymentmanager/operations/index.md b/docs/google-docs/providers/google/deploymentmanager/operations/index.md index 06e173421a..b5e9cb8520 100644 --- a/docs/google-docs/providers/google/deploymentmanager/operations/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/operations/index.md @@ -30,29 +30,30 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the operation. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the operation. | | `description` | `string` | [Output Only] A textual description of the operation, which is set when the operation is created. | -| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | -| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | -| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | -| `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | -| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | -| `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | -| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | +| `targetLink` | `string` | [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. | | `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com`. | -| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | -| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | -| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | +| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | +| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | +| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | | `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | -| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | -| `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | | `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | -| `targetLink` | `string` | [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. | +| `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | +| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | +| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | +| `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | +| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | | `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | +| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | +| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | +| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | +| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | +| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | | `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | -| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operation, project` | Gets information about a specific operation. | | `list` | `SELECT` | `project` | Lists all operations for a project. | +| `_list` | `EXEC` | `project` | Lists all operations for a project. | diff --git a/docs/google-docs/providers/google/deploymentmanager/resources/index.md b/docs/google-docs/providers/google/deploymentmanager/resources/index.md index 4ad92f6277..e56991d5fd 100644 --- a/docs/google-docs/providers/google/deploymentmanager/resources/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/resources/index.md @@ -27,10 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token used to continue a truncated list request. | -| `resources` | `array` | Resources contained in this list response. | +| `id` | `string` | | +| `name` | `string` | Output only. The name of the resource as it appears in the YAML config. | +| `finalProperties` | `string` | Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML. | +| `insertTime` | `string` | Output only. Creation timestamp in RFC3339 text format. | +| `manifest` | `string` | Output only. URL of the manifest representing the current configuration of this resource. | +| `updateTime` | `string` | Output only. Update timestamp in RFC3339 text format. | +| `update` | `object` | | +| `accessControl` | `object` | The access controls set on the resource. | +| `type` | `string` | Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`. | +| `url` | `string` | Output only. The URL of the actual resource. | +| `warnings` | `array` | Output only. If warning messages are generated during processing of this resource, this field will be populated. | +| `properties` | `string` | Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `deployment, project, resource` | Gets information about a single resource. | | `list` | `SELECT` | `deployment, project` | Lists all resources in a given deployment. | +| `_list` | `EXEC` | `deployment, project` | Lists all resources in a given deployment. | diff --git a/docs/google-docs/providers/google/deploymentmanager/types/index.md b/docs/google-docs/providers/google/deploymentmanager/types/index.md index a2078aac8a..e19d1e5331 100644 --- a/docs/google-docs/providers/google/deploymentmanager/types/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/types/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token used to continue a truncated list request. | -| `types` | `array` | Output only. A list of resource types supported by Deployment Manager. | +| `id` | `string` | | +| `name` | `string` | Name of the type. | +| `operation` | `object` | Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. | +| `selfLink` | `string` | Output only. Server defined URL for the resource. | +| `insertTime` | `string` | Output only. Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `project` | +| `_list` | `EXEC` | `project` | diff --git a/docs/google-docs/providers/google/dialogflow/agents/index.md b/docs/google-docs/providers/google/dialogflow/agents/index.md index 394026463e..a43c5c7c94 100644 --- a/docs/google-docs/providers/google/dialogflow/agents/index.md +++ b/docs/google-docs/providers/google/dialogflow/agents/index.md @@ -29,20 +29,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. | | `description` | `string` | The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. | -| `textToSpeechSettings` | `object` | Settings related to speech synthesizing. | +| `advancedSettings` | `object` | Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. | +| `enableStackdriverLogging` | `boolean` | Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. | +| `supportedLanguageCodes` | `array` | The list of all languages supported by the agent (except for the `default_language_code`). | +| `avatarUri` | `string` | The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. | | `timeZone` | `string` | Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. | -| `startFlow` | `string` | Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. | | `displayName` | `string` | Required. The human-readable name of the agent, unique within the location. | -| `defaultLanguageCode` | `string` | Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method. | -| `avatarUri` | `string` | The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. | | `gitIntegrationSettings` | `object` | Settings for connecting to Git repository for an agent. | -| `securitySettings` | `string` | Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. | -| `advancedSettings` | `object` | Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. | +| `textToSpeechSettings` | `object` | Settings related to speech synthesizing. | +| `startFlow` | `string` | Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. | +| `enableSpellCorrection` | `boolean` | Indicates if automatic spell correction is enabled in detect intent requests. | | `speechToTextSettings` | `object` | Settings related to speech recognition. | -| `enableStackdriverLogging` | `boolean` | Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. | +| `defaultLanguageCode` | `string` | Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method. | | `locked` | `boolean` | Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent. | -| `enableSpellCorrection` | `boolean` | Indicates if automatic spell correction is enabled in detect intent requests. | -| `supportedLanguageCodes` | `array` | The list of all languages supported by the agent (except for the `default_language_code`). | +| `securitySettings` | `string` | Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -50,6 +50,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_agents_list` | `SELECT` | `locationsId, projectsId` | Returns the list of all agents in the specified location. | | `projects_locations_agents_create` | `INSERT` | `locationsId, projectsId` | Creates an agent in the specified location. Note: You should always train flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | | `projects_locations_agents_delete` | `DELETE` | `agentsId, locationsId, projectsId` | Deletes the specified agent. | +| `_projects_locations_agents_list` | `EXEC` | `locationsId, projectsId` | Returns the list of all agents in the specified location. | | `projects_locations_agents_export` | `EXEC` | `agentsId, locationsId, projectsId` | Exports the specified agent to a binary file. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: ExportAgentResponse | | `projects_locations_agents_patch` | `EXEC` | `agentsId, locationsId, projectsId` | Updates the specified agent. Note: You should always train flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | | `projects_locations_agents_restore` | `EXEC` | `agentsId, locationsId, projectsId` | Restores the specified agent from a binary file. Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | diff --git a/docs/google-docs/providers/google/dialogflow/changelogs/index.md b/docs/google-docs/providers/google/dialogflow/changelogs/index.md index ecd2ca14f3..d679f40899 100644 --- a/docs/google-docs/providers/google/dialogflow/changelogs/index.md +++ b/docs/google-docs/providers/google/dialogflow/changelogs/index.md @@ -28,14 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The unique identifier of the changelog. Format: `projects//locations//agents//changelogs/`. | -| `resource` | `string` | The affected resource name of the change. | | `type` | `string` | The affected resource type. | | `userEmail` | `string` | Email address of the authenticated user. | | `action` | `string` | The action of the change. | | `createTime` | `string` | The timestamp of the change. | | `displayName` | `string` | The affected resource display name of the change. | +| `resource` | `string` | The affected resource name of the change. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_agents_changelogs_get` | `SELECT` | `agentsId, changelogsId, locationsId, projectsId` | Retrieves the specified Changelog. | | `projects_locations_agents_changelogs_list` | `SELECT` | `agentsId, locationsId, projectsId` | Returns the list of Changelogs. | +| `_projects_locations_agents_changelogs_list` | `EXEC` | `agentsId, locationsId, projectsId` | Returns the list of Changelogs. | diff --git a/docs/google-docs/providers/google/dialogflow/continuous_test_results/index.md b/docs/google-docs/providers/google/dialogflow/continuous_test_results/index.md index 56c4acc5e3..0ea5385677 100644 --- a/docs/google-docs/providers/google/dialogflow/continuous_test_results/index.md +++ b/docs/google-docs/providers/google/dialogflow/continuous_test_results/index.md @@ -27,9 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `continuousTestResults` | `array` | The list of continuous test results. | +| `name` | `string` | The resource name for the continuous test result. Format: `projects//locations//agents//environments//continuousTestResults/`. | +| `testCaseResults` | `array` | A list of individual test case results names in this continuous test run. | +| `result` | `string` | The result of this continuous test run, i.e. whether all the tests in this continuous test run pass or not. | +| `runTime` | `string` | Time when the continuous testing run starts. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_locations_agents_environments_continuous_test_results_list` | `SELECT` | `agentsId, environmentsId, locationsId, projectsId` | +| `_projects_locations_agents_environments_continuous_test_results_list` | `EXEC` | `agentsId, environmentsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dialogflow/deployments/index.md b/docs/google-docs/providers/google/dialogflow/deployments/index.md index 8a7fffdb3a..5e98edd0f0 100644 --- a/docs/google-docs/providers/google/dialogflow/deployments/index.md +++ b/docs/google-docs/providers/google/dialogflow/deployments/index.md @@ -27,10 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `deployments` | `array` | The list of deployments. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | The name of the deployment. Format: projects//locations//agents//environments//deployments/. | +| `result` | `object` | Result of the deployment. | +| `startTime` | `string` | Start time of this deployment. | +| `state` | `string` | The current state of the deployment. | +| `endTime` | `string` | End time of this deployment. | +| `flowVersion` | `string` | The name of the flow version for this deployment. Format: projects//locations//agents//flows//versions/. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_agents_environments_deployments_get` | `SELECT` | `agentsId, deploymentsId, environmentsId, locationsId, projectsId` | Retrieves the specified Deployment. | | `projects_locations_agents_environments_deployments_list` | `SELECT` | `agentsId, environmentsId, locationsId, projectsId` | Returns the list of all deployments in the specified Environment. | +| `_projects_locations_agents_environments_deployments_list` | `EXEC` | `agentsId, environmentsId, locationsId, projectsId` | Returns the list of all deployments in the specified Environment. | diff --git a/docs/google-docs/providers/google/dialogflow/entity_types/index.md b/docs/google-docs/providers/google/dialogflow/entity_types/index.md index b1aa11e9d1..5df17f1929 100644 --- a/docs/google-docs/providers/google/dialogflow/entity_types/index.md +++ b/docs/google-docs/providers/google/dialogflow/entity_types/index.md @@ -27,9 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. | -| `entityOverrideMode` | `string` | Required. Indicates whether the additional data should override or supplement the custom entity type definition. | -| `entities` | `array` | Required. The collection of entities to override or supplement the custom entity type. | +| `name` | `string` | The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: `projects//locations//agents//entityTypes/`. | +| `autoExpansionMode` | `string` | Indicates whether the entity type can be automatically expanded. | +| `displayName` | `string` | Required. The human-readable name of the entity type, unique within the agent. | +| `enableFuzzyExtraction` | `boolean` | Enables fuzzy entity extraction during classification. | +| `entities` | `array` | The collection of entity entries associated with the entity type. | +| `excludedPhrases` | `array` | Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry `giant`(an adjective), you might consider adding `giants`(a noun) as an exclusion. If the kind of entity type is `KIND_MAP`, then the phrases specified by entities and excluded phrases should be mutually exclusive. | +| `kind` | `string` | Required. Indicates the kind of entity type. | +| `redact` | `boolean` | Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -45,6 +50,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_agents_entity_types_delete` | `DELETE` | `agentsId, entityTypesId, locationsId, projectsId` | Deletes the specified entity type. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | | `projects_locations_agents_environments_sessions_entity_types_delete` | `DELETE` | `agentsId, entityTypesId, environmentsId, locationsId, projectsId, sessionsId` | Deletes the specified session entity type. | | `projects_locations_agents_sessions_entity_types_delete` | `DELETE` | `agentsId, entityTypesId, locationsId, projectsId, sessionsId` | Deletes the specified session entity type. | +| `_projects_locations_agents_entity_types_list` | `EXEC` | `agentsId, locationsId, projectsId` | Returns the list of all entity types in the specified agent. | +| `_projects_locations_agents_environments_sessions_entity_types_list` | `EXEC` | `agentsId, environmentsId, locationsId, projectsId, sessionsId` | Returns the list of all session entity types in the specified session. | +| `_projects_locations_agents_sessions_entity_types_list` | `EXEC` | `agentsId, locationsId, projectsId, sessionsId` | Returns the list of all session entity types in the specified session. | | `projects_locations_agents_entity_types_patch` | `EXEC` | `agentsId, entityTypesId, locationsId, projectsId` | Updates the specified entity type. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | | `projects_locations_agents_environments_sessions_entity_types_patch` | `EXEC` | `agentsId, entityTypesId, environmentsId, locationsId, projectsId, sessionsId` | Updates the specified session entity type. | | `projects_locations_agents_sessions_entity_types_patch` | `EXEC` | `agentsId, entityTypesId, locationsId, projectsId, sessionsId` | Updates the specified session entity type. | diff --git a/docs/google-docs/providers/google/dialogflow/environments/index.md b/docs/google-docs/providers/google/dialogflow/environments/index.md index 38a9d6e05a..b4d25abcc6 100644 --- a/docs/google-docs/providers/google/dialogflow/environments/index.md +++ b/docs/google-docs/providers/google/dialogflow/environments/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The name of the environment. Format: `projects//locations//agents//environments/`. | | `description` | `string` | The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected. | -| `versionConfigs` | `array` | A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned. | | `webhookConfig` | `object` | Configuration for webhooks. | | `displayName` | `string` | Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters. | | `testCasesConfig` | `object` | The configuration for continuous tests. | | `updateTime` | `string` | Output only. Update time of this environment. | +| `versionConfigs` | `array` | A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -41,6 +41,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_agents_environments_list` | `SELECT` | `agentsId, locationsId, projectsId` | Returns the list of all environments in the specified Agent. | | `projects_locations_agents_environments_create` | `INSERT` | `agentsId, locationsId, projectsId` | Creates an Environment in the specified Agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: Environment | | `projects_locations_agents_environments_delete` | `DELETE` | `agentsId, environmentsId, locationsId, projectsId` | Deletes the specified Environment. | +| `_projects_locations_agents_environments_list` | `EXEC` | `agentsId, locationsId, projectsId` | Returns the list of all environments in the specified Agent. | | `projects_locations_agents_environments_deploy_flow` | `EXEC` | `agentsId, environmentsId, locationsId, projectsId` | Deploys a flow to the specified Environment. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: DeployFlowMetadata - `response`: DeployFlowResponse | | `projects_locations_agents_environments_lookup_environment_history` | `EXEC` | `agentsId, environmentsId, locationsId, projectsId` | Looks up the history of the specified Environment. | | `projects_locations_agents_environments_patch` | `EXEC` | `agentsId, environmentsId, locationsId, projectsId` | Updates the specified Environment. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: Environment | diff --git a/docs/google-docs/providers/google/dialogflow/experiments/index.md b/docs/google-docs/providers/google/dialogflow/experiments/index.md index 6a4fb7a1ff..0cf0867ded 100644 --- a/docs/google-docs/providers/google/dialogflow/experiments/index.md +++ b/docs/google-docs/providers/google/dialogflow/experiments/index.md @@ -27,8 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `experiments` | `array` | The list of experiments. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | The name of the experiment. Format: projects//locations//agents//environments//experiments/.. | +| `description` | `string` | The human-readable description of the experiment. | +| `definition` | `object` | Definition of the experiment. | +| `createTime` | `string` | Creation time of this experiment. | +| `rolloutFailureReason` | `string` | The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED. | +| `result` | `object` | The inference result which includes an objective metric to optimize and the confidence interval. | +| `rolloutConfig` | `object` | The configuration for auto rollout. | +| `displayName` | `string` | Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters. | +| `startTime` | `string` | Start time of this experiment. | +| `endTime` | `string` | End time of this experiment. | +| `lastUpdateTime` | `string` | Last update time of this experiment. | +| `rolloutState` | `object` | State of the auto-rollout process. | +| `variantsHistory` | `array` | The history of updates to the experiment variants. | +| `experimentLength` | `string` | Maximum number of days to run the experiment/rollout. If auto-rollout is not enabled, default value and maximum will be 30 days. If auto-rollout is enabled, default value and maximum will be 6 days. | +| `state` | `string` | The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +49,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_agents_environments_experiments_list` | `SELECT` | `agentsId, environmentsId, locationsId, projectsId` | Returns the list of all experiments in the specified Environment. | | `projects_locations_agents_environments_experiments_create` | `INSERT` | `agentsId, environmentsId, locationsId, projectsId` | Creates an Experiment in the specified Environment. | | `projects_locations_agents_environments_experiments_delete` | `DELETE` | `agentsId, environmentsId, experimentsId, locationsId, projectsId` | Deletes the specified Experiment. | +| `_projects_locations_agents_environments_experiments_list` | `EXEC` | `agentsId, environmentsId, locationsId, projectsId` | Returns the list of all experiments in the specified Environment. | | `projects_locations_agents_environments_experiments_patch` | `EXEC` | `agentsId, environmentsId, experimentsId, locationsId, projectsId` | Updates the specified Experiment. | | `projects_locations_agents_environments_experiments_start` | `EXEC` | `agentsId, environmentsId, experimentsId, locationsId, projectsId` | Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING. | | `projects_locations_agents_environments_experiments_stop` | `EXEC` | `agentsId, environmentsId, experimentsId, locationsId, projectsId` | Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE. | diff --git a/docs/google-docs/providers/google/dialogflow/flows/index.md b/docs/google-docs/providers/google/dialogflow/flows/index.md index 3e093dff2e..41a534b693 100644 --- a/docs/google-docs/providers/google/dialogflow/flows/index.md +++ b/docs/google-docs/providers/google/dialogflow/flows/index.md @@ -30,7 +30,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | The unique identifier of the flow. Format: `projects//locations//agents//flows/`. | | `description` | `string` | The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. | | `nluSettings` | `object` | Settings related to NLU. | -| `transitionRouteGroups` | `array` | A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/`. | +| `transitionRouteGroups` | `array` | A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. | | `transitionRoutes` | `array` | A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. | | `displayName` | `string` | Required. The human-readable name of the flow. | | `eventHandlers` | `array` | A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. | @@ -41,6 +41,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_agents_flows_list` | `SELECT` | `agentsId, locationsId, projectsId` | Returns the list of all flows in the specified agent. | | `projects_locations_agents_flows_create` | `INSERT` | `agentsId, locationsId, projectsId` | Creates a flow in the specified agent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | | `projects_locations_agents_flows_delete` | `DELETE` | `agentsId, flowsId, locationsId, projectsId` | Deletes a specified flow. | +| `_projects_locations_agents_flows_list` | `EXEC` | `agentsId, locationsId, projectsId` | Returns the list of all flows in the specified agent. | | `projects_locations_agents_flows_export` | `EXEC` | `agentsId, flowsId, locationsId, projectsId` | Exports the specified flow to a binary file. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: ExportFlowResponse Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported. | | `projects_locations_agents_flows_import` | `EXEC` | `agentsId, locationsId, projectsId` | Imports the specified flow to the specified agent from a binary file. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: ImportFlowResponse Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | | `projects_locations_agents_flows_patch` | `EXEC` | `agentsId, flowsId, locationsId, projectsId` | Updates the specified flow. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | diff --git a/docs/google-docs/providers/google/dialogflow/flows_validation_result/index.md b/docs/google-docs/providers/google/dialogflow/flows_validation_result/index.md index 5279dcaa73..1f23e02570 100644 --- a/docs/google-docs/providers/google/dialogflow/flows_validation_result/index.md +++ b/docs/google-docs/providers/google/dialogflow/flows_validation_result/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The unique identifier of the flow validation result. Format: `projects//locations//agents//flows//validationResult`. | -| `updateTime` | `string` | Last time the flow was validated. | | `validationMessages` | `array` | Contains all validation messages. | +| `updateTime` | `string` | Last time the flow was validated. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/dialogflow/index.md b/docs/google-docs/providers/google/dialogflow/index.md index 88c4b489c4..3c8a09c2de 100644 --- a/docs/google-docs/providers/google/dialogflow/index.md +++ b/docs/google-docs/providers/google/dialogflow/index.md @@ -21,7 +21,7 @@ Builds Conversational Interfaces (For Example, Chatbots, And Voice-Powered Apps
total resources: 21
total selectable resources: 20
-total methods: 112
+total methods: 139
@@ -33,7 +33,7 @@ Builds Conversational Interfaces (For Example, Chatbots, And Voice-Powered Apps TypeService TitleDialogflow API DescriptionBuilds Conversational Interfaces (For Example, Chatbots, And Voice-Powered Apps And Devices). -Iddialogflow:v23.08.00155 +Iddialogflow:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/dialogflow/intents/index.md b/docs/google-docs/providers/google/dialogflow/intents/index.md index d3d0eb5e9a..e5e5f96035 100644 --- a/docs/google-docs/providers/google/dialogflow/intents/index.md +++ b/docs/google-docs/providers/google/dialogflow/intents/index.md @@ -27,13 +27,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `intents` | `array` | The list of intents. There will be a maximum number of items returned based on the page_size field in the request. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. | +| `description` | `string` | Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. | +| `displayName` | `string` | Required. The human-readable name of the intent, unique within the agent. | +| `isFallback` | `boolean` | Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. | +| `labels` | `object` | The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. | +| `parameters` | `array` | The collection of parameters associated with the intent. | +| `priority` | `integer` | The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. | +| `trainingPhrases` | `array` | The collection of training phrases the agent is trained on to identify the intent. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_agents_intents_list` | `SELECT` | `agentsId, locationsId, projectsId` | Returns the list of all intents in the specified agent. | | `projects_locations_agents_intents_create` | `INSERT` | `agentsId, locationsId, projectsId` | Creates an intent in the specified agent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | | `projects_locations_agents_intents_delete` | `DELETE` | `agentsId, intentsId, locationsId, projectsId` | Deletes the specified intent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | +| `_projects_locations_agents_intents_list` | `EXEC` | `agentsId, locationsId, projectsId` | Returns the list of all intents in the specified agent. | | `projects_locations_agents_intents_get` | `EXEC` | `agentsId, intentsId, locationsId, projectsId` | Retrieves the specified intent. | | `projects_locations_agents_intents_patch` | `EXEC` | `agentsId, intentsId, locationsId, projectsId` | Updates the specified intent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | diff --git a/docs/google-docs/providers/google/dialogflow/locations/index.md b/docs/google-docs/providers/google/dialogflow/locations/index.md index 852f92807f..58f1d462d1 100644 --- a/docs/google-docs/providers/google/dialogflow/locations/index.md +++ b/docs/google-docs/providers/google/dialogflow/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/dialogflow/operations/index.md b/docs/google-docs/providers/google/dialogflow/operations/index.md index da86d3c3cf..af103f57fc 100644 --- a/docs/google-docs/providers/google/dialogflow/operations/index.md +++ b/docs/google-docs/providers/google/dialogflow/operations/index.md @@ -27,13 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `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 | |:-----|:--------------|:----------------|:------------| | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_operations_list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_operations_list` | `EXEC` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | | `projects_locations_operations_get` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | | `projects_operations_cancel` | `EXEC` | `operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/dialogflow/pages/index.md b/docs/google-docs/providers/google/dialogflow/pages/index.md index aeb5348cb5..4c69d918d2 100644 --- a/docs/google-docs/providers/google/dialogflow/pages/index.md +++ b/docs/google-docs/providers/google/dialogflow/pages/index.md @@ -27,8 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `pages` | `array` | The list of pages. There will be a maximum number of items returned based on the page_size field in the request. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. | +| `transitionRouteGroups` | `array` | Ordered list of `TransitionRouteGroups` associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. | +| `transitionRoutes` | `array` | A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. | +| `displayName` | `string` | Required. The human-readable name of the page, unique within the flow. | +| `entryFulfillment` | `object` | A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. | +| `eventHandlers` | `array` | Handlers associated with the page to handle events such as webhook errors, no match or no input. | +| `form` | `object` | A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +41,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_agents_flows_pages_list` | `SELECT` | `agentsId, flowsId, locationsId, projectsId` | Returns the list of all pages in the specified flow. | | `projects_locations_agents_flows_pages_create` | `INSERT` | `agentsId, flowsId, locationsId, projectsId` | Creates a page in the specified flow. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | | `projects_locations_agents_flows_pages_delete` | `DELETE` | `agentsId, flowsId, locationsId, pagesId, projectsId` | Deletes the specified page. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | +| `_projects_locations_agents_flows_pages_list` | `EXEC` | `agentsId, flowsId, locationsId, projectsId` | Returns the list of all pages in the specified flow. | | `projects_locations_agents_flows_pages_patch` | `EXEC` | `agentsId, flowsId, locationsId, pagesId, projectsId` | Updates the specified page. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | diff --git a/docs/google-docs/providers/google/dialogflow/results/index.md b/docs/google-docs/providers/google/dialogflow/results/index.md index c203b43f96..5c7a3ae721 100644 --- a/docs/google-docs/providers/google/dialogflow/results/index.md +++ b/docs/google-docs/providers/google/dialogflow/results/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `testCaseResults` | `array` | The list of test case results. | +| `name` | `string` | The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. | +| `testResult` | `string` | Whether the test case passed in the agent environment. | +| `testTime` | `string` | The time that the test was run. | +| `conversationTurns` | `array` | The conversation turns uttered during the test case replay in chronological order. | +| `environment` | `string` | Environment where the test was run. If not set, it indicates the draft environment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_agents_test_cases_results_get` | `SELECT` | `agentsId, locationsId, projectsId, resultsId, testCasesId` | Gets a test case result. | | `projects_locations_agents_test_cases_results_list` | `SELECT` | `agentsId, locationsId, projectsId, testCasesId` | Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case. | +| `_projects_locations_agents_test_cases_results_list` | `EXEC` | `agentsId, locationsId, projectsId, testCasesId` | Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case. | diff --git a/docs/google-docs/providers/google/dialogflow/security_settings/index.md b/docs/google-docs/providers/google/dialogflow/security_settings/index.md index e2af84dc5b..933e6ec982 100644 --- a/docs/google-docs/providers/google/dialogflow/security_settings/index.md +++ b/docs/google-docs/providers/google/dialogflow/security_settings/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: `projects//locations//securitySettings/`. | -| `insightsExportSettings` | `object` | Settings for exporting conversations to [Insights](https://cloud.google.com/contact-center/insights/docs). | +| `redactionStrategy` | `string` | Strategy that defines how we do redaction. | | `redactionScope` | `string` | Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging. | +| `insightsExportSettings` | `object` | Settings for exporting conversations to [Insights](https://cloud.google.com/contact-center/insights/docs). | | `audioExportSettings` | `object` | Settings for exporting audio. | -| `retentionWindowDays` | `integer` | Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. | -| `deidentifyTemplate` | `string` | [DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this template to define de-identification configuration for the content. The `DLP De-identify Templates Reader` role is needed on the Dialogflow service identity service account (has the form `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`) for your agent's project. If empty, Dialogflow replaces sensitive info with `[redacted]` text. The template name will have one of the following formats: `projects//locations//deidentifyTemplates/` OR `organizations//locations//deidentifyTemplates/` Note: `deidentify_template` must be located in the same region as the `SecuritySettings`. | -| `purgeDataTypes` | `array` | List of types of data to remove when retention settings triggers purge. | | `displayName` | `string` | Required. The human-readable name of the security settings, unique within the location. | -| `redactionStrategy` | `string` | Strategy that defines how we do redaction. | | `inspectTemplate` | `string` | [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. The `DLP Inspect Templates Reader` role is needed on the Dialogflow service identity service account (has the form `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`) for your agent's project. If empty, we use the default DLP inspect config. The template name will have one of the following formats: `projects//locations//inspectTemplates/` OR `organizations//locations//inspectTemplates/` Note: `inspect_template` must be located in the same region as the `SecuritySettings`. | +| `retentionWindowDays` | `integer` | Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. | +| `purgeDataTypes` | `array` | List of types of data to remove when retention settings triggers purge. | +| `deidentifyTemplate` | `string` | [DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this template to define de-identification configuration for the content. The `DLP De-identify Templates Reader` role is needed on the Dialogflow service identity service account (has the form `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`) for your agent's project. If empty, Dialogflow replaces sensitive info with `[redacted]` text. The template name will have one of the following formats: `projects//locations//deidentifyTemplates/` OR `organizations//locations//deidentifyTemplates/` Note: `deidentify_template` must be located in the same region as the `SecuritySettings`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,4 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_security_settings_list` | `SELECT` | `locationsId, projectsId` | Returns the list of all security settings in the specified location. | | `projects_locations_security_settings_create` | `INSERT` | `locationsId, projectsId` | Create security settings in the specified location. | | `projects_locations_security_settings_delete` | `DELETE` | `locationsId, projectsId, securitySettingsId` | Deletes the specified SecuritySettings. | +| `_projects_locations_security_settings_list` | `EXEC` | `locationsId, projectsId` | Returns the list of all security settings in the specified location. | | `projects_locations_security_settings_patch` | `EXEC` | `locationsId, projectsId, securitySettingsId` | Updates the specified SecuritySettings. | diff --git a/docs/google-docs/providers/google/dialogflow/test_cases/index.md b/docs/google-docs/providers/google/dialogflow/test_cases/index.md index caacfbbfef..e8e02de7a4 100644 --- a/docs/google-docs/providers/google/dialogflow/test_cases/index.md +++ b/docs/google-docs/providers/google/dialogflow/test_cases/index.md @@ -28,19 +28,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. | +| `creationTime` | `string` | Output only. When the test was created. | | `displayName` | `string` | Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters. | | `lastTestResult` | `object` | Represents a result from running a test case in an agent environment. | | `notes` | `string` | Additional freeform notes about the test case. Limit of 400 characters. | | `tags` | `array` | Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with "#" and has a limit of 30 characters. | | `testCaseConversationTurns` | `array` | The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly. | | `testConfig` | `object` | Represents configurations for a test case. | -| `creationTime` | `string` | Output only. When the test was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_agents_test_cases_get` | `SELECT` | `agentsId, locationsId, projectsId, testCasesId` | Gets a test case. | | `projects_locations_agents_test_cases_list` | `SELECT` | `agentsId, locationsId, projectsId` | Fetches a list of test cases for a given agent. | | `projects_locations_agents_test_cases_create` | `INSERT` | `agentsId, locationsId, projectsId` | Creates a test case for the given agent. | +| `_projects_locations_agents_test_cases_list` | `EXEC` | `agentsId, locationsId, projectsId` | Fetches a list of test cases for a given agent. | | `projects_locations_agents_test_cases_batch_delete` | `EXEC` | `agentsId, locationsId, projectsId` | Batch deletes test cases. | | `projects_locations_agents_test_cases_batch_run` | `EXEC` | `agentsId, locationsId, projectsId` | Kicks off a batch run of test cases. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: BatchRunTestCasesMetadata - `response`: BatchRunTestCasesResponse | | `projects_locations_agents_test_cases_calculate_coverage` | `EXEC` | `agentsId, locationsId, projectsId` | Calculates the test coverage for an agent. | diff --git a/docs/google-docs/providers/google/dialogflow/transition_route_groups/index.md b/docs/google-docs/providers/google/dialogflow/transition_route_groups/index.md index 9746be1779..4a549284e5 100644 --- a/docs/google-docs/providers/google/dialogflow/transition_route_groups/index.md +++ b/docs/google-docs/providers/google/dialogflow/transition_route_groups/index.md @@ -27,13 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `transitionRouteGroups` | `array` | The list of transition route groups. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page. | +| `name` | `string` | The unique identifier of the transition route group. TransitionRouteGroups.CreateTransitionRouteGroup populates the name automatically. Format: `projects//locations//agents//flows//transitionRouteGroups/` . | +| `transitionRoutes` | `array` | Transition routes associated with the TransitionRouteGroup. | +| `displayName` | `string` | Required. The human-readable name of the transition route group, unique within the flow. The display name can be no longer than 30 characters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_agents_flows_transition_route_groups_get` | `SELECT` | `agentsId, flowsId, locationsId, projectsId, transitionRouteGroupsId` | Retrieves the specified TransitionRouteGroup. | | `projects_locations_agents_flows_transition_route_groups_list` | `SELECT` | `agentsId, flowsId, locationsId, projectsId` | Returns the list of all transition route groups in the specified flow. | +| `projects_locations_agents_transition_route_groups_get` | `SELECT` | `agentsId, locationsId, projectsId, transitionRouteGroupsId` | Retrieves the specified TransitionRouteGroup. | +| `projects_locations_agents_transition_route_groups_list` | `SELECT` | `agentsId, locationsId, projectsId` | Returns the list of all transition route groups in the specified flow. | | `projects_locations_agents_flows_transition_route_groups_create` | `INSERT` | `agentsId, flowsId, locationsId, projectsId` | Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | +| `projects_locations_agents_transition_route_groups_create` | `INSERT` | `agentsId, locationsId, projectsId` | Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | | `projects_locations_agents_flows_transition_route_groups_delete` | `DELETE` | `agentsId, flowsId, locationsId, projectsId, transitionRouteGroupsId` | Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | +| `projects_locations_agents_transition_route_groups_delete` | `DELETE` | `agentsId, locationsId, projectsId, transitionRouteGroupsId` | Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | +| `_projects_locations_agents_flows_transition_route_groups_list` | `EXEC` | `agentsId, flowsId, locationsId, projectsId` | Returns the list of all transition route groups in the specified flow. | +| `_projects_locations_agents_transition_route_groups_list` | `EXEC` | `agentsId, locationsId, projectsId` | Returns the list of all transition route groups in the specified flow. | | `projects_locations_agents_flows_transition_route_groups_patch` | `EXEC` | `agentsId, flowsId, locationsId, projectsId, transitionRouteGroupsId` | Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | +| `projects_locations_agents_transition_route_groups_patch` | `EXEC` | `agentsId, locationsId, projectsId, transitionRouteGroupsId` | Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | diff --git a/docs/google-docs/providers/google/dialogflow/versions/index.md b/docs/google-docs/providers/google/dialogflow/versions/index.md index 9f3bd2f684..fdea878734 100644 --- a/docs/google-docs/providers/google/dialogflow/versions/index.md +++ b/docs/google-docs/providers/google/dialogflow/versions/index.md @@ -27,8 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `versions` | `array` | A list of versions. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. | +| `description` | `string` | The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected. | +| `state` | `string` | Output only. The state of this version. This field is read-only and cannot be set by create and update methods. | +| `createTime` | `string` | Output only. Create time of the version. | +| `displayName` | `string` | Required. The human-readable name of the version. Limit of 64 characters. | +| `nluSettings` | `object` | Settings related to NLU. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +40,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_agents_flows_versions_list` | `SELECT` | `agentsId, flowsId, locationsId, projectsId` | Returns the list of all versions in the specified Flow. | | `projects_locations_agents_flows_versions_create` | `INSERT` | `agentsId, flowsId, locationsId, projectsId` | Creates a Version in the specified Flow. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: CreateVersionOperationMetadata - `response`: Version | | `projects_locations_agents_flows_versions_delete` | `DELETE` | `agentsId, flowsId, locationsId, projectsId, versionsId` | Deletes the specified Version. | +| `_projects_locations_agents_flows_versions_list` | `EXEC` | `agentsId, flowsId, locationsId, projectsId` | Returns the list of all versions in the specified Flow. | | `projects_locations_agents_flows_versions_compare_versions` | `EXEC` | `agentsId, flowsId, locationsId, projectsId, versionsId` | Compares the specified base version with target version. | | `projects_locations_agents_flows_versions_load` | `EXEC` | `agentsId, flowsId, locationsId, projectsId, versionsId` | Loads resources in the specified version to the draft flow. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) | | `projects_locations_agents_flows_versions_patch` | `EXEC` | `agentsId, flowsId, locationsId, projectsId, versionsId` | Updates the specified Version. | diff --git a/docs/google-docs/providers/google/dialogflow/webhooks/index.md b/docs/google-docs/providers/google/dialogflow/webhooks/index.md index b501cdb1f2..47f156b8ef 100644 --- a/docs/google-docs/providers/google/dialogflow/webhooks/index.md +++ b/docs/google-docs/providers/google/dialogflow/webhooks/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`. | -| `genericWebService` | `object` | Represents configuration for a generic web service. | | `serviceDirectory` | `object` | Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service. | | `timeout` | `string` | Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds. | | `disabled` | `boolean` | Indicates whether the webhook is disabled. | | `displayName` | `string` | Required. The human-readable name of the webhook, unique within the agent. | +| `genericWebService` | `object` | Represents configuration for a generic web service. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -40,4 +40,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_agents_webhooks_list` | `SELECT` | `agentsId, locationsId, projectsId` | Returns the list of all webhooks in the specified agent. | | `projects_locations_agents_webhooks_create` | `INSERT` | `agentsId, locationsId, projectsId` | Creates a webhook in the specified agent. | | `projects_locations_agents_webhooks_delete` | `DELETE` | `agentsId, locationsId, projectsId, webhooksId` | Deletes the specified webhook. | +| `_projects_locations_agents_webhooks_list` | `EXEC` | `agentsId, locationsId, projectsId` | Returns the list of all webhooks in the specified agent. | | `projects_locations_agents_webhooks_patch` | `EXEC` | `agentsId, locationsId, projectsId, webhooksId` | Updates the specified webhook. | diff --git a/docs/google-docs/providers/google/discoveryengine/documents/index.md b/docs/google-docs/providers/google/discoveryengine/documents/index.md index fca698f2b1..4ea59dda65 100644 --- a/docs/google-docs/providers/google/discoveryengine/documents/index.md +++ b/docs/google-docs/providers/google/discoveryengine/documents/index.md @@ -27,8 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token that can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `documents` | `array` | The Documents. | +| `id` | `string` | Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. | +| `name` | `string` | Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. | +| `schemaId` | `string` | The identifier of the schema located in the same data store. | +| `structData` | `object` | The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. | +| `jsonData` | `string` | The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. | +| `parentDocumentId` | `string` | The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,6 +42,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_data_stores_branches_documents_create` | `INSERT` | `branchesId, dataStoresId, locationsId, projectsId` | Creates a Document. | | `projects_locations_collections_data_stores_branches_documents_delete` | `DELETE` | `branchesId, collectionsId, dataStoresId, documentsId, locationsId, projectsId` | Deletes a Document. | | `projects_locations_data_stores_branches_documents_delete` | `DELETE` | `branchesId, dataStoresId, documentsId, locationsId, projectsId` | Deletes a Document. | +| `_projects_locations_collections_data_stores_branches_documents_list` | `EXEC` | `branchesId, collectionsId, dataStoresId, locationsId, projectsId` | Gets a list of Documents. | +| `_projects_locations_data_stores_branches_documents_list` | `EXEC` | `branchesId, dataStoresId, locationsId, projectsId` | Gets a list of Documents. | | `projects_locations_collections_data_stores_branches_documents_get` | `EXEC` | `branchesId, collectionsId, dataStoresId, documentsId, locationsId, projectsId` | Gets a Document. | | `projects_locations_collections_data_stores_branches_documents_import` | `EXEC` | `branchesId, collectionsId, dataStoresId, locationsId, projectsId` | Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated. | | `projects_locations_collections_data_stores_branches_documents_patch` | `EXEC` | `branchesId, collectionsId, dataStoresId, documentsId, locationsId, projectsId` | Updates a Document. | diff --git a/docs/google-docs/providers/google/discoveryengine/index.md b/docs/google-docs/providers/google/discoveryengine/index.md index 0f127e59cd..f3ac7ef915 100644 --- a/docs/google-docs/providers/google/discoveryengine/index.md +++ b/docs/google-docs/providers/google/discoveryengine/index.md @@ -21,7 +21,7 @@ Discovery Engine API.
total resources: 6
total selectable resources: 4
-total methods: 48
+total methods: 63
@@ -33,7 +33,7 @@ Discovery Engine API. TypeService TitleDiscovery Engine API DescriptionDiscovery Engine API. -Iddiscoveryengine:v23.08.00155 +Iddiscoveryengine:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/discoveryengine/operations/index.md b/docs/google-docs/providers/google/discoveryengine/operations/index.md index d5b9e9712a..782e010714 100644 --- a/docs/google-docs/providers/google/discoveryengine/operations/index.md +++ b/docs/google-docs/providers/google/discoveryengine/operations/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -43,6 +46,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_data_stores_operations_list` | `SELECT` | `dataStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_operations_list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_collections_data_stores_branches_operations_list` | `EXEC` | `branchesId, collectionsId, dataStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_collections_data_stores_models_operations_list` | `EXEC` | `collectionsId, dataStoresId, locationsId, modelsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_collections_data_stores_operations_list` | `EXEC` | `collectionsId, dataStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_collections_data_stores_schemas_operations_list` | `EXEC` | `collectionsId, dataStoresId, locationsId, projectsId, schemasId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_collections_engines_operations_list` | `EXEC` | `collectionsId, enginesId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_collections_operations_list` | `EXEC` | `collectionsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_data_stores_branches_operations_list` | `EXEC` | `branchesId, dataStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_data_stores_models_operations_list` | `EXEC` | `dataStoresId, locationsId, modelsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_data_stores_operations_list` | `EXEC` | `dataStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_operations_list` | `EXEC` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_collections_data_stores_branches_operations_get` | `EXEC` | `branchesId, collectionsId, dataStoresId, locationsId, operationsId, projectsId` | 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. | | `projects_locations_collections_data_stores_models_operations_get` | `EXEC` | `collectionsId, dataStoresId, locationsId, modelsId, operationsId, projectsId` | 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. | | `projects_locations_collections_data_stores_operations_get` | `EXEC` | `collectionsId, dataStoresId, locationsId, operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/discoveryengine/search_engine_operations/index.md b/docs/google-docs/providers/google/discoveryengine/search_engine_operations/index.md index 79e4803a8d..2beec868a4 100644 --- a/docs/google-docs/providers/google/discoveryengine/search_engine_operations/index.md +++ b/docs/google-docs/providers/google/discoveryengine/search_engine_operations/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_locations_collections_data_stores_site_search_engine_operations_list` | `SELECT` | `collectionsId, dataStoresId, locationsId, projectsId` | +| `_projects_locations_collections_data_stores_site_search_engine_operations_list` | `EXEC` | `collectionsId, dataStoresId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/discoveryengine/target_site_operations/index.md b/docs/google-docs/providers/google/discoveryengine/target_site_operations/index.md index ba03ed9f8d..65a7ff86e9 100644 --- a/docs/google-docs/providers/google/discoveryengine/target_site_operations/index.md +++ b/docs/google-docs/providers/google/discoveryengine/target_site_operations/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `metadata` | `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. | +| `response` | `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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_locations_collections_data_stores_site_search_engine_target_sites_operations_list` | `SELECT` | `collectionsId, dataStoresId, locationsId, projectsId` | +| `_projects_locations_collections_data_stores_site_search_engine_target_sites_operations_list` | `EXEC` | `collectionsId, dataStoresId, locationsId, projectsId` | 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 0c9ec83ec4..b413077d25 100644 --- a/docs/google-docs/providers/google/dlp/deidentify_templates/index.md +++ b/docs/google-docs/providers/google/dlp/deidentify_templates/index.md @@ -27,8 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If the next page is available then the next page token to be used in following ListDeidentifyTemplates request. | -| `deidentifyTemplates` | `array` | List of deidentify templates, up to page_size in ListDeidentifyTemplatesRequest. | +| `name` | `string` | Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` | +| `description` | `string` | Short description (max 256 chars). | +| `deidentifyConfig` | `object` | The configuration that controls how the data will change. | +| `displayName` | `string` | Display name (max 256 chars). | +| `updateTime` | `string` | Output only. The last update timestamp of an inspectTemplate. | +| `createTime` | `string` | Output only. The creation timestamp of an inspectTemplate. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -48,6 +52,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_locations_deidentify_templates_delete` | `DELETE` | `deidentifyTemplatesId, locationsId, organizationsId` | Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. | | `projects_deidentify_templates_delete` | `DELETE` | `deidentifyTemplatesId, projectsId` | Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. | | `projects_locations_deidentify_templates_delete` | `DELETE` | `deidentifyTemplatesId, locationsId, projectsId` | Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. | +| `_organizations_deidentify_templates_list` | `EXEC` | `organizationsId` | Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. | +| `_organizations_locations_deidentify_templates_list` | `EXEC` | `locationsId, organizationsId` | Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. | +| `_projects_deidentify_templates_list` | `EXEC` | `projectsId` | Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. | +| `_projects_locations_deidentify_templates_list` | `EXEC` | `locationsId, projectsId` | Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. | | `organizations_deidentify_templates_patch` | `EXEC` | `deidentifyTemplatesId, organizationsId` | Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. | | `organizations_locations_deidentify_templates_patch` | `EXEC` | `deidentifyTemplatesId, locationsId, organizationsId` | Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. | | `projects_deidentify_templates_patch` | `EXEC` | `deidentifyTemplatesId, projectsId` | Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more. | 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 2a0ccc06f4..0c489e17ff 100644 --- a/docs/google-docs/providers/google/dlp/dlp_jobs/index.md +++ b/docs/google-docs/providers/google/dlp/dlp_jobs/index.md @@ -27,8 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `jobs` | `array` | A list of DlpJobs that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | The server-assigned name. | +| `state` | `string` | State of a job. | +| `type` | `string` | The type of job. | +| `actionDetails` | `array` | Events that should occur after the job has completed. | +| `errors` | `array` | A stream of errors encountered running the job. | +| `inspectDetails` | `object` | The results of an inspect DataSource job. | +| `riskDetails` | `object` | Result of a risk analysis operation request. | +| `startTime` | `string` | Time when the job started. | +| `endTime` | `string` | Time when the job finished. | +| `jobTriggerName` | `string` | If created by a job trigger, the resource name of the trigger that instantiated the job. | +| `createTime` | `string` | Time when the job was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -41,6 +50,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_dlp_jobs_create` | `INSERT` | `locationsId, projectsId` | Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. | | `projects_dlp_jobs_delete` | `DELETE` | `dlpJobsId, projectsId` | Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. | | `projects_locations_dlp_jobs_delete` | `DELETE` | `dlpJobsId, locationsId, projectsId` | Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. | +| `_organizations_locations_dlp_jobs_list` | `EXEC` | `locationsId, organizationsId` | Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. | +| `_projects_dlp_jobs_list` | `EXEC` | `projectsId` | Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. | +| `_projects_locations_dlp_jobs_list` | `EXEC` | `locationsId, projectsId` | Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. | | `projects_dlp_jobs_cancel` | `EXEC` | `dlpJobsId, projectsId` | Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. | | `projects_locations_dlp_jobs_cancel` | `EXEC` | `dlpJobsId, locationsId, projectsId` | Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more. | | `projects_locations_dlp_jobs_finish` | `EXEC` | `dlpJobsId, locationsId, projectsId` | Finish a running hybrid DlpJob. Triggers the finalization steps and running of any enabled actions that have not yet run. | diff --git a/docs/google-docs/providers/google/dlp/index.md b/docs/google-docs/providers/google/dlp/index.md index 9c5880727a..0bdc0101d1 100644 --- a/docs/google-docs/providers/google/dlp/index.md +++ b/docs/google-docs/providers/google/dlp/index.md @@ -21,7 +21,7 @@ Provides Methods For Detection, Risk Analysis, And De-Identification Of Privacy-
total resources: 8
total selectable resources: 6
-total methods: 101
+total methods: 119
@@ -33,7 +33,7 @@ Provides Methods For Detection, Risk Analysis, And De-Identification Of Privacy- TypeService TitleCloud Data Loss Prevention (DLP) DescriptionProvides Methods For Detection, Risk Analysis, And De-Identification Of Privacy-Sensitive Fragments In Text, Images, And Google Cloud Platform Storage Repositories. -Iddlp:v23.08.00155 +Iddlp:v23.08.00157 ## Resources 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 139bc2e6e6..5aaf089a90 100644 --- a/docs/google-docs/providers/google/dlp/inspect_templates/index.md +++ b/docs/google-docs/providers/google/dlp/inspect_templates/index.md @@ -27,8 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `inspectTemplates` | `array` | List of inspectTemplates, up to page_size in ListInspectTemplatesRequest. | -| `nextPageToken` | `string` | If the next page is available then the next page token to be used in following ListInspectTemplates request. | +| `name` | `string` | Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; | +| `description` | `string` | Short description (max 256 chars). | +| `displayName` | `string` | Display name (max 256 chars). | +| `inspectConfig` | `object` | Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. | +| `updateTime` | `string` | Output only. The last update timestamp of an inspectTemplate. | +| `createTime` | `string` | Output only. The creation timestamp of an inspectTemplate. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -48,6 +52,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_locations_inspect_templates_delete` | `DELETE` | `inspectTemplatesId, locationsId, organizationsId` | Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. | | `projects_inspect_templates_delete` | `DELETE` | `inspectTemplatesId, projectsId` | Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. | | `projects_locations_inspect_templates_delete` | `DELETE` | `inspectTemplatesId, locationsId, projectsId` | Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. | +| `_organizations_inspect_templates_list` | `EXEC` | `organizationsId` | Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more. | +| `_organizations_locations_inspect_templates_list` | `EXEC` | `locationsId, organizationsId` | Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more. | +| `_projects_inspect_templates_list` | `EXEC` | `projectsId` | Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more. | +| `_projects_locations_inspect_templates_list` | `EXEC` | `locationsId, projectsId` | Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more. | | `organizations_inspect_templates_patch` | `EXEC` | `inspectTemplatesId, organizationsId` | Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. | | `organizations_locations_inspect_templates_patch` | `EXEC` | `inspectTemplatesId, locationsId, organizationsId` | Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. | | `projects_inspect_templates_patch` | `EXEC` | `inspectTemplatesId, projectsId` | Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more. | 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 7eabf4b099..2335719667 100644 --- a/docs/google-docs/providers/google/dlp/job_triggers/index.md +++ b/docs/google-docs/providers/google/dlp/job_triggers/index.md @@ -27,8 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `jobTriggers` | `array` | List of triggeredJobs, up to page_size in ListJobTriggersRequest. | -| `nextPageToken` | `string` | If the next page is available then the next page token to be used in following ListJobTriggers request. | +| `name` | `string` | Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. | +| `description` | `string` | User provided description (max 256 chars) | +| `errors` | `array` | Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared. | +| `lastRunTime` | `string` | Output only. The timestamp of the last time this trigger executed. | +| `status` | `string` | Required. A status for this trigger. | +| `createTime` | `string` | Output only. The creation timestamp of a triggeredJob. | +| `displayName` | `string` | Display name (max 100 chars) | +| `triggers` | `array` | A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. | +| `inspectJob` | `object` | Controls what and how to inspect for findings. | +| `updateTime` | `string` | Output only. The last update timestamp of a triggeredJob. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,6 +52,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_locations_job_triggers_delete` | `DELETE` | `jobTriggersId, locationsId, organizationsId` | Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. | | `projects_job_triggers_delete` | `DELETE` | `jobTriggersId, projectsId` | Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. | | `projects_locations_job_triggers_delete` | `DELETE` | `jobTriggersId, locationsId, projectsId` | Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. | +| `_organizations_locations_job_triggers_list` | `EXEC` | `locationsId, organizationsId` | Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. | +| `_projects_job_triggers_list` | `EXEC` | `projectsId` | Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. | +| `_projects_locations_job_triggers_list` | `EXEC` | `locationsId, projectsId` | Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. | | `organizations_locations_job_triggers_patch` | `EXEC` | `jobTriggersId, locationsId, organizationsId` | Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. | | `projects_job_triggers_activate` | `EXEC` | `jobTriggersId, projectsId` | Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur. | | `projects_job_triggers_patch` | `EXEC` | `jobTriggersId, projectsId` | Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more. | 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 929aae685c..5602f2bafd 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 @@ -27,8 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `storedInfoTypes` | `array` | List of storedInfoTypes, up to page_size in ListStoredInfoTypesRequest. | -| `nextPageToken` | `string` | If the next page is available then the next page token to be used in following ListStoredInfoTypes request. | +| `name` | `string` | Resource name. | +| `currentVersion` | `object` | Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. | +| `pendingVersions` | `array` | Pending versions of the stored info type. Empty if no versions are pending. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -48,6 +49,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_stored_info_types_delete` | `DELETE` | `organizationsId, storedInfoTypesId` | Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. | | `projects_locations_stored_info_types_delete` | `DELETE` | `locationsId, projectsId, storedInfoTypesId` | Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. | | `projects_stored_info_types_delete` | `DELETE` | `projectsId, storedInfoTypesId` | Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. | +| `_organizations_locations_stored_info_types_list` | `EXEC` | `locationsId, organizationsId` | Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. | +| `_organizations_stored_info_types_list` | `EXEC` | `organizationsId` | Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. | +| `_projects_locations_stored_info_types_list` | `EXEC` | `locationsId, projectsId` | Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. | +| `_projects_stored_info_types_list` | `EXEC` | `projectsId` | Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. | | `organizations_locations_stored_info_types_patch` | `EXEC` | `locationsId, organizationsId, storedInfoTypesId` | Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. | | `organizations_stored_info_types_patch` | `EXEC` | `organizationsId, storedInfoTypesId` | Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. | | `projects_locations_stored_info_types_patch` | `EXEC` | `locationsId, projectsId, storedInfoTypesId` | Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. | diff --git a/docs/google-docs/providers/google/dns/changes/index.md b/docs/google-docs/providers/google/dns/changes/index.md index 43baa73121..7e2ef7390c 100644 --- a/docs/google-docs/providers/google/dns/changes/index.md +++ b/docs/google-docs/providers/google/dns/changes/index.md @@ -27,13 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `changes` | `array` | The requested changes. | -| `header` | `object` | Elements common to every response. | -| `kind` | `string` | Type of resource. | -| `nextPageToken` | `string` | The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. This lets you retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a "snapshot" of collections larger than the maximum page size. | +| `id` | `string` | Unique identifier for the resource; defined by the server (output only). | +| `kind` | `string` | | +| `startTime` | `string` | The time that this operation was started by the server (output only). This is in RFC3339 text format. | +| `status` | `string` | Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. | +| `additions` | `array` | Which ResourceRecordSets to add? | +| `deletions` | `array` | Which ResourceRecordSets to remove? Must match existing data exactly. | +| `isServing` | `boolean` | If the DNS queries for the zone will be served. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `changeId, managedZone, project` | Fetches the representation of an existing Change. | | `list` | `SELECT` | `managedZone, project` | Enumerates Changes to a ResourceRecordSet collection. | | `create` | `INSERT` | `managedZone, project` | Atomically updates the ResourceRecordSet collection. | +| `_list` | `EXEC` | `managedZone, project` | Enumerates Changes to a ResourceRecordSet collection. | diff --git a/docs/google-docs/providers/google/dns/dns_keys/index.md b/docs/google-docs/providers/google/dns/dns_keys/index.md index b00d5f6581..beaac92f2a 100644 --- a/docs/google-docs/providers/google/dns/dns_keys/index.md +++ b/docs/google-docs/providers/google/dns/dns_keys/index.md @@ -27,12 +27,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size. | -| `dnsKeys` | `array` | The requested resources. | -| `header` | `object` | Elements common to every response. | -| `kind` | `string` | Type of resource. | +| `id` | `string` | Unique identifier for the resource; defined by the server (output only). | +| `description` | `string` | A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function. | +| `keyTag` | `integer` | The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only. | +| `isActive` | `boolean` | Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures. | +| `algorithm` | `string` | String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. | +| `type` | `string` | One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time. | +| `creationTime` | `string` | The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. | +| `digests` | `array` | Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only. | +| `kind` | `string` | | +| `keyLength` | `integer` | Length of the key in bits. Specified at creation time, and then immutable. | +| `publicKey` | `string` | Base64 encoded public half of this key. Output only. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `dnsKeyId, managedZone, project` | Fetches the representation of an existing DnsKey. | | `list` | `SELECT` | `managedZone, project` | Enumerates DnsKeys to a ResourceRecordSet collection. | +| `_list` | `EXEC` | `managedZone, project` | Enumerates DnsKeys to a ResourceRecordSet collection. | diff --git a/docs/google-docs/providers/google/dns/index.md b/docs/google-docs/providers/google/dns/index.md index 5d76acb222..ed7bb54919 100644 --- a/docs/google-docs/providers/google/dns/index.md +++ b/docs/google-docs/providers/google/dns/index.md @@ -20,8 +20,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 10
-total selectable resources: 9
-total methods: 40
+total selectable resources: 10
+total methods: 48
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleCloud DNS API Description -Iddns:v23.08.00155 +Iddns:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/dns/managed_zone_operations/index.md b/docs/google-docs/providers/google/dns/managed_zone_operations/index.md index 8b49092a18..d460f92f64 100644 --- a/docs/google-docs/providers/google/dns/managed_zone_operations/index.md +++ b/docs/google-docs/providers/google/dns/managed_zone_operations/index.md @@ -27,12 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `header` | `object` | Elements common to every response. | -| `kind` | `string` | Type of resource. | -| `nextPageToken` | `string` | The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. | -| `operations` | `array` | The operation resources. | +| `id` | `string` | Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only) | +| `zoneContext` | `object` | | +| `dnsKeyContext` | `object` | | +| `kind` | `string` | | +| `startTime` | `string` | The time that this operation was started by the server. This is in RFC3339 text format (output only). | +| `status` | `string` | Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. | +| `type` | `string` | Type of the operation. Operations include insert, update, and delete (output only). | +| `user` | `string` | User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only) | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `managedZone, operation, project` | Fetches the representation of an existing Operation. | | `list` | `SELECT` | `managedZone, project` | Enumerates Operations for the given ManagedZone. | +| `_list` | `EXEC` | `managedZone, project` | Enumerates Operations for the given ManagedZone. | diff --git a/docs/google-docs/providers/google/dns/managed_zones/index.md b/docs/google-docs/providers/google/dns/managed_zones/index.md index 45819ff2d9..25cfd33737 100644 --- a/docs/google-docs/providers/google/dns/managed_zones/index.md +++ b/docs/google-docs/providers/google/dns/managed_zones/index.md @@ -27,10 +27,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. | -| `header` | `object` | Elements common to every response. | -| `kind` | `string` | Type of resource. | -| `managedZones` | `array` | The managed zone resources. | +| `id` | `string` | Unique identifier for the resource; defined by the server (output only) | +| `name` | `string` | User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. | +| `description` | `string` | A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. | +| `nameServers` | `array` | Delegate your managed_zone to these virtual name servers; defined by the server (output only) | +| `dnsName` | `string` | The DNS name of this managed zone, for instance "example.com.". | +| `forwardingConfig` | `object` | | +| `peeringConfig` | `object` | | +| `privateVisibilityConfig` | `object` | | +| `visibility` | `string` | The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. | +| `kind` | `string` | | +| `cloudLoggingConfig` | `object` | Cloud Logging configurations for publicly visible zones. | +| `serviceDirectoryConfig` | `object` | Contains information about Service Directory-backed zones. | +| `labels` | `object` | User labels. | +| `nameServerSet` | `string` | Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team. | +| `reverseLookupConfig` | `object` | | +| `creationTime` | `string` | The time that this resource was created on the server. This is in RFC3339 text format. Output only. | +| `dnssecConfig` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,5 +51,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Enumerates ManagedZones that have been created but not yet deleted. | | `create` | `INSERT` | `project` | Creates a new ManagedZone. | | `delete` | `DELETE` | `managedZone, project` | Deletes a previously created ManagedZone. | +| `_list` | `EXEC` | `project` | Enumerates ManagedZones that have been created but not yet deleted. | | `patch` | `EXEC` | `managedZone, project` | Applies a partial update to an existing ManagedZone. | | `update` | `EXEC` | `managedZone, project` | Updates an existing ManagedZone. | diff --git a/docs/google-docs/providers/google/dns/managed_zones_iam_policies/index.md b/docs/google-docs/providers/google/dns/managed_zones_iam_policies/index.md index fd99c7ad96..42dcef7a28 100644 --- a/docs/google-docs/providers/google/dns/managed_zones_iam_policies/index.md +++ b/docs/google-docs/providers/google/dns/managed_zones_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `managedZonesId, projectsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | +| `get_iam_policy` | `SELECT` | `managedZonesId, projectsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | | `set_iam_policy` | `EXEC` | `managedZonesId, projectsId` | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. | | `test_iam_permissions` | `EXEC` | `managedZonesId, projectsId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this returns an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | diff --git a/docs/google-docs/providers/google/dns/policies/index.md b/docs/google-docs/providers/google/dns/policies/index.md index 51d42cfa97..478b04d9b6 100644 --- a/docs/google-docs/providers/google/dns/policies/index.md +++ b/docs/google-docs/providers/google/dns/policies/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `header` | `object` | Elements common to every response. | -| `kind` | `string` | Type of resource. | -| `nextPageToken` | `string` | The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. This lets you the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. | -| `policies` | `array` | The policy resources. | +| `id` | `string` | Unique identifier for the resource; defined by the server (output only). | +| `name` | `string` | User-assigned name for this policy. | +| `description` | `string` | A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. | +| `kind` | `string` | | +| `networks` | `array` | List of network names specifying networks to which this policy is applied. | +| `alternativeNameServerConfig` | `object` | | +| `enableInboundForwarding` | `boolean` | Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy. | +| `enableLogging` | `boolean` | Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,5 +42,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Enumerates all Policies associated with a project. | | `create` | `INSERT` | `project` | Creates a new Policy. | | `delete` | `DELETE` | `policy, project` | Deletes a previously created Policy. Fails if the policy is still being referenced by a network. | +| `_list` | `EXEC` | `project` | Enumerates all Policies associated with a project. | | `patch` | `EXEC` | `policy, project` | Applies a partial update to an existing Policy. | | `update` | `EXEC` | `policy, project` | Updates an existing Policy. | diff --git a/docs/google-docs/providers/google/dns/projects/index.md b/docs/google-docs/providers/google/dns/projects/index.md index d4fffc346b..2201b4845c 100644 --- a/docs/google-docs/providers/google/dns/projects/index.md +++ b/docs/google-docs/providers/google/dns/projects/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | User assigned unique identifier for the resource (output only). | -| `quota` | `object` | Limits associated with a Project. | | `kind` | `string` | | | `number` | `string` | Unique numeric identifier for the resource; defined by the server (output only). | +| `quota` | `object` | Limits associated with a Project. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/dns/resource_record_sets/index.md b/docs/google-docs/providers/google/dns/resource_record_sets/index.md index eff1023db4..4ceee4429b 100644 --- a/docs/google-docs/providers/google/dns/resource_record_sets/index.md +++ b/docs/google-docs/providers/google/dns/resource_record_sets/index.md @@ -27,10 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `rrsets` | `array` | The resource record set resources. | -| `header` | `object` | Elements common to every response. | -| `kind` | `string` | Type of resource. | -| `nextPageToken` | `string` | The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. This lets you retrieve complete contents of even larger collections, one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. | +| `name` | `string` | For example, www.example.com. | +| `signatureRrdatas` | `array` | As defined in RFC 4034 (section 3.2). | +| `ttl` | `integer` | Number of seconds that this ResourceRecordSet can be cached by resolvers. | +| `type` | `string` | The identifier of a supported record type. See the list of Supported DNS record types. | +| `kind` | `string` | | +| `routingPolicy` | `object` | A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. | +| `rrdatas` | `array` | As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,4 +41,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `managedZone, project` | Enumerates ResourceRecordSets that you have created but not yet deleted. | | `create` | `INSERT` | `managedZone, project` | Creates a new ResourceRecordSet. | | `delete` | `DELETE` | `managedZone, name, project, type` | Deletes a previously created ResourceRecordSet. | +| `_list` | `EXEC` | `managedZone, project` | Enumerates ResourceRecordSets that you have created but not yet deleted. | | `patch` | `EXEC` | `managedZone, name, project, type` | Applies a partial update to an existing ResourceRecordSet. | diff --git a/docs/google-docs/providers/google/dns/response_policies/index.md b/docs/google-docs/providers/google/dns/response_policies/index.md index b0936da426..50ae920f92 100644 --- a/docs/google-docs/providers/google/dns/response_policies/index.md +++ b/docs/google-docs/providers/google/dns/response_policies/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `header` | `object` | Elements common to every response. | -| `nextPageToken` | `string` | The presence of this field indicates that more results exist following your last page of results in pagination order. To fetch them, make another list request by using this value as your page token. This lets you view the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned are an inconsistent view of the collection. You cannot retrieve a consistent snapshot of a collection larger than the maximum page size. | -| `responsePolicies` | `array` | The Response Policy resources. | +| `id` | `string` | Unique identifier for the resource; defined by the server (output only). | +| `description` | `string` | User-provided description for this Response Policy. | +| `gkeClusters` | `array` | The list of Google Kubernetes Engine clusters to which this response policy is applied. | +| `kind` | `string` | | +| `labels` | `object` | User labels. | +| `networks` | `array` | List of network names specifying networks to which this policy is applied. | +| `responsePolicyName` | `string` | User assigned name for this Response Policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,5 +41,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Enumerates all Response Policies associated with a project. | | `create` | `INSERT` | `project` | Creates a new Response Policy | | `delete` | `DELETE` | `project, responsePolicy` | Deletes a previously created Response Policy. Fails if the response policy is non-empty or still being referenced by a network. | +| `_list` | `EXEC` | `project` | Enumerates all Response Policies associated with a project. | | `patch` | `EXEC` | `project, responsePolicy` | Applies a partial update to an existing Response Policy. | | `update` | `EXEC` | `project, responsePolicy` | Updates an existing Response Policy. | diff --git a/docs/google-docs/providers/google/dns/response_policy_rules/index.md b/docs/google-docs/providers/google/dns/response_policy_rules/index.md index 1867409470..5796d7cbd5 100644 --- a/docs/google-docs/providers/google/dns/response_policy_rules/index.md +++ b/docs/google-docs/providers/google/dns/response_policy_rules/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `ruleName` | `string` | An identifier for this rule. Must be unique with the ResponsePolicy. | -| `behavior` | `string` | Answer this query with a behavior rather than DNS data. | | `dnsName` | `string` | The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. | | `kind` | `string` | | | `localData` | `object` | | +| `ruleName` | `string` | An identifier for this rule. Must be unique with the ResponsePolicy. | +| `behavior` | `string` | Answer this query with a behavior rather than DNS data. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -39,5 +39,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, responsePolicy` | Enumerates all Response Policy Rules associated with a project. | | `create` | `INSERT` | `project, responsePolicy` | Creates a new Response Policy Rule. | | `delete` | `DELETE` | `project, responsePolicy, responsePolicyRule` | Deletes a previously created Response Policy Rule. | +| `_list` | `EXEC` | `project, responsePolicy` | Enumerates all Response Policy Rules associated with a project. | | `patch` | `EXEC` | `project, responsePolicy, responsePolicyRule` | Applies a partial update to an existing Response Policy Rule. | | `update` | `EXEC` | `project, responsePolicy, responsePolicyRule` | Updates an existing Response Policy Rule. | diff --git a/docs/google-docs/providers/google/documentai/evaluations/index.md b/docs/google-docs/providers/google/documentai/evaluations/index.md index e55d898f0d..d47fec2036 100644 --- a/docs/google-docs/providers/google/documentai/evaluations/index.md +++ b/docs/google-docs/providers/google/documentai/evaluations/index.md @@ -27,10 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `evaluations` | `array` | The evaluations requested. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | The resource name of the evaluation. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` | +| `allEntitiesMetrics` | `object` | Metrics across multiple confidence levels. | +| `createTime` | `string` | The time that the evaluation was created. | +| `documentCounters` | `object` | Evaluation counters for the documents that were used. | +| `entityMetrics` | `object` | Metrics across confidence levels, for different entities. | +| `kmsKeyName` | `string` | The KMS key name used for encryption. | +| `kmsKeyVersionName` | `string` | The KMS key version with which data is encrypted. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_processors_processor_versions_evaluations_list` | `SELECT` | `locationsId, processorVersionsId, processorsId, projectsId` | Retrieves a set of evaluations for a given processor version. | +| `_projects_locations_processors_processor_versions_evaluations_list` | `EXEC` | `locationsId, processorVersionsId, processorsId, projectsId` | Retrieves a set of evaluations for a given processor version. | | `projects_locations_processors_processor_versions_evaluations_get` | `EXEC` | `evaluationsId, locationsId, processorVersionsId, processorsId, projectsId` | Retrieves a specific evaluation. | diff --git a/docs/google-docs/providers/google/documentai/index.md b/docs/google-docs/providers/google/documentai/index.md index dea577bf2f..58dda47855 100644 --- a/docs/google-docs/providers/google/documentai/index.md +++ b/docs/google-docs/providers/google/documentai/index.md @@ -21,7 +21,7 @@ Service To Parse Structured Information From Unstructured Or Semi-Structured Doc
total resources: 7
total selectable resources: 6
-total methods: 31
+total methods: 37
@@ -33,7 +33,7 @@ Service To Parse Structured Information From Unstructured Or Semi-Structured Doc TypeService TitleCloud Document AI API DescriptionService To Parse Structured Information From Unstructured Or Semi-Structured Documents Using State-Of-The-Art Google AI Such As Natural Language, Computer Vision, Translation, And AutoML. -Iddocumentai:v23.08.00155 +Iddocumentai:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/documentai/locations/index.md b/docs/google-docs/providers/google/documentai/locations/index.md index 6c6ea95bd3..8d9faf5e09 100644 --- a/docs/google-docs/providers/google/documentai/locations/index.md +++ b/docs/google-docs/providers/google/documentai/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/documentai/operations/index.md b/docs/google-docs/providers/google/documentai/operations/index.md index 91db0ab427..a39d383d40 100644 --- a/docs/google-docs/providers/google/documentai/operations/index.md +++ b/docs/google-docs/providers/google/documentai/operations/index.md @@ -27,13 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `response` | `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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `operations_delete` | `DELETE` | `operationsId` | 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`. | +| `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | | `projects_locations_operations_get` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | | `projects_operations_get` | `EXEC` | `operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/documentai/processor_types/index.md b/docs/google-docs/providers/google/documentai/processor_types/index.md index 9afa3be86e..aeaee01d57 100644 --- a/docs/google-docs/providers/google/documentai/processor_types/index.md +++ b/docs/google-docs/providers/google/documentai/processor_types/index.md @@ -28,15 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}` | -| `sampleDocumentUris` | `array` | A set of Cloud Storage URIs of sample documents for this processor. | | `type` | `string` | The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. | | `allowCreation` | `boolean` | Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access. | | `availableLocations` | `array` | The locations in which this processor is available. | | `category` | `string` | The processor category, used by UI to group processor types. | | `launchStage` | `string` | Launch stage of the processor type | +| `sampleDocumentUris` | `array` | A set of Cloud Storage URIs of sample documents for this processor. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_processor_types_get` | `SELECT` | `locationsId, processorTypesId, projectsId` | Gets a processor type detail. | | `projects_locations_processor_types_list` | `SELECT` | `locationsId, projectsId` | Lists the processor types that exist. | +| `_projects_locations_processor_types_list` | `EXEC` | `locationsId, projectsId` | Lists the processor types that exist. | | `projects_locations_fetch_processor_types` | `EXEC` | `locationsId, projectsId` | Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated. | diff --git a/docs/google-docs/providers/google/documentai/processor_versions/index.md b/docs/google-docs/providers/google/documentai/processor_versions/index.md index 33731f5620..a28ddf9b18 100644 --- a/docs/google-docs/providers/google/documentai/processor_versions/index.md +++ b/docs/google-docs/providers/google/documentai/processor_versions/index.md @@ -27,14 +27,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `processorVersions` | `array` | The list of processors. | -| `nextPageToken` | `string` | Points to the next processor, otherwise empty. | +| `name` | `string` | The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` | +| `state` | `string` | The state of the processor version. | +| `kmsKeyVersionName` | `string` | The KMS key version with which data is encrypted. | +| `deprecationInfo` | `object` | Information about the upcoming deprecation of this processor version. | +| `displayName` | `string` | The display name of the processor version. | +| `latestEvaluation` | `object` | Gives a short summary of an evaluation, and links to the evaluation itself. | +| `documentSchema` | `object` | The schema defines the output of the processed document by a processor. | +| `googleManaged` | `boolean` | Output only. Denotes that this `ProcessorVersion` is managed by Google. | +| `kmsKeyName` | `string` | The KMS key name used for encryption. | +| `createTime` | `string` | The time the processor version was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_processors_processor_versions_get` | `SELECT` | `locationsId, processorVersionsId, processorsId, projectsId` | Gets a processor version detail. | | `projects_locations_processors_processor_versions_list` | `SELECT` | `locationsId, processorsId, projectsId` | Lists all versions of a processor. | | `projects_locations_processors_processor_versions_delete` | `DELETE` | `locationsId, processorVersionsId, processorsId, projectsId` | Deletes the processor version, all artifacts under the processor version will be deleted. | +| `_projects_locations_processors_processor_versions_list` | `EXEC` | `locationsId, processorsId, projectsId` | Lists all versions of a processor. | | `projects_locations_processors_processor_versions_batch_process` | `EXEC` | `locationsId, processorVersionsId, processorsId, projectsId` | LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. | | `projects_locations_processors_processor_versions_deploy` | `EXEC` | `locationsId, processorVersionsId, processorsId, projectsId` | Deploys the processor version. | | `projects_locations_processors_processor_versions_evaluate_processor_version` | `EXEC` | `locationsId, processorVersionsId, processorsId, projectsId` | Evaluates a ProcessorVersion against annotated documents, producing an Evaluation. | diff --git a/docs/google-docs/providers/google/documentai/processors/index.md b/docs/google-docs/providers/google/documentai/processors/index.md index 7aef643dc5..6660d0699e 100644 --- a/docs/google-docs/providers/google/documentai/processors/index.md +++ b/docs/google-docs/providers/google/documentai/processors/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}` | -| `defaultProcessorVersion` | `string` | The default processor version. | -| `processEndpoint` | `string` | Output only. Immutable. The http endpoint that can be called to invoke processing. | -| `kmsKeyName` | `string` | The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. | +| `type` | `string` | The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. | | `createTime` | `string` | The time the processor was created. | | `processorVersionAliases` | `array` | Output only. The processor version aliases. | +| `kmsKeyName` | `string` | The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. | | `state` | `string` | Output only. The state of the processor. | -| `type` | `string` | The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. | +| `defaultProcessorVersion` | `string` | The default processor version. | +| `processEndpoint` | `string` | Output only. Immutable. The http endpoint that can be called to invoke processing. | | `displayName` | `string` | The display name of the processor. | ## Methods | Name | Accessible by | Required Params | Description | @@ -43,6 +43,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_processors_list` | `SELECT` | `locationsId, projectsId` | Lists all processors which belong to this project. | | `projects_locations_processors_create` | `INSERT` | `locationsId, projectsId` | Creates a processor from the ProcessorType provided. The processor will be at `ENABLED` state by default after its creation. | | `projects_locations_processors_delete` | `DELETE` | `locationsId, processorsId, projectsId` | Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor. | +| `_projects_locations_processors_list` | `EXEC` | `locationsId, projectsId` | Lists all processors which belong to this project. | | `projects_locations_processors_batch_process` | `EXEC` | `locationsId, processorsId, projectsId` | LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. | | `projects_locations_processors_disable` | `EXEC` | `locationsId, processorsId, projectsId` | Disables a processor | | `projects_locations_processors_enable` | `EXEC` | `locationsId, processorsId, projectsId` | Enables a processor | diff --git a/docs/google-docs/providers/google/domains/index.md b/docs/google-docs/providers/google/domains/index.md index da122fdfa3..5252677b61 100644 --- a/docs/google-docs/providers/google/domains/index.md +++ b/docs/google-docs/providers/google/domains/index.md @@ -21,7 +21,7 @@ Enables Management And Configuration Of Domain Names.
total resources: 8
total selectable resources: 4
-total methods: 24
+total methods: 27
@@ -33,7 +33,7 @@ Enables Management And Configuration Of Domain Names. TypeService TitleCloud Domains API DescriptionEnables Management And Configuration Of Domain Names. -Iddomains:v23.08.00155 +Iddomains:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/domains/locations/index.md b/docs/google-docs/providers/google/domains/locations/index.md index d5af4c8a89..e23fe5cc7a 100644 --- a/docs/google-docs/providers/google/domains/locations/index.md +++ b/docs/google-docs/providers/google/domains/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/domains/operations/index.md b/docs/google-docs/providers/google/domains/operations/index.md index 852521cd84..c98393dd8b 100644 --- a/docs/google-docs/providers/google/domains/operations/index.md +++ b/docs/google-docs/providers/google/domains/operations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | diff --git a/docs/google-docs/providers/google/domains/registrations/index.md b/docs/google-docs/providers/google/domains/registrations/index.md index 821d5dc343..0079c681ee 100644 --- a/docs/google-docs/providers/google/domains/registrations/index.md +++ b/docs/google-docs/providers/google/domains/registrations/index.md @@ -27,14 +27,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | When present, there are more results to retrieve. Set `page_token` to this value on a subsequent call to get the next page of results. | -| `registrations` | `array` | A list of `Registration`s. | +| `name` | `string` | Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. | +| `managementSettings` | `object` | Defines renewal, billing, and transfer settings for a `Registration`. | +| `labels` | `object` | Set of labels associated with the `Registration`. | +| `issues` | `array` | Output only. The set of issues with the `Registration` that require attention. | +| `dnsSettings` | `object` | Defines the DNS configuration of a `Registration`, including name servers, DNSSEC, and glue records. | +| `pendingContactSettings` | `object` | Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. | +| `state` | `string` | Output only. The state of the `Registration` | +| `expireTime` | `string` | Output only. The expiration timestamp of the `Registration`. | +| `createTime` | `string` | Output only. The creation timestamp of the `Registration` resource. | +| `contactSettings` | `object` | Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. | +| `domainName` | `string` | Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. | +| `supportedPrivacy` | `array` | Output only. Set of options for the `contact_settings.privacy` field that this `Registration` supports. | +| `transferFailureReason` | `string` | Output only. The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state. | +| `registerFailureReason` | `string` | Output only. The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId, registrationsId` | Gets the details of a `Registration` resource. | | `list` | `SELECT` | `locationsId, projectsId` | Lists the `Registration` resources in a project. | | `delete` | `DELETE` | `locationsId, projectsId, registrationsId` | Deletes a `Registration` resource. This method works on any `Registration` resource using [Subscription or Commitment billing](/domains/pricing#billing-models), provided that the resource was created at least 1 day in the past. For `Registration` resources using [Monthly billing](/domains/pricing#billing-models), this method works if: * `state` is `EXPORTED` with `expire_time` in the past * `state` is `REGISTRATION_FAILED` * `state` is `TRANSFER_FAILED` When an active registration is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists the `Registration` resources in a project. | | `configure_contact_settings` | `EXEC` | `locationsId, projectsId, registrationsId` | Updates a `Registration`'s contact settings. Some changes require confirmation by the domain's registrant contact . | | `configure_dns_settings` | `EXEC` | `locationsId, projectsId, registrationsId` | Updates a `Registration`'s DNS settings. | | `configure_management_settings` | `EXEC` | `locationsId, projectsId, registrationsId` | Updates a `Registration`'s management settings. | diff --git a/docs/google-docs/providers/google/domains/registrations_iam_policies/index.md b/docs/google-docs/providers/google/domains/registrations_iam_policies/index.md index 7b7487fec5..ca97657707 100644 --- a/docs/google-docs/providers/google/domains/registrations_iam_policies/index.md +++ b/docs/google-docs/providers/google/domains/registrations_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/essentialcontacts/contacts/index.md b/docs/google-docs/providers/google/essentialcontacts/contacts/index.md index 1af7c2d5df..ec8974cdb1 100644 --- a/docs/google-docs/providers/google/essentialcontacts/contacts/index.md +++ b/docs/google-docs/providers/google/essentialcontacts/contacts/index.md @@ -27,8 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. | -| `contacts` | `array` | The contacts for the specified resource. | +| `name` | `string` | Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} | +| `validateTime` | `string` | The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. | +| `validationState` | `string` | The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. | +| `email` | `string` | Required. The email address to send notifications to. The email address does not need to be a Google Account. | +| `languageTag` | `string` | Required. The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages. | +| `notificationCategorySubscriptions` | `array` | Required. The categories of notifications that the contact will receive communications for. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,6 +48,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `folders_contacts_delete` | `DELETE` | `contactsId, foldersId` | Deletes a contact. | | `organizations_contacts_delete` | `DELETE` | `contactsId, organizationsId` | Deletes a contact. | | `projects_contacts_delete` | `DELETE` | `contactsId, projectsId` | Deletes a contact. | +| `_folders_contacts_list` | `EXEC` | `foldersId` | Lists the contacts that have been set on a resource. | +| `_organizations_contacts_list` | `EXEC` | `organizationsId` | Lists the contacts that have been set on a resource. | +| `_projects_contacts_list` | `EXEC` | `projectsId` | Lists the contacts that have been set on a resource. | | `folders_contacts_compute` | `EXEC` | `foldersId` | Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources. | | `folders_contacts_patch` | `EXEC` | `contactsId, foldersId` | Updates a contact. Note: A contact's email address cannot be changed. | | `folders_contacts_send_test_message` | `EXEC` | `foldersId` | Allows a contact admin to send a test message to contact to verify that it has been configured correctly. | diff --git a/docs/google-docs/providers/google/essentialcontacts/index.md b/docs/google-docs/providers/google/essentialcontacts/index.md index 2f81477a4c..15d531fea5 100644 --- a/docs/google-docs/providers/google/essentialcontacts/index.md +++ b/docs/google-docs/providers/google/essentialcontacts/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 1
total selectable resources: 1
-total methods: 21
+total methods: 24
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleEssential Contacts API Description -Idessentialcontacts:v23.08.00155 +Idessentialcontacts:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/eventarc/channel_connections/index.md b/docs/google-docs/providers/google/eventarc/channel_connections/index.md index 77b2ddb0c6..3a109764f6 100644 --- a/docs/google-docs/providers/google/eventarc/channel_connections/index.md +++ b/docs/google-docs/providers/google/eventarc/channel_connections/index.md @@ -27,9 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `channelConnections` | `array` | The requested channel connections, up to the number specified in `page_size`. | -| `nextPageToken` | `string` | A page token that can be sent to `ListChannelConnections` to request the next page. If this is empty, then there are no more pages. | -| `unreachable` | `array` | Unreachable resources, if any. | +| `name` | `string` | Required. The name of the connection. | +| `uid` | `string` | Output only. Server assigned ID of the resource. The server guarantees uniqueness and immutability until deleted. | +| `updateTime` | `string` | Output only. The last-modified time. | +| `activationToken` | `string` | Input only. Activation token for the channel. The token will be used during the creation of ChannelConnection to bind the channel with the provider project. This field will not be stored in the provider resource. | +| `channel` | `string` | Required. The name of the connected subscriber Channel. This is a weak reference to avoid cross project and cross accounts references. This must be in `projects/{project}/location/{location}/channels/{channel_id}` format. | +| `createTime` | `string` | Output only. The creation time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,3 +40,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | List channel connections. | | `create` | `INSERT` | `locationsId, projectsId` | Create a new ChannelConnection in a particular project and location. | | `delete` | `DELETE` | `channelConnectionsId, locationsId, projectsId` | Delete a single ChannelConnection. | +| `_list` | `EXEC` | `locationsId, projectsId` | List channel connections. | diff --git a/docs/google-docs/providers/google/eventarc/channel_connections_iam_policies/index.md b/docs/google-docs/providers/google/eventarc/channel_connections_iam_policies/index.md index 673d707733..fb6463239c 100644 --- a/docs/google-docs/providers/google/eventarc/channel_connections_iam_policies/index.md +++ b/docs/google-docs/providers/google/eventarc/channel_connections_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/eventarc/channels/index.md b/docs/google-docs/providers/google/eventarc/channels/index.md index b6590bec70..7ea6473a06 100644 --- a/docs/google-docs/providers/google/eventarc/channels/index.md +++ b/docs/google-docs/providers/google/eventarc/channels/index.md @@ -27,9 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A page token that can be sent to `ListChannels` to request the next page. If this is empty, then there are no more pages. | -| `unreachable` | `array` | Unreachable resources, if any. | -| `channels` | `array` | The requested channels, up to the number specified in `page_size`. | +| `name` | `string` | Required. The resource name of the channel. Must be unique within the location on the project and must be in `projects/{project}/locations/{location}/channels/{channel_id}` format. | +| `pubsubTopic` | `string` | Output only. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: `projects/{project}/topics/{topic_id}`. | +| `updateTime` | `string` | Output only. The last-modified time. | +| `uid` | `string` | Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | +| `provider` | `string` | The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: `projects/{project}/locations/{location}/providers/{provider_id}`. | +| `activationToken` | `string` | Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing. | +| `state` | `string` | Output only. The state of a Channel. | +| `createTime` | `string` | Output only. The creation time. | +| `cryptoKeyName` | `string` | Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +43,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | List channels. | | `create` | `INSERT` | `locationsId, projectsId` | Create a new channel in a particular project and location. | | `delete` | `DELETE` | `channelsId, locationsId, projectsId` | Delete a single channel. | +| `_list` | `EXEC` | `locationsId, projectsId` | List channels. | | `patch` | `EXEC` | `channelsId, locationsId, projectsId` | Update a single channel. | diff --git a/docs/google-docs/providers/google/eventarc/channels_iam_policies/index.md b/docs/google-docs/providers/google/eventarc/channels_iam_policies/index.md index 4d044215de..d0f055f96a 100644 --- a/docs/google-docs/providers/google/eventarc/channels_iam_policies/index.md +++ b/docs/google-docs/providers/google/eventarc/channels_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/eventarc/google_channel_config/index.md b/docs/google-docs/providers/google/eventarc/google_channel_config/index.md index 9ea66aeee4..e1d197dc00 100644 --- a/docs/google-docs/providers/google/eventarc/google_channel_config/index.md +++ b/docs/google-docs/providers/google/eventarc/google_channel_config/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. | -| `cryptoKeyName` | `string` | Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`. | | `updateTime` | `string` | Output only. The last-modified time. | +| `cryptoKeyName` | `string` | Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/eventarc/index.md b/docs/google-docs/providers/google/eventarc/index.md index 124283e91c..7fa7b9116f 100644 --- a/docs/google-docs/providers/google/eventarc/index.md +++ b/docs/google-docs/providers/google/eventarc/index.md @@ -21,7 +21,7 @@ Build Event-Driven Applications On Google Cloud Platform.
total resources: 10
total selectable resources: 10
-total methods: 33
+total methods: 39
@@ -33,7 +33,7 @@ Build Event-Driven Applications On Google Cloud Platform. TypeService TitleEventarc API DescriptionBuild Event-Driven Applications On Google Cloud Platform. -Ideventarc:v23.08.00155 +Ideventarc:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/eventarc/locations/index.md b/docs/google-docs/providers/google/eventarc/locations/index.md index 2f2eb09c87..33044e294b 100644 --- a/docs/google-docs/providers/google/eventarc/locations/index.md +++ b/docs/google-docs/providers/google/eventarc/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/eventarc/operations/index.md b/docs/google-docs/providers/google/eventarc/operations/index.md index ef06038746..b31e97efcf 100644 --- a/docs/google-docs/providers/google/eventarc/operations/index.md +++ b/docs/google-docs/providers/google/eventarc/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/eventarc/providers/index.md b/docs/google-docs/providers/google/eventarc/providers/index.md index 676fa20b11..2973b02993 100644 --- a/docs/google-docs/providers/google/eventarc/providers/index.md +++ b/docs/google-docs/providers/google/eventarc/providers/index.md @@ -27,11 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `providers` | `array` | The requested providers, up to the number specified in `page_size`. | -| `unreachable` | `array` | Unreachable resources, if any. | -| `nextPageToken` | `string` | A page token that can be sent to `ListProviders` to request the next page. If this is empty, then there are no more pages. | +| `name` | `string` | Output only. In `projects/{project}/locations/{location}/providers/{provider_id}` format. | +| `displayName` | `string` | Output only. Human friendly name for the Provider. For example "Cloud Storage". | +| `eventTypes` | `array` | Output only. Event types for this provider. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId, providersId` | Get a single Provider. | | `list` | `SELECT` | `locationsId, projectsId` | List providers. | +| `_list` | `EXEC` | `locationsId, projectsId` | List providers. | diff --git a/docs/google-docs/providers/google/eventarc/triggers/index.md b/docs/google-docs/providers/google/eventarc/triggers/index.md index 153de03201..81ff217dce 100644 --- a/docs/google-docs/providers/google/eventarc/triggers/index.md +++ b/docs/google-docs/providers/google/eventarc/triggers/index.md @@ -27,9 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `triggers` | `array` | The requested triggers, up to the number specified in `page_size`. | -| `unreachable` | `array` | Unreachable resources, if any. | -| `nextPageToken` | `string` | A page token that can be sent to `ListTriggers` to request the next page. If this is empty, then there are no more pages. | +| `name` | `string` | Required. The resource name of the trigger. Must be unique within the location of the project and must be in `projects/{project}/locations/{location}/triggers/{trigger}` format. | +| `destination` | `object` | Represents a target of an invocation over HTTP. | +| `eventDataContentType` | `string` | Optional. EventDataContentType specifies the type of payload in MIME format that is expected from the CloudEvent data field. This is set to `application/json` if the value is not defined. | +| `updateTime` | `string` | Output only. The last-modified time. | +| `labels` | `object` | Optional. User labels attached to the triggers that can be used to group resources. | +| `eventFilters` | `array` | Required. Unordered list. The list of filters that applies to event attributes. Only events that match all the provided filters are sent to the destination. | +| `serviceAccount` | `string` | Optional. The IAM service account email associated with the trigger. The service account represents the identity of the trigger. The `iam.serviceAccounts.actAs` permission must be granted on the service account to allow a principal to impersonate the service account. For more information, see the [Roles and permissions](/eventarc/docs/all-roles-permissions) page specific to the trigger destination. | +| `channel` | `string` | Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners. | +| `conditions` | `object` | Output only. The reason(s) why a trigger is in FAILED state. | +| `uid` | `string` | Output only. Server-assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | +| `createTime` | `string` | Output only. The creation time. | +| `transport` | `object` | Represents the transport intermediaries created for the trigger to deliver events. | +| `etag` | `string` | Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that the client has an up-to-date value before proceeding. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +47,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | List triggers. | | `create` | `INSERT` | `locationsId, projectsId` | Create a new trigger in a particular project and location. | | `delete` | `DELETE` | `locationsId, projectsId, triggersId` | Delete a single trigger. | +| `_list` | `EXEC` | `locationsId, projectsId` | List triggers. | | `patch` | `EXEC` | `locationsId, projectsId, triggersId` | Update a single trigger. | diff --git a/docs/google-docs/providers/google/eventarc/triggers_iam_policies/index.md b/docs/google-docs/providers/google/eventarc/triggers_iam_policies/index.md index 4643716cf8..6c5cb88a85 100644 --- a/docs/google-docs/providers/google/eventarc/triggers_iam_policies/index.md +++ b/docs/google-docs/providers/google/eventarc/triggers_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/file/backups/index.md b/docs/google-docs/providers/google/file/backups/index.md index d7c749f8ad..a3abff35b0 100644 --- a/docs/google-docs/providers/google/file/backups/index.md +++ b/docs/google-docs/providers/google/file/backups/index.md @@ -27,9 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The token you can use to retrieve the next page of results. Not returned if there are no more results in the list. | -| `unreachable` | `array` | Locations that could not be reached. | -| `backups` | `array` | A list of backups in the project for the specified location. If the `{location}` value in the request is "-", the response contains a list of backups from all locations. If any location is unreachable, the response will only return backups in reachable locations and the "unreachable" field will be populated with a list of unreachable locations. | +| `name` | `string` | Output only. The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`. | +| `description` | `string` | A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. | +| `labels` | `object` | Resource labels to represent user provided metadata. | +| `sourceInstanceTier` | `string` | Output only. The service tier of the source Filestore instance that this backup is created from. | +| `storageBytes` | `string` | Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. | +| `sourceInstance` | `string` | The resource name of the source Filestore instance, in the format `projects/{project_number}/locations/{location_id}/instances/{instance_id}`, used to create this backup. | +| `createTime` | `string` | Output only. The time when the backup was created. | +| `capacityGb` | `string` | Output only. Capacity of the source file share when the backup was created. | +| `downloadBytes` | `string` | Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage. | +| `kmsKey` | `string` | Immutable. KMS key name used for data encryption. | +| `state` | `string` | Output only. The backup state. | +| `sourceFileShare` | `string` | Name of the file share in the source Filestore instance that the backup is created from. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +47,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists all backups in a project for either a specified location or for all locations. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a backup. | | `delete` | `DELETE` | `backupsId, locationsId, projectsId` | Deletes a backup. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists all backups in a project for either a specified location or for all locations. | | `patch` | `EXEC` | `backupsId, locationsId, projectsId` | Updates the settings of a specific backup. | diff --git a/docs/google-docs/providers/google/file/index.md b/docs/google-docs/providers/google/file/index.md index efe8f4c273..f9c6200807 100644 --- a/docs/google-docs/providers/google/file/index.md +++ b/docs/google-docs/providers/google/file/index.md @@ -21,7 +21,7 @@ The Cloud Filestore API Is Used For Creating And Managing Cloud File Servers.
total resources: 5
total selectable resources: 5
-total methods: 23
+total methods: 28
@@ -33,7 +33,7 @@ The Cloud Filestore API Is Used For Creating And Managing Cloud File Servers. TypeService TitleCloud Filestore API DescriptionThe Cloud Filestore API Is Used For Creating And Managing Cloud File Servers. -Idfile:v23.08.00155 +Idfile:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/file/instances/index.md b/docs/google-docs/providers/google/file/instances/index.md index 6f3411fd7c..eaea8aa4d1 100644 --- a/docs/google-docs/providers/google/file/instances/index.md +++ b/docs/google-docs/providers/google/file/instances/index.md @@ -27,9 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `instances` | `array` | A list of instances in the project for the specified location. If the `{location}` value in the request is "-", the response contains a list of instances from all locations. If any location is unreachable, the response will only return instances in reachable locations and the "unreachable" field will be populated with a list of unreachable locations. | -| `nextPageToken` | `string` | The token you can use to retrieve the next page of results. Not returned if there are no more results in the list. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | Output only. The resource name of the instance, in the format `projects/{project}/locations/{location}/instances/{instance}`. | +| `description` | `string` | The description of the instance (2048 characters or less). | +| `suspensionReasons` | `array` | Output only. Field indicates all the reasons the instance is in "SUSPENDED" state. | +| `labels` | `object` | Resource labels to represent user provided metadata. | +| `networks` | `array` | VPC networks to which the instance is connected. For this version, only a single network is supported. | +| `fileShares` | `array` | File system shares on the instance. For this version, only a single file share is supported. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `tier` | `string` | The service tier of the instance. | +| `state` | `string` | Output only. The instance state. | +| `statusMessage` | `string` | Output only. Additional information about the instance state, if available. | +| `kmsKeyName` | `string` | KMS key name used for data encryption. | +| `etag` | `string` | Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. | +| `createTime` | `string` | Output only. The time when the instance was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +47,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists all instances in a project for either a specified location or for all locations. | | `create` | `INSERT` | `locationsId, projectsId` | Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier). | | `delete` | `DELETE` | `instancesId, locationsId, projectsId` | Deletes an instance. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists all instances in a project for either a specified location or for all locations. | | `patch` | `EXEC` | `instancesId, locationsId, projectsId` | Updates the settings of a specific instance. | | `restore` | `EXEC` | `instancesId, locationsId, projectsId` | Restores an existing instance's file share from a backup. The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier). | | `revert` | `EXEC` | `instancesId, locationsId, projectsId` | Revert an existing instance's file system to a specified snapshot. | diff --git a/docs/google-docs/providers/google/file/locations/index.md b/docs/google-docs/providers/google/file/locations/index.md index fdb0155bfe..b148557288 100644 --- a/docs/google-docs/providers/google/file/locations/index.md +++ b/docs/google-docs/providers/google/file/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `locations` | `array` | A list of locations that matches the specified filter in the request. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/file/operations/index.md b/docs/google-docs/providers/google/file/operations/index.md index c4aa87c4ed..87a53a47ae 100644 --- a/docs/google-docs/providers/google/file/operations/index.md +++ b/docs/google-docs/providers/google/file/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/file/snapshots/index.md b/docs/google-docs/providers/google/file/snapshots/index.md index 894d0bf027..99e96f2926 100644 --- a/docs/google-docs/providers/google/file/snapshots/index.md +++ b/docs/google-docs/providers/google/file/snapshots/index.md @@ -27,8 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The token you can use to retrieve the next page of results. Not returned if there are no more results in the list. | -| `snapshots` | `array` | A list of snapshots in the project for the specified instance. | +| `name` | `string` | Output only. The resource name of the snapshot, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}`. | +| `description` | `string` | A description of the snapshot with 2048 characters or less. Requests with longer descriptions will be rejected. | +| `filesystemUsedBytes` | `string` | Output only. The amount of bytes needed to allocate a full copy of the snapshot content | +| `labels` | `object` | Resource labels to represent user provided metadata. | +| `state` | `string` | Output only. The snapshot state. | +| `createTime` | `string` | Output only. The time when the snapshot was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +40,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `instancesId, locationsId, projectsId` | Lists all snapshots in a project for either a specified location or for all locations. | | `create` | `INSERT` | `instancesId, locationsId, projectsId` | Creates a snapshot. | | `delete` | `DELETE` | `instancesId, locationsId, projectsId, snapshotsId` | Deletes a snapshot. | +| `_list` | `EXEC` | `instancesId, locationsId, projectsId` | Lists all snapshots in a project for either a specified location or for all locations. | | `patch` | `EXEC` | `instancesId, locationsId, projectsId, snapshotsId` | Updates the settings of a specific snapshot. | diff --git a/docs/google-docs/providers/google/firestore/backup_schedules/index.md b/docs/google-docs/providers/google/firestore/backup_schedules/index.md index 9c759379d2..4f354bca38 100644 --- a/docs/google-docs/providers/google/firestore/backup_schedules/index.md +++ b/docs/google-docs/providers/google/firestore/backup_schedules/index.md @@ -25,14 +25,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` | -| `dailyRecurrence` | `object` | Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. | -| `retention` | `string` | At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. | -| `updateTime` | `string` | Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. | -| `weeklyRecurrence` | `object` | Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. | -| `createTime` | `string` | Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/firestore/backups/index.md b/docs/google-docs/providers/google/firestore/backups/index.md index a2e13fed94..1fc05eceb0 100644 --- a/docs/google-docs/providers/google/firestore/backups/index.md +++ b/docs/google-docs/providers/google/firestore/backups/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The unique resource name of the Backup. Format is `projects/{project}/locations/{location}/backups/{backup}`. | -| `snapshotTime` | `string` | Output only. The backup contains an externally consistent copy of the database at this time. | -| `state` | `string` | Output only. The current state of the backup. | | `stats` | `object` | Backup specific statistics. | | `database` | `string` | Output only. Name of the Firestore database that the backup is from. Format is `projects/{project}/databases/{database}`. | | `databaseUid` | `string` | Output only. The system-generated UUID4 for the Firestore database that the backup is from. | | `expireTime` | `string` | Output only. The timestamp at which this backup expires. | +| `snapshotTime` | `string` | Output only. The backup contains an externally consistent copy of the database at this time. | +| `state` | `string` | Output only. The current state of the backup. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/firestore/documents/index.md b/docs/google-docs/providers/google/firestore/documents/index.md index 1afe0ad42c..dfdac28bac 100644 --- a/docs/google-docs/providers/google/firestore/documents/index.md +++ b/docs/google-docs/providers/google/firestore/documents/index.md @@ -27,18 +27,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `documents` | `array` | The Documents found. | -| `nextPageToken` | `string` | A token to retrieve the next page of documents. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. | +| `createTime` | `string` | Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. | +| `fields` | `object` | The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. | +| `updateTime` | `string` | Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `databasesId, documentsId, documentsId1, projectsId` | Gets a single document. | | `list` | `SELECT` | `collectionId, databasesId, documentsId, documentsId1, projectsId` | Lists documents. | +| `list_documents` | `SELECT` | `collectionId, databasesId, projectsId` | Lists documents. | +| `create_document` | `INSERT` | `collectionId, databasesId, documentsId, projectsId` | Creates a new document. | | `delete` | `DELETE` | `databasesId, documentsId, documentsId1, projectsId` | Deletes a document. | +| `_list` | `EXEC` | `collectionId, databasesId, documentsId, documentsId1, projectsId` | Lists documents. | +| `_list_documents` | `EXEC` | `collectionId, databasesId, projectsId` | Lists documents. | | `batch_get` | `EXEC` | `databasesId, projectsId` | Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested. | | `batch_write` | `EXEC` | `databasesId, projectsId` | Applies a batch of write operations. The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the BatchWriteResponse for the success status of each write. If you require an atomically applied set of writes, use Commit instead. | | `begin_transaction` | `EXEC` | `databasesId, projectsId` | Starts a new transaction. | | `commit` | `EXEC` | `databasesId, projectsId` | Commits a transaction, while optionally updating documents. | +| `listen` | `EXEC` | `databasesId, projectsId` | Listens to changes. This method is only available via gRPC or WebChannel (not REST). | | `partition_query` | `EXEC` | `databasesId, documentsId, documentsId1, projectsId` | Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results. | | `patch` | `EXEC` | `databasesId, documentsId, documentsId1, projectsId` | Updates or inserts a document. | | `rollback` | `EXEC` | `databasesId, projectsId` | Rolls back a transaction. | diff --git a/docs/google-docs/providers/google/firestore/fields/index.md b/docs/google-docs/providers/google/firestore/fields/index.md index af0686690c..3bc3e8c1a8 100644 --- a/docs/google-docs/providers/google/firestore/fields/index.md +++ b/docs/google-docs/providers/google/firestore/fields/index.md @@ -27,11 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `fields` | `array` | The requested fields. | -| `nextPageToken` | `string` | A page token that may be used to request another page of results. If blank, this is the last page. | +| `name` | `string` | Required. A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration. | +| `indexConfig` | `object` | The index configuration for this field. | +| `ttlConfig` | `object` | The TTL (time-to-live) configuration for documents that have this `Field` set. Storing a timestamp value into a TTL-enabled field will be treated as the document's absolute expiration time. Timestamp values in the past indicate that the document is eligible for immediate expiration. Using any other data type or leaving the field absent will disable expiration for the individual document. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `collectionGroupsId, databasesId, fieldsId, projectsId` | Gets the metadata and configuration for a Field. | | `list` | `SELECT` | `collectionGroupsId, databasesId, projectsId` | Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false or `ttlConfig:*`. | +| `_list` | `EXEC` | `collectionGroupsId, databasesId, projectsId` | Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false or `ttlConfig:*`. | | `patch` | `EXEC` | `collectionGroupsId, databasesId, fieldsId, projectsId` | Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: "index_config" }`. This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`. | diff --git a/docs/google-docs/providers/google/firestore/index.md b/docs/google-docs/providers/google/firestore/index.md index 734d954351..9da046d25c 100644 --- a/docs/google-docs/providers/google/firestore/index.md +++ b/docs/google-docs/providers/google/firestore/index.md @@ -19,9 +19,9 @@ Accesses The NoSQL Document Database Built For Automatic Scaling, High Performan
-total resources: 12
-total selectable resources: 9
-total methods: 46
+total resources: 9
+total selectable resources: 8
+total methods: 52
@@ -33,7 +33,7 @@ Accesses The NoSQL Document Database Built For Automatic Scaling, High Performan TypeService TitleCloud Firestore API DescriptionAccesses The NoSQL Document Database Built For Automatic Scaling, High Performance, And Ease Of Application Development. -Idfirestore:v23.08.00155 +Idfirestore:v23.08.00157 ## Resources @@ -44,11 +44,8 @@ Accesses The NoSQL Document Database Built For Automatic Scaling, High Performan databases
documents
documents_collection_ids
-documents_document
-documents_documents
-documents_en
fields
indexes
locations
diff --git a/docs/google-docs/providers/google/firestore/indexes/index.md b/docs/google-docs/providers/google/firestore/indexes/index.md index ef8b3abc24..bf67e51649 100644 --- a/docs/google-docs/providers/google/firestore/indexes/index.md +++ b/docs/google-docs/providers/google/firestore/indexes/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. | -| `apiScope` | `string` | The API scope supported by this index. | | `fields` | `array` | The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field. | | `queryScope` | `string` | Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index. | | `state` | `string` | Output only. The serving state of the index. | +| `apiScope` | `string` | The API scope supported by this index. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -39,3 +39,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `collectionGroupsId, databasesId, projectsId` | Lists composite indexes. | | `create` | `INSERT` | `collectionGroupsId, databasesId, projectsId` | Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata. | | `delete` | `DELETE` | `collectionGroupsId, databasesId, indexesId, projectsId` | Deletes a composite index. | +| `_list` | `EXEC` | `collectionGroupsId, databasesId, projectsId` | Lists composite indexes. | diff --git a/docs/google-docs/providers/google/firestore/locations/index.md b/docs/google-docs/providers/google/firestore/locations/index.md index dfc7acaca1..32c71d773c 100644 --- a/docs/google-docs/providers/google/firestore/locations/index.md +++ b/docs/google-docs/providers/google/firestore/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `locations` | `array` | A list of locations that matches the specified filter in the request. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/firestore/operations/index.md b/docs/google-docs/providers/google/firestore/operations/index.md index ca78786c84..b56635758b 100644 --- a/docs/google-docs/providers/google/firestore/operations/index.md +++ b/docs/google-docs/providers/google/firestore/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `databasesId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `databasesId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `databasesId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `databasesId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `databasesId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/gameservices/game_server_deployments_iam_policies/index.md b/docs/google-docs/providers/google/gameservices/game_server_deployments_iam_policies/index.md index 57af2d0de0..733df98884 100644 --- a/docs/google-docs/providers/google/gameservices/game_server_deployments_iam_policies/index.md +++ b/docs/google-docs/providers/google/gameservices/game_server_deployments_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gameservices/index.md b/docs/google-docs/providers/google/gameservices/index.md index 7b5b52fd32..10229dd9aa 100644 --- a/docs/google-docs/providers/google/gameservices/index.md +++ b/docs/google-docs/providers/google/gameservices/index.md @@ -21,7 +21,7 @@ Deploy And Manage Infrastructure For Global Multiplayer Gaming Experiences.
total resources: 3
total selectable resources: 3
-total methods: 9
+total methods: 11
@@ -33,7 +33,7 @@ Deploy And Manage Infrastructure For Global Multiplayer Gaming Experiences. TypeService TitleGame Services API DescriptionDeploy And Manage Infrastructure For Global Multiplayer Gaming Experiences. -Idgameservices:v23.08.00155 +Idgameservices:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/gameservices/locations/index.md b/docs/google-docs/providers/google/gameservices/locations/index.md index a28ac5265b..dabe99fb9a 100644 --- a/docs/google-docs/providers/google/gameservices/locations/index.md +++ b/docs/google-docs/providers/google/gameservices/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `locations` | `array` | A list of locations that matches the specified filter in the request. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/gameservices/operations/index.md b/docs/google-docs/providers/google/gameservices/operations/index.md index 89acca9643..49add8347a 100644 --- a/docs/google-docs/providers/google/gameservices/operations/index.md +++ b/docs/google-docs/providers/google/gameservices/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/gkebackup/backup_plans/index.md b/docs/google-docs/providers/google/gkebackup/backup_plans/index.md index dd3b2e352d..4ce6176a9d 100644 --- a/docs/google-docs/providers/google/gkebackup/backup_plans/index.md +++ b/docs/google-docs/providers/google/gkebackup/backup_plans/index.md @@ -27,9 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token which may be sent as page_token in a subsequent `ListBackupPlans` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return. | -| `unreachable` | `array` | Locations that could not be reached. | -| `backupPlans` | `array` | The list of BackupPlans matching the given criteria. | +| `name` | `string` | Output only. The full name of the BackupPlan resource. Format: `projects/*/locations/*/backupPlans/*` | +| `description` | `string` | Optional. User specified descriptive string for this BackupPlan. | +| `backupSchedule` | `object` | Defines scheduling parameters for automatically creating Backups via this BackupPlan. | +| `cluster` | `string` | Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` | +| `createTime` | `string` | Output only. The timestamp when this BackupPlan resource was created. | +| `deactivated` | `boolean` | Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False | +| `labels` | `object` | Optional. A set of custom labels supplied by user. | +| `state` | `string` | Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update | +| `stateReason` | `string` | Output only. Human-readable description of why BackupPlan is in the current `state` | +| `retentionPolicy` | `object` | RetentionPolicy defines a Backup retention policy for a BackupPlan. | +| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | +| `backupConfig` | `object` | BackupConfig defines the configuration of Backups created via this BackupPlan. | +| `etag` | `string` | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupPlan`, and systems are expected to put that etag in the request to `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change will be applied to the same version of the resource. | +| `protectedPodCount` | `integer` | Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan. | +| `updateTime` | `string` | Output only. The timestamp when this BackupPlan resource was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +49,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists BackupPlans in a given location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new BackupPlan in a given location. | | `delete` | `DELETE` | `backupPlansId, locationsId, projectsId` | Deletes an existing BackupPlan. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists BackupPlans in a given location. | | `patch` | `EXEC` | `backupPlansId, locationsId, projectsId` | Update a BackupPlan. | diff --git a/docs/google-docs/providers/google/gkebackup/backups/index.md b/docs/google-docs/providers/google/gkebackup/backups/index.md index 0aeab2b8fa..d5f9f559e9 100644 --- a/docs/google-docs/providers/google/gkebackup/backups/index.md +++ b/docs/google-docs/providers/google/gkebackup/backups/index.md @@ -27,8 +27,33 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `backups` | `array` | The list of Backups matching the given criteria. | -| `nextPageToken` | `string` | A token which may be sent as page_token in a subsequent `ListBackups` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return. | +| `name` | `string` | Output only. The fully qualified name of the Backup. `projects/*/locations/*/backupPlans/*/backups/*` | +| `description` | `string` | Optional. User specified descriptive string for this Backup. | +| `manual` | `boolean` | Output only. This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually. | +| `selectedApplications` | `object` | A list of namespaced Kubernetes resources. | +| `containsVolumeData` | `boolean` | Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value. | +| `encryptionKey` | `object` | Defined a customer managed encryption key that will be used to encrypt Backup artifacts. | +| `completeTime` | `string` | Output only. Completion time of the Backup | +| `createTime` | `string` | Output only. The timestamp when this Backup resource was created. | +| `uid` | `string` | Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier) | +| `configBackupSizeBytes` | `string` | Output only. The size of the config backup in bytes. | +| `stateReason` | `string` | Output only. Human-readable description of why the backup is in the current `state`. | +| `retainExpireTime` | `string` | Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days). | +| `deleteLockDays` | `integer` | Optional. Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update). | +| `clusterMetadata` | `object` | Information about the GKE cluster from which this Backup was created. | +| `etag` | `string` | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackup`, and systems are expected to put that etag in the request to `UpdateBackup` or `DeleteBackup` to ensure that their change will be applied to the same version of the resource. | +| `resourceCount` | `integer` | Output only. The total number of Kubernetes resources included in the Backup. | +| `deleteLockExpireTime` | `string` | Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days). | +| `retainDays` | `integer` | Optional. The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= delete_lock_days and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value. | +| `labels` | `object` | Optional. A set of custom labels supplied by user. | +| `sizeBytes` | `string` | Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes) | +| `allNamespaces` | `boolean` | Output only. If True, all namespaces were included in the Backup. | +| `podCount` | `integer` | Output only. The total number of Kubernetes Pods contained in the Backup. | +| `containsSecrets` | `boolean` | Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value. | +| `volumeCount` | `integer` | Output only. The total number of volume backups contained in the Backup. | +| `updateTime` | `string` | Output only. The timestamp when this Backup resource was last updated. | +| `state` | `string` | Output only. Current state of the Backup | +| `selectedNamespaces` | `object` | A list of Kubernetes Namespaces | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +61,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `backupPlansId, locationsId, projectsId` | Lists the Backups for a given BackupPlan. | | `create` | `INSERT` | `backupPlansId, locationsId, projectsId` | Creates a Backup for the given BackupPlan. | | `delete` | `DELETE` | `backupPlansId, backupsId, locationsId, projectsId` | Deletes an existing Backup. | +| `_list` | `EXEC` | `backupPlansId, locationsId, projectsId` | Lists the Backups for a given BackupPlan. | | `patch` | `EXEC` | `backupPlansId, backupsId, locationsId, projectsId` | Update a Backup. | diff --git a/docs/google-docs/providers/google/gkebackup/backups_iam_policies/index.md b/docs/google-docs/providers/google/gkebackup/backups_iam_policies/index.md index 43e71c941b..9c62dd05a0 100644 --- a/docs/google-docs/providers/google/gkebackup/backups_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkebackup/backups_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/index.md b/docs/google-docs/providers/google/gkebackup/index.md index 2d97e3d110..0b23f9a1dc 100644 --- a/docs/google-docs/providers/google/gkebackup/index.md +++ b/docs/google-docs/providers/google/gkebackup/index.md @@ -21,7 +21,7 @@ Backup For GKE Is A Managed Kubernetes Workload Backup And Restore Service For G
total resources: 14
total selectable resources: 14
-total methods: 48
+total methods: 56
@@ -33,7 +33,7 @@ Backup For GKE Is A Managed Kubernetes Workload Backup And Restore Service For G TypeService TitleBackup For GKE API DescriptionBackup For GKE Is A Managed Kubernetes Workload Backup And Restore Service For GKE Clusters. -Idgkebackup:v23.08.00155 +Idgkebackup:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/gkebackup/locations/index.md b/docs/google-docs/providers/google/gkebackup/locations/index.md index 44ab130f22..c6e8a718a9 100644 --- a/docs/google-docs/providers/google/gkebackup/locations/index.md +++ b/docs/google-docs/providers/google/gkebackup/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/gkebackup/operations/index.md b/docs/google-docs/providers/google/gkebackup/operations/index.md index 1ed9a5d2b4..504073e01e 100644 --- a/docs/google-docs/providers/google/gkebackup/operations/index.md +++ b/docs/google-docs/providers/google/gkebackup/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete_operations` | `DELETE` | `locationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/gkebackup/restore_plans/index.md b/docs/google-docs/providers/google/gkebackup/restore_plans/index.md index 01d327f02e..cac63adf16 100644 --- a/docs/google-docs/providers/google/gkebackup/restore_plans/index.md +++ b/docs/google-docs/providers/google/gkebackup/restore_plans/index.md @@ -27,9 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `restorePlans` | `array` | The list of RestorePlans matching the given criteria. | -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | A token which may be sent as page_token in a subsequent `ListRestorePlans` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return. | +| `name` | `string` | Output only. The full name of the RestorePlan resource. Format: `projects/*/locations/*/restorePlans/*`. | +| `description` | `string` | Optional. User specified descriptive string for this RestorePlan. | +| `stateReason` | `string` | Output only. Human-readable description of why RestorePlan is in the current `state` | +| `backupPlan` | `string` | Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: `projects/*/locations/*/backupPlans/*`. | +| `updateTime` | `string` | Output only. The timestamp when this RestorePlan resource was last updated. | +| `cluster` | `string` | Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` | +| `createTime` | `string` | Output only. The timestamp when this RestorePlan resource was created. | +| `restoreConfig` | `object` | Configuration of a restore. Next id: 12 | +| `etag` | `string` | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestorePlan`, and systems are expected to put that etag in the request to `UpdateRestorePlan` or `DeleteRestorePlan` to ensure that their change will be applied to the same version of the resource. | +| `labels` | `object` | Optional. A set of custom labels supplied by user. | +| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | +| `state` | `string` | Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +46,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists RestorePlans in a given location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new RestorePlan in a given location. | | `delete` | `DELETE` | `locationsId, projectsId, restorePlansId` | Deletes an existing RestorePlan. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists RestorePlans in a given location. | | `patch` | `EXEC` | `locationsId, projectsId, restorePlansId` | Update a RestorePlan. | diff --git a/docs/google-docs/providers/google/gkebackup/restore_plans_iam_policies/index.md b/docs/google-docs/providers/google/gkebackup/restore_plans_iam_policies/index.md index b05c8d378b..5f10c4e4a9 100644 --- a/docs/google-docs/providers/google/gkebackup/restore_plans_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkebackup/restore_plans_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/restores/index.md b/docs/google-docs/providers/google/gkebackup/restores/index.md index 51eed8acf8..3aa9e55a33 100644 --- a/docs/google-docs/providers/google/gkebackup/restores/index.md +++ b/docs/google-docs/providers/google/gkebackup/restores/index.md @@ -27,9 +27,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | A token which may be sent as page_token in a subsequent `ListRestores` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return. | -| `restores` | `array` | The list of Restores matching the given criteria. | +| `name` | `string` | Output only. The full name of the Restore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*` | +| `description` | `string` | User specified descriptive string for this Restore. | +| `resourcesFailedCount` | `integer` | Output only. Number of resources that failed to be restored during the restore execution. | +| `completeTime` | `string` | Output only. Timestamp of when the restore operation completed. | +| `state` | `string` | Output only. The current state of the Restore. | +| `restoreConfig` | `object` | Configuration of a restore. Next id: 12 | +| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | +| `stateReason` | `string` | Output only. Human-readable description of why the Restore is in its current state. | +| `cluster` | `string` | Output only. The target cluster into which this Restore will restore data. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` Inherited from parent RestorePlan's cluster value. | +| `backup` | `string` | Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: `projects/*/locations/*/backupPlans/*/backups/*`. | +| `updateTime` | `string` | Output only. The timestamp when this Restore resource was last updated. | +| `etag` | `string` | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestore`, and systems are expected to put that etag in the request to `UpdateRestore` or `DeleteRestore` to ensure that their change will be applied to the same version of the resource. | +| `labels` | `object` | A set of custom labels supplied by user. | +| `volumesRestoredCount` | `integer` | Output only. Number of volumes restored during the restore execution. | +| `createTime` | `string` | Output only. The timestamp when this Restore resource was created. | +| `resourcesExcludedCount` | `integer` | Output only. Number of resources excluded during the restore execution. | +| `resourcesRestoredCount` | `integer` | Output only. Number of resources restored during the restore execution. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +51,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId, restorePlansId` | Lists the Restores for a given RestorePlan. | | `create` | `INSERT` | `locationsId, projectsId, restorePlansId` | Creates a new Restore for the given RestorePlan. | | `delete` | `DELETE` | `locationsId, projectsId, restorePlansId, restoresId` | Deletes an existing Restore. | +| `_list` | `EXEC` | `locationsId, projectsId, restorePlansId` | Lists the Restores for a given RestorePlan. | | `patch` | `EXEC` | `locationsId, projectsId, restorePlansId, restoresId` | Update a Restore. | diff --git a/docs/google-docs/providers/google/gkebackup/restores_iam_policies/index.md b/docs/google-docs/providers/google/gkebackup/restores_iam_policies/index.md index 29103d5a77..33306f4fac 100644 --- a/docs/google-docs/providers/google/gkebackup/restores_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkebackup/restores_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/volume_backups/index.md b/docs/google-docs/providers/google/gkebackup/volume_backups/index.md index 1df1754991..3830b20888 100644 --- a/docs/google-docs/providers/google/gkebackup/volume_backups/index.md +++ b/docs/google-docs/providers/google/gkebackup/volume_backups/index.md @@ -27,10 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token which may be sent as page_token in a subsequent `ListVolumeBackups` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return. | -| `volumeBackups` | `array` | The list of VolumeBackups matching the given criteria. | +| `name` | `string` | Output only. The full name of the VolumeBackup resource. Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`. | +| `sourcePvc` | `object` | A reference to a namespaced resource in Kubernetes. | +| `format` | `string` | Output only. The format used for the volume backup. | +| `volumeBackupHandle` | `string` | Output only. A storage system-specific opaque handle to the underlying volume backup. | +| `etag` | `string` | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume backup from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform volume backup updates in order to avoid race conditions. | +| `stateMessage` | `string` | Output only. A human readable message explaining why the VolumeBackup is in its current state. | +| `storageBytes` | `string` | Output only. The aggregate size of the underlying artifacts associated with this VolumeBackup in the backup storage. This may change over time when multiple backups of the same volume share the same backup storage location. In particular, this is likely to increase in size when the immediately preceding backup of the same volume is deleted. | +| `updateTime` | `string` | Output only. The timestamp when this VolumeBackup resource was last updated. | +| `completeTime` | `string` | Output only. The timestamp when the associated underlying volume backup operation completed. | +| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | +| `createTime` | `string` | Output only. The timestamp when this VolumeBackup resource was created. | +| `state` | `string` | Output only. The current state of this VolumeBackup. | +| `diskSizeBytes` | `string` | Output only. The minimum size of the disk to which this VolumeBackup can be restored. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `backupPlansId, backupsId, locationsId, projectsId, volumeBackupsId` | Retrieve the details of a single VolumeBackup. | | `list` | `SELECT` | `backupPlansId, backupsId, locationsId, projectsId` | Lists the VolumeBackups for a given Backup. | +| `_list` | `EXEC` | `backupPlansId, backupsId, locationsId, projectsId` | Lists the VolumeBackups for a given Backup. | diff --git a/docs/google-docs/providers/google/gkebackup/volume_backups_iam_policies/index.md b/docs/google-docs/providers/google/gkebackup/volume_backups_iam_policies/index.md index 1fe6b44d60..9932435056 100644 --- a/docs/google-docs/providers/google/gkebackup/volume_backups_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkebackup/volume_backups_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/volume_restores/index.md b/docs/google-docs/providers/google/gkebackup/volume_restores/index.md index 19c950ae04..dd2b5a63b3 100644 --- a/docs/google-docs/providers/google/gkebackup/volume_restores/index.md +++ b/docs/google-docs/providers/google/gkebackup/volume_restores/index.md @@ -28,19 +28,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Full name of the VolumeRestore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*` | -| `stateMessage` | `string` | Output only. A human readable message explaining why the VolumeRestore is in its current state. | -| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | -| `targetPvc` | `object` | A reference to a namespaced resource in Kubernetes. | | `volumeHandle` | `string` | Output only. A storage system-specific opaque handler to the underlying volume created for the target PVC from the volume backup. | -| `volumeBackup` | `string` | Output only. The full name of the VolumeBackup from which the volume will be restored. Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`. | -| `etag` | `string` | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform volume restore updates in order to avoid race conditions. | | `state` | `string` | Output only. The current state of this VolumeRestore. | -| `volumeType` | `string` | Output only. The type of volume provisioned | | `updateTime` | `string` | Output only. The timestamp when this VolumeRestore resource was last updated. | -| `completeTime` | `string` | Output only. The timestamp when the associated underlying volume restoration completed. | +| `volumeBackup` | `string` | Output only. The full name of the VolumeBackup from which the volume will be restored. Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`. | +| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | +| `volumeType` | `string` | Output only. The type of volume provisioned | +| `etag` | `string` | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform volume restore updates in order to avoid race conditions. | | `createTime` | `string` | Output only. The timestamp when this VolumeRestore resource was created. | +| `stateMessage` | `string` | Output only. A human readable message explaining why the VolumeRestore is in its current state. | +| `completeTime` | `string` | Output only. The timestamp when the associated underlying volume restoration completed. | +| `targetPvc` | `object` | A reference to a namespaced resource in Kubernetes. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId, restorePlansId, restoresId, volumeRestoresId` | Retrieve the details of a single VolumeRestore. | | `list` | `SELECT` | `locationsId, projectsId, restorePlansId, restoresId` | Lists the VolumeRestores for a given Restore. | +| `_list` | `EXEC` | `locationsId, projectsId, restorePlansId, restoresId` | Lists the VolumeRestores for a given Restore. | diff --git a/docs/google-docs/providers/google/gkebackup/volume_restores_iam_policies/index.md b/docs/google-docs/providers/google/gkebackup/volume_restores_iam_policies/index.md index 4b8d353378..92b5d6612d 100644 --- a/docs/google-docs/providers/google/gkebackup/volume_restores_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkebackup/volume_restores_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkehub/bindings/index.md b/docs/google-docs/providers/google/gkehub/bindings/index.md index 7c7b530960..3be02c332e 100644 --- a/docs/google-docs/providers/google/gkehub/bindings/index.md +++ b/docs/google-docs/providers/google/gkehub/bindings/index.md @@ -27,13 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to request the next page of resources from the `ListMembershipBindings` method. The value of an empty string means that there are no more resources to return. | -| `membershipBindings` | `array` | The list of membership_bindings | +| `name` | `string` | The resource name for the membershipbinding itself `projects/{project}/locations/{location}/memberships/{membership}/bindings/{membershipbinding}` | +| `createTime` | `string` | Output only. When the membership binding was created. | +| `scope` | `string` | A Scope resource name in the format `projects/*/locations/*/scopes/*`. | +| `state` | `object` | MembershipBindingLifecycleState describes the state of a Binding resource. | +| `labels` | `object` | Optional. Labels for this MembershipBinding. | +| `fleet` | `boolean` | Whether the membershipbinding is Fleet-wide; true means that this Membership should be bound to all Namespaces in this entire Fleet. | +| `deleteTime` | `string` | Output only. When the membership binding was deleted. | +| `uid` | `string` | Output only. Google-generated UUID for this resource. This is unique across all membershipbinding resources. If a membershipbinding resource is deleted and another resource with the same name is created, it gets a different uid. | +| `updateTime` | `string` | Output only. When the membership binding was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_memberships_bindings_list` | `SELECT` | `locationsId, membershipsId, projectsId` | Lists MembershipBindings. | | `projects_locations_memberships_bindings_create` | `INSERT` | `locationsId, membershipsId, projectsId` | Creates a MembershipBinding. | | `projects_locations_memberships_bindings_delete` | `DELETE` | `bindingsId, locationsId, membershipsId, projectsId` | Deletes a MembershipBinding. | +| `_projects_locations_memberships_bindings_list` | `EXEC` | `locationsId, membershipsId, projectsId` | Lists MembershipBindings. | | `projects_locations_memberships_bindings_get` | `EXEC` | `bindingsId, locationsId, membershipsId, projectsId` | Returns the details of a MembershipBinding. | | `projects_locations_memberships_bindings_patch` | `EXEC` | `bindingsId, locationsId, membershipsId, projectsId` | Updates a MembershipBinding. | diff --git a/docs/google-docs/providers/google/gkehub/features/index.md b/docs/google-docs/providers/google/gkehub/features/index.md index 37e4b55366..0d869c20f4 100644 --- a/docs/google-docs/providers/google/gkehub/features/index.md +++ b/docs/google-docs/providers/google/gkehub/features/index.md @@ -27,13 +27,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `resources` | `array` | The list of matching Features | -| `nextPageToken` | `string` | A token to request the next page of resources from the `ListFeatures` method. The value of an empty string means that there are no more resources to return. | +| `name` | `string` | Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. | +| `membershipStates` | `object` | Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number. | +| `resourceState` | `object` | FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. | +| `spec` | `object` | CommonFeatureSpec contains Hub-wide configuration information | +| `membershipSpecs` | `object` | Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. | +| `fleetDefaultMemberConfig` | `object` | CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet | +| `createTime` | `string` | Output only. When the Feature resource was created. | +| `deleteTime` | `string` | Output only. When the Feature resource was deleted. | +| `state` | `object` | CommonFeatureState contains Hub-wide Feature status information. | +| `labels` | `object` | Labels for this Feature. | +| `scopeSpecs` | `object` | Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. | +| `updateTime` | `string` | Output only. When the Feature resource was last updated. | +| `scopeStates` | `object` | Output only. Scope-specific Feature status. If this Feature does report any per-Scope status, this field may be unused. The keys indicate which Scope the state is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_features_list` | `SELECT` | `locationsId, projectsId` | Lists Features in a given project and location. | | `projects_locations_features_create` | `INSERT` | `locationsId, projectsId` | Adds a new Feature. | | `projects_locations_features_delete` | `DELETE` | `featuresId, locationsId, projectsId` | Removes a Feature. | +| `_projects_locations_features_list` | `EXEC` | `locationsId, projectsId` | Lists Features in a given project and location. | | `projects_locations_features_get` | `EXEC` | `featuresId, locationsId, projectsId` | Gets details of a single Feature. | | `projects_locations_features_patch` | `EXEC` | `featuresId, locationsId, projectsId` | Updates an existing Feature. | diff --git a/docs/google-docs/providers/google/gkehub/features_iam_policies/index.md b/docs/google-docs/providers/google/gkehub/features_iam_policies/index.md index 0757c5b156..6afdc3efba 100644 --- a/docs/google-docs/providers/google/gkehub/features_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkehub/features_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkehub/fleets/index.md b/docs/google-docs/providers/google/gkehub/fleets/index.md index 8b5bd2c755..8933c5fe07 100644 --- a/docs/google-docs/providers/google/gkehub/fleets/index.md +++ b/docs/google-docs/providers/google/gkehub/fleets/index.md @@ -27,8 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `fleets` | `array` | The list of matching fleets. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. The token is only valid for 1h. | +| `name` | `string` | Output only. The full, unique resource name of this fleet in the format of `projects/{project}/locations/{location}/fleets/{fleet}`. Each Google Cloud project can have at most one fleet resource, named "default". | +| `labels` | `object` | Optional. Labels for this Fleet. | +| `state` | `object` | FleetLifecycleState describes the state of a Fleet resource. | +| `uid` | `string` | Output only. Google-generated UUID for this resource. This is unique across all Fleet resources. If a Fleet resource is deleted and another resource with the same name is created, it gets a different uid. | +| `updateTime` | `string` | Output only. When the Fleet was last updated. | +| `createTime` | `string` | Output only. When the Fleet was created. | +| `deleteTime` | `string` | Output only. When the Fleet was deleted. | +| `displayName` | `string` | Optional. A user-assigned display name of the Fleet. When present, it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `Production Fleet` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +42,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_fleets_list` | `SELECT` | `locationsId, projectsId` | Returns all fleets within an organization or a project that the caller has access to. | | `projects_locations_fleets_create` | `INSERT` | `locationsId, projectsId` | Creates a fleet. | | `projects_locations_fleets_delete` | `DELETE` | `fleetsId, locationsId, projectsId` | Removes a Fleet. There must be no memberships remaining in the Fleet. | +| `_organizations_locations_fleets_list` | `EXEC` | `locationsId, organizationsId` | Returns all fleets within an organization or a project that the caller has access to. | +| `_projects_locations_fleets_list` | `EXEC` | `locationsId, projectsId` | Returns all fleets within an organization or a project that the caller has access to. | | `projects_locations_fleets_get` | `EXEC` | `fleetsId, locationsId, projectsId` | Returns the details of a fleet. | | `projects_locations_fleets_patch` | `EXEC` | `fleetsId, locationsId, projectsId` | Updates a fleet. | diff --git a/docs/google-docs/providers/google/gkehub/index.md b/docs/google-docs/providers/google/gkehub/index.md index 55c27ffa46..320412550a 100644 --- a/docs/google-docs/providers/google/gkehub/index.md +++ b/docs/google-docs/providers/google/gkehub/index.md @@ -19,9 +19,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
-total resources: 10
-total selectable resources: 10
-total methods: 42
+total resources: 12
+total selectable resources: 12
+total methods: 62
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleGKE Hub API Description -Idgkehub:v23.08.00155 +Idgkehub:v23.08.00157 ## Resources @@ -44,11 +44,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png features_iam_policies
fleets
locations
+memberships
-memberships
memberships_iam_policies
+namespaces
operations
+rbacrolebindings
scopes
scopes_iam_policies
diff --git a/docs/google-docs/providers/google/gkehub/locations/index.md b/docs/google-docs/providers/google/gkehub/locations/index.md index e86053cffd..db4abe5b19 100644 --- a/docs/google-docs/providers/google/gkehub/locations/index.md +++ b/docs/google-docs/providers/google/gkehub/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/gkehub/memberships/index.md b/docs/google-docs/providers/google/gkehub/memberships/index.md index 94deef4a6f..1818f0634a 100644 --- a/docs/google-docs/providers/google/gkehub/memberships/index.md +++ b/docs/google-docs/providers/google/gkehub/memberships/index.md @@ -25,17 +25,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to request the next page of resources from the `ListMemberships` method. The value of an empty string means that there are no more resources to return. | -| `resources` | `array` | The list of matching Memberships. | -| `unreachable` | `array` | List of locations that could not be reached while fetching this list. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_memberships_list` | `SELECT` | `locationsId, projectsId` | Lists Memberships in a given project and location. | | `projects_locations_memberships_create` | `INSERT` | `locationsId, projectsId` | Creates a new Membership. **This is currently only supported for GKE clusters on Google Cloud**. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster. | | `projects_locations_memberships_delete` | `DELETE` | `locationsId, membershipsId, projectsId` | Removes a Membership. **This is currently only supported for GKE clusters on Google Cloud**. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster. | +| `_projects_locations_memberships_list` | `EXEC` | `locationsId, projectsId` | Lists Memberships in a given project and location. | | `projects_locations_memberships_generate_connect_manifest` | `EXEC` | `locationsId, membershipsId, projectsId` | Generates the manifest for deployment of the GKE connect agent. **This method is used internally by Google-provided libraries.** Most clients should not need to call this method directly. | | `projects_locations_memberships_get` | `EXEC` | `locationsId, membershipsId, projectsId` | Gets the details of a Membership. | | `projects_locations_memberships_patch` | `EXEC` | `locationsId, membershipsId, projectsId` | Updates an existing Membership. | diff --git a/docs/google-docs/providers/google/gkehub/memberships_iam_policies/index.md b/docs/google-docs/providers/google/gkehub/memberships_iam_policies/index.md index 7eeb6b597e..7ec9d8f11e 100644 --- a/docs/google-docs/providers/google/gkehub/memberships_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkehub/memberships_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkehub/namespaces/index.md b/docs/google-docs/providers/google/gkehub/namespaces/index.md new file mode 100644 index 0000000000..67cffa032a --- /dev/null +++ b/docs/google-docs/providers/google/gkehub/namespaces/index.md @@ -0,0 +1,47 @@ +--- +title: namespaces +hide_title: false +hide_table_of_contents: false +keywords: + - namespaces + - gkehub + - 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 +--- + + + +## Overview + + + + +
Namenamespaces
TypeResource
Idgoogle.gkehub.namespaces
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | The resource name for the namespace `projects/{project}/locations/{location}/namespaces/{namespace}` | +| `scope` | `string` | Required. Scope associated with the namespace | +| `createTime` | `string` | Output only. When the namespace was created. | +| `deleteTime` | `string` | Output only. When the namespace was deleted. | +| `state` | `object` | NamespaceLifecycleState describes the state of a Namespace resource. | +| `updateTime` | `string` | Output only. When the namespace was last updated. | +| `namespaceLabels` | `object` | Optional. Namespace-level cluster namespace labels. These labels are applied to the related namespace of the member clusters bound to the parent Scope. Scope-level labels (`namespace_labels` in the Fleet Scope resource) take precedence over Namespace-level labels if they share a key. Keys and values must be Kubernetes-conformant. | +| `labels` | `object` | Optional. Labels for this Namespace. | +| `uid` | `string` | Output only. Google-generated UUID for this resource. This is unique across all namespace resources. If a namespace resource is deleted and another resource with the same name is created, it gets a different uid. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `projects_locations_scopes_namespaces_list` | `SELECT` | `locationsId, projectsId, scopesId` | Lists fleet namespaces. | +| `projects_locations_scopes_namespaces_create` | `INSERT` | `locationsId, projectsId, scopesId` | Creates a fleet namespace. | +| `projects_locations_scopes_namespaces_delete` | `DELETE` | `locationsId, namespacesId, projectsId, scopesId` | Deletes a fleet namespace. | +| `_projects_locations_scopes_namespaces_list` | `EXEC` | `locationsId, projectsId, scopesId` | Lists fleet namespaces. | +| `projects_locations_scopes_namespaces_get` | `EXEC` | `locationsId, namespacesId, projectsId, scopesId` | Returns the details of a fleet namespace. | +| `projects_locations_scopes_namespaces_patch` | `EXEC` | `locationsId, namespacesId, projectsId, scopesId` | Updates a fleet namespace. | diff --git a/docs/google-docs/providers/google/gkehub/operations/index.md b/docs/google-docs/providers/google/gkehub/operations/index.md index f6499b329f..05e59828a3 100644 --- a/docs/google-docs/providers/google/gkehub/operations/index.md +++ b/docs/google-docs/providers/google/gkehub/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | | `projects_locations_operations_get` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/gkehub/rbacrolebindings/index.md b/docs/google-docs/providers/google/gkehub/rbacrolebindings/index.md new file mode 100644 index 0000000000..daa87a45fd --- /dev/null +++ b/docs/google-docs/providers/google/gkehub/rbacrolebindings/index.md @@ -0,0 +1,48 @@ +--- +title: rbacrolebindings +hide_title: false +hide_table_of_contents: false +keywords: + - rbacrolebindings + - gkehub + - 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 +--- + + + +## Overview + + + + +
Namerbacrolebindings
TypeResource
Idgoogle.gkehub.rbacrolebindings
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | The resource name for the rbacrolebinding `projects/{project}/locations/{location}/namespaces/{namespace}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}` | +| `labels` | `object` | Optional. Labels for this RBACRolebinding. | +| `createTime` | `string` | Output only. When the rbacrolebinding was created. | +| `updateTime` | `string` | Output only. When the rbacrolebinding was last updated. | +| `group` | `string` | group is the group, as seen by the kubernetes cluster. | +| `state` | `object` | RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource. | +| `uid` | `string` | Output only. Google-generated UUID for this resource. This is unique across all rbacrolebinding resources. If a rbacrolebinding resource is deleted and another resource with the same name is created, it gets a different uid. | +| `role` | `object` | Role is the type for Kubernetes roles | +| `user` | `string` | user is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld" | +| `deleteTime` | `string` | Output only. When the rbacrolebinding was deleted. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `projects_locations_scopes_rbacrolebindings_list` | `SELECT` | `locationsId, projectsId, scopesId` | Lists all Scope RBACRoleBindings. | +| `projects_locations_scopes_rbacrolebindings_create` | `INSERT` | `locationsId, projectsId, scopesId` | Creates a Scope RBACRoleBinding. | +| `projects_locations_scopes_rbacrolebindings_delete` | `DELETE` | `locationsId, projectsId, rbacrolebindingsId, scopesId` | Deletes a Scope RBACRoleBinding. | +| `_projects_locations_scopes_rbacrolebindings_list` | `EXEC` | `locationsId, projectsId, scopesId` | Lists all Scope RBACRoleBindings. | +| `projects_locations_scopes_rbacrolebindings_get` | `EXEC` | `locationsId, projectsId, rbacrolebindingsId, scopesId` | Returns the details of a Scope RBACRoleBinding. | +| `projects_locations_scopes_rbacrolebindings_patch` | `EXEC` | `locationsId, projectsId, rbacrolebindingsId, scopesId` | Updates a Scope RBACRoleBinding. | diff --git a/docs/google-docs/providers/google/gkehub/scopes/index.md b/docs/google-docs/providers/google/gkehub/scopes/index.md index 87a3ce1d84..2bfebc0bbf 100644 --- a/docs/google-docs/providers/google/gkehub/scopes/index.md +++ b/docs/google-docs/providers/google/gkehub/scopes/index.md @@ -27,13 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to request the next page of resources from the `ListScopes` method. The value of an empty string means that there are no more resources to return. | -| `scopes` | `array` | The list of Scopes | +| `name` | `string` | The resource name for the scope `projects/{project}/locations/{location}/scopes/{scope}` | +| `allMemberships` | `boolean` | If true, all Memberships in the Fleet bind to this Scope. | +| `createTime` | `string` | Output only. When the scope was created. | +| `state` | `object` | ScopeLifecycleState describes the state of a Scope resource. | +| `labels` | `object` | Optional. Labels for this Scope. | +| `deleteTime` | `string` | Output only. When the scope was deleted. | +| `updateTime` | `string` | Output only. When the scope was last updated. | +| `namespaceLabels` | `object` | Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (`namespace_labels` in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant. | +| `uid` | `string` | Output only. Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_scopes_list` | `SELECT` | `locationsId, projectsId` | Lists Scopes. | | `projects_locations_scopes_create` | `INSERT` | `locationsId, projectsId` | Creates a Scope. | | `projects_locations_scopes_delete` | `DELETE` | `locationsId, projectsId, scopesId` | Deletes a Scope. | +| `_projects_locations_scopes_list` | `EXEC` | `locationsId, projectsId` | Lists Scopes. | | `projects_locations_scopes_get` | `EXEC` | `locationsId, projectsId, scopesId` | Returns the details of a Scope. | | `projects_locations_scopes_patch` | `EXEC` | `locationsId, projectsId, scopesId` | Updates a scopes. | diff --git a/docs/google-docs/providers/google/gkeonprem/bare_metal_admin_clusters/index.md b/docs/google-docs/providers/google/gkeonprem/bare_metal_admin_clusters/index.md index a8373a81d8..91a34a1fc8 100644 --- a/docs/google-docs/providers/google/gkeonprem/bare_metal_admin_clusters/index.md +++ b/docs/google-docs/providers/google/gkeonprem/bare_metal_admin_clusters/index.md @@ -27,14 +27,40 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token identifying a page of results the server should return. If the token is not empty this means that more results are available and should be retrieved by repeating the request with the provided page token. | -| `unreachable` | `array` | Locations that could not be reached. | -| `bareMetalAdminClusters` | `array` | The list of bare metal admin cluster. | +| `name` | `string` | Immutable. The bare metal admin cluster resource name. | +| `description` | `string` | A human readable description of this bare metal admin cluster. | +| `fleet` | `object` | Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## | +| `updateTime` | `string` | Output only. The time at which this bare metal admin cluster was last updated. | +| `clusterOperations` | `object` | BareMetalAdminClusterOperationsConfig specifies the admin cluster's observability infrastructure. | +| `nodeAccessConfig` | `object` | Specifies the node access related settings for the bare metal admin cluster. | +| `maintenanceStatus` | `object` | BareMetalAdminMaintenanceStatus represents the maintenance status for bare metal Admin cluster CR's nodes. | +| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the bare metal Admin Cluster. | +| `controlPlane` | `object` | BareMetalAdminControlPlaneConfig specifies the control plane configuration. | +| `uid` | `string` | Output only. The unique identifier of the bare metal admin cluster. | +| `bareMetalVersion` | `string` | The Anthos clusters on bare metal version for the bare metal admin cluster. | +| `localName` | `string` | Output only. The object name of the bare metal cluster custom resource. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs. | +| `endpoint` | `string` | Output only. The IP address name of bare metal admin cluster's API server. | +| `deleteTime` | `string` | Output only. The time at which this bare metal admin cluster was deleted. If the resource is not deleted, this must be empty | +| `networkConfig` | `object` | BareMetalAdminNetworkConfig specifies the cluster network configuration. | +| `nodeConfig` | `object` | BareMetalAdminWorkloadNodeConfig specifies the workload node configurations. | +| `proxy` | `object` | BareMetalAdminProxyConfig specifies the cluster proxy configuration. | +| `maintenanceConfig` | `object` | BareMetalAdminMaintenanceConfig specifies configurations to put bare metal Admin cluster CRs nodes in and out of maintenance. | +| `validationCheck` | `object` | ValidationCheck represents the result of preflight check. | +| `state` | `string` | Output only. The current state of the bare metal admin cluster. | +| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | +| `createTime` | `string` | Output only. The time at which this bare metal admin cluster was created. | +| `annotations` | `object` | Annotations on the bare metal admin cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. | +| `loadBalancer` | `object` | BareMetalAdminLoadBalancerConfig specifies the load balancer configuration. | +| `securityConfig` | `object` | Specifies the security related settings for the bare metal admin cluster. | +| `storage` | `object` | BareMetalAdminStorageConfig specifies the cluster storage configuration. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. | +| `osEnvironmentConfig` | `object` | Specifies operating system operation settings for cluster provisioning. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_bare_metal_admin_clusters_list` | `SELECT` | `locationsId, projectsId` | Lists bare metal admin clusters in a given project and location. | | `projects_locations_bare_metal_admin_clusters_create` | `INSERT` | `locationsId, projectsId` | Creates a new bare metal admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work. See: https://cloud.google.com/anthos/clusters/docs/bare-metal/latest/installing/creating-clusters/create-admin-cluster-api#prepare_bootstrap_environment | +| `_projects_locations_bare_metal_admin_clusters_list` | `EXEC` | `locationsId, projectsId` | Lists bare metal admin clusters in a given project and location. | | `projects_locations_bare_metal_admin_clusters_enroll` | `EXEC` | `locationsId, projectsId` | Enrolls an existing bare metal admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API. | | `projects_locations_bare_metal_admin_clusters_get` | `EXEC` | `bareMetalAdminClustersId, locationsId, projectsId` | Gets details of a single bare metal admin cluster. | | `projects_locations_bare_metal_admin_clusters_patch` | `EXEC` | `bareMetalAdminClustersId, locationsId, projectsId` | Updates the parameters of a single bare metal admin cluster. | diff --git a/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters/index.md b/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters/index.md index 7961590e6e..7ad1a88735 100644 --- a/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters/index.md +++ b/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters/index.md @@ -27,15 +27,44 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `bareMetalClusters` | `array` | The list of bare metal Clusters. | -| `nextPageToken` | `string` | A token identifying a page of results the server should return. If the token is not empty this means that more results are available and should be retrieved by repeating the request with the provided page token. | +| `name` | `string` | Immutable. The bare metal user cluster resource name. | +| `description` | `string` | A human readable description of this bare metal user cluster. | +| `createTime` | `string` | Output only. The time when the bare metal user cluster was created. | +| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the bare metal user cluster. | +| `maintenanceStatus` | `object` | Represents the maintenance status of the bare metal user cluster. | +| `osEnvironmentConfig` | `object` | Specifies operating system settings for cluster provisioning. | +| `adminClusterName` | `string` | Output only. The resource name of the bare metal admin cluster managing this user cluster. | +| `endpoint` | `string` | Output only. The IP address of the bare metal user cluster's API server. | +| `state` | `string` | Output only. The current state of the bare metal user cluster. | +| `localName` | `string` | Output only. The object name of the bare metal user cluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the name in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. When the local name and cluster name differ, the local name is used in the admin cluster controller logs. You use the cluster name when accessing the cluster using bmctl and kubectl. | +| `bareMetalVersion` | `string` | Required. The Anthos clusters on bare metal version for your user cluster. | +| `etag` | `string` | Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. | +| `annotations` | `object` | Annotations on the bare metal user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. | +| `deleteTime` | `string` | Output only. The time when the bare metal user cluster was deleted. If the resource is not deleted, this must be empty | +| `nodeConfig` | `object` | Specifies the workload node configurations. | +| `nodeAccessConfig` | `object` | Specifies the node access related settings for the bare metal user cluster. | +| `validationCheck` | `object` | ValidationCheck represents the result of preflight check. | +| `storage` | `object` | BareMetalStorageConfig specifies the cluster storage configuration. | +| `fleet` | `object` | Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## | +| `networkConfig` | `object` | Specifies the cluster network configuration. | +| `securityConfig` | `object` | Specifies the security related settings for the bare metal user cluster. | +| `proxy` | `object` | Specifies the cluster proxy configuration. | +| `clusterOperations` | `object` | Specifies the bare metal user cluster's observability infrastructure. | +| `upgradePolicy` | `object` | BareMetalClusterUpgradePolicy defines the cluster upgrade policy. | +| `controlPlane` | `object` | Specifies the control plane configuration. | +| `adminClusterMembership` | `string` | Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. | +| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | +| `updateTime` | `string` | Output only. The time when the bare metal user cluster was last updated. | +| `uid` | `string` | Output only. The unique identifier of the bare metal user cluster. | +| `loadBalancer` | `object` | Specifies the load balancer configuration. | +| `maintenanceConfig` | `object` | Specifies configurations to put bare metal nodes in and out of maintenance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_bare_metal_clusters_list` | `SELECT` | `locationsId, projectsId` | Lists bare metal clusters in a given project and location. | | `projects_locations_bare_metal_clusters_create` | `INSERT` | `locationsId, projectsId` | Creates a new bare metal cluster in a given project and location. | | `projects_locations_bare_metal_clusters_delete` | `DELETE` | `bareMetalClustersId, locationsId, projectsId` | Deletes a single bare metal Cluster. | +| `_projects_locations_bare_metal_clusters_list` | `EXEC` | `locationsId, projectsId` | Lists bare metal clusters in a given project and location. | | `projects_locations_bare_metal_clusters_enroll` | `EXEC` | `locationsId, projectsId` | Enrolls an existing bare metal user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API. | | `projects_locations_bare_metal_clusters_get` | `EXEC` | `bareMetalClustersId, locationsId, projectsId` | Gets details of a single bare metal Cluster. | | `projects_locations_bare_metal_clusters_patch` | `EXEC` | `bareMetalClustersId, locationsId, projectsId` | Updates the parameters of a single bare metal Cluster. | diff --git a/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters_iam_policies/index.md b/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters_iam_policies/index.md index c51f07a68c..db47640494 100644 --- a/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkeonprem/bare_metal_node_pools/index.md b/docs/google-docs/providers/google/gkeonprem/bare_metal_node_pools/index.md index 20b1646d7e..c570cebb8e 100644 --- a/docs/google-docs/providers/google/gkeonprem/bare_metal_node_pools/index.md +++ b/docs/google-docs/providers/google/gkeonprem/bare_metal_node_pools/index.md @@ -27,15 +27,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `unreachable` | `array` | Locations that could not be reached. | -| `bareMetalNodePools` | `array` | The node pools from the specified parent resource. | +| `name` | `string` | Immutable. The bare metal node pool resource name. | +| `nodePoolConfig` | `object` | BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. | +| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the bare metal node pool. | +| `state` | `string` | Output only. The current state of the bare metal node pool. | +| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | +| `createTime` | `string` | Output only. The time at which this bare metal node pool was created. | +| `displayName` | `string` | The display name for the bare metal node pool. | +| `annotations` | `object` | Annotations on the bare metal node pool. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. | +| `updateTime` | `string` | Output only. The time at which this bare metal node pool was last updated. | +| `uid` | `string` | Output only. The unique identifier of the bare metal node pool. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. | +| `upgradePolicy` | `object` | BareMetalNodePoolUpgradePolicy defines the node pool upgrade policy. | +| `deleteTime` | `string` | Output only. The time at which this bare metal node pool was deleted. If the resource is not deleted, this must be empty | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_bare_metal_clusters_bare_metal_node_pools_list` | `SELECT` | `bareMetalClustersId, locationsId, projectsId` | Lists bare metal node pools in a given project, location and bare metal cluster. | | `projects_locations_bare_metal_clusters_bare_metal_node_pools_create` | `INSERT` | `bareMetalClustersId, locationsId, projectsId` | Creates a new bare metal node pool in a given project, location and Bare Metal cluster. | | `projects_locations_bare_metal_clusters_bare_metal_node_pools_delete` | `DELETE` | `bareMetalClustersId, bareMetalNodePoolsId, locationsId, projectsId` | Deletes a single bare metal node pool. | +| `_projects_locations_bare_metal_clusters_bare_metal_node_pools_list` | `EXEC` | `bareMetalClustersId, locationsId, projectsId` | Lists bare metal node pools in a given project, location and bare metal cluster. | | `projects_locations_bare_metal_clusters_bare_metal_node_pools_enroll` | `EXEC` | `bareMetalClustersId, locationsId, projectsId` | Enrolls an existing bare metal node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created. | | `projects_locations_bare_metal_clusters_bare_metal_node_pools_get` | `EXEC` | `bareMetalClustersId, bareMetalNodePoolsId, locationsId, projectsId` | Gets details of a single bare metal node pool. | | `projects_locations_bare_metal_clusters_bare_metal_node_pools_patch` | `EXEC` | `bareMetalClustersId, bareMetalNodePoolsId, locationsId, projectsId` | Updates the parameters of a single bare metal node pool. | diff --git a/docs/google-docs/providers/google/gkeonprem/index.md b/docs/google-docs/providers/google/gkeonprem/index.md index f4741b1340..70cc0cdb80 100644 --- a/docs/google-docs/providers/google/gkeonprem/index.md +++ b/docs/google-docs/providers/google/gkeonprem/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 14
total selectable resources: 14
-total methods: 78
+total methods: 92
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleAnthos On-Prem API Description -Idgkeonprem:v23.08.00155 +Idgkeonprem:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/gkeonprem/locations/index.md b/docs/google-docs/providers/google/gkeonprem/locations/index.md index cf94dd2585..3aa09f9f21 100644 --- a/docs/google-docs/providers/google/gkeonprem/locations/index.md +++ b/docs/google-docs/providers/google/gkeonprem/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/gkeonprem/operations/index.md b/docs/google-docs/providers/google/gkeonprem/operations/index.md index c5db4643b7..778b8da2be 100644 --- a/docs/google-docs/providers/google/gkeonprem/operations/index.md +++ b/docs/google-docs/providers/google/gkeonprem/operations/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -40,6 +43,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_vmware_clusters_operations_list` | `SELECT` | `locationsId, projectsId, vmwareClustersId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_vmware_clusters_vmware_node_pools_operations_list` | `SELECT` | `locationsId, projectsId, vmwareClustersId, vmwareNodePoolsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_projects_locations_bare_metal_admin_clusters_operations_list` | `EXEC` | `bareMetalAdminClustersId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_list` | `EXEC` | `bareMetalClustersId, bareMetalNodePoolsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_bare_metal_clusters_operations_list` | `EXEC` | `bareMetalClustersId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_vmware_admin_clusters_operations_list` | `EXEC` | `locationsId, projectsId, vmwareAdminClustersId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_vmware_clusters_operations_list` | `EXEC` | `locationsId, projectsId, vmwareClustersId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_vmware_clusters_vmware_node_pools_operations_list` | `EXEC` | `locationsId, projectsId, vmwareClustersId, vmwareNodePoolsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_bare_metal_admin_clusters_operations_get` | `EXEC` | `bareMetalAdminClustersId, locationsId, operationsId, projectsId` | 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. | | `projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_get` | `EXEC` | `bareMetalClustersId, bareMetalNodePoolsId, locationsId, operationsId, projectsId` | 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. | | `projects_locations_bare_metal_clusters_operations_get` | `EXEC` | `bareMetalClustersId, locationsId, operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/gkeonprem/vmware_admin_clusters/index.md b/docs/google-docs/providers/google/gkeonprem/vmware_admin_clusters/index.md index 7ce0134536..c1c26f8c6f 100644 --- a/docs/google-docs/providers/google/gkeonprem/vmware_admin_clusters/index.md +++ b/docs/google-docs/providers/google/gkeonprem/vmware_admin_clusters/index.md @@ -27,13 +27,35 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `vmwareAdminClusters` | `array` | The list of VMware admin cluster. | -| `nextPageToken` | `string` | A token identifying a page of results the server should return. If the token is not empty this means that more results are available and should be retrieved by repeating the request with the provided page token. | +| `name` | `string` | Immutable. The VMware admin cluster resource name. | +| `description` | `string` | A human readable description of this VMware admin cluster. | +| `state` | `string` | Output only. The current state of VMware admin cluster. | +| `fleet` | `object` | Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## | +| `imageType` | `string` | The OS image type for the VMware admin cluster. | +| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the VMware admin cluster. | +| `loadBalancer` | `object` | VmwareAdminLoadBalancerConfig contains load balancer configuration for VMware admin cluster. | +| `localName` | `string` | Output only. The object name of the VMware OnPremAdminCluster custom resource. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs. | +| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | +| `addonNode` | `object` | VmwareAdminAddonNodeConfig contains add-on node configurations for VMware admin cluster. | +| `antiAffinityGroups` | `object` | Specifies anti affinity group config for the VMware user cluster. | +| `vcenter` | `object` | VmwareAdminVCenterConfig contains VCenter configuration for VMware admin cluster. | +| `uid` | `string` | Output only. The unique identifier of the VMware admin cluster. | +| `platformConfig` | `object` | VmwarePlatformConfig represents configuration for the VMware platform. | +| `updateTime` | `string` | Output only. The time at which VMware admin cluster was last updated. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. | +| `annotations` | `object` | Annotations on the VMware admin cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. | +| `bootstrapClusterMembership` | `string` | The bootstrap cluster this VMware admin cluster belongs to. | +| `networkConfig` | `object` | VmwareAdminNetworkConfig contains network configuration for VMware admin cluster. | +| `onPremVersion` | `string` | The Anthos clusters on the VMware version for the admin cluster. | +| `createTime` | `string` | Output only. The time at which VMware admin cluster was created. | +| `autoRepairConfig` | `object` | Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. | +| `endpoint` | `string` | Output only. The DNS name of VMware admin cluster's API server. | +| `controlPlaneNode` | `object` | VmwareAdminControlPlaneNodeConfig contains control plane node configuration for VMware admin cluster. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_vmware_admin_clusters_list` | `SELECT` | `locationsId, projectsId` | Lists VMware admin clusters in a given project and location. | +| `_projects_locations_vmware_admin_clusters_list` | `EXEC` | `locationsId, projectsId` | Lists VMware admin clusters in a given project and location. | | `projects_locations_vmware_admin_clusters_enroll` | `EXEC` | `locationsId, projectsId` | Enrolls an existing VMware admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API. | | `projects_locations_vmware_admin_clusters_get` | `EXEC` | `locationsId, projectsId, vmwareAdminClustersId` | Gets details of a single VMware admin cluster. | | `projects_locations_vmware_admin_clusters_patch` | `EXEC` | `locationsId, projectsId, vmwareAdminClustersId` | Updates the parameters of a single VMware admin cluster. | diff --git a/docs/google-docs/providers/google/gkeonprem/vmware_clusters/index.md b/docs/google-docs/providers/google/gkeonprem/vmware_clusters/index.md index 7ef706e0a8..4976e91b39 100644 --- a/docs/google-docs/providers/google/gkeonprem/vmware_clusters/index.md +++ b/docs/google-docs/providers/google/gkeonprem/vmware_clusters/index.md @@ -27,15 +27,42 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `vmwareClusters` | `array` | The list of VMware Cluster. | -| `nextPageToken` | `string` | A token identifying a page of results the server should return. If the token is not empty this means that more results are available and should be retrieved by repeating the request with the provided page token. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | Immutable. The VMware user cluster resource name. | +| `description` | `string` | A human readable description of this VMware user cluster. | +| `deleteTime` | `string` | Output only. The time at which VMware user cluster was deleted. | +| `onPremVersion` | `string` | Required. The Anthos clusters on the VMware version for your user cluster. | +| `enableControlPlaneV2` | `boolean` | Enable control plane V2. Default to false. | +| `authorization` | `object` | Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. | +| `adminClusterMembership` | `string` | Required. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources. | +| `updateTime` | `string` | Output only. The time at which VMware user cluster was last updated. | +| `adminClusterName` | `string` | Output only. The resource name of the VMware admin cluster hosting this user cluster. | +| `endpoint` | `string` | Output only. The DNS name of VMware user cluster's API server. | +| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | +| `createTime` | `string` | Output only. The time at which VMware user cluster was created. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. | +| `loadBalancer` | `object` | Specifies the locad balancer config for the VMware user cluster. | +| `annotations` | `object` | Annotations on the VMware user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. | +| `dataplaneV2` | `object` | Contains configurations for Dataplane V2, which is optimized dataplane for Kubernetes networking. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dataplane-v2 | +| `validationCheck` | `object` | ValidationCheck represents the result of preflight check. | +| `networkConfig` | `object` | Specifies network config for the VMware user cluster. | +| `storage` | `object` | Specifies vSphere CSI components deployment config in the VMware user cluster. | +| `state` | `string` | Output only. The current state of VMware user cluster. | +| `vmTrackingEnabled` | `boolean` | Enable VM tracking. | +| `antiAffinityGroups` | `object` | Specifies anti affinity group config for the VMware user cluster. | +| `autoRepairConfig` | `object` | Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. | +| `localName` | `string` | Output only. The object name of the VMware OnPremUserCluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs. | +| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the VMware user cluster. | +| `vcenter` | `object` | Represents configuration for the VMware VCenter for the user cluster. | +| `uid` | `string` | Output only. The unique identifier of the VMware user cluster. | +| `fleet` | `object` | Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## | +| `controlPlaneNode` | `object` | Specifies control plane node config for the VMware user cluster. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_vmware_clusters_list` | `SELECT` | `locationsId, projectsId` | Lists VMware Clusters in a given project and location. | | `projects_locations_vmware_clusters_create` | `INSERT` | `locationsId, projectsId` | Creates a new VMware user cluster in a given project and location. | | `projects_locations_vmware_clusters_delete` | `DELETE` | `locationsId, projectsId, vmwareClustersId` | Deletes a single VMware Cluster. | +| `_projects_locations_vmware_clusters_list` | `EXEC` | `locationsId, projectsId` | Lists VMware Clusters in a given project and location. | | `projects_locations_vmware_clusters_enroll` | `EXEC` | `locationsId, projectsId` | Enrolls an existing VMware user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API. | | `projects_locations_vmware_clusters_get` | `EXEC` | `locationsId, projectsId, vmwareClustersId` | Gets details of a single VMware Cluster. | | `projects_locations_vmware_clusters_patch` | `EXEC` | `locationsId, projectsId, vmwareClustersId` | Updates the parameters of a single VMware cluster. | diff --git a/docs/google-docs/providers/google/gkeonprem/vmware_clusters_iam_policies/index.md b/docs/google-docs/providers/google/gkeonprem/vmware_clusters_iam_policies/index.md index 1ba73006e9..378509cada 100644 --- a/docs/google-docs/providers/google/gkeonprem/vmware_clusters_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkeonprem/vmware_clusters_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkeonprem/vmware_node_pools/index.md b/docs/google-docs/providers/google/gkeonprem/vmware_node_pools/index.md index 9454f7bb76..d39d130cce 100644 --- a/docs/google-docs/providers/google/gkeonprem/vmware_node_pools/index.md +++ b/docs/google-docs/providers/google/gkeonprem/vmware_node_pools/index.md @@ -27,15 +27,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `vmwareNodePools` | `array` | The node pools from the specified parent resource. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Immutable. The resource name of this node pool. | +| `nodePoolAutoscaling` | `object` | NodePoolAutoscaling config for the NodePool to allow for the kubernetes to scale NodePool. | +| `uid` | `string` | Output only. The unique identifier of the node pool. | +| `createTime` | `string` | Output only. The time at which this node pool was created. | +| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the node pool. | +| `state` | `string` | Output only. The current state of the node pool. | +| `displayName` | `string` | The display name for the node pool. | +| `deleteTime` | `string` | Output only. The time at which this node pool was deleted. If the resource is not deleted, this must be empty | +| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | +| `onPremVersion` | `string` | Anthos version for the node pool. Defaults to the user cluster version. | +| `annotations` | `object` | Annotations on the node pool. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. | +| `config` | `object` | Parameters that describe the configuration of all nodes within a given node pool. | +| `updateTime` | `string` | Output only. The time at which this node pool was last updated. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_vmware_clusters_vmware_node_pools_list` | `SELECT` | `locationsId, projectsId, vmwareClustersId` | Lists VMware node pools in a given project, location and VMWare cluster. | | `projects_locations_vmware_clusters_vmware_node_pools_create` | `INSERT` | `locationsId, projectsId, vmwareClustersId` | Creates a new VMware node pool in a given project, location and VMWare cluster. | | `projects_locations_vmware_clusters_vmware_node_pools_delete` | `DELETE` | `locationsId, projectsId, vmwareClustersId, vmwareNodePoolsId` | Deletes a single VMware node pool. | +| `_projects_locations_vmware_clusters_vmware_node_pools_list` | `EXEC` | `locationsId, projectsId, vmwareClustersId` | Lists VMware node pools in a given project, location and VMWare cluster. | | `projects_locations_vmware_clusters_vmware_node_pools_enroll` | `EXEC` | `locationsId, projectsId, vmwareClustersId` | Enrolls a VMware node pool to Anthos On-Prem API | | `projects_locations_vmware_clusters_vmware_node_pools_get` | `EXEC` | `locationsId, projectsId, vmwareClustersId, vmwareNodePoolsId` | Gets details of a single VMware node pool. | | `projects_locations_vmware_clusters_vmware_node_pools_patch` | `EXEC` | `locationsId, projectsId, vmwareClustersId, vmwareNodePoolsId` | Updates the parameters of a single VMware node pool. | diff --git a/docs/google-docs/providers/google/gkeonprem/vmware_node_pools_iam_policies/index.md b/docs/google-docs/providers/google/gkeonprem/vmware_node_pools_iam_policies/index.md index dd5d5d34ce..e2699ab58c 100644 --- a/docs/google-docs/providers/google/gkeonprem/vmware_node_pools_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkeonprem/vmware_node_pools_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/attribute_definitions/index.md b/docs/google-docs/providers/google/healthcare/attribute_definitions/index.md index a425633c17..85ce9f66c3 100644 --- a/docs/google-docs/providers/google/healthcare/attribute_definitions/index.md +++ b/docs/google-docs/providers/google/healthcare/attribute_definitions/index.md @@ -27,8 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `attributeDefinitions` | `array` | The returned Attribute definitions. The maximum number of attributes returned is determined by the value of page_size in the ListAttributeDefinitionsRequest. | +| `name` | `string` | Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. | +| `description` | `string` | Optional. A description of the attribute. | +| `consentDefaultValues` | `array` | Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value. | +| `dataMappingDefaultValue` | `string` | Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category `RESOURCE`. | +| `allowedValues` | `array` | Required. Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation. | +| `category` | `string` | Required. The category of the attribute. The value of this field cannot be changed after creation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +40,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `consentStoresId, datasetsId, locationsId, projectsId` | Lists the Attribute definitions in the specified consent store. | | `create` | `INSERT` | `consentStoresId, datasetsId, locationsId, projectsId` | Creates a new Attribute definition in the parent consent store. | | `delete` | `DELETE` | `attributeDefinitionsId, consentStoresId, datasetsId, locationsId, projectsId` | Deletes the specified Attribute definition. Fails if the Attribute definition is referenced by any User data mapping, or the latest revision of any Consent. | +| `_list` | `EXEC` | `consentStoresId, datasetsId, locationsId, projectsId` | Lists the Attribute definitions in the specified consent store. | | `patch` | `EXEC` | `attributeDefinitionsId, consentStoresId, datasetsId, locationsId, projectsId` | Updates the specified Attribute definition. | diff --git a/docs/google-docs/providers/google/healthcare/consent_artifacts/index.md b/docs/google-docs/providers/google/healthcare/consent_artifacts/index.md index 3072ce0fd0..e1253d2ccb 100644 --- a/docs/google-docs/providers/google/healthcare/consent_artifacts/index.md +++ b/docs/google-docs/providers/google/healthcare/consent_artifacts/index.md @@ -27,8 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `consentArtifacts` | `array` | The returned Consent artifacts. The maximum number of artifacts returned is determined by the value of page_size in the ListConsentArtifactsRequest. | +| `name` | `string` | Resource name of the Consent artifact, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. Cannot be changed after creation. | +| `consentContentScreenshots` | `array` | Optional. Screenshots, PDFs, or other binary information documenting the user's consent. | +| `consentContentVersion` | `string` | Optional. An string indicating the version of the consent information shown to the user. | +| `guardianSignature` | `object` | User signature. | +| `metadata` | `object` | Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version. | +| `userId` | `string` | Required. User's UUID provided by the client. | +| `userSignature` | `object` | User signature. | +| `witnessSignature` | `object` | User signature. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,3 +42,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `consentStoresId, datasetsId, locationsId, projectsId` | Lists the Consent artifacts in the specified consent store. | | `create` | `INSERT` | `consentStoresId, datasetsId, locationsId, projectsId` | Creates a new Consent artifact in the parent consent store. | | `delete` | `DELETE` | `consentArtifactsId, consentStoresId, datasetsId, locationsId, projectsId` | Deletes the specified Consent artifact. Fails if the artifact is referenced by the latest revision of any Consent. | +| `_list` | `EXEC` | `consentStoresId, datasetsId, locationsId, projectsId` | Lists the Consent artifacts in the specified consent store. | diff --git a/docs/google-docs/providers/google/healthcare/consent_stores/index.md b/docs/google-docs/providers/google/healthcare/consent_stores/index.md index 179ebc35ab..5599e6efdf 100644 --- a/docs/google-docs/providers/google/healthcare/consent_stores/index.md +++ b/docs/google-docs/providers/google/healthcare/consent_stores/index.md @@ -27,8 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `consentStores` | `array` | The returned consent stores. The maximum number of stores returned is determined by the value of page_size in the ListConsentStoresRequest. | +| `name` | `string` | Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. Cannot be changed after creation. | +| `labels` | `object` | Optional. User-supplied key-value pairs used to organize consent stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}. Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. No more than 64 labels can be associated with a given store. For more information: https://cloud.google.com/healthcare/docs/how-tos/labeling-resources | +| `defaultConsentTtl` | `string` | Optional. Default time to live for Consents created in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents. | +| `enableConsentCreateOnUpdate` | `boolean` | Optional. If `true`, UpdateConsent creates the Consent if it does not already exist. If unspecified, defaults to `false`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +38,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `datasetsId, locationsId, projectsId` | Lists the consent stores in the specified dataset. | | `create` | `INSERT` | `datasetsId, locationsId, projectsId` | Creates a new consent store in the parent dataset. Attempting to create a consent store with the same ID as an existing store fails with an ALREADY_EXISTS error. | | `delete` | `DELETE` | `consentStoresId, datasetsId, locationsId, projectsId` | Deletes the specified consent store and removes all the consent store's data. | +| `_list` | `EXEC` | `datasetsId, locationsId, projectsId` | Lists the consent stores in the specified dataset. | | `check_data_access` | `EXEC` | `consentStoresId, datasetsId, locationsId, projectsId` | Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use. | | `evaluate_user_consents` | `EXEC` | `consentStoresId, datasetsId, locationsId, projectsId` | Evaluates the user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, which can cause a slight delay between the time mappings are created or updated and when they are included in EvaluateUserConsents results. | | `patch` | `EXEC` | `consentStoresId, datasetsId, locationsId, projectsId` | Updates the specified consent store. | diff --git a/docs/google-docs/providers/google/healthcare/consents/index.md b/docs/google-docs/providers/google/healthcare/consents/index.md index fcbdb2bb18..34dbc617da 100644 --- a/docs/google-docs/providers/google/healthcare/consents/index.md +++ b/docs/google-docs/providers/google/healthcare/consents/index.md @@ -27,8 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `consents` | `array` | The returned Consents. The maximum number of Consents returned is determined by the value of page_size in the ListConsentsRequest. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. | +| `state` | `string` | Required. Indicates the current state of this Consent. | +| `revisionId` | `string` | Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. | +| `policies` | `array` | Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. | +| `userId` | `string` | Required. User's UUID provided by the client. | +| `ttl` | `string` | Input only. The time to live for this Consent from when it is created. | +| `consentArtifact` | `string` | Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. | +| `metadata` | `object` | Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. | +| `expireTime` | `string` | Timestamp in UTC of when this Consent is considered expired. | +| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +44,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `consentStoresId, datasetsId, locationsId, projectsId` | Lists the Consent in the given consent store, returning each Consent's latest revision. | | `create` | `INSERT` | `consentStoresId, datasetsId, locationsId, projectsId` | Creates a new Consent in the parent consent store. | | `delete` | `DELETE` | `consentStoresId, consentsId, datasetsId, locationsId, projectsId` | Deletes the Consent and its revisions. To keep a record of the Consent but mark it inactive, see [RevokeConsent]. To delete a revision of a Consent, see [DeleteConsentRevision]. This operation does not delete the related Consent artifact. | +| `_list` | `EXEC` | `consentStoresId, datasetsId, locationsId, projectsId` | Lists the Consent in the given consent store, returning each Consent's latest revision. | | `activate` | `EXEC` | `consentStoresId, consentsId, datasetsId, locationsId, projectsId` | Activates the latest revision of the specified Consent by committing a new revision with `state` updated to `ACTIVE`. If the latest revision of the specified Consent is in the `ACTIVE` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the `REJECTED` or `REVOKED` state. | | `patch` | `EXEC` | `consentStoresId, consentsId, datasetsId, locationsId, projectsId` | Updates the latest revision of the specified Consent by committing a new revision with the changes. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the `REJECTED` or `REVOKED` state. | | `reject` | `EXEC` | `consentStoresId, consentsId, datasetsId, locationsId, projectsId` | Rejects the latest revision of the specified Consent by committing a new revision with `state` updated to `REJECTED`. If the latest revision of the specified Consent is in the `REJECTED` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the `ACTIVE` or `REVOKED` state. | diff --git a/docs/google-docs/providers/google/healthcare/consents_revisions/index.md b/docs/google-docs/providers/google/healthcare/consents_revisions/index.md index 02d899e90c..0f85d4fd86 100644 --- a/docs/google-docs/providers/google/healthcare/consents_revisions/index.md +++ b/docs/google-docs/providers/google/healthcare/consents_revisions/index.md @@ -27,9 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `consents` | `array` | The returned Consent revisions. The maximum number of revisions returned is determined by the value of `page_size` in the ListConsentRevisionsRequest. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. | +| `revisionId` | `string` | Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. | +| `ttl` | `string` | Input only. The time to live for this Consent from when it is created. | +| `state` | `string` | Required. Indicates the current state of this Consent. | +| `expireTime` | `string` | Timestamp in UTC of when this Consent is considered expired. | +| `userId` | `string` | Required. User's UUID provided by the client. | +| `metadata` | `object` | Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. | +| `consentArtifact` | `string` | Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. | +| `policies` | `array` | Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. | +| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list_revisions` | `SELECT` | `consentStoresId, consentsId, datasetsId, locationsId, projectsId` | +| `_list_revisions` | `EXEC` | `consentStoresId, consentsId, datasetsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/healthcare/datasets/index.md b/docs/google-docs/providers/google/healthcare/datasets/index.md index 198fff87fc..7af1d10a53 100644 --- a/docs/google-docs/providers/google/healthcare/datasets/index.md +++ b/docs/google-docs/providers/google/healthcare/datasets/index.md @@ -36,5 +36,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists the health datasets in the current project. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new health dataset. Results are returned through the Operation interface which returns either an `Operation.response` which contains a Dataset or `Operation.error`. The metadata field type is OperationMetadata. | | `delete` | `DELETE` | `datasetsId, locationsId, projectsId` | Deletes the specified health dataset and all data contained in the dataset. Deleting a dataset does not affect the sources from which the dataset was imported (if any). | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists the health datasets in the current project. | | `deidentify` | `EXEC` | `datasetsId, locationsId, projectsId` | Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The new de-identified dataset will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). | | `patch` | `EXEC` | `datasetsId, locationsId, projectsId` | Updates dataset metadata. | diff --git a/docs/google-docs/providers/google/healthcare/datasets_iam_policies/index.md b/docs/google-docs/providers/google/healthcare/datasets_iam_policies/index.md index e4b8e32b4a..f27328d5c5 100644 --- a/docs/google-docs/providers/google/healthcare/datasets_iam_policies/index.md +++ b/docs/google-docs/providers/google/healthcare/datasets_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/dicom_stores/index.md b/docs/google-docs/providers/google/healthcare/dicom_stores/index.md index e43a070b50..d555babc3f 100644 --- a/docs/google-docs/providers/google/healthcare/dicom_stores/index.md +++ b/docs/google-docs/providers/google/healthcare/dicom_stores/index.md @@ -27,8 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `dicomStores` | `array` | The returned DICOM stores. Won't be more DICOM stores than the value of page_size in the request. | -| `nextPageToken` | `string` | Token to retrieve the next page of results or empty if there are no more results in the list. | +| `name` | `string` | Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. | +| `labels` | `object` | User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. | +| `notificationConfig` | `object` | Specifies where to send notifications upon changes to a data store. | +| `streamConfigs` | `array` | Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +38,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `datasetsId, locationsId, projectsId` | Lists the DICOM stores in the given dataset. | | `create` | `INSERT` | `datasetsId, locationsId, projectsId` | Creates a new DICOM store within the parent dataset. | | `delete` | `DELETE` | `datasetsId, dicomStoresId, locationsId, projectsId` | Deletes the specified DICOM store and removes all images that are contained within it. | +| `_list` | `EXEC` | `datasetsId, locationsId, projectsId` | Lists the DICOM stores in the given dataset. | | `deidentify` | `EXEC` | `datasetsId, dicomStoresId, locationsId, projectsId` | De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyDicomStoreSummary. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The output DICOM store will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). | | `export` | `EXEC` | `datasetsId, dicomStoresId, locationsId, projectsId` | Exports data to the specified destination by copying it from the DICOM store. Errors are also logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. | | `import` | `EXEC` | `datasetsId, dicomStoresId, locationsId, projectsId` | Imports data into the DICOM store by copying it from the specified source. Errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. | diff --git a/docs/google-docs/providers/google/healthcare/dicom_stores_iam_policies/index.md b/docs/google-docs/providers/google/healthcare/dicom_stores_iam_policies/index.md index c19877877d..7cce08f872 100644 --- a/docs/google-docs/providers/google/healthcare/dicom_stores_iam_policies/index.md +++ b/docs/google-docs/providers/google/healthcare/dicom_stores_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/fhir_stores/index.md b/docs/google-docs/providers/google/healthcare/fhir_stores/index.md index d818bc2f12..4bb72fa16b 100644 --- a/docs/google-docs/providers/google/healthcare/fhir_stores/index.md +++ b/docs/google-docs/providers/google/healthcare/fhir_stores/index.md @@ -27,8 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `fhirStores` | `array` | The returned FHIR stores. Won't be more FHIR stores than the value of page_size in the request. | -| `nextPageToken` | `string` | Token to retrieve the next page of results or empty if there are no more results in the list. | +| `name` | `string` | Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. | +| `disableResourceVersioning` | `boolean` | Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. | +| `labels` | `object` | User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. | +| `notificationConfig` | `object` | Specifies where to send notifications upon changes to a data store. | +| `streamConfigs` | `array` | A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. | +| `version` | `string` | Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. | +| `complexDataTypeReferenceParsing` | `string` | Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. | +| `enableUpdateCreate` | `boolean` | Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. | +| `notificationConfigs` | `array` | Specifies where and whether to send notifications upon changes to a FHIR store. | +| `defaultSearchHandlingStrict` | `boolean` | If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. | +| `disableReferentialIntegrity` | `boolean` | Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. | +| `validationConfig` | `object` | Contains the configuration for FHIR profiles and validation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +46,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `datasetsId, locationsId, projectsId` | Lists the FHIR stores in the given dataset. | | `create` | `INSERT` | `datasetsId, locationsId, projectsId` | Creates a new FHIR store within the parent dataset. | | `delete` | `DELETE` | `datasetsId, fhirStoresId, locationsId, projectsId` | Deletes the specified FHIR store and removes all resources within it. | +| `_list` | `EXEC` | `datasetsId, locationsId, projectsId` | Lists the FHIR stores in the given dataset. | | `deidentify` | `EXEC` | `datasetsId, fhirStoresId, locationsId, projectsId` | De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirStoreSummary. If errors occur, error is set. Error details are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). | | `export` | `EXEC` | `datasetsId, fhirStoresId, locationsId, projectsId` | Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. | | `import` | `EXEC` | `datasetsId, fhirStoresId, locationsId, projectsId` | Imports resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it's possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters in ImportResourcesRequest. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. | diff --git a/docs/google-docs/providers/google/healthcare/fhir_stores_iam_policies/index.md b/docs/google-docs/providers/google/healthcare/fhir_stores_iam_policies/index.md index bd46170f79..a3b3c764dd 100644 --- a/docs/google-docs/providers/google/healthcare/fhir_stores_iam_policies/index.md +++ b/docs/google-docs/providers/google/healthcare/fhir_stores_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/hl7_v2_stores/index.md b/docs/google-docs/providers/google/healthcare/hl7_v2_stores/index.md index 120265a214..13262af732 100644 --- a/docs/google-docs/providers/google/healthcare/hl7_v2_stores/index.md +++ b/docs/google-docs/providers/google/healthcare/hl7_v2_stores/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `hl7V2Stores` | `array` | The returned HL7v2 stores. Won't be more HL7v2 stores than the value of page_size in the request. | -| `nextPageToken` | `string` | Token to retrieve the next page of results or empty if there are no more results in the list. | +| `name` | `string` | Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. | +| `rejectDuplicateMessage` | `boolean` | Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. | +| `labels` | `object` | User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. | +| `notificationConfigs` | `array` | A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. | +| `parserConfig` | `object` | The configuration for the parser. It determines how the server parses the messages. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +39,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `datasetsId, locationsId, projectsId` | Lists the HL7v2 stores in the given dataset. | | `create` | `INSERT` | `datasetsId, locationsId, projectsId` | Creates a new HL7v2 store within the parent dataset. | | `delete` | `DELETE` | `datasetsId, hl7V2StoresId, locationsId, projectsId` | Deletes the specified HL7v2 store and removes all messages that it contains. | +| `_list` | `EXEC` | `datasetsId, locationsId, projectsId` | Lists the HL7v2 stores in the given dataset. | | `export` | `EXEC` | `datasetsId, hl7V2StoresId, locationsId, projectsId` | Exports the messages to a destination. To filter messages to be exported, define a filter using the start and end time, relative to the message generation time (MSH.7). This API returns an Operation that can be used to track the status of the job by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. | | `import` | `EXEC` | `datasetsId, hl7V2StoresId, locationsId, projectsId` | Import messages to the HL7v2 store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some HL7v2 store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty HL7v2 store that is not being used by other clients. An existing message will be overwritten if a duplicate message is imported. A duplicate message is a message with the same raw bytes as a message that already exists in this HL7v2 store. When a message is overwritten, its labels will also be overwritten. The import operation is idempotent unless the input data contains multiple valid messages with the same raw bytes but different labels. In that case, after the import completes, the store contains exactly one message with those raw bytes but there is no ordering guarantee on which version of the labels it has. The operation result counters do not count duplicated raw bytes as an error and count one success for each message in the input, which might result in a success count larger than the number of messages in the HL7v2 store. If some messages fail to import, for example due to parsing errors, successfully imported messages are not rolled back. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a response of type ImportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. | | `patch` | `EXEC` | `datasetsId, hl7V2StoresId, locationsId, projectsId` | Updates the HL7v2 store. | diff --git a/docs/google-docs/providers/google/healthcare/hl7_v2_stores_iam_policies/index.md b/docs/google-docs/providers/google/healthcare/hl7_v2_stores_iam_policies/index.md index 7d918e8420..e68383078e 100644 --- a/docs/google-docs/providers/google/healthcare/hl7_v2_stores_iam_policies/index.md +++ b/docs/google-docs/providers/google/healthcare/hl7_v2_stores_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/index.md b/docs/google-docs/providers/google/healthcare/index.md index 5339656d75..8651305ad0 100644 --- a/docs/google-docs/providers/google/healthcare/index.md +++ b/docs/google-docs/providers/google/healthcare/index.md @@ -21,7 +21,7 @@ Manage, Store, And Access Healthcare Data In Google Cloud Platform.
total resources: 34
total selectable resources: 19
-total methods: 124
+total methods: 137
@@ -33,7 +33,7 @@ Manage, Store, And Access Healthcare Data In Google Cloud Platform. TypeService TitleCloud Healthcare API DescriptionManage, Store, And Access Healthcare Data In Google Cloud Platform. -Idhealthcare:v23.08.00155 +Idhealthcare:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/healthcare/locations/index.md b/docs/google-docs/providers/google/healthcare/locations/index.md index 602c634295..674ebba4e0 100644 --- a/docs/google-docs/providers/google/healthcare/locations/index.md +++ b/docs/google-docs/providers/google/healthcare/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/healthcare/messages/index.md b/docs/google-docs/providers/google/healthcare/messages/index.md index 0d1af50367..7f7a0f8d8e 100644 --- a/docs/google-docs/providers/google/healthcare/messages/index.md +++ b/docs/google-docs/providers/google/healthcare/messages/index.md @@ -27,8 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `hl7V2Messages` | `array` | The returned Messages. Won't be more Messages than the value of page_size in the request. See view for populated fields. | -| `nextPageToken` | `string` | Token to retrieve the next page of results or empty if there are no more results in the list. | +| `name` | `string` | Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. | +| `sendFacility` | `string` | The hospital that this message came from. MSH-4. | +| `createTime` | `string` | Output only. The datetime when the message was created. Set by the server. | +| `messageType` | `string` | The message type for this message. MSH-9.1. | +| `sendTime` | `string` | The datetime the sending application sent this message. MSH-7. | +| `patientIds` | `array` | All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. | +| `schematizedData` | `object` | The content of an HL7v2 message in a structured format as specified by a schema. | +| `parsedData` | `object` | The content of a HL7v2 message in a structured format. | +| `labels` | `object` | User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. | +| `data` | `string` | Raw message bytes. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +44,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `datasetsId, hl7V2StoresId, locationsId, projectsId` | Lists all the messages in the given HL7v2 store with support for filtering. Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay between the time a message is created and when it can be found through a filter. | | `create` | `INSERT` | `datasetsId, hl7V2StoresId, locationsId, projectsId` | Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. | | `delete` | `DELETE` | `datasetsId, hl7V2StoresId, locationsId, messagesId, projectsId` | Deletes an HL7v2 message. | +| `_list` | `EXEC` | `datasetsId, hl7V2StoresId, locationsId, projectsId` | Lists all the messages in the given HL7v2 store with support for filtering. Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay between the time a message is created and when it can be found through a filter. | | `ingest` | `EXEC` | `datasetsId, hl7V2StoresId, locationsId, projectsId` | Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. If the method is successful, it generates a response containing an HL7v2 acknowledgment (`ACK`) message. If the method encounters an error, it returns a negative acknowledgment (`NACK`) message. This behavior is suitable for replying to HL7v2 interface systems that expect these acknowledgments. | | `patch` | `EXEC` | `datasetsId, hl7V2StoresId, locationsId, messagesId, projectsId` | Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time cannot be altered. Only the Message.labels field is allowed to be updated. The labels in the request are merged with the existing set of labels. Existing labels with the same keys are updated. | diff --git a/docs/google-docs/providers/google/healthcare/operations/index.md b/docs/google-docs/providers/google/healthcare/operations/index.md index 7141a993ef..1c46849a16 100644 --- a/docs/google-docs/providers/google/healthcare/operations/index.md +++ b/docs/google-docs/providers/google/healthcare/operations/index.md @@ -27,11 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `datasetsId, locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `datasetsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_list` | `EXEC` | `datasetsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `datasetsId, locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/healthcare/user_data_mappings/index.md b/docs/google-docs/providers/google/healthcare/user_data_mappings/index.md index 995782e425..99519bb162 100644 --- a/docs/google-docs/providers/google/healthcare/user_data_mappings/index.md +++ b/docs/google-docs/providers/google/healthcare/user_data_mappings/index.md @@ -27,8 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `userDataMappings` | `array` | The returned User data mappings. The maximum number of User data mappings returned is determined by the value of page_size in the ListUserDataMappingsRequest. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`. | +| `archived` | `boolean` | Output only. Indicates whether this mapping is archived. | +| `dataId` | `string` | Required. A unique identifier for the mapped resource. | +| `resourceAttributes` | `array` | Attributes of the resource. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute. | +| `userId` | `string` | Required. User's UUID provided by the client. | +| `archiveTime` | `string` | Output only. Indicates the time when this mapping was archived. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +40,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `consentStoresId, datasetsId, locationsId, projectsId` | Lists the User data mappings in the specified consent store. | | `create` | `INSERT` | `consentStoresId, datasetsId, locationsId, projectsId` | Creates a new User data mapping in the parent consent store. | | `delete` | `DELETE` | `consentStoresId, datasetsId, locationsId, projectsId, userDataMappingsId` | Deletes the specified User data mapping. | +| `_list` | `EXEC` | `consentStoresId, datasetsId, locationsId, projectsId` | Lists the User data mappings in the specified consent store. | | `archive` | `EXEC` | `consentStoresId, datasetsId, locationsId, projectsId, userDataMappingsId` | Archives the specified User data mapping. | | `patch` | `EXEC` | `consentStoresId, datasetsId, locationsId, projectsId, userDataMappingsId` | Updates the specified User data mapping. | diff --git a/docs/google-docs/providers/google/iam/index.md b/docs/google-docs/providers/google/iam/index.md index 8eb249cf94..24c162e6fc 100644 --- a/docs/google-docs/providers/google/iam/index.md +++ b/docs/google-docs/providers/google/iam/index.md @@ -19,9 +19,9 @@ Manages Identity And Access Control For Google Cloud Platform Resources, Includi
-total resources: 4
+total resources: 2
total selectable resources: 1
-total methods: 6
+total methods: 7
@@ -33,17 +33,15 @@ Manages Identity And Access Control For Google Cloud Platform Resources, Includi TypeService TitleIdentity And Access Management (IAM) API DescriptionManages Identity And Access Control For Google Cloud Platform Resources, Including The Creation Of Service Accounts, Which You Can Use To Authenticate To Google And Make API Calls. -Idiam:v23.08.00155 +Idiam:v23.08.00157 ## Resources
operations
-policies
-policies_policies
-policies_policy
+policies
diff --git a/docs/google-docs/providers/google/iam/policies/index.md b/docs/google-docs/providers/google/iam/policies/index.md index 5c58a7331f..15288f2eae 100644 --- a/docs/google-docs/providers/google/iam/policies/index.md +++ b/docs/google-docs/providers/google/iam/policies/index.md @@ -24,9 +24,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png Idgoogle.iam.policies +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `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. | +| `annotations` | `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. | +| `etag` | `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. | +| `deleteTime` | `string` | Output only. The time when the `Policy` was deleted. Empty if the policy is not deleted. | +| `uid` | `string` | Immutable. The globally unique ID of the `Policy`. Assigned automatically when the `Policy` is created. | +| `rules` | `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`. | +| `displayName` | `string` | A user-specified description of the `Policy`. This value can be up to 63 characters. | +| `kind` | `string` | Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`. | +| `createTime` | `string` | Output only. The time when the `Policy` was created. | +| `updateTime` | `string` | Output only. The time when the `Policy` was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `policiesId, policiesId1, policiesId2` | Gets a policy. | +| `list_policies` | `SELECT` | `policiesId, policiesId1` | 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. | +| `create_policy` | `INSERT` | `policiesId, policiesId1` | Creates a policy. | | `delete` | `DELETE` | `policiesId, policiesId1, policiesId2` | Deletes a policy. This action is permanent. | +| `_list_policies` | `EXEC` | `policiesId, policiesId1` | 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. | | `update` | `EXEC` | `policiesId, policiesId1, policiesId2` | 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. | diff --git a/docs/google-docs/providers/google/iamcredentials/index.md b/docs/google-docs/providers/google/iamcredentials/index.md index 811c8fb2fb..b8d4d0e6f3 100644 --- a/docs/google-docs/providers/google/iamcredentials/index.md +++ b/docs/google-docs/providers/google/iamcredentials/index.md @@ -33,7 +33,7 @@ Creates Short-Lived Credentials For Impersonating IAM Service Accounts. To Enabl TypeService TitleIAM Service Account Credentials API DescriptionCreates Short-Lived Credentials For Impersonating IAM Service Accounts. To Enable This API, You Must Enable The IAM API (Iam.Googleapis.Com). -Idiamcredentials:v23.08.00155 +Idiamcredentials:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/iap/dest_groups/index.md b/docs/google-docs/providers/google/iap/dest_groups/index.md index 61623e82eb..9d47821aef 100644 --- a/docs/google-docs/providers/google/iap/dest_groups/index.md +++ b/docs/google-docs/providers/google/iap/dest_groups/index.md @@ -27,8 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `tunnelDestGroups` | `array` | TunnelDestGroup existing in the project. | -| `nextPageToken` | `string` | A token that you can send as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Required. Immutable. Identifier for the TunnelDestGroup. Must be unique within the project and contain only lower case letters (a-z) and dashes (-). | +| `fqdns` | `array` | Unordered list. List of FQDNs that this group applies to. | +| `cidrs` | `array` | Unordered list. List of CIDRs that this group applies to. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +37,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists the existing TunnelDestGroups. To group across all locations, use a `-` as the location ID. For example: `/v1/projects/123/iap_tunnel/locations/-/destGroups` | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new TunnelDestGroup. | | `delete` | `DELETE` | `destGroupsId, locationsId, projectsId` | Deletes a TunnelDestGroup. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists the existing TunnelDestGroups. To group across all locations, use a `-` as the location ID. For example: `/v1/projects/123/iap_tunnel/locations/-/destGroups` | | `patch` | `EXEC` | `destGroupsId, locationsId, projectsId` | Updates a TunnelDestGroup. | diff --git a/docs/google-docs/providers/google/iap/iap_iam_policies/index.md b/docs/google-docs/providers/google/iap/iap_iam_policies/index.md index b5b5f96bc7..37b0a22c1a 100644 --- a/docs/google-docs/providers/google/iap/iap_iam_policies/index.md +++ b/docs/google-docs/providers/google/iap/iap_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `v1Id` | Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api | +| `get_iam_policy` | `SELECT` | `v1Id` | Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api | | `set_iam_policy` | `EXEC` | `v1Id` | Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api | | `test_iam_permissions` | `EXEC` | `v1Id` | Returns permissions that a caller has on the Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api | diff --git a/docs/google-docs/providers/google/iap/identity_aware_proxy_clients/index.md b/docs/google-docs/providers/google/iap/identity_aware_proxy_clients/index.md index 35e66d7668..a7ed983466 100644 --- a/docs/google-docs/providers/google/iap/identity_aware_proxy_clients/index.md +++ b/docs/google-docs/providers/google/iap/identity_aware_proxy_clients/index.md @@ -37,4 +37,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `brandsId, projectsId` | Lists the existing clients for the brand. | | `create` | `INSERT` | `brandsId, projectsId` | Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned by IAP. Requires that the brand for the project exists and that it is set for internal-only use. | | `delete` | `DELETE` | `brandsId, identityAwareProxyClientsId, projectsId` | Deletes an Identity Aware Proxy (IAP) OAuth client. Useful for removing obsolete clients, managing the number of clients in a given project, and cleaning up after tests. Requires that the client is owned by IAP. | +| `_list` | `EXEC` | `brandsId, projectsId` | Lists the existing clients for the brand. | | `reset_secret` | `EXEC` | `brandsId, identityAwareProxyClientsId, projectsId` | Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the secret was compromised. Requires that the client is owned by IAP. | diff --git a/docs/google-docs/providers/google/iap/index.md b/docs/google-docs/providers/google/iap/index.md index 883fa30bdb..07bb8e728a 100644 --- a/docs/google-docs/providers/google/iap/index.md +++ b/docs/google-docs/providers/google/iap/index.md @@ -20,8 +20,8 @@ Controls Access To Cloud Applications Running On Google Cloud Platform.
total resources: 6
-total selectable resources: 4
-total methods: 19
+total selectable resources: 5
+total methods: 21
@@ -33,7 +33,7 @@ Controls Access To Cloud Applications Running On Google Cloud Platform. TypeService TitleCloud Identity-Aware Proxy API DescriptionControls Access To Cloud Applications Running On Google Cloud Platform. -Idiap:v23.08.00155 +Idiap:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/identitytoolkit/index.md b/docs/google-docs/providers/google/identitytoolkit/index.md index 2bbac780d5..2454c256ce 100644 --- a/docs/google-docs/providers/google/identitytoolkit/index.md +++ b/docs/google-docs/providers/google/identitytoolkit/index.md @@ -33,7 +33,7 @@ Help The Third Party Sites To Implement Federated Login. TypeService TitleGoogle Identity Toolkit API DescriptionHelp The Third Party Sites To Implement Federated Login. -Ididentitytoolkit:v23.08.00155 +Ididentitytoolkit:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/identitytoolkit/relyingparty_project_config/index.md b/docs/google-docs/providers/google/identitytoolkit/relyingparty_project_config/index.md index b903ace0c4..db6126a754 100644 --- a/docs/google-docs/providers/google/identitytoolkit/relyingparty_project_config/index.md +++ b/docs/google-docs/providers/google/identitytoolkit/relyingparty_project_config/index.md @@ -27,18 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `useEmailSending` | `boolean` | Whether to use email sending provided by Firebear. | -| `verifyEmailTemplate` | `object` | Template for an email template. | -| `legacyResetPasswordTemplate` | `object` | Template for an email template. | +| `allowPasswordUser` | `boolean` | Whether to allow password user sign in or sign up. | +| `changeEmailTemplate` | `object` | Template for an email template. | | `apiKey` | `string` | Browser API key, needed when making http request to Apiary. | -| `projectId` | `string` | Project ID of the relying party. | | `enableAnonymousUser` | `boolean` | Whether anonymous user is enabled. | | `idpConfig` | `array` | OAuth2 provider configuration. | -| `changeEmailTemplate` | `object` | Template for an email template. | -| `resetPasswordTemplate` | `object` | Template for an email template. | | `dynamicLinksDomain` | `string` | | -| `allowPasswordUser` | `boolean` | Whether to allow password user sign in or sign up. | +| `useEmailSending` | `boolean` | Whether to use email sending provided by Firebear. | | `authorizedDomains` | `array` | Authorized domains. | +| `projectId` | `string` | Project ID of the relying party. | +| `legacyResetPasswordTemplate` | `object` | Template for an email template. | +| `resetPasswordTemplate` | `object` | Template for an email template. | +| `verifyEmailTemplate` | `object` | Template for an email template. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/ids/endpoints/index.md b/docs/google-docs/providers/google/ids/endpoints/index.md index 7ac903f8aa..02f485b556 100644 --- a/docs/google-docs/providers/google/ids/endpoints/index.md +++ b/docs/google-docs/providers/google/ids/endpoints/index.md @@ -27,9 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `unreachable` | `array` | Locations that could not be reached. | -| `endpoints` | `array` | The list of endpoints response. | +| `name` | `string` | Output only. The name of the endpoint. | +| `description` | `string` | User-provided description of the endpoint | +| `trafficLogs` | `boolean` | Whether the endpoint should report traffic logs in addition to threat logs. | +| `threatExceptions` | `array` | List of threat IDs to be excepted from generating alerts. | +| `endpointForwardingRule` | `string` | Output only. The fully qualified URL of the endpoint's ILB Forwarding Rule. | +| `endpointIp` | `string` | Output only. The IP address of the IDS Endpoint's ILB. | +| `network` | `string` | Required. The fully qualified URL of the network to which the IDS Endpoint is attached. | +| `state` | `string` | Output only. Current state of the endpoint. | +| `updateTime` | `string` | Output only. The update time timestamp. | +| `labels` | `object` | The labels of the endpoint. | +| `createTime` | `string` | Output only. The create time timestamp. | +| `severity` | `string` | Required. Lowest threat severity that this endpoint will alert on. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +46,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists Endpoints in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new Endpoint in a given project and location. | | `delete` | `DELETE` | `endpointsId, locationsId, projectsId` | Deletes a single Endpoint. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Endpoints in a given project and location. | | `patch` | `EXEC` | `endpointsId, locationsId, projectsId` | Updates the parameters of a single Endpoint. | diff --git a/docs/google-docs/providers/google/ids/index.md b/docs/google-docs/providers/google/ids/index.md index f703bed629..8e80f2fbb3 100644 --- a/docs/google-docs/providers/google/ids/index.md +++ b/docs/google-docs/providers/google/ids/index.md @@ -21,7 +21,7 @@ Cloud IDS (Cloud Intrusion Detection System) Detects Malware, Spyware, Command-A
total resources: 4
total selectable resources: 4
-total methods: 14
+total methods: 17
@@ -33,7 +33,7 @@ Cloud IDS (Cloud Intrusion Detection System) Detects Malware, Spyware, Command-A TypeService TitleCloud IDS API DescriptionCloud IDS (Cloud Intrusion Detection System) Detects Malware, Spyware, Command-And-Control Attacks, And Other Network-Based Threats. Its Security Efficacy Is Industry Leading, Built With Palo Alto Networks Technologies. When You Use This Product, Your Organization Name And Consumption Levels Will Be Shared With Palo Alto Networks. -Idids:v23.08.00155 +Idids:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/ids/locations/index.md b/docs/google-docs/providers/google/ids/locations/index.md index 267e72281f..8376f6c4ff 100644 --- a/docs/google-docs/providers/google/ids/locations/index.md +++ b/docs/google-docs/providers/google/ids/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/ids/operations/index.md b/docs/google-docs/providers/google/ids/operations/index.md index 2a34c68104..88c479dff9 100644 --- a/docs/google-docs/providers/google/ids/operations/index.md +++ b/docs/google-docs/providers/google/ids/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | 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 6812112235..c1a960f6af 100644 --- a/docs/google-docs/providers/google/integrations/auth_configs/index.md +++ b/docs/google-docs/providers/google/integrations/auth_configs/index.md @@ -29,21 +29,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}. | | `description` | `string` | A description of the auth config. | -| `reason` | `string` | The reason / details of the current status. | -| `lastModifierEmail` | `string` | The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call. | +| `encryptedCredential` | `string` | Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. | +| `state` | `string` | The status of the auth config. | | `createTime` | `string` | Output only. The timestamp when the auth config is created. | -| `credentialType` | `string` | Credential type of the encrypted credential. | -| `certificateId` | `string` | Certificate id for client certificate | -| `expiryNotificationDuration` | `array` | User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. | -| `overrideValidTime` | `string` | User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings. | | `displayName` | `string` | Required. The name of the auth config. | +| `creatorEmail` | `string` | The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call. | +| `visibility` | `string` | The visibility of the auth config. | +| `expiryNotificationDuration` | `array` | User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. | +| `reason` | `string` | The reason / details of the current status. | | `decryptedCredential` | `object` | Defines parameters for a single, canonical credential. | +| `credentialType` | `string` | Credential type of the encrypted credential. | | `validTime` | `string` | The time until the auth config is valid. Empty or max value is considered the auth config won't expire. | -| `creatorEmail` | `string` | The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call. | -| `encryptedCredential` | `string` | Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. | -| `state` | `string` | The status of the auth config. | | `updateTime` | `string` | Output only. The timestamp when the auth config is modified. | -| `visibility` | `string` | The visibility of the auth config. | +| `lastModifierEmail` | `string` | The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call. | +| `overrideValidTime` | `string` | User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings. | +| `certificateId` | `string` | Certificate id for client certificate | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -55,5 +55,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_products_auth_configs_create` | `INSERT` | `locationsId, productsId, projectsId` | Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config. | | `projects_locations_auth_configs_delete` | `DELETE` | `authConfigsId, locationsId, projectsId` | Deletes an auth config. | | `projects_locations_products_auth_configs_delete` | `DELETE` | `authConfigsId, locationsId, productsId, projectsId` | Deletes an auth config. | +| `_projects_locations_auth_configs_list` | `EXEC` | `locationsId, projectsId` | Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only. | +| `_projects_locations_products_auth_configs_list` | `EXEC` | `locationsId, productsId, projectsId` | Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only. | | `projects_locations_auth_configs_patch` | `EXEC` | `authConfigsId, locationsId, projectsId` | Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config. | | `projects_locations_products_auth_configs_patch` | `EXEC` | `authConfigsId, locationsId, productsId, projectsId` | Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config. | diff --git a/docs/google-docs/providers/google/integrations/certificates/index.md b/docs/google-docs/providers/google/integrations/certificates/index.md index da008bf1a6..aa944ec702 100644 --- a/docs/google-docs/providers/google/integrations/certificates/index.md +++ b/docs/google-docs/providers/google/integrations/certificates/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Auto generated primary key | | `description` | `string` | Description of the certificate | -| `validStartTime` | `string` | Output only. The timestamp after which certificate will be valid | | `validEndTime` | `string` | Output only. The timestamp after which certificate will expire | +| `displayName` | `string` | Name of the certificate | +| `validStartTime` | `string` | Output only. The timestamp after which certificate will be valid | +| `requestorId` | `string` | Immutable. Requestor ID to be used to register certificate with trawler | | `credentialId` | `string` | Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY | | `rawCertificate` | `object` | Contains client certificate information | -| `displayName` | `string` | Required. Name of the certificate | -| `requestorId` | `string` | Immutable. Requestor ID to be used to register certificate with trawler | | `certificateStatus` | `string` | Status of the certificate | ## Methods | Name | Accessible by | Required Params | Description | @@ -44,4 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_products_certificates_list` | `SELECT` | `locationsId, productsId, projectsId` | List all the certificates that match the filter. Restrict to certificate of current client only. | | `projects_locations_products_certificates_create` | `INSERT` | `locationsId, productsId, projectsId` | Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate. | | `projects_locations_products_certificates_delete` | `DELETE` | `certificatesId, locationsId, productsId, projectsId` | Delete a certificate | +| `_projects_locations_products_certificates_list` | `EXEC` | `locationsId, productsId, projectsId` | List all the certificates that match the filter. Restrict to certificate of current client only. | | `projects_locations_products_certificates_patch` | `EXEC` | `certificatesId, locationsId, productsId, projectsId` | Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate. | diff --git a/docs/google-docs/providers/google/integrations/connections/index.md b/docs/google-docs/providers/google/integrations/connections/index.md index 181dcddf2f..517b6e369e 100644 --- a/docs/google-docs/providers/google/integrations/connections/index.md +++ b/docs/google-docs/providers/google/integrations/connections/index.md @@ -27,9 +27,34 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `connections` | `array` | Connections. | -| `nextPageToken` | `string` | Next page token. | +| `name` | `string` | Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} | +| `description` | `string` | Optional. Description of the resource. | +| `lockConfig` | `object` | Determines whether or no a connection is locked. If locked, a reason must be specified. | +| `envoyImageLocation` | `string` | Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} | +| `status` | `object` | ConnectionStatus indicates the state of the connection. | +| `connectorVersionLaunchStage` | `string` | Output only. Flag to mark the version indicating the launch stage. | +| `destinationConfigs` | `array` | Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s). | +| `serviceDirectory` | `string` | Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors" | +| `labels` | `object` | Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources | +| `configVariables` | `array` | Optional. Configuration for configuring the connection with an external system. | +| `connectorVersionInfraConfig` | `object` | This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version | +| `eventingEnablementType` | `string` | Optional. Eventing enablement type. Will be nil if eventing is not enabled. | +| `connectionRevision` | `string` | Output only. Connection revision. This field is only updated when the connection is created or updated by User. | +| `nodeConfig` | `object` | Node configuration for the connection. | +| `subscriptionType` | `string` | Output only. This subscription type enum states the subscription type of the project. | +| `logConfig` | `object` | Log configuration for the connection. | +| `suspended` | `boolean` | Optional. Suspended indicates if a user has suspended a connection or not. | +| `serviceAccount` | `string` | Optional. Service account needed for runtime plane to access GCP resources. | +| `sslConfig` | `object` | SSL Configuration of a connection | +| `connectorVersion` | `string` | Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource. | +| `authConfig` | `object` | AuthConfig defines details of a authentication type. | +| `eventingConfig` | `object` | Eventing Configuration of a connection | +| `imageLocation` | `string` | Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} | +| `eventingRuntimeData` | `object` | Eventing runtime data has the details related to eventing managed by the system. | +| `updateTime` | `string` | Output only. Updated time. | +| `createTime` | `string` | Output only. Created time. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_locations_connections_list` | `SELECT` | `locationsId, projectsId` | +| `_projects_locations_connections_list` | `EXEC` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/integrations/connections_connection_schema_metadata/index.md b/docs/google-docs/providers/google/integrations/connections_connection_schema_metadata/index.md index b8004c25bc..4c6dd8b417 100644 --- a/docs/google-docs/providers/google/integrations/connections_connection_schema_metadata/index.md +++ b/docs/google-docs/providers/google/integrations/connections_connection_schema_metadata/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `actions` | `array` | List of actions. | | `entities` | `array` | List of entity names. | +| `actions` | `array` | List of actions. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/integrations/executions/index.md b/docs/google-docs/providers/google/integrations/executions/index.md index 3adffd21d2..2b08094b1c 100644 --- a/docs/google-docs/providers/google/integrations/executions/index.md +++ b/docs/google-docs/providers/google/integrations/executions/index.md @@ -27,13 +27,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `executionInfos` | `array` | Required. The detailed information of requested executions. | -| `executions` | `array` | The detailed information of requested executions | -| `nextPageToken` | `string` | The token used to retrieve the next page results. | +| `name` | `string` | Auto-generated primary key. | +| `requestParameters` | `object` | Event parameters come in as part of the request. | +| `triggerId` | `string` | The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks. | +| `updateTime` | `string` | Output only. Last modified time of the execution. | +| `executionMethod` | `string` | The ways user posts this event. | +| `directSubExecutions` | `array` | Direct sub executions of the following Execution. | +| `requestParams` | `array` | Event parameters come in as part of the request. | +| `responseParams` | `array` | Event parameters come out as part of the response. | +| `eventExecutionDetails` | `object` | Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10 | +| `responseParameters` | `object` | Event parameters returned as part of the response. | +| `createTime` | `string` | Output only. Created time of the execution. | +| `executionDetails` | `object` | Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_integrations_executions_list` | `SELECT` | `integrationsId, locationsId, projectsId` | Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI. | | `projects_locations_products_integrations_executions_list` | `SELECT` | `integrationsId, locationsId, productsId, projectsId` | Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI. | +| `_projects_locations_integrations_executions_list` | `EXEC` | `integrationsId, locationsId, projectsId` | Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI. | +| `_projects_locations_products_integrations_executions_list` | `EXEC` | `integrationsId, locationsId, productsId, projectsId` | Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI. | | `projects_locations_products_integrations_executions_cancel` | `EXEC` | `executionsId, integrationsId, locationsId, productsId, projectsId` | Cancellation of an execution | | `projects_locations_products_integrations_executions_get` | `EXEC` | `executionsId, integrationsId, locationsId, productsId, projectsId` | Get an execution in the specified project. | diff --git a/docs/google-docs/providers/google/integrations/index.md b/docs/google-docs/providers/google/integrations/index.md index d333283ac2..d03e40521a 100644 --- a/docs/google-docs/providers/google/integrations/index.md +++ b/docs/google-docs/providers/google/integrations/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 15
total selectable resources: 12
-total methods: 85
+total methods: 104
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleApplication Integration API Description -Idintegrations:v23.08.00155 +Idintegrations:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/integrations/integrations/index.md b/docs/google-docs/providers/google/integrations/integrations/index.md index 1f5d346bd8..31cc9552da 100644 --- a/docs/google-docs/providers/google/integrations/integrations/index.md +++ b/docs/google-docs/providers/google/integrations/integrations/index.md @@ -27,8 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `integrations` | `array` | The integrations which match the request. | -| `nextPageToken` | `string` | The next page token for the response. | +| `name` | `string` | Required. The resource name of the integration. | +| `description` | `string` | Optional. | +| `updateTime` | `string` | Output only. Auto-generated. | +| `active` | `boolean` | Required. If any integration version is published. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +38,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_products_integrations_list` | `SELECT` | `locationsId, productsId, projectsId` | Returns the list of all integrations in the specified project. | | `projects_locations_integrations_delete` | `DELETE` | `integrationsId, locationsId, projectsId` | Delete the selected integration and all versions inside | | `projects_locations_products_integrations_delete` | `DELETE` | `integrationsId, locationsId, productsId, projectsId` | Delete the selected integration and all versions inside | +| `_projects_locations_integrations_list` | `EXEC` | `locationsId, projectsId` | Returns the list of all integrations in the specified project. | +| `_projects_locations_products_integrations_list` | `EXEC` | `locationsId, productsId, projectsId` | Returns the list of all integrations in the specified project. | | `projects_locations_integrations_execute` | `EXEC` | `integrationsId, locationsId, projectsId` | Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI. | | `projects_locations_integrations_schedule` | `EXEC` | `integrationsId, locationsId, projectsId` | Schedules an integration for execution by passing the trigger id and the scheduled time in the request body. | | `projects_locations_products_integrations_execute` | `EXEC` | `integrationsId, locationsId, productsId, projectsId` | Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI. | diff --git a/docs/google-docs/providers/google/integrations/runtime_action_schemas/index.md b/docs/google-docs/providers/google/integrations/runtime_action_schemas/index.md index 23e6d87c35..3e18470cc0 100644 --- a/docs/google-docs/providers/google/integrations/runtime_action_schemas/index.md +++ b/docs/google-docs/providers/google/integrations/runtime_action_schemas/index.md @@ -27,9 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Next page token. | -| `runtimeActionSchemas` | `array` | Runtime action schemas. | +| `action` | `string` | Name of the action. | +| `inputSchema` | `string` | Input parameter schema for the action. | +| `outputSchema` | `string` | Output parameter schema for the action. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_locations_connections_runtime_action_schemas_list` | `SELECT` | `connectionsId, locationsId, projectsId` | +| `_projects_locations_connections_runtime_action_schemas_list` | `EXEC` | `connectionsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/integrations/runtime_entity_schemas/index.md b/docs/google-docs/providers/google/integrations/runtime_entity_schemas/index.md index c3dd3a55f8..bc258f3f45 100644 --- a/docs/google-docs/providers/google/integrations/runtime_entity_schemas/index.md +++ b/docs/google-docs/providers/google/integrations/runtime_entity_schemas/index.md @@ -27,9 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Next page token. | -| `runtimeEntitySchemas` | `array` | Runtime entity schemas. | +| `fieldSchema` | `string` | List of fields in the entity. | +| `arrayFieldSchema` | `string` | The above schema, but for an array of the associated entity. | +| `entity` | `string` | Name of the entity. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_locations_connections_runtime_entity_schemas_list` | `SELECT` | `connectionsId, locationsId, projectsId` | +| `_projects_locations_connections_runtime_entity_schemas_list` | `EXEC` | `connectionsId, locationsId, projectsId` | 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 4377274f05..5b715e3d42 100644 --- a/docs/google-docs/providers/google/integrations/sfdc_channels/index.md +++ b/docs/google-docs/providers/google/integrations/sfdc_channels/index.md @@ -27,8 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The token used to retrieve the next page of results. | -| `sfdcChannels` | `array` | The list of SfdcChannels retrieved. | +| `name` | `string` | Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. | +| `description` | `string` | The description for this channel | +| `updateTime` | `string` | Output only. Time when the channel was last updated | +| `lastReplayId` | `string` | Last sfdc messsage replay id for channel | +| `createTime` | `string` | Output only. Time when the channel is created | +| `channelTopic` | `string` | The Channel topic defined by salesforce once an channel is opened | +| `deleteTime` | `string` | Output only. Time when the channel was deleted. Empty if not deleted. | +| `displayName` | `string` | Client level unique name/alias to easily reference a channel. | +| `isActive` | `boolean` | Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -40,5 +47,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_sfdc_instances_sfdc_channels_create` | `INSERT` | `locationsId, projectsId, sfdcInstancesId` | Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel. | | `projects_locations_products_sfdc_instances_sfdc_channels_delete` | `DELETE` | `locationsId, productsId, projectsId, sfdcChannelsId, sfdcInstancesId` | Deletes an sfdc channel. | | `projects_locations_sfdc_instances_sfdc_channels_delete` | `DELETE` | `locationsId, projectsId, sfdcChannelsId, sfdcInstancesId` | Deletes an sfdc channel. | +| `_projects_locations_products_sfdc_instances_sfdc_channels_list` | `EXEC` | `locationsId, productsId, projectsId, sfdcInstancesId` | Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only. | +| `_projects_locations_sfdc_instances_sfdc_channels_list` | `EXEC` | `locationsId, projectsId, sfdcInstancesId` | Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only. | | `projects_locations_products_sfdc_instances_sfdc_channels_patch` | `EXEC` | `locationsId, productsId, projectsId, sfdcChannelsId, sfdcInstancesId` | Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel. | | `projects_locations_sfdc_instances_sfdc_channels_patch` | `EXEC` | `locationsId, projectsId, sfdcChannelsId, sfdcInstancesId` | Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel. | 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 5916ed007c..611f7eae9e 100644 --- a/docs/google-docs/providers/google/integrations/sfdc_instances/index.md +++ b/docs/google-docs/providers/google/integrations/sfdc_instances/index.md @@ -27,8 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The token used to retrieve the next page of results. | -| `sfdcInstances` | `array` | The list of SfdcInstances retrieved. | +| `name` | `string` | Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. | +| `description` | `string` | A description of the sfdc instance. | +| `serviceAuthority` | `string` | URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig). | +| `authConfigId` | `array` | A list of AuthConfigs that can be tried to open the channel to SFDC | +| `displayName` | `string` | User selected unique name/alias to easily reference an instance. | +| `updateTime` | `string` | Output only. Time when the instance was last updated | +| `createTime` | `string` | Output only. Time when the instance is created | +| `deleteTime` | `string` | Output only. Time when the instance was deleted. Empty if not deleted. | +| `sfdcOrgId` | `string` | The SFDC Org Id. This is defined in salesforce. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -40,5 +47,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_sfdc_instances_create` | `INSERT` | `locationsId, projectsId` | Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance. | | `projects_locations_products_sfdc_instances_delete` | `DELETE` | `locationsId, productsId, projectsId, sfdcInstancesId` | Deletes an sfdc instance. | | `projects_locations_sfdc_instances_delete` | `DELETE` | `locationsId, projectsId, sfdcInstancesId` | Deletes an sfdc instance. | +| `_projects_locations_products_sfdc_instances_list` | `EXEC` | `locationsId, productsId, projectsId` | Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only. | +| `_projects_locations_sfdc_instances_list` | `EXEC` | `locationsId, projectsId` | Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only. | | `projects_locations_products_sfdc_instances_patch` | `EXEC` | `locationsId, productsId, projectsId, sfdcInstancesId` | Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance. | | `projects_locations_sfdc_instances_patch` | `EXEC` | `locationsId, projectsId, sfdcInstancesId` | Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance. | diff --git a/docs/google-docs/providers/google/integrations/suspensions/index.md b/docs/google-docs/providers/google/integrations/suspensions/index.md index 3e510e9f4e..50fa8845bd 100644 --- a/docs/google-docs/providers/google/integrations/suspensions/index.md +++ b/docs/google-docs/providers/google/integrations/suspensions/index.md @@ -27,13 +27,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results. | -| `suspensions` | `array` | The suspensions for the relevant execution which the caller has permissions to view and resolve. | +| `name` | `string` | Resource name for suspensions suspension/{suspension_id} | +| `audit` | `object` | Contains when and by whom the suspension was resolved. | +| `state` | `string` | Required. State of this suspension, indicating what action a resolver has taken. | +| `integration` | `string` | Required. The name of the originating integration. | +| `suspensionConfig` | `object` | | +| `createTime` | `string` | Output only. Auto-generated. | +| `approvalConfig` | `object` | Configurations for approving the Suspension. | +| `eventExecutionInfoId` | `string` | Required. ID of the associated execution. | +| `lastModifyTime` | `string` | Output only. Auto-generated. | +| `taskId` | `string` | Required. Task id of the associated SuspensionTask. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_integrations_executions_suspensions_list` | `SELECT` | `executionsId, integrationsId, locationsId, projectsId` | * Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them. | | `projects_locations_products_integrations_executions_suspensions_list` | `SELECT` | `executionsId, integrationsId, locationsId, productsId, projectsId` | * Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them. | +| `_projects_locations_integrations_executions_suspensions_list` | `EXEC` | `executionsId, integrationsId, locationsId, projectsId` | * Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them. | +| `_projects_locations_products_integrations_executions_suspensions_list` | `EXEC` | `executionsId, integrationsId, locationsId, productsId, projectsId` | * Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them. | | `projects_locations_integrations_executions_suspensions_lift` | `EXEC` | `executionsId, integrationsId, locationsId, projectsId, suspensionsId` | * Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task. | | `projects_locations_integrations_executions_suspensions_resolve` | `EXEC` | `executionsId, integrationsId, locationsId, projectsId, suspensionsId` | * Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again. | | `projects_locations_products_integrations_executions_suspensions_lift` | `EXEC` | `executionsId, integrationsId, locationsId, productsId, projectsId, suspensionsId` | * Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task. | diff --git a/docs/google-docs/providers/google/integrations/versions/index.md b/docs/google-docs/providers/google/integrations/versions/index.md index 447a5bc0b6..8c9ff83d4f 100644 --- a/docs/google-docs/providers/google/integrations/versions/index.md +++ b/docs/google-docs/providers/google/integrations/versions/index.md @@ -27,8 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `integrationTemplateVersions` | `array` | The IntegrationTemplateVersions which match the request. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Output only. Auto-generated primary key. Format: projects/{project}/locations/{location}/products/{product}/integrationtemplates/{integrationtemplate}/versions/{version} | +| `description` | `string` | Optional. The templateversion description. Permitted format is alphanumeric with underscores and no spaces. | +| `lastModifierEmail` | `string` | Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call. | +| `createTime` | `string` | Output only. Auto-generated. | +| `databasePersistencePolicy` | `string` | Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index. | +| `errorCatcherConfigs` | `array` | Optional. Error Catch Task configuration for the IntegrationTemplateVersion. It's optional. | +| `parentIntegrationVersionId` | `string` | Optional. ID of the IntegrationVersion that was used to create this IntegrationTemplateVersion | +| `triggerConfigs` | `array` | Optional. Trigger configurations. | +| `status` | `string` | Optional. Generated by eventbus. User should not set it as an input. | +| `templateParameters` | `object` | LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. | +| `snapshotNumber` | `string` | Output only. An increasing sequence that is set when a new snapshot is created. | +| `userLabel` | `string` | Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created. | +| `updateTime` | `string` | Output only. Auto-generated. | +| `taskConfigs` | `array` | Optional. Task configuration for the IntegrationTemplateVersion. It's optional, but the IntegrationTemplateVersion doesn't do anything without task_configs. | +| `teardown` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -43,6 +56,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_products_integrationtemplates_versions_create` | `INSERT` | `integrationtemplatesId, locationsId, productsId, projectsId` | Creates an IntegrationTemplateVersion. | | `projects_locations_integrations_versions_delete` | `DELETE` | `integrationsId, locationsId, projectsId, versionsId` | Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism. | | `projects_locations_products_integrations_versions_delete` | `DELETE` | `integrationsId, locationsId, productsId, projectsId, versionsId` | Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism. | +| `_projects_locations_integrations_versions_list` | `EXEC` | `integrationsId, locationsId, projectsId` | Returns the list of all integration versions in the specified project. | +| `_projects_locations_products_integrations_versions_list` | `EXEC` | `integrationsId, locationsId, productsId, projectsId` | Returns the list of all integration versions in the specified project. | +| `_projects_locations_products_integrationtemplates_versions_list` | `EXEC` | `integrationtemplatesId, locationsId, productsId, projectsId` | Returns the list of all IntegrationTemplateVersions in the specified project. | | `projects_locations_integrations_versions_download` | `EXEC` | `integrationsId, locationsId, projectsId, versionsId` | Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string. | | `projects_locations_integrations_versions_patch` | `EXEC` | `integrationsId, locationsId, projectsId, versionsId` | Update a integration with a draft version in the specified project. | | `projects_locations_integrations_versions_publish` | `EXEC` | `integrationsId, locationsId, projectsId, versionsId` | This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released. | diff --git a/docs/google-docs/providers/google/jobs/companies/index.md b/docs/google-docs/providers/google/jobs/companies/index.md index c346227b60..af45209435 100644 --- a/docs/google-docs/providers/google/jobs/companies/index.md +++ b/docs/google-docs/providers/google/jobs/companies/index.md @@ -27,9 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `companies` | `array` | Companies for the current client. | -| `metadata` | `object` | Additional information returned to client, such as debugging information. | -| `nextPageToken` | `string` | A token to retrieve the next page of results. | +| `name` | `string` | Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz". | +| `externalId` | `string` | Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255. | +| `eeoText` | `string` | Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500. | +| `suspended` | `boolean` | Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy. | +| `websiteUri` | `string` | The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255. | +| `careerSiteUri` | `string` | The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com". | +| `derivedInfo` | `object` | Derived details about the company. | +| `imageUri` | `string` | A URI that hosts the employer's company logo. | +| `size` | `string` | The employer's company size. | +| `keywordSearchableJobCustomAttributes` | `array` | This field is deprecated. Please set the searchability of the custom attribute in the Job.custom_attributes going forward. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword searches. Jobs with `string_values` under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes. | +| `headquartersAddress` | `string` | The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location. | +| `displayName` | `string` | Required. The display name of the company, for example, "Google LLC". | +| `hiringAgency` | `boolean` | Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +47,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId, tenantsId` | Lists all companies associated with the project. | | `create` | `INSERT` | `projectsId, tenantsId` | Creates a new company entity. | | `delete` | `DELETE` | `companiesId, projectsId, tenantsId` | Deletes specified company. Prerequisite: The company has no jobs associated with it. | +| `_list` | `EXEC` | `projectsId, tenantsId` | Lists all companies associated with the project. | | `patch` | `EXEC` | `companiesId, projectsId, tenantsId` | Updates specified company. | diff --git a/docs/google-docs/providers/google/jobs/index.md b/docs/google-docs/providers/google/jobs/index.md index c9d01dae03..0cdada28bd 100644 --- a/docs/google-docs/providers/google/jobs/index.md +++ b/docs/google-docs/providers/google/jobs/index.md @@ -21,7 +21,7 @@ Cloud Talent Solution Provides The Capability To Create, Read, Update, And Delet
total resources: 5
total selectable resources: 3
-total methods: 23
+total methods: 26
@@ -33,7 +33,7 @@ Cloud Talent Solution Provides The Capability To Create, Read, Update, And Delet TypeService TitleCloud Talent Solution API DescriptionCloud Talent Solution Provides The Capability To Create, Read, Update, And Delete Job Postings, As Well As Search Jobs Based On Keywords And Filters. -Idjobs:v23.08.00155 +Idjobs:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/jobs/jobs/index.md b/docs/google-docs/providers/google/jobs/jobs/index.md index afe285c843..4400673606 100644 --- a/docs/google-docs/providers/google/jobs/jobs/index.md +++ b/docs/google-docs/providers/google/jobs/jobs/index.md @@ -27,9 +27,36 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `jobs` | `array` | The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. | -| `metadata` | `object` | Additional information returned to client, such as debugging information. | -| `nextPageToken` | `string` | A token to retrieve the next page of results. | +| `name` | `string` | Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. | +| `description` | `string` | Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000. | +| `jobLevel` | `string` | The experience level associated with the job, such as "Entry Level". | +| `title` | `string` | Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. | +| `jobBenefits` | `array` | The benefits included with the job. | +| `requisitionId` | `string` | Required. The requisition ID, also referred to as the posting ID, is assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job isn't allowed to be created if there is another job with the same company, language_code and requisition_id. The maximum number of allowed characters is 255. | +| `qualifications` | `string` | A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. | +| `jobStartTime` | `string` | The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored. | +| `jobEndTime` | `string` | The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored. | +| `postingExpireTime` | `string` | Strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be listed by the ListJobs API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the DeleteJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company, language_code and requisition_id. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum number of open jobs over previous 7 days. If this threshold is exceeded, expired jobs are cleaned out in order of earliest expire time. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. If the timestamp is before the instant request is made, the job is treated as expired immediately on creation. This kind of job can not be updated. And when creating a job with past timestamp, the posting_publish_time must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as Application, to refer a job that didn't exist in the system prior to becoming expired. If you want to modify a job that was expired on creation, delete it and create a new one. If this value isn't provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value isn't provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include job_end_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. | +| `customAttributes` | `object` | A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: `a-zA-Z*`. For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. | +| `addresses` | `array` | Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. | +| `languageCode` | `string` | The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. | +| `postingPublishTime` | `string` | The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored. | +| `visibility` | `string` | Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. | +| `degreeTypes` | `array` | The desired education degrees for the job, such as Bachelors, Masters. | +| `employmentTypes` | `array` | The employment type(s) of a job, for example, full time or part time. | +| `incentives` | `string` | A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000. | +| `promotionValue` | `integer` | A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0. | +| `applicationInfo` | `object` | Application related details of a job posting. | +| `postingRegion` | `string` | The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match isn't specified. If this field is set to PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended. | +| `postingCreateTime` | `string` | Output only. The timestamp when this job posting was created. | +| `responsibilities` | `string` | A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. | +| `postingUpdateTime` | `string` | Output only. The timestamp when this job posting was last updated. | +| `department` | `string` | The department or functional area within the company with the open position. The maximum number of allowed characters is 255. | +| `companyDisplayName` | `string` | Output only. Display name of the company listing the job. | +| `processingOptions` | `object` | Options for job processing. | +| `company` | `string` | Required. The resource name of the company listing the job. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz". | +| `compensationInfo` | `object` | Job compensation details. | +| `derivedInfo` | `object` | Derived details about the job posting. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +64,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId, tenantsId` | Lists jobs by filter. | | `create` | `INSERT` | `projectsId, tenantsId` | Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes. | | `delete` | `DELETE` | `jobsId, projectsId, tenantsId` | Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes. | +| `_list` | `EXEC` | `projectsId, tenantsId` | Lists jobs by filter. | | `batch_create` | `EXEC` | `projectsId, tenantsId` | Begins executing a batch create jobs operation. | | `batch_delete` | `EXEC` | `projectsId, tenantsId` | Begins executing a batch delete jobs operation. | | `batch_update` | `EXEC` | `projectsId, tenantsId` | Begins executing a batch update jobs operation. | diff --git a/docs/google-docs/providers/google/jobs/tenants/index.md b/docs/google-docs/providers/google/jobs/tenants/index.md index 3e28bbde02..d022f92754 100644 --- a/docs/google-docs/providers/google/jobs/tenants/index.md +++ b/docs/google-docs/providers/google/jobs/tenants/index.md @@ -36,5 +36,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId` | Lists all tenants associated with the project. | | `create` | `INSERT` | `projectsId` | Creates a new tenant entity. | | `delete` | `DELETE` | `projectsId, tenantsId` | Deletes specified tenant. | +| `_list` | `EXEC` | `projectsId` | Lists all tenants associated with the project. | | `complete_query` | `EXEC` | `projectsId, tenantsId` | Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box. | | `patch` | `EXEC` | `projectsId, tenantsId` | Updates specified tenant. | diff --git a/docs/google-docs/providers/google/kmsinventory/crypto_keys/index.md b/docs/google-docs/providers/google/kmsinventory/crypto_keys/index.md index b42a8402a2..5629a1c01f 100644 --- a/docs/google-docs/providers/google/kmsinventory/crypto_keys/index.md +++ b/docs/google-docs/providers/google/kmsinventory/crypto_keys/index.md @@ -27,9 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `cryptoKeys` | `array` | The list of CryptoKeys. | -| `nextPageToken` | `string` | The page token returned from the previous response if the next page is desired. | +| `name` | `string` | Output only. The resource name for this CryptoKey in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. | +| `versionTemplate` | `object` | A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation. | +| `destroyScheduledDuration` | `string` | Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 24 hours. | +| `labels` | `object` | Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). | +| `nextRotationTime` | `string` | At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. | +| `createTime` | `string` | Output only. The time at which this CryptoKey was created. | +| `rotationPeriod` | `string` | next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. | +| `cryptoKeyBackend` | `string` | Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC, with the resource name in the format `projects/*/locations/*/ekmConnections/*`. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future. | +| `importOnly` | `boolean` | Immutable. Whether this key may contain imported versions only. | +| `primary` | `object` | A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS. | +| `purpose` | `string` | Immutable. The immutable purpose of this CryptoKey. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `projectsId` | +| `_list` | `EXEC` | `projectsId` | diff --git a/docs/google-docs/providers/google/kmsinventory/index.md b/docs/google-docs/providers/google/kmsinventory/index.md index a80e4b5343..19ecd6b0c4 100644 --- a/docs/google-docs/providers/google/kmsinventory/index.md +++ b/docs/google-docs/providers/google/kmsinventory/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 3
total selectable resources: 1
-total methods: 3
+total methods: 4
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleKMS Inventory API Description -Idkmsinventory:v23.08.00155 +Idkmsinventory:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/language/index.md b/docs/google-docs/providers/google/language/index.md index 5c351f18ed..6634455e10 100644 --- a/docs/google-docs/providers/google/language/index.md +++ b/docs/google-docs/providers/google/language/index.md @@ -33,7 +33,7 @@ Provides Natural Language Understanding Technologies, Such As Sentiment Analysis TypeService TitleCloud Natural Language API DescriptionProvides Natural Language Understanding Technologies, Such As Sentiment Analysis, Entity Recognition, Entity Sentiment Analysis, And Other Text Annotations, To Developers. -Idlanguage:v23.08.00155 +Idlanguage:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/libraryagent/books/index.md b/docs/google-docs/providers/google/libraryagent/books/index.md index b1238cad72..33da1c2a1c 100644 --- a/docs/google-docs/providers/google/libraryagent/books/index.md +++ b/docs/google-docs/providers/google/libraryagent/books/index.md @@ -28,13 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the book. Book names have the form `shelves/{shelf_id}/books/{book_id}`. The name is ignored when creating a book. | -| `title` | `string` | The title of the book. | | `author` | `string` | The name of the book author. | | `read` | `boolean` | Value indicating whether the book has been read. | +| `title` | `string` | The title of the book. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `booksId, shelvesId` | Gets a book. Returns NOT_FOUND if the book does not exist. | | `list` | `SELECT` | `shelvesId` | Lists books in a shelf. The order is unspecified but deterministic. Newly created books will not necessarily be added to the end of this list. Returns NOT_FOUND if the shelf does not exist. | +| `_list` | `EXEC` | `shelvesId` | Lists books in a shelf. The order is unspecified but deterministic. Newly created books will not necessarily be added to the end of this list. Returns NOT_FOUND if the shelf does not exist. | | `borrow` | `EXEC` | `booksId, shelvesId` | Borrow a book from the library. Returns the book if it is borrowed successfully. Returns NOT_FOUND if the book does not exist in the library. Returns quota exceeded error if the amount of books borrowed exceeds allocation quota in any dimensions. | | `return` | `EXEC` | `booksId, shelvesId` | Return a book to the library. Returns the book if it is returned to the library successfully. Returns error if the book does not belong to the library or the users didn't borrow before. | diff --git a/docs/google-docs/providers/google/libraryagent/index.md b/docs/google-docs/providers/google/libraryagent/index.md index 66d60321b0..b1025a0df5 100644 --- a/docs/google-docs/providers/google/libraryagent/index.md +++ b/docs/google-docs/providers/google/libraryagent/index.md @@ -21,7 +21,7 @@ A Simple Google Example Library API.
total resources: 2
total selectable resources: 2
-total methods: 6
+total methods: 8
@@ -33,7 +33,7 @@ A Simple Google Example Library API. TypeService TitleLibrary Agent API DescriptionA Simple Google Example Library API. -Idlibraryagent:v23.08.00155 +Idlibraryagent:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/libraryagent/shelves/index.md b/docs/google-docs/providers/google/libraryagent/shelves/index.md index f05e77c842..1077542adf 100644 --- a/docs/google-docs/providers/google/libraryagent/shelves/index.md +++ b/docs/google-docs/providers/google/libraryagent/shelves/index.md @@ -27,10 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to retrieve next page of results. Pass this value in the ListShelvesRequest.page_token field in the subsequent call to `ListShelves` method to retrieve the next page of results. | -| `shelves` | `array` | The list of shelves. | +| `name` | `string` | Output only. The resource name of the shelf. Shelf names have the form `shelves/{shelf_id}`. The name is ignored when creating a shelf. | +| `theme` | `string` | The theme of the shelf | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `shelvesId` | Gets a shelf. Returns NOT_FOUND if the shelf does not exist. | | `list` | `SELECT` | | Lists shelves. The order is unspecified but deterministic. Newly created shelves will not necessarily be added to the end of this list. | +| `_list` | `EXEC` | | Lists shelves. The order is unspecified but deterministic. Newly created shelves will not necessarily be added to the end of this list. | diff --git a/docs/google-docs/providers/google/lifesciences/index.md b/docs/google-docs/providers/google/lifesciences/index.md index 7419ea617d..74049c2969 100644 --- a/docs/google-docs/providers/google/lifesciences/index.md +++ b/docs/google-docs/providers/google/lifesciences/index.md @@ -21,7 +21,7 @@ Cloud Life Sciences Is A Suite Of Services And Tools For Managing, Processing, A
total resources: 3
total selectable resources: 2
-total methods: 6
+total methods: 8
@@ -33,7 +33,7 @@ Cloud Life Sciences Is A Suite Of Services And Tools For Managing, Processing, A TypeService TitleCloud Life Sciences API DescriptionCloud Life Sciences Is A Suite Of Services And Tools For Managing, Processing, And Transforming Life Sciences Data. -Idlifesciences:v23.08.00155 +Idlifesciences:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/lifesciences/locations/index.md b/docs/google-docs/providers/google/lifesciences/locations/index.md index 47fc445707..cda3317b05 100644 --- a/docs/google-docs/providers/google/lifesciences/locations/index.md +++ b/docs/google-docs/providers/google/lifesciences/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `locations` | `array` | A list of locations that matches the specified filter in the request. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/lifesciences/operations/index.md b/docs/google-docs/providers/google/lifesciences/operations/index.md index b07161d9a7..735064fc8f 100644 --- a/docs/google-docs/providers/google/lifesciences/operations/index.md +++ b/docs/google-docs/providers/google/lifesciences/operations/index.md @@ -27,11 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `string` | The server-assigned name for the operation. This may be passed to the other operation methods to retrieve information about the operation's status. | +| `metadata` | `object` | An Metadata object. This will always be returned with the Operation. | +| `response` | `object` | An Empty object. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `lifesciences.operations.get` | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `lifesciences.operations.list` | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `lifesciences.operations.list` | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `lifesciences.operations.cancel` | diff --git a/docs/google-docs/providers/google/logging/billing_accounts_settings/index.md b/docs/google-docs/providers/google/logging/billing_accounts_settings/index.md index 2933d4e6c3..940287765f 100644 --- a/docs/google-docs/providers/google/logging/billing_accounts_settings/index.md +++ b/docs/google-docs/providers/google/logging/billing_accounts_settings/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the settings. | +| `kmsServiceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Log Router will use to access your Cloud KMS key. Use GetSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | +| `loggingServiceAccountId` | `string` | Output only. The service account for the given container. Sinks use this service account as their writer_identity if no custom service account is provided. | | `storageLocation` | `string` | Optional. The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided. The use cases includes: The location of _Default and _Required log bucket for newly created projects and folders.Example value: europe-west1.Note: this setting does not affect the location of resources where a location is explicitly provided when created, such as custom log buckets. | | `disableDefaultSink` | `boolean` | Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log storage if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed. | | `kmsKeyName` | `string` | Optional. The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `kmsServiceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Log Router will use to access your Cloud KMS key. Use GetSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `loggingServiceAccountId` | `string` | Output only. The service account for the given container. Sinks use this service account as their writer_identity if no custom service account is provided. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/logging/buckets/index.md b/docs/google-docs/providers/google/logging/buckets/index.md index 05d4444c0b..7e25183779 100644 --- a/docs/google-docs/providers/google/logging/buckets/index.md +++ b/docs/google-docs/providers/google/logging/buckets/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `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. | | `description` | `string` | Describes this bucket. | -| `retentionDays` | `integer` | Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. | | `lifecycleState` | `string` | Output only. The bucket lifecycle state. | -| `updateTime` | `string` | Output only. The last update timestamp of the bucket. | | `cmekSettings` | `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. | -| `locked` | `boolean` | Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty. | -| `restrictedFields` | `array` | Log entry field paths that are denied access in this bucket.The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation.Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. foo.bar will block foo.bar.baz) | | `createTime` | `string` | Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. | +| `updateTime` | `string` | Output only. The last update timestamp of the bucket. | +| `retentionDays` | `integer` | Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. | +| `restrictedFields` | `array` | Log entry field paths that are denied access in this bucket.The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation.Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. foo.bar will block foo.bar.baz) | | `analyticsEnabled` | `boolean` | Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled. | | `indexConfigs` | `array` | A list of indexed fields and related configuration data. | +| `locked` | `boolean` | Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -58,6 +58,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `folders_locations_buckets_delete` | `DELETE` | `bucketsId, foldersId, locationsId` | Deletes a log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted. | | `organizations_locations_buckets_delete` | `DELETE` | `bucketsId, locationsId, organizationsId` | Deletes a log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted. | | `projects_locations_buckets_delete` | `DELETE` | `bucketsId, locationsId, projectsId` | Deletes a log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted. | +| `_billing_accounts_locations_buckets_list` | `EXEC` | `billingAccountsId, locationsId` | Lists log buckets. | +| `_folders_locations_buckets_list` | `EXEC` | `foldersId, locationsId` | Lists log buckets. | +| `_locations_buckets_list` | `EXEC` | `parent` | Lists log buckets. | +| `_organizations_locations_buckets_list` | `EXEC` | `locationsId, organizationsId` | Lists log buckets. | +| `_projects_locations_buckets_list` | `EXEC` | `locationsId, projectsId` | Lists log buckets. | | `billing_accounts_locations_buckets_patch` | `EXEC` | `billingAccountsId, bucketsId, locationsId` | Updates a log bucket.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. | | `billing_accounts_locations_buckets_undelete` | `EXEC` | `billingAccountsId, bucketsId, locationsId` | Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days. | | `folders_locations_buckets_patch` | `EXEC` | `bucketsId, foldersId, locationsId` | Updates a log bucket.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. | diff --git a/docs/google-docs/providers/google/logging/buckets_async/index.md b/docs/google-docs/providers/google/logging/buckets_async/index.md index 66c5358ac9..72b77bb4c6 100644 --- a/docs/google-docs/providers/google/logging/buckets_async/index.md +++ b/docs/google-docs/providers/google/logging/buckets_async/index.md @@ -36,5 +36,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_buckets_create_async` | `INSERT` | `locationsId, projectsId` | Creates a log bucket asynchronously that can be used to store log entries.After a bucket has been created, the bucket's location cannot be changed. | | `billing_accounts_locations_buckets_update_async` | `EXEC` | `billingAccountsId, bucketsId, locationsId` | Updates a log bucket asynchronously.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. | | `folders_locations_buckets_update_async` | `EXEC` | `bucketsId, foldersId, locationsId` | Updates a log bucket asynchronously.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. | +| `locations_buckets_update_async` | `EXEC` | `name` | Updates a log bucket asynchronously.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. | | `organizations_locations_buckets_update_async` | `EXEC` | `bucketsId, locationsId, organizationsId` | Updates a log bucket asynchronously.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. | | `projects_locations_buckets_update_async` | `EXEC` | `bucketsId, locationsId, projectsId` | Updates a log bucket asynchronously.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. | diff --git a/docs/google-docs/providers/google/logging/cmek_settings/index.md b/docs/google-docs/providers/google/logging/cmek_settings/index.md index 9a5f2190cb..0557fc04d9 100644 --- a/docs/google-docs/providers/google/logging/cmek_settings/index.md +++ b/docs/google-docs/providers/google/logging/cmek_settings/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the CMEK settings. | -| `serviceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | | `kmsKeyName` | `string` | The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | | `kmsKeyVersionName` | `string` | The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion. | +| `serviceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/logging/exclusions/index.md b/docs/google-docs/providers/google/logging/exclusions/index.md index 43282e8582..35467526aa 100644 --- a/docs/google-docs/providers/google/logging/exclusions/index.md +++ b/docs/google-docs/providers/google/logging/exclusions/index.md @@ -56,6 +56,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `folders_exclusions_delete` | `DELETE` | `exclusionsId, foldersId` | Deletes an exclusion in the _Default sink. | | `organizations_exclusions_delete` | `DELETE` | `exclusionsId, organizationsId` | Deletes an exclusion in the _Default sink. | | `projects_exclusions_delete` | `DELETE` | `exclusionsId, projectsId` | Deletes an exclusion in the _Default sink. | +| `_billing_accounts_exclusions_list` | `EXEC` | `billingAccountsId` | Lists all the exclusions on the _Default sink in a parent resource. | +| `_exclusions_list` | `EXEC` | `parent` | Lists all the exclusions on the _Default sink in a parent resource. | +| `_folders_exclusions_list` | `EXEC` | `foldersId` | Lists all the exclusions on the _Default sink in a parent resource. | +| `_organizations_exclusions_list` | `EXEC` | `organizationsId` | Lists all the exclusions on the _Default sink in a parent resource. | +| `_projects_exclusions_list` | `EXEC` | `projectsId` | Lists all the exclusions on the _Default sink in a parent resource. | | `billing_accounts_exclusions_patch` | `EXEC` | `billingAccountsId, exclusionsId` | Changes one or more properties of an existing exclusion in the _Default sink. | | `exclusions_patch` | `EXEC` | `name` | Changes one or more properties of an existing exclusion in the _Default sink. | | `folders_exclusions_patch` | `EXEC` | `exclusionsId, foldersId` | Changes one or more properties of an existing exclusion in the _Default sink. | diff --git a/docs/google-docs/providers/google/logging/index.md b/docs/google-docs/providers/google/logging/index.md index 6b08a99394..a1499b86bf 100644 --- a/docs/google-docs/providers/google/logging/index.md +++ b/docs/google-docs/providers/google/logging/index.md @@ -21,7 +21,7 @@ Writes Log Entries And Manages Your Cloud Logging Configuration.
total resources: 18
total selectable resources: 16
-total methods: 190
+total methods: 236
@@ -33,7 +33,7 @@ Writes Log Entries And Manages Your Cloud Logging Configuration. TypeService TitleCloud Logging API DescriptionWrites Log Entries And Manages Your Cloud Logging Configuration. -Idlogging:v23.08.00155 +Idlogging:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/logging/links/index.md b/docs/google-docs/providers/google/logging/links/index.md index 8cb8c88853..7d46c3f6f8 100644 --- a/docs/google-docs/providers/google/logging/links/index.md +++ b/docs/google-docs/providers/google/logging/links/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the link. The name can have up to 100 characters. A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example:`projects/my-project/locations/global/buckets/my-bucket/links/my_link | | `description` | `string` | Describes this link.The maximum length of the description is 8000 characters. | +| `lifecycleState` | `string` | Output only. The resource lifecycle state. | | `bigqueryDataset` | `object` | Describes a BigQuery dataset that was created by a link. | | `createTime` | `string` | Output only. The creation timestamp of the link. | -| `lifecycleState` | `string` | Output only. The resource lifecycle state. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -53,3 +53,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `folders_locations_buckets_links_delete` | `DELETE` | `bucketsId, foldersId, linksId, locationsId` | Deletes a link. This will also delete the corresponding BigQuery linked dataset. | | `organizations_locations_buckets_links_delete` | `DELETE` | `bucketsId, linksId, locationsId, organizationsId` | Deletes a link. This will also delete the corresponding BigQuery linked dataset. | | `projects_locations_buckets_links_delete` | `DELETE` | `bucketsId, linksId, locationsId, projectsId` | Deletes a link. This will also delete the corresponding BigQuery linked dataset. | +| `_billing_accounts_locations_buckets_links_list` | `EXEC` | `billingAccountsId, bucketsId, locationsId` | Lists links. | +| `_folders_locations_buckets_links_list` | `EXEC` | `bucketsId, foldersId, locationsId` | Lists links. | +| `_locations_buckets_links_list` | `EXEC` | `parent` | Lists links. | +| `_organizations_locations_buckets_links_list` | `EXEC` | `bucketsId, locationsId, organizationsId` | Lists links. | +| `_projects_locations_buckets_links_list` | `EXEC` | `bucketsId, locationsId, projectsId` | Lists links. | diff --git a/docs/google-docs/providers/google/logging/locations/index.md b/docs/google-docs/providers/google/logging/locations/index.md index 2e0fb9f257..671ff27a65 100644 --- a/docs/google-docs/providers/google/logging/locations/index.md +++ b/docs/google-docs/providers/google/logging/locations/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1" | +| `locationId` | `string` | The canonical id for this location. For example: "us-east1". | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +40,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `locations_list` | `SELECT` | `name` | Lists information about the supported locations for this service. | | `organizations_locations_list` | `SELECT` | `organizationsId` | Lists information about the supported locations for this service. | | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_billing_accounts_locations_list` | `EXEC` | `billingAccountsId` | Lists information about the supported locations for this service. | +| `_folders_locations_list` | `EXEC` | `foldersId` | Lists information about the supported locations for this service. | +| `_locations_list` | `EXEC` | `name` | Lists information about the supported locations for this service. | +| `_organizations_locations_list` | `EXEC` | `organizationsId` | Lists information about the supported locations for this service. | +| `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `billing_accounts_locations_get` | `EXEC` | `billingAccountsId, locationsId` | Gets information about a location. | | `folders_locations_get` | `EXEC` | `foldersId, locationsId` | Gets information about a location. | | `organizations_locations_get` | `EXEC` | `locationsId, organizationsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/logging/logging_cmek_settings/index.md b/docs/google-docs/providers/google/logging/logging_cmek_settings/index.md index 4f6142d2f1..21ac04b121 100644 --- a/docs/google-docs/providers/google/logging/logging_cmek_settings/index.md +++ b/docs/google-docs/providers/google/logging/logging_cmek_settings/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the CMEK settings. | +| `serviceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | | `kmsKeyName` | `string` | The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | | `kmsKeyVersionName` | `string` | The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion. | -| `serviceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/logging/logs/index.md b/docs/google-docs/providers/google/logging/logs/index.md index 57926cec75..d40b3e2d66 100644 --- a/docs/google-docs/providers/google/logging/logs/index.md +++ b/docs/google-docs/providers/google/logging/logs/index.md @@ -25,10 +25,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken. | -| `logNames` | `array` | A list of log names. For example, "projects/my-project/logs/syslog" or "organizations/123/logs/cloudresourcemanager.googleapis.com%2Factivity". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -46,3 +42,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `logs_delete` | `DELETE` | `logName` | Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. | | `organizations_logs_delete` | `DELETE` | `logsId, organizationsId` | Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. | | `projects_logs_delete` | `DELETE` | `logsId, projectsId` | Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. | +| `_billing_accounts_locations_buckets_views_logs_list` | `EXEC` | `billingAccountsId, bucketsId, locationsId, viewsId` | Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. | +| `_billing_accounts_logs_list` | `EXEC` | `billingAccountsId` | Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. | +| `_folders_locations_buckets_views_logs_list` | `EXEC` | `bucketsId, foldersId, locationsId, viewsId` | Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. | +| `_folders_logs_list` | `EXEC` | `foldersId` | Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. | +| `_logs_list` | `EXEC` | `parent` | Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. | +| `_organizations_locations_buckets_views_logs_list` | `EXEC` | `bucketsId, locationsId, organizationsId, viewsId` | Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. | +| `_organizations_logs_list` | `EXEC` | `organizationsId` | Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. | +| `_projects_locations_buckets_views_logs_list` | `EXEC` | `bucketsId, locationsId, projectsId, viewsId` | Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. | +| `_projects_logs_list` | `EXEC` | `projectsId` | Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. | diff --git a/docs/google-docs/providers/google/logging/metrics/index.md b/docs/google-docs/providers/google/logging/metrics/index.md index 327e0dbd93..936f0f83ae 100644 --- a/docs/google-docs/providers/google/logging/metrics/index.md +++ b/docs/google-docs/providers/google/logging/metrics/index.md @@ -27,13 +27,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `metrics` | `array` | A list of logs-based metrics. | -| `nextPageToken` | `string` | If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken. | +| `name` | `string` | Required. The client-assigned metric identifier. Examples: "error_count", "nginx/requests".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.This field is the [METRIC_ID] part of a metric resource name in the format "projects/PROJECT_ID/metrics/METRIC_ID". Example: If the resource name of a metric is "projects/my-project/metrics/nginx%2Frequests", this field's value is "nginx/requests". | +| `description` | `string` | Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters. | +| `bucketOptions` | `object` | BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. | +| `bucketName` | `string` | Optional. The resource name of the Log Bucket that owns the Log Metric. Only Log Buckets in projects are supported. The bucket has to be in the same project as the metric.For example:projects/my-project/locations/global/buckets/my-bucketIf empty, then the Log Metric is considered a non-Bucket Log Metric. | +| `updateTime` | `string` | Output only. The last update timestamp of the metric.This field may not be present for older metrics. | +| `labelExtractors` | `object` | Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project. | +| `valueExtractor` | `string` | Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The arguments are: field: The name of the log entry field from which the value is to be extracted. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, ".*quantity=(\d+).*") | +| `disabled` | `boolean` | Optional. If set to True, then this metric is disabled and it does not generate any points. | +| `createTime` | `string` | Output only. The creation timestamp of the metric.This field may not be present for older metrics. | +| `version` | `string` | Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed. | +| `filter` | `string` | Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced_filters) which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters. | +| `metricDescriptor` | `object` | Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_metrics_list` | `SELECT` | `projectsId` | Lists logs-based metrics. | | `projects_metrics_create` | `INSERT` | `projectsId` | Creates a logs-based metric. | | `projects_metrics_delete` | `DELETE` | `metricsId, projectsId` | Deletes a logs-based metric. | +| `_projects_metrics_list` | `EXEC` | `projectsId` | Lists logs-based metrics. | | `projects_metrics_get` | `EXEC` | `metricsId, projectsId` | Gets a logs-based metric. | | `projects_metrics_update` | `EXEC` | `metricsId, projectsId` | Creates or updates a logs-based metric. | diff --git a/docs/google-docs/providers/google/logging/monitored_resource_descriptors/index.md b/docs/google-docs/providers/google/logging/monitored_resource_descriptors/index.md index 6970d6f5f8..741ee72caa 100644 --- a/docs/google-docs/providers/google/logging/monitored_resource_descriptors/index.md +++ b/docs/google-docs/providers/google/logging/monitored_resource_descriptors/index.md @@ -27,9 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `resourceDescriptors` | `array` | A list of resource descriptors. | -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken. | +| `name` | `string` | Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". | +| `description` | `string` | Optional. A detailed description of the monitored resource type that might be used in documentation. | +| `type` | `string` | Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list). | +| `displayName` | `string` | Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database". | +| `labels` | `array` | Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone". | +| `launchStage` | `string` | Optional. The launch stage of the monitored resource definition. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `monitored_resource_descriptors_list` | `SELECT` | | +| `_monitored_resource_descriptors_list` | `EXEC` | | diff --git a/docs/google-docs/providers/google/logging/operations/index.md b/docs/google-docs/providers/google/logging/operations/index.md index a95d71de67..6c4d51f0b6 100644 --- a/docs/google-docs/providers/google/logging/operations/index.md +++ b/docs/google-docs/providers/google/logging/operations/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}. | +| `response` | `object` | The normal response of the operation in case of success. 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. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,11 +40,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `locations_operations_list` | `SELECT` | `name` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `organizations_locations_operations_list` | `SELECT` | `locationsId, organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | +| `_billing_accounts_locations_operations_list` | `EXEC` | `billingAccountsId, locationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | +| `_folders_locations_operations_list` | `EXEC` | `foldersId, locationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | +| `_locations_operations_list` | `EXEC` | `name` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | +| `_organizations_locations_operations_list` | `EXEC` | `locationsId, organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | +| `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `billing_accounts_locations_operations_cancel` | `EXEC` | `billingAccountsId, locationsId, operationsId` | 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. | | `billing_accounts_locations_operations_get` | `EXEC` | `billingAccountsId, locationsId, operationsId` | 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. | | `folders_locations_operations_cancel` | `EXEC` | `foldersId, locationsId, operationsId` | 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. | | `folders_locations_operations_get` | `EXEC` | `foldersId, locationsId, operationsId` | 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. | -| `locations_operations_cancel` | `EXEC` | `name` | 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. | | `organizations_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, organizationsId` | 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. | | `organizations_locations_operations_get` | `EXEC` | `locationsId, operationsId, organizationsId` | 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. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/logging/settings/index.md b/docs/google-docs/providers/google/logging/settings/index.md index 2506417701..db45035297 100644 --- a/docs/google-docs/providers/google/logging/settings/index.md +++ b/docs/google-docs/providers/google/logging/settings/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the settings. | +| `kmsServiceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Log Router will use to access your Cloud KMS key. Use GetSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | +| `loggingServiceAccountId` | `string` | Output only. The service account for the given container. Sinks use this service account as their writer_identity if no custom service account is provided. | | `storageLocation` | `string` | Optional. The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided. The use cases includes: The location of _Default and _Required log bucket for newly created projects and folders.Example value: europe-west1.Note: this setting does not affect the location of resources where a location is explicitly provided when created, such as custom log buckets. | | `disableDefaultSink` | `boolean` | Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log storage if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed. | | `kmsKeyName` | `string` | Optional. The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `kmsServiceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Log Router will use to access your Cloud KMS key. Use GetSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `loggingServiceAccountId` | `string` | Output only. The service account for the given container. Sinks use this service account as their writer_identity if no custom service account is provided. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/logging/sinks/index.md b/docs/google-docs/providers/google/logging/sinks/index.md index 703181b734..f558c1fdab 100644 --- a/docs/google-docs/providers/google/logging/sinks/index.md +++ b/docs/google-docs/providers/google/logging/sinks/index.md @@ -27,8 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken. | -| `sinks` | `array` | A list of sinks. | +| `name` | `string` | Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. | +| `description` | `string` | Optional. A description of this sink.The maximum length of the description is 8000 characters. | +| `includeChildren` | `boolean` | Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then log entries from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression.For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent.To only export entries from certain child projects, filter on the project part of the log name:logName:("projects/test-project1/" OR "projects/test-project2/") AND resource.type=gce_instance | +| `outputVersionFormat` | `string` | Deprecated. This field is unused. | +| `writerIdentity` | `string` | Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. | +| `updateTime` | `string` | Output only. The last update timestamp of the sink.This field may not be present for older sinks. | +| `disabled` | `boolean` | Optional. If set to true, then this sink is disabled and it does not export any log entries. | +| `createTime` | `string` | Output only. The creation timestamp of the sink.This field may not be present for older sinks. | +| `exclusions` | `array` | Optional. Log entries that match any of these exclusion filters will not be exported.If a log entry is matched by both filter and one of exclusion_filters it will not be exported. | +| `filter` | `string` | Optional. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries). The only exported log entries are those that are in the resource owning the sink and that match the filter.For example:logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR | +| `destination` | `string` | Required. The export destination: "storage.googleapis.com/[GCS_BUCKET]" "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" "logging.googleapis.com/projects/[PROJECT_ID]" "logging.googleapis.com/projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks (https://cloud.google.com/logging/docs/api/tasks/exporting-logs). | +| `bigqueryOptions` | `object` | Options that change functionality of a sink exporting data to BigQuery. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -52,6 +62,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_sinks_delete` | `DELETE` | `organizationsId, sinksId` | Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted. | | `projects_sinks_delete` | `DELETE` | `projectsId, sinksId` | Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted. | | `sinks_delete` | `DELETE` | `sinkName` | Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted. | +| `_billing_accounts_sinks_list` | `EXEC` | `billingAccountsId` | Lists sinks. | +| `_folders_sinks_list` | `EXEC` | `foldersId` | Lists sinks. | +| `_organizations_sinks_list` | `EXEC` | `organizationsId` | Lists sinks. | +| `_projects_sinks_list` | `EXEC` | `projectsId` | Lists sinks. | +| `_sinks_list` | `EXEC` | `parent` | Lists sinks. | | `billing_accounts_sinks_patch` | `EXEC` | `billingAccountsId, sinksId` | Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field. | | `billing_accounts_sinks_update` | `EXEC` | `billingAccountsId, sinksId` | Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field. | | `folders_sinks_patch` | `EXEC` | `foldersId, sinksId` | Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.The updated sink might also have a new writer_identity; see the unique_writer_identity field. | diff --git a/docs/google-docs/providers/google/logging/views/index.md b/docs/google-docs/providers/google/logging/views/index.md index 04329a4237..4a8afa438e 100644 --- a/docs/google-docs/providers/google/logging/views/index.md +++ b/docs/google-docs/providers/google/logging/views/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken. | -| `views` | `array` | A list of views. | +| `name` | `string` | The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view | +| `description` | `string` | Describes this view. | +| `updateTime` | `string` | Output only. The last update timestamp of the view. | +| `createTime` | `string` | Output only. The creation timestamp of the view. | +| `filter` | `string` | Filter that restricts which log entries in a bucket are visible in this view.Filters are restricted to be a logical AND of ==/!= of any of the following: originating project/folder/organization/billing account. resource type log idFor example:SOURCE("projects/myproject") AND resource.type = "gce_instance" AND LOG_ID("stdout") | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -50,6 +53,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `folders_locations_buckets_views_delete` | `DELETE` | `bucketsId, foldersId, locationsId, viewsId` | Deletes a view on a log bucket. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes. | | `organizations_locations_buckets_views_delete` | `DELETE` | `bucketsId, locationsId, organizationsId, viewsId` | Deletes a view on a log bucket. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes. | | `projects_locations_buckets_views_delete` | `DELETE` | `bucketsId, locationsId, projectsId, viewsId` | Deletes a view on a log bucket. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes. | +| `_billing_accounts_locations_buckets_views_list` | `EXEC` | `billingAccountsId, bucketsId, locationsId` | Lists views on a log bucket. | +| `_folders_locations_buckets_views_list` | `EXEC` | `bucketsId, foldersId, locationsId` | Lists views on a log bucket. | +| `_locations_buckets_views_list` | `EXEC` | `parent` | Lists views on a log bucket. | +| `_organizations_locations_buckets_views_list` | `EXEC` | `bucketsId, locationsId, organizationsId` | Lists views on a log bucket. | +| `_projects_locations_buckets_views_list` | `EXEC` | `bucketsId, locationsId, projectsId` | Lists views on a log bucket. | | `billing_accounts_locations_buckets_views_patch` | `EXEC` | `billingAccountsId, bucketsId, locationsId, viewsId` | Updates a view on a log bucket. This method replaces the following fields in the existing view with values from the new view: filter. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes. | | `folders_locations_buckets_views_patch` | `EXEC` | `bucketsId, foldersId, locationsId, viewsId` | Updates a view on a log bucket. This method replaces the following fields in the existing view with values from the new view: filter. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes. | | `organizations_locations_buckets_views_patch` | `EXEC` | `bucketsId, locationsId, organizationsId, viewsId` | Updates a view on a log bucket. This method replaces the following fields in the existing view with values from the new view: filter. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes. | diff --git a/docs/google-docs/providers/google/managedidentities/backups/index.md b/docs/google-docs/providers/google/managedidentities/backups/index.md index 1fec612721..6ec8e26e98 100644 --- a/docs/google-docs/providers/google/managedidentities/backups/index.md +++ b/docs/google-docs/providers/google/managedidentities/backups/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `backups` | `array` | A list of Cloud AD backups in the domain. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | Output only. The unique name of the Backup in the form of `projects/{project_id}/locations/global/domains/{domain_name}/backups/{name}` | +| `statusMessage` | `string` | Output only. Additional information about the current status of this backup, if available. | +| `type` | `string` | Output only. Indicates whether it’s an on-demand backup or scheduled. | +| `updateTime` | `string` | Output only. Last update time. | +| `createTime` | `string` | Output only. The time the backups was created. | +| `labels` | `object` | Optional. Resource labels to represent user provided metadata. | +| `state` | `string` | Output only. The current state of the backup. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +41,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `domainsId, projectsId` | Lists Backup in a given project. | | `create` | `INSERT` | `domainsId, projectsId` | Creates a Backup for a domain. | | `delete` | `DELETE` | `backupsId, domainsId, projectsId` | Deletes identified Backup. | +| `_list` | `EXEC` | `domainsId, projectsId` | Lists Backup in a given project. | | `patch` | `EXEC` | `backupsId, domainsId, projectsId` | Updates the labels for specified Backup. | diff --git a/docs/google-docs/providers/google/managedidentities/backups_iam_policies/index.md b/docs/google-docs/providers/google/managedidentities/backups_iam_policies/index.md index d9321c60bf..8674016637 100644 --- a/docs/google-docs/providers/google/managedidentities/backups_iam_policies/index.md +++ b/docs/google-docs/providers/google/managedidentities/backups_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/managedidentities/domains/index.md b/docs/google-docs/providers/google/managedidentities/domains/index.md index dedb6a2a94..5b1cbc8660 100644 --- a/docs/google-docs/providers/google/managedidentities/domains/index.md +++ b/docs/google-docs/providers/google/managedidentities/domains/index.md @@ -27,9 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `domains` | `array` | A list of Managed Identities Service domains in the project. | -| `nextPageToken` | `string` | A token to retrieve the next page of results, or empty if there are no more results in the list. | -| `unreachable` | `array` | A list of locations that could not be reached. | +| `name` | `string` | Required. The unique name of the domain using the form: `projects/{project_id}/locations/global/domains/{domain_name}`. | +| `createTime` | `string` | Output only. The time the instance was created. | +| `fqdn` | `string` | Output only. The fully-qualified domain name of the exposed domain used by clients to connect to the service. Similar to what would be chosen for an Active Directory set up on an internal network. | +| `state` | `string` | Output only. The current state of this domain. | +| `admin` | `string` | Optional. The name of delegated administrator account used to perform Active Directory operations. If not specified, `setupadmin` will be used. | +| `locations` | `array` | Required. Locations where domain needs to be provisioned. regions e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block. | +| `statusMessage` | `string` | Output only. Additional information about the current status of this domain, if available. | +| `reservedIpRange` | `string` | Required. The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger. Ranges must be unique and non-overlapping with existing subnets in [Domain].[authorized_networks]. | +| `auditLogsEnabled` | `boolean` | Optional. Configuration for audit logs. True if audit logs are enabled, else false. Default is audit logs disabled. | +| `trusts` | `array` | Output only. The current trusts associated with the domain. | +| `updateTime` | `string` | Output only. The last update time. | +| `authorizedNetworks` | `array` | Optional. The full names of the Google Compute Engine [networks](/compute/docs/networks-and-firewalls#networks) the domain instance is connected to. Networks can be added using UpdateDomain. The domain is only available on networks listed in `authorized_networks`. If CIDR subnets overlap between networks, domain creation will fail. | +| `labels` | `object` | Optional. Resource labels that can contain user-provided metadata. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +47,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId` | Lists domains in a project. | | `create` | `INSERT` | `projectsId` | Creates a Microsoft AD domain. | | `delete` | `DELETE` | `domainsId, projectsId` | Deletes a domain. | +| `_list` | `EXEC` | `projectsId` | Lists domains in a project. | | `attach_trust` | `EXEC` | `domainsId, projectsId` | Adds an AD trust to a domain. | | `check_migration_permission` | `EXEC` | `domainsId, projectsId` | CheckMigrationPermission API gets the current state of DomainMigration | | `detach_trust` | `EXEC` | `domainsId, projectsId` | Removes an AD trust. | diff --git a/docs/google-docs/providers/google/managedidentities/domains_iam_policies/index.md b/docs/google-docs/providers/google/managedidentities/domains_iam_policies/index.md index c2622dc101..bacc052c66 100644 --- a/docs/google-docs/providers/google/managedidentities/domains_iam_policies/index.md +++ b/docs/google-docs/providers/google/managedidentities/domains_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/managedidentities/domains_ldapssettings/index.md b/docs/google-docs/providers/google/managedidentities/domains_ldapssettings/index.md index f89bc5d1f5..b7659f29eb 100644 --- a/docs/google-docs/providers/google/managedidentities/domains_ldapssettings/index.md +++ b/docs/google-docs/providers/google/managedidentities/domains_ldapssettings/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the LDAPS settings. Uses the form: `projects/{project}/locations/{location}/domains/{domain}`. | -| `certificatePfx` | `string` | Input only. The uploaded PKCS12-formatted certificate to configure LDAPS with. It will enable the domain controllers in this domain to accept LDAPS connections (either LDAP over SSL/TLS or the StartTLS operation). A valid certificate chain must form a valid x.509 certificate chain (or be comprised of a single self-signed certificate. It must be encrypted with either: 1) PBES2 + PBKDF2 + AES256 encryption and SHA256 PRF; or 2) pbeWithSHA1And3-KeyTripleDES-CBC Private key must be included for the leaf / single self-signed certificate. Note: For a fqdn your-example-domain.com, the wildcard fqdn is *.your-example-domain.com. Specifically the leaf certificate must have: - Either a blank subject or a subject with CN matching the wildcard fqdn. - Exactly two SANs - the fqdn and wildcard fqdn. - Encipherment and digital key signature key usages. - Server authentication extended key usage (OID=1.3.6.1.5.5.7.3.1) - Private key must be in one of the following formats: RSA, ECDSA, ED25519. - Private key must have appropriate key length: 2048 for RSA, 256 for ECDSA - Signature algorithm of the leaf certificate cannot be MD2, MD5 or SHA1. | | `state` | `string` | Output only. The current state of this LDAPS settings. | | `updateTime` | `string` | Output only. Last update time. | | `certificate` | `object` | Certificate used to configure LDAPS. | | `certificatePassword` | `string` | Input only. The password used to encrypt the uploaded PFX certificate. | +| `certificatePfx` | `string` | Input only. The uploaded PKCS12-formatted certificate to configure LDAPS with. It will enable the domain controllers in this domain to accept LDAPS connections (either LDAP over SSL/TLS or the StartTLS operation). A valid certificate chain must form a valid x.509 certificate chain (or be comprised of a single self-signed certificate. It must be encrypted with either: 1) PBES2 + PBKDF2 + AES256 encryption and SHA256 PRF; or 2) pbeWithSHA1And3-KeyTripleDES-CBC Private key must be included for the leaf / single self-signed certificate. Note: For a fqdn your-example-domain.com, the wildcard fqdn is *.your-example-domain.com. Specifically the leaf certificate must have: - Either a blank subject or a subject with CN matching the wildcard fqdn. - Exactly two SANs - the fqdn and wildcard fqdn. - Encipherment and digital key signature key usages. - Server authentication extended key usage (OID=1.3.6.1.5.5.7.3.1) - Private key must be in one of the following formats: RSA, ECDSA, ED25519. - Private key must have appropriate key length: 2048 for RSA, 256 for ECDSA - Signature algorithm of the leaf certificate cannot be MD2, MD5 or SHA1. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/managedidentities/index.md b/docs/google-docs/providers/google/managedidentities/index.md index e38917c96a..54537d6d6b 100644 --- a/docs/google-docs/providers/google/managedidentities/index.md +++ b/docs/google-docs/providers/google/managedidentities/index.md @@ -21,7 +21,7 @@ The Managed Service For Microsoft Active Directory API Is Used For Managing A Hi
total resources: 10
total selectable resources: 10
-total methods: 45
+total methods: 51
@@ -33,7 +33,7 @@ The Managed Service For Microsoft Active Directory API Is Used For Managing A Hi TypeService TitleManaged Service For Microsoft Active Directory API DescriptionThe Managed Service For Microsoft Active Directory API Is Used For Managing A Highly Available, Hardened Service Running Microsoft Active Directory (AD). -Idmanagedidentities:v23.08.00155 +Idmanagedidentities:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/managedidentities/locations/index.md b/docs/google-docs/providers/google/managedidentities/locations/index.md index f85c38cb8f..60dfeff922 100644 --- a/docs/google-docs/providers/google/managedidentities/locations/index.md +++ b/docs/google-docs/providers/google/managedidentities/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `locations` | `array` | A list of locations that matches the specified filter in the request. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/managedidentities/operations/index.md b/docs/google-docs/providers/google/managedidentities/operations/index.md index 76ac895952..6c556d3dc6 100644 --- a/docs/google-docs/providers/google/managedidentities/operations/index.md +++ b/docs/google-docs/providers/google/managedidentities/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operationsId, projectsId` | 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. | | `list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/managedidentities/peerings/index.md b/docs/google-docs/providers/google/managedidentities/peerings/index.md index 85baeb48aa..be63ab3fba 100644 --- a/docs/google-docs/providers/google/managedidentities/peerings/index.md +++ b/docs/google-docs/providers/google/managedidentities/peerings/index.md @@ -27,9 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `peerings` | `array` | A list of Managed Identities Service Peerings in the project. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | Output only. Unique name of the peering in this scope including projects and location using the form: `projects/{project_id}/locations/global/peerings/{peering_id}`. | +| `domainResource` | `string` | Required. Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form: `projects/{project_id}/locations/global/domains/{domain_name}` | +| `labels` | `object` | Optional. Resource labels to represent user-provided metadata. | +| `state` | `string` | Output only. The current state of this Peering. | +| `statusMessage` | `string` | Output only. Additional information about the current status of this peering, if available. | +| `updateTime` | `string` | Output only. Last update time. | +| `authorizedNetwork` | `string` | Required. The full names of the Google Compute Engine [networks](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail. | +| `createTime` | `string` | Output only. The time the instance was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +42,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId` | Lists Peerings in a given project. | | `create` | `INSERT` | `projectsId` | Creates a Peering for Managed AD instance. | | `delete` | `DELETE` | `peeringsId, projectsId` | Deletes identified Peering. | +| `_list` | `EXEC` | `projectsId` | Lists Peerings in a given project. | | `patch` | `EXEC` | `peeringsId, projectsId` | Updates the labels for specified Peering. | diff --git a/docs/google-docs/providers/google/managedidentities/sql_integrations/index.md b/docs/google-docs/providers/google/managedidentities/sql_integrations/index.md index faa3514896..73b2e6b2c3 100644 --- a/docs/google-docs/providers/google/managedidentities/sql_integrations/index.md +++ b/docs/google-docs/providers/google/managedidentities/sql_integrations/index.md @@ -37,3 +37,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `domainsId, projectsId, sqlIntegrationsId` | Gets details of a single sqlIntegration. | | `list` | `SELECT` | `domainsId, projectsId` | Lists SqlIntegrations in a given domain. | +| `_list` | `EXEC` | `domainsId, projectsId` | Lists SqlIntegrations in a given domain. | diff --git a/docs/google-docs/providers/google/memcache/index.md b/docs/google-docs/providers/google/memcache/index.md index 392b42f137..f2c811b7c5 100644 --- a/docs/google-docs/providers/google/memcache/index.md +++ b/docs/google-docs/providers/google/memcache/index.md @@ -21,7 +21,7 @@ Google Cloud Memorystore For Memcached API Is Used For Creating And Managing Mem
total resources: 4
total selectable resources: 3
-total methods: 14
+total methods: 17
@@ -33,7 +33,7 @@ Google Cloud Memorystore For Memcached API Is Used For Creating And Managing Mem TypeService TitleCloud Memorystore For Memcached API DescriptionGoogle Cloud Memorystore For Memcached API Is Used For Creating And Managing Memcached Instances In GCP. -Idmemcache:v23.08.00155 +Idmemcache:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/memcache/instances/index.md b/docs/google-docs/providers/google/memcache/instances/index.md index 7131f06070..3a2ebb54a7 100644 --- a/docs/google-docs/providers/google/memcache/instances/index.md +++ b/docs/google-docs/providers/google/memcache/instances/index.md @@ -27,9 +27,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `unreachable` | `array` | Locations that could not be reached. | -| `instances` | `array` | A list of Memcached instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. | +| `name` | `string` | Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at the regional level so `location_id` here refers to a Google Cloud region; however, users may choose which zones Memcached nodes should be provisioned in within an instance. Refer to zones field for more details. | +| `memcacheVersion` | `string` | The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is `MEMCACHE_1_5`. The minor version will be automatically determined by our system based on the latest supported minor version. | +| `labels` | `object` | Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources | +| `memcacheNodes` | `array` | Output only. List of Memcached nodes. Refer to Node message for more details. | +| `maintenancePolicy` | `object` | Maintenance policy per instance. | +| `memcacheFullVersion` | `string` | Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16". | +| `nodeConfig` | `object` | Configuration for a Memcached Node. | +| `updateTime` | `string` | Output only. The time the instance was updated. | +| `state` | `string` | Output only. The state of this Memcached instance. | +| `displayName` | `string` | User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters. | +| `parameters` | `object` | | +| `createTime` | `string` | Output only. The time the instance was created. | +| `nodeCount` | `integer` | Required. Number of nodes in the Memcached instance. | +| `reservedIpRangeId` | `array` | Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. | +| `instanceMessages` | `array` | List of messages that describe the current state of the Memcached instance. | +| `maintenanceSchedule` | `object` | Upcoming maintenance schedule. | +| `discoveryEndpoint` | `string` | Output only. Endpoint for the Discovery API. | +| `zones` | `array` | Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance. | +| `authorizedNetwork` | `string` | The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +53,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists Instances in a given location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new Instance in a given location. | | `delete` | `DELETE` | `instancesId, locationsId, projectsId` | Deletes a single Instance. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Instances in a given location. | | `apply_parameters` | `EXEC` | `instancesId, locationsId, projectsId` | `ApplyParameters` restarts the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance. | | `patch` | `EXEC` | `instancesId, locationsId, projectsId` | Updates an existing Instance in a given project and location. | | `reschedule_maintenance` | `EXEC` | `instancesId, locationsId, projectsId` | Reschedules upcoming maintenance event. | diff --git a/docs/google-docs/providers/google/memcache/locations/index.md b/docs/google-docs/providers/google/memcache/locations/index.md index ae345ecc0e..d77bf1bbb2 100644 --- a/docs/google-docs/providers/google/memcache/locations/index.md +++ b/docs/google-docs/providers/google/memcache/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `locations` | `array` | A list of locations that matches the specified filter in the request. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/memcache/operations/index.md b/docs/google-docs/providers/google/memcache/operations/index.md index cae39f81e6..ef358b8f61 100644 --- a/docs/google-docs/providers/google/memcache/operations/index.md +++ b/docs/google-docs/providers/google/memcache/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/metastore/backups/index.md b/docs/google-docs/providers/google/metastore/backups/index.md index 8aed87ec21..156cfe45f6 100644 --- a/docs/google-docs/providers/google/metastore/backups/index.md +++ b/docs/google-docs/providers/google/metastore/backups/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The relative resource name of the backup, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id} | | `description` | `string` | The description of the backup. | -| `createTime` | `string` | Output only. The time when the backup was started. | | `endTime` | `string` | Output only. The time when the backup finished creating. | | `restoringServices` | `array` | Output only. Services that are restoring from the backup. | | `serviceRevision` | `object` | A managed metastore service that serves metadata queries. | | `state` | `string` | Output only. The current state of the backup. | +| `createTime` | `string` | Output only. The time when the backup was started. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -41,3 +41,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId, servicesId` | Lists backups in a service. | | `create` | `INSERT` | `locationsId, projectsId, servicesId` | Creates a new backup in a given project and location. | | `delete` | `DELETE` | `backupsId, locationsId, projectsId, servicesId` | Deletes a single backup. | +| `_list` | `EXEC` | `locationsId, projectsId, servicesId` | Lists backups in a service. | diff --git a/docs/google-docs/providers/google/metastore/backups_iam_policies/index.md b/docs/google-docs/providers/google/metastore/backups_iam_policies/index.md index 846e4d5a5e..5539fa37fd 100644 --- a/docs/google-docs/providers/google/metastore/backups_iam_policies/index.md +++ b/docs/google-docs/providers/google/metastore/backups_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/metastore/federations/index.md b/docs/google-docs/providers/google/metastore/federations/index.md index 03e825e6b2..fa3fe00858 100644 --- a/docs/google-docs/providers/google/metastore/federations/index.md +++ b/docs/google-docs/providers/google/metastore/federations/index.md @@ -27,9 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `unreachable` | `array` | Locations that could not be reached. | -| `federations` | `array` | The services in the specified location. | +| `name` | `string` | Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`. | +| `endpointUri` | `string` | Output only. The federation endpoint. | +| `state` | `string` | Output only. The current state of the federation. | +| `labels` | `object` | User-defined labels for the metastore federation. | +| `createTime` | `string` | Output only. The time when the metastore federation was created. | +| `version` | `string` | Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version. | +| `updateTime` | `string` | Output only. The time when the metastore federation was last updated. | +| `stateMessage` | `string` | Output only. Additional information about the current state of the metastore federation, if available. | +| `backendMetastores` | `object` | A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number. | +| `uid` | `string` | Output only. The globally unique resource identifier of the metastore federation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists federations in a project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a metastore federation in a project and location. | | `delete` | `DELETE` | `federationsId, locationsId, projectsId` | Deletes a single federation. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists federations in a project and location. | | `patch` | `EXEC` | `federationsId, locationsId, projectsId` | Updates the fields of a federation. | diff --git a/docs/google-docs/providers/google/metastore/federations_iam_policies/index.md b/docs/google-docs/providers/google/metastore/federations_iam_policies/index.md index 40472a8c63..61408e0c1b 100644 --- a/docs/google-docs/providers/google/metastore/federations_iam_policies/index.md +++ b/docs/google-docs/providers/google/metastore/federations_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | -| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/metastore/index.md b/docs/google-docs/providers/google/metastore/index.md index 11425d5bc0..84d8199eb3 100644 --- a/docs/google-docs/providers/google/metastore/index.md +++ b/docs/google-docs/providers/google/metastore/index.md @@ -21,7 +21,7 @@ The Dataproc Metastore API Is Used To Manage The Lifecycle And Configuration Of
total resources: 9
total selectable resources: 9
-total methods: 37
+total methods: 43
@@ -33,7 +33,7 @@ The Dataproc Metastore API Is Used To Manage The Lifecycle And Configuration Of TypeService TitleDataproc Metastore API DescriptionThe Dataproc Metastore API Is Used To Manage The Lifecycle And Configuration Of Metastore Services. -Idmetastore:v23.08.00155 +Idmetastore:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/metastore/locations/index.md b/docs/google-docs/providers/google/metastore/locations/index.md index 6493b88a83..082666d472 100644 --- a/docs/google-docs/providers/google/metastore/locations/index.md +++ b/docs/google-docs/providers/google/metastore/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `locations` | `array` | A list of locations that matches the specified filter in the request. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1" | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: "us-east1". | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/metastore/metadata_imports/index.md b/docs/google-docs/providers/google/metastore/metadata_imports/index.md index cd117a49a6..3edda6d023 100644 --- a/docs/google-docs/providers/google/metastore/metadata_imports/index.md +++ b/docs/google-docs/providers/google/metastore/metadata_imports/index.md @@ -27,13 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `metadataImports` | `array` | The imports in the specified service. | -| `nextPageToken` | `string` | A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Immutable. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}. | +| `description` | `string` | The description of the metadata import. | +| `endTime` | `string` | Output only. The time when the metadata import finished. | +| `state` | `string` | Output only. The current state of the metadata import. | +| `updateTime` | `string` | Output only. The time when the metadata import was last updated. | +| `createTime` | `string` | Output only. The time when the metadata import was started. | +| `databaseDump` | `object` | A specification of the location of and metadata about a database dump from a relational database management system. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, metadataImportsId, projectsId, servicesId` | Gets details of a single import. | | `list` | `SELECT` | `locationsId, projectsId, servicesId` | Lists imports in a service. | | `create` | `INSERT` | `locationsId, projectsId, servicesId` | Creates a new MetadataImport in a given project and location. | +| `_list` | `EXEC` | `locationsId, projectsId, servicesId` | Lists imports in a service. | | `patch` | `EXEC` | `locationsId, metadataImportsId, projectsId, servicesId` | Updates a single import. Only the description field of MetadataImport is supported to be updated. | diff --git a/docs/google-docs/providers/google/metastore/operations/index.md b/docs/google-docs/providers/google/metastore/operations/index.md index 46ec3dcff3..0a0c516ba2 100644 --- a/docs/google-docs/providers/google/metastore/operations/index.md +++ b/docs/google-docs/providers/google/metastore/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/metastore/services/index.md b/docs/google-docs/providers/google/metastore/services/index.md index c4a8de845e..224d90ad87 100644 --- a/docs/google-docs/providers/google/metastore/services/index.md +++ b/docs/google-docs/providers/google/metastore/services/index.md @@ -27,9 +27,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `services` | `array` | The services in the specified location. | +| `name` | `string` | Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. | +| `createTime` | `string` | Output only. The time when the metastore service was created. | +| `artifactGcsUri` | `string` | Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored. | +| `endpointUri` | `string` | Output only. The URI of the endpoint used to access the metastore service. | +| `telemetryConfig` | `object` | Telemetry Configuration for the Dataproc Metastore service. | +| `maintenanceWindow` | `object` | Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service. | +| `updateTime` | `string` | Output only. The time when the metastore service was last updated. | +| `labels` | `object` | User-defined labels for the metastore service. | +| `network` | `string` | Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. | +| `stateMessage` | `string` | Output only. Additional information about the current state of the metastore service, if available. | +| `state` | `string` | Output only. The current state of the metastore service. | +| `encryptionConfig` | `object` | Encryption settings for the service. | +| `scalingConfig` | `object` | Represents the scaling configuration of a metastore service. | +| `releaseChannel` | `string` | Immutable. The release channel of the service. If unspecified, defaults to STABLE. | +| `uid` | `string` | Output only. The globally unique resource identifier of the metastore service. | +| `networkConfig` | `object` | Network configuration for the Dataproc Metastore service.Next available ID: 4 | +| `hiveMetastoreConfig` | `object` | Specifies configuration information specific to running Hive metastore software as the metastore service. | +| `metadataManagementActivity` | `object` | The metadata management activities of the metastore service. | +| `databaseType` | `string` | Immutable. The database type that the Metastore service stores its data. | +| `port` | `integer` | The TCP port at which the metastore service is reached. Default: 9083. | +| `tier` | `string` | The tier of the service. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +55,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists services in a project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a metastore service in a project and location. | | `delete` | `DELETE` | `locationsId, projectsId, servicesId` | Deletes a single service. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists services in a project and location. | | `alter_location` | `EXEC` | `locationsId, projectsId, servicesId` | Alter metadata resource location. The metadata resource can be a database, table, or partition. This functionality only updates the parent directory for the respective metadata resource and does not transfer any existing data to the new location. | | `export_metadata` | `EXEC` | `locationsId, projectsId, servicesId` | Exports metadata from a service. | | `move_table_to_database` | `EXEC` | `locationsId, projectsId, servicesId` | Move a table to another database. | diff --git a/docs/google-docs/providers/google/metastore/services_iam_policies/index.md b/docs/google-docs/providers/google/metastore/services_iam_policies/index.md index 1bce633cf0..01ce170351 100644 --- a/docs/google-docs/providers/google/metastore/services_iam_policies/index.md +++ b/docs/google-docs/providers/google/metastore/services_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | -| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/migrationcenter/assets/index.md b/docs/google-docs/providers/google/migrationcenter/assets/index.md index e741f50d9c..0a6c8eb958 100644 --- a/docs/google-docs/providers/google/migrationcenter/assets/index.md +++ b/docs/google-docs/providers/google/migrationcenter/assets/index.md @@ -27,15 +27,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `assets` | `array` | A list of assets. | -| `nextPageToken` | `string` | A token identifying a page of results the server should return. | +| `name` | `string` | Output only. The full name of the asset. | +| `insightList` | `object` | Message containing insights list. | +| `labels` | `object` | Labels as key value pairs. | +| `sources` | `array` | Output only. The list of sources contributing to the asset. | +| `updateTime` | `string` | Output only. The timestamp when the asset was last updated. | +| `attributes` | `object` | Generic asset attributes. | +| `assignedGroups` | `array` | Output only. The list of groups that the asset is assigned to. | +| `createTime` | `string` | Output only. The timestamp when the asset was created. | +| `performanceData` | `object` | Performance data for an asset. | +| `machineDetails` | `object` | Details of a machine. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `assetsId, locationsId, projectsId` | Gets the details of an asset. | | `list` | `SELECT` | `locationsId, projectsId` | Lists all the assets in a given project and location. | | `delete` | `DELETE` | `assetsId, locationsId, projectsId` | Deletes an asset. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists all the assets in a given project and location. | | `aggregate_values` | `EXEC` | `locationsId, projectsId` | Aggregates the requested fields based on provided function. | | `batch_delete` | `EXEC` | `locationsId, projectsId` | Deletes list of Assets. | | `batch_update` | `EXEC` | `locationsId, projectsId` | Updates the parameters of a list of assets. | diff --git a/docs/google-docs/providers/google/migrationcenter/error_frames/index.md b/docs/google-docs/providers/google/migrationcenter/error_frames/index.md index 3b5d659960..968b0ee3b6 100644 --- a/docs/google-docs/providers/google/migrationcenter/error_frames/index.md +++ b/docs/google-docs/providers/google/migrationcenter/error_frames/index.md @@ -28,11 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The identifier of the ErrorFrame. | +| `ingestionTime` | `string` | Output only. Frame ingestion time. | | `originalFrame` | `object` | Contains data reported from an inventory source on an asset. | | `violations` | `array` | Output only. All the violations that were detected for the frame. | -| `ingestionTime` | `string` | Output only. Frame ingestion time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `errorFramesId, locationsId, projectsId, sourcesId` | Gets the details of an error frame. | | `list` | `SELECT` | `locationsId, projectsId, sourcesId` | Lists all error frames in a given source and location. | +| `_list` | `EXEC` | `locationsId, projectsId, sourcesId` | Lists all error frames in a given source and location. | diff --git a/docs/google-docs/providers/google/migrationcenter/groups/index.md b/docs/google-docs/providers/google/migrationcenter/groups/index.md index 2302c25607..e14af06d4a 100644 --- a/docs/google-docs/providers/google/migrationcenter/groups/index.md +++ b/docs/google-docs/providers/google/migrationcenter/groups/index.md @@ -27,9 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `groups` | `array` | The list of Group | -| `nextPageToken` | `string` | A token identifying a page of results the server should return. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | Output only. The name of the group. | +| `description` | `string` | The description of the resource. | +| `updateTime` | `string` | Output only. The timestamp when the group was last updated. | +| `createTime` | `string` | Output only. The timestamp when the group was created. | +| `displayName` | `string` | User-friendly display name. | +| `labels` | `object` | Labels as key value pairs. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +40,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists all groups in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new group in a given project and location. | | `delete` | `DELETE` | `groupsId, locationsId, projectsId` | Deletes a group. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists all groups in a given project and location. | | `patch` | `EXEC` | `groupsId, locationsId, projectsId` | Updates the parameters of a group. | diff --git a/docs/google-docs/providers/google/migrationcenter/import_data_files/index.md b/docs/google-docs/providers/google/migrationcenter/import_data_files/index.md index 43433b6e94..a64020272d 100644 --- a/docs/google-docs/providers/google/migrationcenter/import_data_files/index.md +++ b/docs/google-docs/providers/google/migrationcenter/import_data_files/index.md @@ -27,9 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `importDataFiles` | `array` | The list of import data files. | -| `nextPageToken` | `string` | A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Output only. The name of the file. | +| `createTime` | `string` | Output only. The timestamp when the file was created. | +| `displayName` | `string` | User-friendly display name. Maximum length is 63 characters. | +| `format` | `string` | Required. The payload format. | +| `state` | `string` | Output only. The state of the import data file. | +| `uploadFileInfo` | `object` | A resource that contains a URI to which a data file can be uploaded. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,3 +40,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `importJobsId, locationsId, projectsId` | List import data files. | | `create` | `INSERT` | `importJobsId, locationsId, projectsId` | Creates an import data file. | | `delete` | `DELETE` | `importDataFilesId, importJobsId, locationsId, projectsId` | Delete an import data file. | +| `_list` | `EXEC` | `importJobsId, locationsId, projectsId` | List import data files. | diff --git a/docs/google-docs/providers/google/migrationcenter/import_jobs/index.md b/docs/google-docs/providers/google/migrationcenter/import_jobs/index.md index a60e54fed1..8580654990 100644 --- a/docs/google-docs/providers/google/migrationcenter/import_jobs/index.md +++ b/docs/google-docs/providers/google/migrationcenter/import_jobs/index.md @@ -27,9 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `importJobs` | `array` | The list of import jobs. | -| `nextPageToken` | `string` | A token identifying a page of results the server should return. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | Output only. The full name of the import job. | +| `updateTime` | `string` | Output only. The timestamp when the import job was last updated. | +| `createTime` | `string` | Output only. The timestamp when the import job was created. | +| `labels` | `object` | Labels as key value pairs. | +| `completeTime` | `string` | Output only. The timestamp when the import job was completed. | +| `assetSource` | `string` | Required. Reference to a source. | +| `executionReport` | `object` | A resource that reports result of the import job execution. | +| `displayName` | `string` | User-friendly display name. Maximum length is 63 characters. | +| `validationReport` | `object` | A resource that aggregates errors across import job files. | +| `state` | `string` | Output only. The state of the import job. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +44,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists all import jobs. | | `create` | `INSERT` | `locationsId, projectsId` | Creates an import job. | | `delete` | `DELETE` | `importJobsId, locationsId, projectsId` | Deletes an import job. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists all import jobs. | | `patch` | `EXEC` | `importJobsId, locationsId, projectsId` | Updates an import job. | | `run` | `EXEC` | `importJobsId, locationsId, projectsId` | Runs an import job. | | `validate` | `EXEC` | `importJobsId, locationsId, projectsId` | Validates an import job. | diff --git a/docs/google-docs/providers/google/migrationcenter/index.md b/docs/google-docs/providers/google/migrationcenter/index.md index 6f92a0830d..adcfee9522 100644 --- a/docs/google-docs/providers/google/migrationcenter/index.md +++ b/docs/google-docs/providers/google/migrationcenter/index.md @@ -21,7 +21,7 @@ A Unified Platform That Helps You Accelerate Your End-To-End Cloud Journey From
total resources: 13
total selectable resources: 12
-total methods: 54
+total methods: 65
@@ -33,7 +33,7 @@ A Unified Platform That Helps You Accelerate Your End-To-End Cloud Journey From TypeService TitleMigration Center API DescriptionA Unified Platform That Helps You Accelerate Your End-To-End Cloud Journey From Your Current On-Premises Or Cloud Environments To Google Cloud. -Idmigrationcenter:v23.08.00155 +Idmigrationcenter:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/migrationcenter/locations/index.md b/docs/google-docs/providers/google/migrationcenter/locations/index.md index b5c11a5afb..93d96e9960 100644 --- a/docs/google-docs/providers/google/migrationcenter/locations/index.md +++ b/docs/google-docs/providers/google/migrationcenter/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/migrationcenter/operations/index.md b/docs/google-docs/providers/google/migrationcenter/operations/index.md index 3df2eef60d..5b7ce613d2 100644 --- a/docs/google-docs/providers/google/migrationcenter/operations/index.md +++ b/docs/google-docs/providers/google/migrationcenter/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/migrationcenter/preference_sets/index.md b/docs/google-docs/providers/google/migrationcenter/preference_sets/index.md index 1222e4c446..e70c7f5a12 100644 --- a/docs/google-docs/providers/google/migrationcenter/preference_sets/index.md +++ b/docs/google-docs/providers/google/migrationcenter/preference_sets/index.md @@ -27,9 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | A token identifying a page of results the server should return. | -| `preferenceSets` | `array` | The list of PreferenceSets | +| `name` | `string` | Output only. Name of the preference set. | +| `description` | `string` | A description of the preference set. | +| `createTime` | `string` | Output only. The timestamp when the preference set was created. | +| `displayName` | `string` | User-friendly display name. Maximum length is 63 characters. | +| `updateTime` | `string` | Output only. The timestamp when the preference set was last updated. | +| `virtualMachinePreferences` | `object` | VirtualMachinePreferences enables you to create sets of assumptions, for example, a geographical location and pricing track, for your migrated virtual machines. The set of preferences influence recommendations for migrating virtual machine assets. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +40,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists all the preference sets in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new preference set in a given project and location. | | `delete` | `DELETE` | `locationsId, preferenceSetsId, projectsId` | Deletes a preference set. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists all the preference sets in a given project and location. | | `patch` | `EXEC` | `locationsId, preferenceSetsId, projectsId` | Updates the parameters of a preference set. | diff --git a/docs/google-docs/providers/google/migrationcenter/report_configs/index.md b/docs/google-docs/providers/google/migrationcenter/report_configs/index.md index d608c1e275..af6f9d47d5 100644 --- a/docs/google-docs/providers/google/migrationcenter/report_configs/index.md +++ b/docs/google-docs/providers/google/migrationcenter/report_configs/index.md @@ -27,9 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | A token identifying a page of results the server should return. | -| `reportConfigs` | `array` | A list of report configs. | +| `name` | `string` | Output only. Name of resource. | +| `description` | `string` | Free-text description. | +| `displayName` | `string` | User-friendly display name. Maximum length is 63 characters. | +| `groupPreferencesetAssignments` | `array` | Required. Collection of combinations of groups and preference sets. | +| `updateTime` | `string` | Output only. The timestamp when the resource was last updated. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,3 +40,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists ReportConfigs in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a report configuration. | | `delete` | `DELETE` | `locationsId, projectsId, reportConfigsId` | Deletes a ReportConfig. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists ReportConfigs in a given project and location. | diff --git a/docs/google-docs/providers/google/migrationcenter/reports/index.md b/docs/google-docs/providers/google/migrationcenter/reports/index.md index 73049d7c53..06ef6ace61 100644 --- a/docs/google-docs/providers/google/migrationcenter/reports/index.md +++ b/docs/google-docs/providers/google/migrationcenter/reports/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Name of resource. | | `description` | `string` | Free-text description. | -| `displayName` | `string` | User-friendly display name. Maximum length is 63 characters. | | `state` | `string` | Report creation state. | | `summary` | `object` | Describes the Summary view of a Report, which contains aggregated values for all the groups and preference sets included in this Report. | | `type` | `string` | Report type. | | `updateTime` | `string` | Output only. Last update timestamp. | | `createTime` | `string` | Output only. Creation timestamp. | +| `displayName` | `string` | User-friendly display name. Maximum length is 63 characters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -42,3 +42,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId, reportConfigsId` | Lists Reports in a given ReportConfig. | | `create` | `INSERT` | `locationsId, projectsId, reportConfigsId` | Creates a report. | | `delete` | `DELETE` | `locationsId, projectsId, reportConfigsId, reportsId` | Deletes a Report. | +| `_list` | `EXEC` | `locationsId, projectsId, reportConfigsId` | Lists Reports in a given ReportConfig. | diff --git a/docs/google-docs/providers/google/migrationcenter/sources/index.md b/docs/google-docs/providers/google/migrationcenter/sources/index.md index d7d9594748..6f2959b1c5 100644 --- a/docs/google-docs/providers/google/migrationcenter/sources/index.md +++ b/docs/google-docs/providers/google/migrationcenter/sources/index.md @@ -27,9 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | A token identifying a page of results the server should return. | -| `sources` | `array` | The list of sources. | +| `name` | `string` | Output only. The full name of the source. | +| `description` | `string` | Free-text description. | +| `displayName` | `string` | User-friendly display name. | +| `type` | `string` | Data source type. | +| `managed` | `boolean` | If `true`, the source is managed by other service(s). | +| `priority` | `integer` | The information confidence of the source. The higher the value, the higher the confidence. | +| `errorFrameCount` | `integer` | Output only. The number of frames that were reported by the source and contained errors. | +| `pendingFrameCount` | `integer` | Output only. Number of frames that are still being processed. | +| `state` | `string` | Output only. The state of the source. | +| `updateTime` | `string` | Output only. The timestamp when the source was last updated. | +| `createTime` | `string` | Output only. The timestamp when the source was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +45,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists all the sources in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new source in a given project and location. | | `delete` | `DELETE` | `locationsId, projectsId, sourcesId` | Deletes a source. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists all the sources in a given project and location. | | `patch` | `EXEC` | `locationsId, projectsId, sourcesId` | Updates the parameters of a source. | diff --git a/docs/google-docs/providers/google/ml/config/index.md b/docs/google-docs/providers/google/ml/config/index.md index 6c3914a330..b5611a0c49 100644 --- a/docs/google-docs/providers/google/ml/config/index.md +++ b/docs/google-docs/providers/google/ml/config/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `config` | `object` | | | `serviceAccount` | `string` | The service account Cloud ML uses to access resources in the project. | | `serviceAccountProject` | `string` | The project number for `service_account`. | +| `config` | `object` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/ml/index.md b/docs/google-docs/providers/google/ml/index.md index 392fd6d15c..c0dea3e0f6 100644 --- a/docs/google-docs/providers/google/ml/index.md +++ b/docs/google-docs/providers/google/ml/index.md @@ -21,7 +21,7 @@ An API To Enable Creating And Using Machine Learning Models.
total resources: 13
total selectable resources: 10
-total methods: 46
+total methods: 51
@@ -33,7 +33,7 @@ An API To Enable Creating And Using Machine Learning Models. TypeService TitleAI Platform Training & Prediction API DescriptionAn API To Enable Creating And Using Machine Learning Models. -Idml:v23.08.00155 +Idml:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/ml/jobs/index.md b/docs/google-docs/providers/google/ml/jobs/index.md index 76f973d412..858174d5bb 100644 --- a/docs/google-docs/providers/google/ml/jobs/index.md +++ b/docs/google-docs/providers/google/ml/jobs/index.md @@ -27,13 +27,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `jobs` | `array` | The list of jobs. | -| `nextPageToken` | `string` | Optional. Pass this token as the `page_token` field of the request for a subsequent call. | +| `createTime` | `string` | Output only. When the job was created. | +| `errorMessage` | `string` | Output only. The details of a failure or a cancellation. | +| `jobId` | `string` | Required. The user-specified id of the job. | +| `labels` | `object` | Optional. One or more labels that you can add, to organize your jobs. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. | +| `endTime` | `string` | Output only. When the job processing was completed. | +| `predictionInput` | `object` | Represents input parameters for a prediction job. | +| `startTime` | `string` | Output only. When the job processing was started. | +| `state` | `string` | Output only. The detailed state of a job. | +| `jobPosition` | `string` | Output only. It's only effect when the job is in QUEUED state. If it's positive, it indicates the job's position in the job scheduler. It's 0 when the job is already scheduled. | +| `predictionOutput` | `object` | Represents results of a prediction job. | +| `trainingInput` | `object` | Represents input parameters for a training job. When using the gcloud command to submit your training job, you can specify the input parameters as command-line arguments and/or in a YAML configuration file referenced from the --config command-line argument. For details, see the guide to [submitting a training job](/ai-platform/training/docs/training-jobs). | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a job from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform job updates in order to avoid race conditions: An `etag` is returned in the response to `GetJob`, and systems are expected to put that etag in the request to `UpdateJob` to ensure that their change will be applied to the same version of the job. | +| `trainingOutput` | `object` | Represents results of a training job. Output only. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_jobs_list` | `SELECT` | `projectsId` | Lists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: {}. | | `projects_jobs_create` | `INSERT` | `projectsId` | Creates a training or a batch prediction job. | +| `_projects_jobs_list` | `EXEC` | `projectsId` | Lists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: {}. | | `projects_jobs_cancel` | `EXEC` | `jobsId, projectsId` | Cancels a running job. | | `projects_jobs_get` | `EXEC` | `jobsId, projectsId` | Describes a job. | | `projects_jobs_patch` | `EXEC` | `jobsId, projectsId` | Updates a specific job resource. Currently the only supported fields to update are `labels`. | diff --git a/docs/google-docs/providers/google/ml/jobs_iam_policies/index.md b/docs/google-docs/providers/google/ml/jobs_iam_policies/index.md index 4dd8193b18..45207a8a87 100644 --- a/docs/google-docs/providers/google/ml/jobs_iam_policies/index.md +++ b/docs/google-docs/providers/google/ml/jobs_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/ml/locations/index.md b/docs/google-docs/providers/google/ml/locations/index.md index 62e06cb152..97c56262ec 100644 --- a/docs/google-docs/providers/google/ml/locations/index.md +++ b/docs/google-docs/providers/google/ml/locations/index.md @@ -27,10 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Optional. Pass this token as the `page_token` field of the request for a subsequent call. | -| `locations` | `array` | Locations where at least one type of CMLE capability is available. | +| `name` | `string` | | +| `capabilities` | `array` | Capabilities available in the location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_get` | `SELECT` | `locationsId, projectsId` | Get the complete list of CMLE capabilities in a location, along with their location-specific properties. | | `projects_locations_list` | `SELECT` | `projectsId` | List all locations that provides at least one type of CMLE capability. | +| `_projects_locations_list` | `EXEC` | `projectsId` | List all locations that provides at least one type of CMLE capability. | diff --git a/docs/google-docs/providers/google/ml/models/index.md b/docs/google-docs/providers/google/ml/models/index.md index e0e578aecf..14816c39b8 100644 --- a/docs/google-docs/providers/google/ml/models/index.md +++ b/docs/google-docs/providers/google/ml/models/index.md @@ -27,13 +27,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `models` | `array` | The list of models. | -| `nextPageToken` | `string` | Optional. Pass this token as the `page_token` field of the request for a subsequent call. | +| `name` | `string` | Required. The name specified for the model when it was created. The model name must be unique within the project it is created in. | +| `description` | `string` | Optional. The description specified for the model when it was created. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetModel`, and systems are expected to put that etag in the request to `UpdateModel` to ensure that their change will be applied to the model as intended. | +| `labels` | `object` | Optional. One or more labels that you can add, to organize your models. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Note that this field is not updatable for mls1* models. | +| `onlinePredictionConsoleLogging` | `boolean` | Optional. If true, online prediction nodes send `stderr` and `stdout` streams to Cloud Logging. These can be more verbose than the standard access logs (see `onlinePredictionLogging`) and can incur higher cost. However, they are helpful for debugging. Note that [logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high QPS. Estimate your costs before enabling this option. Default is false. | +| `onlinePredictionLogging` | `boolean` | Optional. If true, online prediction access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each request. Note that [logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. Default is false. | +| `regions` | `array` | Optional. The list of regions where the model is going to be deployed. Only one region per model is supported. Defaults to 'us-central1' if nothing is set. See the available regions for AI Platform services. Note: * No matter where a model is deployed, it can always be accessed by users from anywhere, both for online and batch prediction. * The region for a batch prediction job is set by the region field when submitting the batch prediction job and does not take its value from this field. | +| `defaultVersion` | `object` | Represents a version of the model. Each version is a trained model deployed in the cloud, ready to handle prediction requests. A model can have multiple versions. You can get information about all of the versions of a given model by calling projects.models.versions.list. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_models_list` | `SELECT` | `projectsId` | Lists the models in a project. Each project can contain multiple models, and each model can have multiple versions. If there are no models that match the request parameters, the list request returns an empty response body: {}. | | `projects_models_create` | `INSERT` | `projectsId` | Creates a model which will later contain one or more versions. You must add at least one version before you can request predictions from the model. Add versions by calling projects.models.versions.create. | | `projects_models_delete` | `DELETE` | `modelsId, projectsId` | Deletes a model. You can only delete a model if there are no versions in it. You can delete versions by calling projects.models.versions.delete. | +| `_projects_models_list` | `EXEC` | `projectsId` | Lists the models in a project. Each project can contain multiple models, and each model can have multiple versions. If there are no models that match the request parameters, the list request returns an empty response body: {}. | | `projects_models_get` | `EXEC` | `modelsId, projectsId` | Gets information about a model, including its name, the description (if set), and the default version (if at least one version of the model has been deployed). | | `projects_models_patch` | `EXEC` | `modelsId, projectsId` | Updates a specific model resource. Currently the only supported fields to update are `description` and `default_version.name`. | diff --git a/docs/google-docs/providers/google/ml/models_iam_policies/index.md b/docs/google-docs/providers/google/ml/models_iam_policies/index.md index 9b2c935d1c..ab89aa1884 100644 --- a/docs/google-docs/providers/google/ml/models_iam_policies/index.md +++ b/docs/google-docs/providers/google/ml/models_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/ml/operations/index.md b/docs/google-docs/providers/google/ml/operations/index.md index a02d2c37e3..3df7a1f630 100644 --- a/docs/google-docs/providers/google/ml/operations/index.md +++ b/docs/google-docs/providers/google/ml/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_operations_list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_operations_list` | `EXEC` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | | `projects_locations_operations_get` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | | `projects_operations_cancel` | `EXEC` | `operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/ml/studies/index.md b/docs/google-docs/providers/google/ml/studies/index.md index 60b6605e31..d1c471d9ea 100644 --- a/docs/google-docs/providers/google/ml/studies/index.md +++ b/docs/google-docs/providers/google/ml/studies/index.md @@ -25,13 +25,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. The name of a study. | -| `studyConfig` | `object` | Represents configuration of a study. | -| `createTime` | `string` | Output only. Time at which the study was created. | -| `inactiveReason` | `string` | Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED. | -| `state` | `string` | Output only. The detailed state of a study. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/ml/versions/index.md b/docs/google-docs/providers/google/ml/versions/index.md index db6ff71305..072d37a9f6 100644 --- a/docs/google-docs/providers/google/ml/versions/index.md +++ b/docs/google-docs/providers/google/ml/versions/index.md @@ -27,14 +27,39 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Optional. Pass this token as the `page_token` field of the request for a subsequent call. | -| `versions` | `array` | The list of versions. | +| `name` | `string` | Required. The name specified for the version when it was created. The version name must be unique within the model it is created in. | +| `description` | `string` | Optional. The description specified for the version when it was created. | +| `explanationConfig` | `object` | Message holding configuration options for explaining model predictions. There are three feature attribution methods supported for TensorFlow models: integrated gradients, sampled Shapley, and XRAI. [Learn more about feature attributions.](/ai-platform/prediction/docs/ai-explanations/overview) | +| `framework` | `string` | Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. Do **not** specify a framework if you're deploying a [custom prediction routine](/ai-platform/prediction/docs/custom-prediction-routines) or if you're using a [custom container](/ai-platform/prediction/docs/use-custom-container). | +| `runtimeVersion` | `string` | Required. The AI Platform runtime version to use for this deployment. For more information, see the [runtime version list](/ml-engine/docs/runtime-version-list) and [how to manage runtime versions](/ml-engine/docs/versioning). | +| `packageUris` | `array` | Optional. Cloud Storage paths (`gs://…`) of packages for [custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines) or [scikit-learn pipelines with custom code](/ml-engine/docs/scikit/exporting-for-prediction#custom-pipeline-code). For a custom prediction routine, one of these packages must contain your Predictor class (see [`predictionClass`](#Version.FIELDS.prediction_class)). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected [runtime version](/ml-engine/docs/tensorflow/runtime-version-list). If you specify this field, you must also set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater. | +| `routes` | `object` | Specifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetVersion`, and systems are expected to put that etag in the request to `UpdateVersion` to ensure that their change will be applied to the model as intended. | +| `lastUseTime` | `string` | Output only. The time the version was last used for prediction. | +| `autoScaling` | `object` | Options for automatically scaling a model. | +| `pythonVersion` | `string` | Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). | +| `manualScaling` | `object` | Options for manually scaling a model. | +| `lastMigrationTime` | `string` | Output only. The last time this version was successfully [migrated to AI Platform (Unified)](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform-unified). | +| `isDefault` | `boolean` | Output only. If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.methods.versions.setDefault. | +| `predictionClass` | `string` | Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction). The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). | +| `deploymentUri` | `string` | The Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version. See the [guide to deploying models](/ai-platform/prediction/docs/deploying-models) for more information. The total number of files under this directory must not exceed 1000. During projects.models.versions.create, AI Platform Prediction copies all files from the specified directory to a location managed by the service. From then on, AI Platform Prediction uses these copies of the model artifacts to serve predictions, not the original files in Cloud Storage, so this location is useful only as a historical record. If you specify container, then this field is optional. Otherwise, it is required. Learn [how to use this field with a custom container](/ai-platform/prediction/docs/custom-container-requirements#artifacts). | +| `serviceAccount` | `string` | Optional. Specifies the service account for resource access control. If you specify this field, then you must also specify either the `containerSpec` or the `predictionClass` field. Learn more about [using a custom service account](/ai-platform/prediction/docs/custom-service-account). | +| `acceleratorConfig` | `object` | Represents a hardware accelerator request config. Note that the AcceleratorConfig can be used in both Jobs and Versions. Learn more about [accelerators for training](/ml-engine/docs/using-gpus) and [accelerators for online prediction](/ml-engine/docs/machine-types-online-prediction#gpus). | +| `machineType` | `string` | Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. To learn about valid values for this field, read [Choosing a machine type for online prediction](/ai-platform/prediction/docs/machine-types-online-prediction). If this field is not specified and you are using a [regional endpoint](/ai-platform/prediction/docs/regional-endpoints), then the machine type defaults to `n1-standard-2`. If this field is not specified and you are using the global endpoint (`ml.googleapis.com`), then the machine type defaults to `mls1-c1-m2`. | +| `createTime` | `string` | Output only. The time the version was created. | +| `container` | `object` | Specification of a custom container for serving predictions. This message is a subset of the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core). | +| `errorMessage` | `string` | Output only. The details of a failure or a cancellation. | +| `labels` | `object` | Optional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Note that this field is not updatable for mls1* models. | +| `lastMigrationModelId` | `string` | Output only. The [AI Platform (Unified) `Model`](https://cloud.google.com/ai-platform-unified/docs/reference/rest/v1beta1/projects.locations.models) ID for the last [model migration](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform-unified). | +| `requestLoggingConfig` | `object` | Configuration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using [continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs. | +| `state` | `string` | Output only. The state of a version. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_models_versions_list` | `SELECT` | `modelsId, projectsId` | Gets basic information about all the versions of a model. If you expect that a model has many versions, or if you need to handle only a limited number of results at a time, you can request that the list be retrieved in batches (called pages). If there are no versions that match the request parameters, the list request returns an empty response body: {}. | | `projects_models_versions_create` | `INSERT` | `modelsId, projectsId` | Creates a new version of a model from a trained TensorFlow model. If the version created in the cloud by this call is the first deployed version of the specified model, it will be made the default version of the model. When you add a version to a model that already has one or more versions, the default version does not automatically change. If you want a new version to be the default, you must call projects.models.versions.setDefault. | | `projects_models_versions_delete` | `DELETE` | `modelsId, projectsId, versionsId` | Deletes a model version. Each model can have multiple versions deployed and in use at any given time. Use this method to remove a single version. Note: You cannot delete the version that is set as the default version of the model unless it is the only remaining version. | +| `_projects_models_versions_list` | `EXEC` | `modelsId, projectsId` | Gets basic information about all the versions of a model. If you expect that a model has many versions, or if you need to handle only a limited number of results at a time, you can request that the list be retrieved in batches (called pages). If there are no versions that match the request parameters, the list request returns an empty response body: {}. | | `projects_models_versions_get` | `EXEC` | `modelsId, projectsId, versionsId` | Gets information about a model version. Models can have multiple versions. You can call projects.models.versions.list to get the same information that this method returns for all of the versions of a model. | | `projects_models_versions_patch` | `EXEC` | `modelsId, projectsId, versionsId` | Updates the specified Version resource. Currently the only update-able fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`. | | `projects_models_versions_set_default` | `EXEC` | `modelsId, projectsId, versionsId` | Designates a version to be the default for the model. The default version is used for prediction requests made against the model that don't specify a version. The first version to be created for a model is automatically set as the default. You must make any subsequent changes to the default version setting manually using this method. | diff --git a/docs/google-docs/providers/google/monitoring/alert_policies/index.md b/docs/google-docs/providers/google/monitoring/alert_policies/index.md index fce815d880..2f9b41a36c 100644 --- a/docs/google-docs/providers/google/monitoring/alert_policies/index.md +++ b/docs/google-docs/providers/google/monitoring/alert_policies/index.md @@ -27,14 +27,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than were returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. | -| `totalSize` | `integer` | The total number of alert policies in all pages. This number is only an estimate, and may change in subsequent pages. https://aip.dev/158 | -| `alertPolicies` | `array` | The returned alert policies. | +| `name` | `string` | Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. | +| `displayName` | `string` | A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.The convention for the display_name of a PrometheusQueryLanguageCondition is "{rule group name}/{alert name}", where the {rule group name} and {alert name} should be taken from the corresponding Prometheus configuration file. This convention is not enforced. In any case the display_name is not a unique key of the AlertPolicy. | +| `documentation` | `object` | A content string and a MIME type that describes the content string's format. | +| `mutationRecord` | `object` | Describes a change made to a configuration. | +| `alertStrategy` | `object` | Control over how the notification channels in notification_channels are notified when this alert fires. | +| `conditions` | `array` | A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If condition_time_series_query_language is present, it must be the only condition. If condition_monitoring_query_language is present, it must be the only condition. | +| `validity` | `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). | +| `creationRecord` | `object` | Describes a change made to a configuration. | +| `userLabels` | `object` | User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.Note that Prometheus {rule group name} and {alert name} are valid Prometheus label names (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). This means that they cannot be stored as-is in user labels, because Prometheus labels may contain upper-case letters. | +| `enabled` | `boolean` | Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out. | +| `combiner` | `string` | How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED. | +| `notificationChannels` | `array` | Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_alert_policies_list` | `SELECT` | `projectsId` | Lists the existing alerting policies for the workspace. | | `projects_alert_policies_create` | `INSERT` | `projectsId` | Creates a new alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy. | | `projects_alert_policies_delete` | `DELETE` | `alertPoliciesId, projectsId` | Deletes an alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy. | +| `_projects_alert_policies_list` | `EXEC` | `projectsId` | Lists the existing alerting policies for the workspace. | | `projects_alert_policies_get` | `EXEC` | `alertPoliciesId, projectsId` | Gets a single alerting policy. | | `projects_alert_policies_patch` | `EXEC` | `alertPoliciesId, projectsId` | Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via updateMask. Returns the updated alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy. | diff --git a/docs/google-docs/providers/google/monitoring/groups/index.md b/docs/google-docs/providers/google/monitoring/groups/index.md index 6129373325..898ca7849f 100644 --- a/docs/google-docs/providers/google/monitoring/groups/index.md +++ b/docs/google-docs/providers/google/monitoring/groups/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically. | +| `parentName` | `string` | The name of the group's parent, if it has one. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] For groups with no parent, parent_name is the empty string, "". | | `displayName` | `string` | A user-assigned name for this group, used only for display purposes. | | `filter` | `string` | The filter used to determine which monitored resources belong to this group. | | `isCluster` | `boolean` | If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters. | -| `parentName` | `string` | The name of the group's parent, if it has one. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] For groups with no parent, parent_name is the empty string, "". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -39,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_groups_list` | `SELECT` | `projectsId` | Lists the existing groups. | | `projects_groups_create` | `INSERT` | `projectsId` | Creates a new group. | | `projects_groups_delete` | `DELETE` | `groupsId, projectsId` | Deletes an existing group. | +| `_projects_groups_list` | `EXEC` | `projectsId` | Lists the existing groups. | | `projects_groups_update` | `EXEC` | `groupsId, projectsId` | Updates an existing group. You can change any group attributes except name. | diff --git a/docs/google-docs/providers/google/monitoring/index.md b/docs/google-docs/providers/google/monitoring/index.md index cb6284c903..bfe109758d 100644 --- a/docs/google-docs/providers/google/monitoring/index.md +++ b/docs/google-docs/providers/google/monitoring/index.md @@ -21,7 +21,7 @@ Manages Your Cloud Monitoring Data And Configurations.
total resources: 16
total selectable resources: 13
-total methods: 51
+total methods: 66
@@ -33,7 +33,7 @@ Manages Your Cloud Monitoring Data And Configurations. TypeService TitleCloud Monitoring API DescriptionManages Your Cloud Monitoring Data And Configurations. -Idmonitoring:v23.08.00155 +Idmonitoring:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/monitoring/members/index.md b/docs/google-docs/providers/google/monitoring/members/index.md index 285effb18d..108425e82b 100644 --- a/docs/google-docs/providers/google/monitoring/members/index.md +++ b/docs/google-docs/providers/google/monitoring/members/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `members` | `array` | A set of monitored resources in the group. | -| `nextPageToken` | `string` | If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. | -| `totalSize` | `integer` | The total number of elements matching this request. | +| `type` | `string` | Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list). | +| `labels` | `object` | Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone". | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_groups_members_list` | `SELECT` | `groupsId, projectsId` | +| `_projects_groups_members_list` | `EXEC` | `groupsId, projectsId` | diff --git a/docs/google-docs/providers/google/monitoring/metric_descriptors/index.md b/docs/google-docs/providers/google/monitoring/metric_descriptors/index.md index 304075fb2c..ac070f2da1 100644 --- a/docs/google-docs/providers/google/monitoring/metric_descriptors/index.md +++ b/docs/google-docs/providers/google/monitoring/metric_descriptors/index.md @@ -27,8 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. | -| `metricDescriptors` | `array` | The metric descriptors that are available to the project and that match the value of filter, if present. | +| `name` | `string` | The resource name of the metric descriptor. | +| `description` | `string` | A detailed description of the metric, which can be used in documentation. | +| `launchStage` | `string` | Optional. The launch stage of the metric definition. | +| `unit` | `string` | The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT \| "%" ) [ Annotation ] \| Annotation \| "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent"). | +| `monitoredResourceTypes` | `array` | Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. | +| `valueType` | `string` | Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. | +| `displayName` | `string` | A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. | +| `metadata` | `object` | Additional annotations that can be used to guide the usage of a metric. | +| `metricKind` | `string` | Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. | +| `type` | `string` | The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" | +| `labels` | `array` | The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,3 +45,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_metric_descriptors_list` | `SELECT` | `projectsId` | Lists metric descriptors that match a filter. | | `projects_metric_descriptors_create` | `INSERT` | `projectsId` | Creates a new metric descriptor. The creation is executed asynchronously. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics). The metric descriptor is updated if it already exists, except that metric labels are never removed. | | `projects_metric_descriptors_delete` | `DELETE` | `metricDescriptorsId, projectsId` | Deletes a metric descriptor. Only user-created custom metrics (https://cloud.google.com/monitoring/custom-metrics) can be deleted. | +| `_projects_metric_descriptors_list` | `EXEC` | `projectsId` | Lists metric descriptors that match a filter. | diff --git a/docs/google-docs/providers/google/monitoring/monitored_resource_descriptors/index.md b/docs/google-docs/providers/google/monitoring/monitored_resource_descriptors/index.md index e722920c68..4cb4ee0e3a 100644 --- a/docs/google-docs/providers/google/monitoring/monitored_resource_descriptors/index.md +++ b/docs/google-docs/providers/google/monitoring/monitored_resource_descriptors/index.md @@ -27,10 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `resourceDescriptors` | `array` | The monitored resource descriptors that are available to this project and that match filter, if present. | -| `nextPageToken` | `string` | If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. | +| `name` | `string` | Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". | +| `description` | `string` | Optional. A detailed description of the monitored resource type that might be used in documentation. | +| `type` | `string` | Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list). | +| `displayName` | `string` | Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database". | +| `labels` | `array` | Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone". | +| `launchStage` | `string` | Optional. The launch stage of the monitored resource definition. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_monitored_resource_descriptors_get` | `SELECT` | `monitoredResourceDescriptorsId, projectsId` | Gets a single monitored resource descriptor. | | `projects_monitored_resource_descriptors_list` | `SELECT` | `projectsId` | Lists monitored resource descriptors that match a filter. | +| `_projects_monitored_resource_descriptors_list` | `EXEC` | `projectsId` | Lists monitored resource descriptors that match a filter. | diff --git a/docs/google-docs/providers/google/monitoring/notification_channel_descriptors/index.md b/docs/google-docs/providers/google/monitoring/notification_channel_descriptors/index.md index 171ce66caf..538985e448 100644 --- a/docs/google-docs/providers/google/monitoring/notification_channel_descriptors/index.md +++ b/docs/google-docs/providers/google/monitoring/notification_channel_descriptors/index.md @@ -27,10 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `channelDescriptors` | `array` | The monitored resource descriptors supported for the specified project, optionally filtered. | -| `nextPageToken` | `string` | If not empty, indicates that there may be more results that match the request. Use the value in the page_token field in a subsequent request to fetch the next set of results. If empty, all results have been returned. | +| `name` | `string` | The full REST resource name for this descriptor. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[TYPE] In the above, [TYPE] is the value of the type field. | +| `description` | `string` | A human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation. | +| `labels` | `array` | The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated. | +| `launchStage` | `string` | The product launch stage for channels of this type. | +| `supportedTiers` | `array` | The tiers that support this notification channel; the project service tier must be one of the supported_tiers. | +| `type` | `string` | The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors (https://cloud.google.com/monitoring/alerts/using-channels-api#ncd). Notification channel types are globally unique. | +| `displayName` | `string` | A human-readable name for the notification channel type. This form of the name is suitable for a user interface. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_notification_channel_descriptors_get` | `SELECT` | `notificationChannelDescriptorsId, projectsId` | Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type. | | `projects_notification_channel_descriptors_list` | `SELECT` | `projectsId` | Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added. | +| `_projects_notification_channel_descriptors_list` | `EXEC` | `projectsId` | Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added. | diff --git a/docs/google-docs/providers/google/monitoring/notification_channels/index.md b/docs/google-docs/providers/google/monitoring/notification_channels/index.md index 48a5aa5f7c..25ba13eec4 100644 --- a/docs/google-docs/providers/google/monitoring/notification_channels/index.md +++ b/docs/google-docs/providers/google/monitoring/notification_channels/index.md @@ -27,15 +27,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `notificationChannels` | `array` | The notification channels defined for the specified project. | -| `totalSize` | `integer` | The total number of notification channels in all pages. This number is only an estimate, and may change in subsequent pages. https://aip.dev/158 | -| `nextPageToken` | `string` | If not empty, indicates that there may be more results that match the request. Use the value in the page_token field in a subsequent request to fetch the next set of results. If empty, all results have been returned. | +| `name` | `string` | The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. | +| `description` | `string` | An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters. | +| `type` | `string` | The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. | +| `verificationStatus` | `string` | Indicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel. | +| `enabled` | `boolean` | Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future. | +| `mutationRecords` | `array` | Records of the modification of this channel. | +| `userLabels` | `object` | User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. | +| `creationRecord` | `object` | Describes a change made to a configuration. | +| `displayName` | `string` | An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters. | +| `labels` | `object` | Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_notification_channels_list` | `SELECT` | `projectsId` | Lists the notification channels that have been created for the project. To list the types of notification channels that are supported, use the ListNotificationChannelDescriptors method. | | `projects_notification_channels_create` | `INSERT` | `projectsId` | Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel. | | `projects_notification_channels_delete` | `DELETE` | `notificationChannelsId, projectsId` | Deletes a notification channel.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel. | +| `_projects_notification_channels_list` | `EXEC` | `projectsId` | Lists the notification channels that have been created for the project. To list the types of notification channels that are supported, use the ListNotificationChannelDescriptors method. | | `projects_notification_channels_get` | `EXEC` | `notificationChannelsId, projectsId` | Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method. | | `projects_notification_channels_patch` | `EXEC` | `notificationChannelsId, projectsId` | Updates a notification channel. Fields not specified in the field mask remain unchanged.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel. | | `projects_notification_channels_send_verification_code` | `EXEC` | `notificationChannelsId, projectsId` | Causes a verification code to be delivered to the channel. The code can then be supplied in VerifyNotificationChannel to verify the channel. | diff --git a/docs/google-docs/providers/google/monitoring/service_level_objectives/index.md b/docs/google-docs/providers/google/monitoring/service_level_objectives/index.md index 6a995e44eb..ed4d8487a8 100644 --- a/docs/google-docs/providers/google/monitoring/service_level_objectives/index.md +++ b/docs/google-docs/providers/google/monitoring/service_level_objectives/index.md @@ -27,13 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `serviceLevelObjectives` | `array` | The ServiceLevelObjectives matching the specified filter. | -| `nextPageToken` | `string` | If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. | +| `name` | `string` | Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] | +| `userLabels` | `object` | Labels which have been used to annotate the service-level objective. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value. | +| `calendarPeriod` | `string` | A calendar period, semantically "since the start of the current ". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported. | +| `displayName` | `string` | Name used for UI elements listing this SLO. | +| `goal` | `number` | The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999. | +| `rollingPeriod` | `string` | A rolling time period, semantically "in the past ". Must be an integer multiple of 1 day no larger than 30 days. | +| `serviceLevelIndicator` | `object` | A Service-Level Indicator (SLI) describes the "performance" of a service. For some services, the SLI is well-defined. In such cases, the SLI can be described easily by referencing the well-known SLI and providing the needed parameters. Alternatively, a "custom" SLI can be defined with a query to the underlying metric store. An SLI is defined to be good_service / total_service over any queried time interval. The value of performance always falls into the range 0 <= performance <= 1. A custom SLI describes how to compute this ratio, whether this is by dividing values from a pair of time series, cutting a Distribution into good and bad counts, or counting time windows in which the service complies with a criterion. For separation of concerns, a single Service-Level Indicator measures performance for only one aspect of service quality, such as fraction of successful queries or fast-enough queries. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `services_service_level_objectives_list` | `SELECT` | `parent` | List the ServiceLevelObjectives for the given Service. | | `services_service_level_objectives_create` | `INSERT` | `parent` | Create a ServiceLevelObjective for the given Service. | -| `services_service_level_objectives_delete` | `DELETE` | `name` | Delete the given ServiceLevelObjective. | -| `services_service_level_objectives_get` | `EXEC` | `name` | Get a ServiceLevelObjective by name. | -| `services_service_level_objectives_patch` | `EXEC` | `name` | Update the given ServiceLevelObjective. | +| `_services_service_level_objectives_list` | `EXEC` | `parent` | List the ServiceLevelObjectives for the given Service. | diff --git a/docs/google-docs/providers/google/monitoring/services/index.md b/docs/google-docs/providers/google/monitoring/services/index.md index 6a0bc37e98..dc601aab14 100644 --- a/docs/google-docs/providers/google/monitoring/services/index.md +++ b/docs/google-docs/providers/google/monitoring/services/index.md @@ -27,10 +27,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. | -| `services` | `array` | The Services matching the specified filter. | +| `name` | `string` | Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] | +| `appEngine` | `object` | App Engine service. Learn more at https://cloud.google.com/appengine. | +| `basicService` | `object` | A well-known service type, defined by its service type and service labels. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). | +| `displayName` | `string` | Name used for UI elements listing this Service. | +| `gkeWorkload` | `object` | A GKE Workload (Deployment, StatefulSet, etc). The field names correspond to the metadata labels on monitored resources that fall under a workload (for example, k8s_container or k8s_pod). | +| `gkeService` | `object` | GKE Service. The "service" here represents a Kubernetes service object (https://kubernetes.io/docs/concepts/services-networking/service). The field names correspond to the resource labels on k8s_service monitored resources (https://cloud.google.com/monitoring/api/resources#tag_k8s_service). | +| `userLabels` | `object` | Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value. | +| `istioCanonicalService` | `object` | Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type. | +| `telemetry` | `object` | Configuration for how to query telemetry on a Service. | +| `cloudEndpoints` | `object` | Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints. | +| `meshIstio` | `object` | Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type. | +| `custom` | `object` | Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service. | +| `cloudRun` | `object` | Cloud Run service. Learn more at https://cloud.google.com/run. | +| `clusterIstio` | `object` | Istio service scoped to a single Kubernetes cluster. Learn more at https://istio.io. Clusters running OSS Istio will have their services ingested as this type. | +| `gkeNamespace` | `object` | GKE Namespace. The field names correspond to the resource metadata labels on monitored resources that fall under a namespace (for example, k8s_container or k8s_pod). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `services_list` | `SELECT` | `parent` | List Services for this Metrics Scope. | | `services_create` | `INSERT` | `parent` | Create a Service. | +| `services_delete` | `DELETE` | `name` | Soft delete this Service. | +| `_services_list` | `EXEC` | `parent` | List Services for this Metrics Scope. | +| `services_get` | `EXEC` | `name` | Get the named Service. | +| `services_patch` | `EXEC` | `name` | Update this Service. | diff --git a/docs/google-docs/providers/google/monitoring/snoozes/index.md b/docs/google-docs/providers/google/monitoring/snoozes/index.md index 1db7ec54df..bc1c7791b6 100644 --- a/docs/google-docs/providers/google/monitoring/snoozes/index.md +++ b/docs/google-docs/providers/google/monitoring/snoozes/index.md @@ -27,12 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Page token for repeated calls to ListSnoozes, to fetch additional pages of results. If this is empty or missing, there are no more pages. | -| `snoozes` | `array` | Snoozes matching this list call. | +| `name` | `string` | Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. | +| `criteria` | `object` | Criteria specific to the AlertPolicys that this Snooze applies to. The Snooze will suppress alerts that come from one of the AlertPolicys whose names are supplied. | +| `displayName` | `string` | Required. A display name for the Snooze. This can be, at most, 512 unicode characters. | +| `interval` | `object` | Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time, and the end time must not be more than 25 hours in the past or more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_snoozes_get` | `SELECT` | `projectsId, snoozesId` | Retrieves a Snooze by name. | | `projects_snoozes_list` | `SELECT` | `projectsId` | Lists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes. | | `projects_snoozes_create` | `INSERT` | `projectsId` | Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened. The Snooze applies for a specific time interval. | +| `_projects_snoozes_list` | `EXEC` | `projectsId` | Lists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes. | | `projects_snoozes_patch` | `EXEC` | `projectsId, snoozesId` | Updates a Snooze, identified by its name, with the parameters in the given Snooze object. | diff --git a/docs/google-docs/providers/google/monitoring/time_series/index.md b/docs/google-docs/providers/google/monitoring/time_series/index.md index 82a31eb570..537fcb4602 100644 --- a/docs/google-docs/providers/google/monitoring/time_series/index.md +++ b/docs/google-docs/providers/google/monitoring/time_series/index.md @@ -27,10 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `timeSeries` | `array` | One or more time series that match the filter included in the request. | -| `unit` | `string` | The unit in which all time_series point values are reported. unit follows the UCUM format for units as seen in https://unitsofmeasure.org/ucum.html. If different time_series have different units (for example, because they come from different metric types, or a unit is absent), then unit will be "{not_a_unit}". | -| `executionErrors` | `array` | Query execution errors that may have caused the time series data returned to be incomplete. | -| `nextPageToken` | `string` | If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. | +| `metric` | `object` | A specific metric, identified by specifying values for all of the labels of a MetricDescriptor. | +| `metricKind` | `string` | The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE. | +| `points` | `array` | The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION. | +| `resource` | `object` | An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "project_id", "instance_id" and "zone": { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }} | +| `unit` | `string` | The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. | +| `valueType` | `string` | The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field. | +| `metadata` | `object` | Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,4 +41,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_time_series_list` | `SELECT` | `organizationsId` | Lists time series that match a filter. | | `projects_time_series_list` | `SELECT` | `projectsId` | Lists time series that match a filter. | | `projects_time_series_create` | `INSERT` | `projectsId` | Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response. | +| `_folders_time_series_list` | `EXEC` | `foldersId` | Lists time series that match a filter. | +| `_organizations_time_series_list` | `EXEC` | `organizationsId` | Lists time series that match a filter. | +| `_projects_time_series_list` | `EXEC` | `projectsId` | Lists time series that match a filter. | | `projects_time_series_query` | `EXEC` | `projectsId` | Queries time series using Monitoring Query Language. | diff --git a/docs/google-docs/providers/google/monitoring/uptime_check_configs/index.md b/docs/google-docs/providers/google/monitoring/uptime_check_configs/index.md index c96ffc5d3e..e014f78095 100644 --- a/docs/google-docs/providers/google/monitoring/uptime_check_configs/index.md +++ b/docs/google-docs/providers/google/monitoring/uptime_check_configs/index.md @@ -27,14 +27,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field). | -| `totalSize` | `integer` | The total number of Uptime check configurations for the project, irrespective of any pagination. | -| `uptimeCheckConfigs` | `array` | The returned Uptime check configurations. | +| `name` | `string` | A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response. | +| `isInternal` | `boolean` | If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false. | +| `syntheticMonitor` | `object` | Describes a Synthetic Monitor to be invoked by Uptime. | +| `checkerType` | `string` | The type of checkers to use to execute the Uptime check. | +| `timeout` | `string` | The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required. | +| `selectedRegions` | `array` | The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions. | +| `httpCheck` | `object` | Information involved in an HTTP/HTTPS Uptime check request. | +| `resourceGroup` | `object` | The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored. | +| `period` | `string` | How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s. | +| `contentMatchers` | `array` | The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check. | +| `tcpCheck` | `object` | Information required for a TCP Uptime check request. | +| `displayName` | `string` | A human-friendly name for the Uptime check configuration. The display name should be unique within a Cloud Monitoring Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required. | +| `userLabels` | `object` | User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. | +| `internalCheckers` | `array` | The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig. | +| `monitoredResource` | `object` | An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "project_id", "instance_id" and "zone": { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_uptime_check_configs_list` | `SELECT` | `projectsId` | Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations). | | `projects_uptime_check_configs_create` | `INSERT` | `projectsId` | Creates a new Uptime check configuration. | | `projects_uptime_check_configs_delete` | `DELETE` | `projectsId, uptimeCheckConfigsId` | Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion. | +| `_projects_uptime_check_configs_list` | `EXEC` | `projectsId` | Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations). | | `projects_uptime_check_configs_get` | `EXEC` | `projectsId, uptimeCheckConfigsId` | Gets a single Uptime check configuration. | | `projects_uptime_check_configs_patch` | `EXEC` | `projectsId, uptimeCheckConfigsId` | Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via updateMask. Returns the updated configuration. | diff --git a/docs/google-docs/providers/google/monitoring/uptime_check_ips/index.md b/docs/google-docs/providers/google/monitoring/uptime_check_ips/index.md index 52e66d3895..fbaafc48ae 100644 --- a/docs/google-docs/providers/google/monitoring/uptime_check_ips/index.md +++ b/docs/google-docs/providers/google/monitoring/uptime_check_ips/index.md @@ -27,9 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field). NOTE: this field is not yet implemented | -| `uptimeCheckIps` | `array` | The returned list of IP addresses (including region and location) that the checkers run from. | +| `ipAddress` | `string` | The IP address from which the Uptime check originates. This is a fully specified IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely, and should support interpreting this field in either IPv4 or IPv6 format. | +| `location` | `string` | A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category. | +| `region` | `string` | A broad region category in which the IP address is located. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `uptime_check_ips_list` | `SELECT` | | +| `_uptime_check_ips_list` | `EXEC` | | diff --git a/docs/google-docs/providers/google/networkconnectivity/groups/index.md b/docs/google-docs/providers/google/networkconnectivity/groups/index.md new file mode 100644 index 0000000000..d135752b4f --- /dev/null +++ b/docs/google-docs/providers/google/networkconnectivity/groups/index.md @@ -0,0 +1,42 @@ +--- +title: groups +hide_title: false +hide_table_of_contents: false +keywords: + - groups + - networkconnectivity + - 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 +--- + + + +## Overview + + + + +
Namegroups
TypeResource
Idgoogle.networkconnectivity.groups
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Immutable. The name of the group. Group names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub}/groups/{group_id}` | +| `description` | `string` | Optional. The description of the group. | +| `updateTime` | `string` | Output only. The time the group was last updated. | +| `createTime` | `string` | Output only. The time the group was created. | +| `labels` | `object` | Optional. Labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). | +| `state` | `string` | Output only. The current lifecycle state of this group. | +| `uid` | `string` | Output only. The Google-generated UUID for the group. This value is unique across all group resources. If a group is deleted and another with the same name is created, the new route table is assigned a different unique_id. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `groupsId, hubsId, projectsId` | Gets details about a Network Connectivity Center group. | +| `list` | `SELECT` | `hubsId, projectsId` | Lists groups in a given hub. | +| `_list` | `EXEC` | `hubsId, projectsId` | Lists groups in a given hub. | diff --git a/docs/google-docs/providers/google/networkconnectivity/groups_iam_policies/index.md b/docs/google-docs/providers/google/networkconnectivity/groups_iam_policies/index.md index 4602577601..4ff5c1052c 100644 --- a/docs/google-docs/providers/google/networkconnectivity/groups_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/groups_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/hubs/index.md b/docs/google-docs/providers/google/networkconnectivity/hubs/index.md index 6d82e1204f..805c769871 100644 --- a/docs/google-docs/providers/google/networkconnectivity/hubs/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/hubs/index.md @@ -27,9 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `hubs` | `array` | The requested hubs. | -| `nextPageToken` | `string` | The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | Immutable. The name of the hub. Hub names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}` | +| `description` | `string` | An optional description of the hub. | +| `routingVpcs` | `array` | The VPC networks associated with this hub's spokes. This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub. | +| `labels` | `object` | Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). | +| `routeTables` | `array` | Output only. The route tables that belong to this hub. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}` This field is read-only. Network Connectivity Center automatically populates it based on the route tables nested under the hub. | +| `state` | `string` | Output only. The current lifecycle state of this hub. | +| `uniqueId` | `string` | Output only. The Google-generated UUID for the hub. This value is unique across all hub resources. If a hub is deleted and another with the same name is created, the new hub is assigned a different unique_id. | +| `updateTime` | `string` | Output only. The time the hub was last updated. | +| `spokeSummary` | `object` | Summarizes information about the spokes associated with a hub. The summary includes a count of spokes according to type and according to state. If any spokes are inactive, the summary also lists the reasons they are inactive, including a count for each reason. | +| `createTime` | `string` | Output only. The time the hub was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId` | Lists the Network Connectivity Center hubs associated with a given project. | | `create` | `INSERT` | `projectsId` | Creates a new Network Connectivity Center hub in the specified project. | | `delete` | `DELETE` | `hubsId, projectsId` | Deletes a Network Connectivity Center hub. | +| `_list` | `EXEC` | `projectsId` | Lists the Network Connectivity Center hubs associated with a given project. | | `patch` | `EXEC` | `hubsId, projectsId` | Updates the description and/or labels of a Network Connectivity Center hub. | diff --git a/docs/google-docs/providers/google/networkconnectivity/index.md b/docs/google-docs/providers/google/networkconnectivity/index.md index 0386fed5aa..84adcaa280 100644 --- a/docs/google-docs/providers/google/networkconnectivity/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/index.md @@ -21,7 +21,7 @@ This API Enables Connectivity With And Between Google Cloud Resources.
total resources: 19
total selectable resources: 19
-total methods: 67
+total methods: 82
@@ -33,16 +33,16 @@ This API Enables Connectivity With And Between Google Cloud Resources. TypeService TitleNetwork Connectivity API DescriptionThis API Enables Connectivity With And Between Google Cloud Resources. -Idnetworkconnectivity:v23.08.00155 +Idnetworkconnectivity:v23.08.00157 ## Resources
+groups
groups_iam_policies
hubs
hubs_iam_policies
-hubs_spokes
internal_ranges
locations
operations
diff --git a/docs/google-docs/providers/google/networkconnectivity/internal_ranges/index.md b/docs/google-docs/providers/google/networkconnectivity/internal_ranges/index.md index 9b2ceee3a8..07c856c248 100644 --- a/docs/google-docs/providers/google/networkconnectivity/internal_ranges/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/internal_ranges/index.md @@ -27,9 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `internalRanges` | `array` | Internal ranges to be returned. | -| `nextPageToken` | `string` | The next pagination token in the List response. It should be used as page_token for the following request. An empty value means no more result. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names | +| `description` | `string` | A description of this resource. | +| `peering` | `string` | The type of peering set for this internal range. | +| `createTime` | `string` | Time when the internal range was created. | +| `ipCidrRange` | `string` | The IP range that this internal range defines. | +| `usage` | `string` | The type of usage set for this InternalRange. | +| `prefixLength` | `integer` | An alternate to ip_cidr_range. Can be set when trying to create a reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. | +| `users` | `array` | Output only. The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range referred to. Can be empty. | +| `updateTime` | `string` | Time when the internal range was updated. | +| `overlaps` | `array` | Optional. Types of resources that are allowed to overlap with the current internal range. | +| `labels` | `object` | User-defined labels. | +| `network` | `string` | The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. This can only be specified for a global internal address. Example: - URL: /compute/v1/projects/{project}/global/networks/{resourceId} - ID: network123 | +| `targetCidrRange` | `array` | Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +47,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists internal ranges in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new internal range in a given project and location. | | `delete` | `DELETE` | `internalRangesId, locationsId, projectsId` | Deletes a single internal range. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists internal ranges in a given project and location. | | `patch` | `EXEC` | `internalRangesId, locationsId, projectsId` | Updates the parameters of a single internal range. | diff --git a/docs/google-docs/providers/google/networkconnectivity/locations/index.md b/docs/google-docs/providers/google/networkconnectivity/locations/index.md index b0482b8c52..03b81eddb9 100644 --- a/docs/google-docs/providers/google/networkconnectivity/locations/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/networkconnectivity/operations/index.md b/docs/google-docs/providers/google/networkconnectivity/operations/index.md index 69034fa5fb..d2a1603f4a 100644 --- a/docs/google-docs/providers/google/networkconnectivity/operations/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/networkconnectivity/policy_based_routes_iam_policies/index.md b/docs/google-docs/providers/google/networkconnectivity/policy_based_routes_iam_policies/index.md index bf22063228..bf4eae2115 100644 --- a/docs/google-docs/providers/google/networkconnectivity/policy_based_routes_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/policy_based_routes_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/route_tables/index.md b/docs/google-docs/providers/google/networkconnectivity/route_tables/index.md index 8ae165a2d1..33731ce6d3 100644 --- a/docs/google-docs/providers/google/networkconnectivity/route_tables/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/route_tables/index.md @@ -27,11 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results. | -| `routeTables` | `array` | The requested route tables. | -| `unreachable` | `array` | Hubs that could not be reached. | +| `name` | `string` | Immutable. The name of the route table. Route table names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}` | +| `description` | `string` | An optional description of the route table. | +| `updateTime` | `string` | Output only. The time the route table was last updated. | +| `createTime` | `string` | Output only. The time the route table was created. | +| `labels` | `object` | Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). | +| `state` | `string` | Output only. The current lifecycle state of this route table. | +| `uid` | `string` | Output only. The Google-generated UUID for the route table. This value is unique across all route table resources. If a route table is deleted and another with the same name is created, the new route table is assigned a different `uid`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `hubsId, projectsId, routeTablesId` | Gets details about a Network Connectivity Center route table. | | `list` | `SELECT` | `hubsId, projectsId` | Lists route tables in a given project. | +| `_list` | `EXEC` | `hubsId, projectsId` | Lists route tables in a given project. | diff --git a/docs/google-docs/providers/google/networkconnectivity/routes/index.md b/docs/google-docs/providers/google/networkconnectivity/routes/index.md index 718851618f..9893fe2f1d 100644 --- a/docs/google-docs/providers/google/networkconnectivity/routes/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/routes/index.md @@ -27,11 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results. | -| `routes` | `array` | The requested routes. | -| `unreachable` | `array` | RouteTables that could not be reached. | +| `name` | `string` | Immutable. The name of the route. Route names must be unique. Route names use the following form: `projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}` | +| `description` | `string` | An optional description of the route. | +| `spoke` | `string` | Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE | +| `uid` | `string` | Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different `uid`. | +| `updateTime` | `string` | Output only. The time the route was last updated. | +| `nextHopVpcNetwork` | `object` | | +| `location` | `string` | Output only. The location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1 | +| `state` | `string` | Output only. The current lifecycle state of the route. | +| `type` | `string` | Output only. The route's type. Its type is determined by the properties of its IP address range. | +| `createTime` | `string` | Output only. The time the route was created. | +| `ipCidrRange` | `string` | The destination IP address range. | +| `labels` | `object` | Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `hubsId, projectsId, routeTablesId, routesId` | Gets details about the specified route. | | `list` | `SELECT` | `hubsId, projectsId, routeTablesId` | Lists routes in a given project. | +| `_list` | `EXEC` | `hubsId, projectsId, routeTablesId` | Lists routes in a given project. | diff --git a/docs/google-docs/providers/google/networkconnectivity/service_classes/index.md b/docs/google-docs/providers/google/networkconnectivity/service_classes/index.md index 4eb1e7ae5d..6de8748854 100644 --- a/docs/google-docs/providers/google/networkconnectivity/service_classes/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/service_classes/index.md @@ -27,13 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | The next pagination token in the List response. It should be used as page_token for the following request. An empty value means no more result. | -| `serviceClasses` | `array` | ServiceClasses to be returned. | +| `name` | `string` | Immutable. The name of a ServiceClass resource. Format: projects/{project}/locations/{location}/serviceClasses/{service_class} See: https://google.aip.dev/122#fields-representing-resource-names | +| `description` | `string` | A description of this resource. | +| `labels` | `object` | User-defined labels. | +| `serviceClass` | `string` | Output only. The generated service class name. Use this name to refer to the Service class in Service Connection Maps and Service Connection Policies. | +| `updateTime` | `string` | Output only. Time when the ServiceClass was updated. | +| `createTime` | `string` | Output only. Time when the ServiceClass was created. | +| `etag` | `string` | Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId, serviceClassesId` | Gets details of a single ServiceClass. | | `list` | `SELECT` | `locationsId, projectsId` | Lists ServiceClasses in a given project and location. | | `delete` | `DELETE` | `locationsId, projectsId, serviceClassesId` | Deletes a single ServiceClass. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists ServiceClasses in a given project and location. | | `patch` | `EXEC` | `locationsId, projectsId, serviceClassesId` | Updates the parameters of a single ServiceClass. | diff --git a/docs/google-docs/providers/google/networkconnectivity/service_connection_maps/index.md b/docs/google-docs/providers/google/networkconnectivity/service_connection_maps/index.md index 339af66763..b984ee8b25 100644 --- a/docs/google-docs/providers/google/networkconnectivity/service_connection_maps/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/service_connection_maps/index.md @@ -27,9 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | The next pagination token in the List response. It should be used as page_token for the following request. An empty value means no more result. | -| `serviceConnectionMaps` | `array` | ServiceConnectionMaps to be returned. | +| `name` | `string` | Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names | +| `description` | `string` | A description of this resource. | +| `consumerPscConfigs` | `array` | The PSC configurations on consumer side. | +| `infrastructure` | `string` | Output only. The infrastructure used for connections between consumers/producers. | +| `serviceClassUri` | `string` | Output only. The service class uri this ServiceConnectionMap is for. | +| `producerPscConfigs` | `array` | The PSC configurations on producer side. | +| `consumerPscConnections` | `array` | Output only. PSC connection details on consumer side. | +| `serviceClass` | `string` | The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnecitivty.serviceclasses.use iam permission for the service class. | +| `token` | `string` | The token provided by the consumer. This token authenticates that the consumer can create a connecton within the specified project and network. | +| `labels` | `object` | User-defined labels. | +| `updateTime` | `string` | Output only. Time when the ServiceConnectionMap was updated. | +| `createTime` | `string` | Output only. Time when the ServiceConnectionMap was created. | +| `etag` | `string` | Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +47,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists ServiceConnectionMaps in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new ServiceConnectionMap in a given project and location. | | `delete` | `DELETE` | `locationsId, projectsId, serviceConnectionMapsId` | Deletes a single ServiceConnectionMap. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists ServiceConnectionMaps in a given project and location. | | `patch` | `EXEC` | `locationsId, projectsId, serviceConnectionMapsId` | Updates the parameters of a single ServiceConnectionMap. | diff --git a/docs/google-docs/providers/google/networkconnectivity/service_connection_policies/index.md b/docs/google-docs/providers/google/networkconnectivity/service_connection_policies/index.md index 0dfc389ff7..6c9274f1b7 100644 --- a/docs/google-docs/providers/google/networkconnectivity/service_connection_policies/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/service_connection_policies/index.md @@ -27,9 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | The next pagination token in the List response. It should be used as page_token for the following request. An empty value means no more result. | -| `serviceConnectionPolicies` | `array` | ServiceConnectionPolicies to be returned. | +| `name` | `string` | Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names | +| `description` | `string` | A description of this resource. | +| `pscConnections` | `array` | Output only. [Output only] Information about each Private Service Connect connection. | +| `updateTime` | `string` | Output only. Time when the ServiceConnectionMap was updated. | +| `infrastructure` | `string` | Output only. The type of underlying resources used to create the connection. | +| `labels` | `object` | User-defined labels. | +| `pscConfig` | `object` | Configuration used for Private Service Connect connections. Used when Infrastructure is PSC. | +| `etag` | `string` | Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `createTime` | `string` | Output only. Time when the ServiceConnectionMap was created. | +| `serviceClass` | `string` | The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx. | +| `network` | `string` | The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +45,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists ServiceConnectionPolicies in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new ServiceConnectionPolicy in a given project and location. | | `delete` | `DELETE` | `locationsId, projectsId, serviceConnectionPoliciesId` | Deletes a single ServiceConnectionPolicy. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists ServiceConnectionPolicies in a given project and location. | | `patch` | `EXEC` | `locationsId, projectsId, serviceConnectionPoliciesId` | Updates the parameters of a single ServiceConnectionPolicy. | diff --git a/docs/google-docs/providers/google/networkconnectivity/service_connection_policies_iam_policies/index.md b/docs/google-docs/providers/google/networkconnectivity/service_connection_policies_iam_policies/index.md index 4f01009623..0854cd3dcc 100644 --- a/docs/google-docs/providers/google/networkconnectivity/service_connection_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/service_connection_policies_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/service_connection_tokens/index.md b/docs/google-docs/providers/google/networkconnectivity/service_connection_tokens/index.md index f5f3c6c130..767719fb18 100644 --- a/docs/google-docs/providers/google/networkconnectivity/service_connection_tokens/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/service_connection_tokens/index.md @@ -27,9 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `serviceConnectionTokens` | `array` | ServiceConnectionTokens to be returned. | -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | The next pagination token in the List response. It should be used as page_token for the following request. An empty value means no more result. | +| `name` | `string` | Immutable. The name of a ServiceConnectionToken. Format: projects/{project}/locations/{location}/ServiceConnectionTokens/{service_connection_token} See: https://google.aip.dev/122#fields-representing-resource-names | +| `description` | `string` | A description of this resource. | +| `token` | `string` | Output only. The token generated by Automation. | +| `network` | `string` | The resource path of the network associated with this token. Example: projects/{projectNumOrId}/global/networks/{resourceId}. | +| `updateTime` | `string` | Output only. Time when the ServiceConnectionToken was updated. | +| `etag` | `string` | Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `expireTime` | `string` | Output only. The time to which this token is valid. | +| `createTime` | `string` | Output only. Time when the ServiceConnectionToken was created. | +| `labels` | `object` | User-defined labels. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,3 +43,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists ServiceConnectionTokens in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new ServiceConnectionToken in a given project and location. | | `delete` | `DELETE` | `locationsId, projectsId, serviceConnectionTokensId` | Deletes a single ServiceConnectionToken. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists ServiceConnectionTokens in a given project and location. | diff --git a/docs/google-docs/providers/google/networkconnectivity/spokes/index.md b/docs/google-docs/providers/google/networkconnectivity/spokes/index.md index 305c04acde..48aa1f8179 100644 --- a/docs/google-docs/providers/google/networkconnectivity/spokes/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/spokes/index.md @@ -27,16 +27,31 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `spokes` | `array` | The requested spokes. | -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results. | +| `name` | `string` | Immutable. The name of the spoke. Spoke names must be unique. They use the following form: `projects/{project_number}/locations/{region}/spokes/{spoke_id}` | +| `description` | `string` | An optional description of the spoke. | +| `createTime` | `string` | Output only. The time the spoke was created. | +| `hub` | `string` | Immutable. The name of the hub that this spoke is attached to. | +| `labels` | `object` | Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). | +| `linkedVpcNetwork` | `object` | An existing VPC network. | +| `uniqueId` | `string` | Output only. The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different `unique_id`. | +| `group` | `string` | The name of the group that this spoke is associated with. | +| `linkedInterconnectAttachments` | `object` | A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. | +| `linkedVpnTunnels` | `object` | A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. | +| `state` | `string` | Output only. The current lifecycle state of this spoke. | +| `reasons` | `array` | Output only. The reasons for current state of the spoke. Only present when the spoke is in the `INACTIVE` state. | +| `spokeType` | `string` | Output only. The type of resource associated with the spoke. | +| `updateTime` | `string` | Output only. The time the spoke was last updated. | +| `linkedRouterApplianceInstances` | `object` | A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId, spokesId` | Gets details about a Network Connectivity Center spoke. | | `list` | `SELECT` | `locationsId, projectsId` | Lists the Network Connectivity Center spokes in a specified project and location. | +| `list_spokes` | `SELECT` | `hubsId, projectsId` | Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a Network Connectivity Center spoke. | | `delete` | `DELETE` | `locationsId, projectsId, spokesId` | Deletes a Network Connectivity Center spoke. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists the Network Connectivity Center spokes in a specified project and location. | +| `_list_spokes` | `EXEC` | `hubsId, projectsId` | Lists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and spokes that have been proposed but not yet accepted. | | `accept` | `EXEC` | `locationsId, projectsId, spokesId` | Accepts a proposal to attach a Network Connectivity Center spoke to the hub. | | `patch` | `EXEC` | `locationsId, projectsId, spokesId` | Updates the parameters of a Network Connectivity Center spoke. | | `reject` | `EXEC` | `locationsId, projectsId, spokesId` | Rejects a Network Connectivity Center spoke from being attached to the hub. If the spoke was previously in the `ACTIVE` state, it transitions to the `INACTIVE` state and is no longer able to connect to other spokes that are attached to the hub. | diff --git a/docs/google-docs/providers/google/networkconnectivity/spokes_iam_policies/index.md b/docs/google-docs/providers/google/networkconnectivity/spokes_iam_policies/index.md index bb9cbe4018..cce5ff5c8c 100644 --- a/docs/google-docs/providers/google/networkconnectivity/spokes_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/spokes_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkmanagement/connectivity_tests/index.md b/docs/google-docs/providers/google/networkmanagement/connectivity_tests/index.md index 4e2953a85f..2cd4b22def 100644 --- a/docs/google-docs/providers/google/networkmanagement/connectivity_tests/index.md +++ b/docs/google-docs/providers/google/networkmanagement/connectivity_tests/index.md @@ -27,9 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `resources` | `array` | List of Connectivity Tests. | -| `unreachable` | `array` | Locations that could not be reached (when querying all locations with `-`). | -| `nextPageToken` | `string` | Page token to fetch the next set of Connectivity Tests. | +| `name` | `string` | Required. Unique name of the resource using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}` | +| `description` | `string` | The user-supplied description of the Connectivity Test. Maximum of 512 characters. | +| `createTime` | `string` | Output only. The time the test was created. | +| `destination` | `object` | Source or destination of the Connectivity Test. | +| `labels` | `object` | Resource labels to represent user-provided metadata. | +| `source` | `object` | Source or destination of the Connectivity Test. | +| `updateTime` | `string` | Output only. The time the test's configuration was updated. | +| `displayName` | `string` | Output only. The display name of a Connectivity Test. | +| `reachabilityDetails` | `object` | Results of the configuration analysis from the last run of the test. | +| `protocol` | `string` | IP Protocol of the test. When not provided, "TCP" is assumed. | +| `relatedProjects` | `array` | Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,5 +45,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId` | Lists all Connectivity Tests owned by a project. | | `create` | `INSERT` | `projectsId` | Creates a new Connectivity Test. After you create a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. If the endpoint specifications in `ConnectivityTest` are invalid (for example, containing non-existent resources in the network, or you don't have read permissions to the network configurations of listed projects), then the reachability result returns a value of `UNKNOWN`. If the endpoint specifications in `ConnectivityTest` are incomplete, the reachability result returns a value of AMBIGUOUS. For more information, see the Connectivity Test documentation. | | `delete` | `DELETE` | `connectivityTestsId, projectsId` | Deletes a specific `ConnectivityTest`. | +| `_list` | `EXEC` | `projectsId` | Lists all Connectivity Tests owned by a project. | | `patch` | `EXEC` | `connectivityTestsId, projectsId` | Updates the configuration of an existing `ConnectivityTest`. After you update a test, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. The Reachability state in the test resource is updated with the new result. If the endpoint specifications in `ConnectivityTest` are invalid (for example, they contain non-existent resources in the network, or the user does not have read permissions to the network configurations of listed projects), then the reachability result returns a value of UNKNOWN. If the endpoint specifications in `ConnectivityTest` are incomplete, the reachability result returns a value of `AMBIGUOUS`. See the documentation in `ConnectivityTest` for for more details. | | `rerun` | `EXEC` | `connectivityTestsId, projectsId` | Rerun an existing `ConnectivityTest`. After the user triggers the rerun, the reachability analysis is performed as part of the long running operation, which completes when the analysis completes. Even though the test configuration remains the same, the reachability result may change due to underlying network configuration changes. If the endpoint specifications in `ConnectivityTest` become invalid (for example, specified resources are deleted in the network, or you lost read permissions to the network configurations of listed projects), then the reachability result returns a value of `UNKNOWN`. | diff --git a/docs/google-docs/providers/google/networkmanagement/connectivity_tests_iam_policies/index.md b/docs/google-docs/providers/google/networkmanagement/connectivity_tests_iam_policies/index.md index 87012c7d14..96ce0e482b 100644 --- a/docs/google-docs/providers/google/networkmanagement/connectivity_tests_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkmanagement/connectivity_tests_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkmanagement/index.md b/docs/google-docs/providers/google/networkmanagement/index.md index 3c75e828ad..6505991256 100644 --- a/docs/google-docs/providers/google/networkmanagement/index.md +++ b/docs/google-docs/providers/google/networkmanagement/index.md @@ -21,7 +21,7 @@ The Network Management API Provides A Collection Of Network Performance Monitori
total resources: 4
total selectable resources: 4
-total methods: 15
+total methods: 18
@@ -33,7 +33,7 @@ The Network Management API Provides A Collection Of Network Performance Monitori TypeService TitleNetwork Management API DescriptionThe Network Management API Provides A Collection Of Network Performance Monitoring And Diagnostic Capabilities. -Idnetworkmanagement:v23.08.00155 +Idnetworkmanagement:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/networkmanagement/locations/index.md b/docs/google-docs/providers/google/networkmanagement/locations/index.md index 8cf5e99fa6..45d3b8f13a 100644 --- a/docs/google-docs/providers/google/networkmanagement/locations/index.md +++ b/docs/google-docs/providers/google/networkmanagement/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/networkmanagement/operations/index.md b/docs/google-docs/providers/google/networkmanagement/operations/index.md index e2d38459b2..789f827086 100644 --- a/docs/google-docs/providers/google/networkmanagement/operations/index.md +++ b/docs/google-docs/providers/google/networkmanagement/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operationsId, projectsId` | 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. | | `list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/networksecurity/address_groups/index.md b/docs/google-docs/providers/google/networksecurity/address_groups/index.md index 61a4d13bc6..4bdbc82c41 100644 --- a/docs/google-docs/providers/google/networksecurity/address_groups/index.md +++ b/docs/google-docs/providers/google/networksecurity/address_groups/index.md @@ -27,8 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `addressGroups` | `array` | List of AddressGroups resources. | -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | +| `name` | `string` | Required. Name of the AddressGroup resource. It matches pattern `projects/*/locations/{location}/addressGroups/`. | +| `description` | `string` | Optional. Free-text description of the resource. | +| `labels` | `object` | Optional. Set of label tags associated with the AddressGroup resource. | +| `capacity` | `integer` | Required. Capacity of the Address Group | +| `selfLink` | `string` | Output only. Server-defined fully-qualified URL for this resource. | +| `items` | `array` | Optional. List of items. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `type` | `string` | Required. The type of the Address Group. Possible values are "IPv4" or "IPV6". | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,6 +45,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_address_groups_create` | `INSERT` | `locationsId, projectsId` | Creates a new address group in a given project and location. | | `organizations_locations_address_groups_delete` | `DELETE` | `addressGroupsId, locationsId, organizationsId` | Deletes an address group. | | `projects_locations_address_groups_delete` | `DELETE` | `addressGroupsId, locationsId, projectsId` | Deletes a single address group. | +| `_organizations_locations_address_groups_list` | `EXEC` | `locationsId, organizationsId` | Lists address groups in a given project and location. | +| `_projects_locations_address_groups_list` | `EXEC` | `locationsId, projectsId` | Lists address groups in a given project and location. | | `organizations_locations_address_groups_clone_items` | `EXEC` | `addressGroupsId, locationsId, organizationsId` | Clones items from one address group to another. | | `organizations_locations_address_groups_get` | `EXEC` | `addressGroupsId, locationsId, organizationsId` | Gets details of a single address group. | | `organizations_locations_address_groups_patch` | `EXEC` | `addressGroupsId, locationsId, organizationsId` | Updates parameters of an address group. | diff --git a/docs/google-docs/providers/google/networksecurity/address_groups_iam_policies/index.md b/docs/google-docs/providers/google/networksecurity/address_groups_iam_policies/index.md index 8262dec1f9..8ec56b910e 100644 --- a/docs/google-docs/providers/google/networksecurity/address_groups_iam_policies/index.md +++ b/docs/google-docs/providers/google/networksecurity/address_groups_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networksecurity/address_groups_references/index.md b/docs/google-docs/providers/google/networksecurity/address_groups_references/index.md index 106867fe21..11e5a00bb4 100644 --- a/docs/google-docs/providers/google/networksecurity/address_groups_references/index.md +++ b/docs/google-docs/providers/google/networksecurity/address_groups_references/index.md @@ -27,10 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | -| `addressGroupReferences` | `array` | A list of references that matches the specified filter in the request. | +| `firewallPolicy` | `string` | FirewallPolicy that is using the Address Group. | +| `rulePriority` | `integer` | Rule priority of the FirewallPolicy that is using the Address Group. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `organizations_locations_address_groups_list_references` | `SELECT` | `addressGroupsId, locationsId, organizationsId` | | `projects_locations_address_groups_list_references` | `SELECT` | `addressGroupsId, locationsId, projectsId` | +| `_organizations_locations_address_groups_list_references` | `EXEC` | `addressGroupsId, locationsId, organizationsId` | +| `_projects_locations_address_groups_list_references` | `EXEC` | `addressGroupsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/networksecurity/authorization_policies/index.md b/docs/google-docs/providers/google/networksecurity/authorization_policies/index.md index be33e8d9cb..80fb53b254 100644 --- a/docs/google-docs/providers/google/networksecurity/authorization_policies/index.md +++ b/docs/google-docs/providers/google/networksecurity/authorization_policies/index.md @@ -27,13 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | -| `authorizationPolicies` | `array` | List of AuthorizationPolicies resources. | +| `name` | `string` | Required. Name of the AuthorizationPolicy resource. It matches pattern `projects/{project}/locations/{location}/authorizationPolicies/`. | +| `description` | `string` | Optional. Free-text description of the resource. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `labels` | `object` | Optional. Set of label tags associated with the AuthorizationPolicy resource. | +| `rules` | `array` | Optional. List of rules to match. Note that at least one of the rules must match in order for the action specified in the 'action' field to be taken. A rule is a match if there is a matching source and destination. If left blank, the action specified in the `action` field will be applied on every request. | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | +| `action` | `string` | Required. The action to take when a rule match is found. Possible values are "ALLOW" or "DENY". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_authorization_policies_list` | `SELECT` | `locationsId, projectsId` | Lists AuthorizationPolicies in a given project and location. | | `projects_locations_authorization_policies_create` | `INSERT` | `locationsId, projectsId` | Creates a new AuthorizationPolicy in a given project and location. | | `projects_locations_authorization_policies_delete` | `DELETE` | `authorizationPoliciesId, locationsId, projectsId` | Deletes a single AuthorizationPolicy. | +| `_projects_locations_authorization_policies_list` | `EXEC` | `locationsId, projectsId` | Lists AuthorizationPolicies in a given project and location. | | `projects_locations_authorization_policies_get` | `EXEC` | `authorizationPoliciesId, locationsId, projectsId` | Gets details of a single AuthorizationPolicy. | | `projects_locations_authorization_policies_patch` | `EXEC` | `authorizationPoliciesId, locationsId, projectsId` | Updates the parameters of a single AuthorizationPolicy. | diff --git a/docs/google-docs/providers/google/networksecurity/client_tls_policies/index.md b/docs/google-docs/providers/google/networksecurity/client_tls_policies/index.md index f07b2556f4..02740a7c8a 100644 --- a/docs/google-docs/providers/google/networksecurity/client_tls_policies/index.md +++ b/docs/google-docs/providers/google/networksecurity/client_tls_policies/index.md @@ -27,13 +27,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | -| `clientTlsPolicies` | `array` | List of ClientTlsPolicy resources. | +| `name` | `string` | Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}` | +| `description` | `string` | Optional. Free-text description of the resource. | +| `labels` | `object` | Optional. Set of label tags associated with the resource. | +| `serverValidationCa` | `array` | Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. | +| `sni` | `string` | Optional. Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com". | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | +| `clientCertificate` | `object` | Specification of certificate provider. Defines the mechanism to obtain the certificate and private key for peer to peer authentication. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_client_tls_policies_list` | `SELECT` | `locationsId, projectsId` | Lists ClientTlsPolicies in a given project and location. | | `projects_locations_client_tls_policies_create` | `INSERT` | `locationsId, projectsId` | Creates a new ClientTlsPolicy in a given project and location. | | `projects_locations_client_tls_policies_delete` | `DELETE` | `clientTlsPoliciesId, locationsId, projectsId` | Deletes a single ClientTlsPolicy. | +| `_projects_locations_client_tls_policies_list` | `EXEC` | `locationsId, projectsId` | Lists ClientTlsPolicies in a given project and location. | | `projects_locations_client_tls_policies_get` | `EXEC` | `clientTlsPoliciesId, locationsId, projectsId` | Gets details of a single ClientTlsPolicy. | | `projects_locations_client_tls_policies_patch` | `EXEC` | `clientTlsPoliciesId, locationsId, projectsId` | Updates the parameters of a single ClientTlsPolicy. | diff --git a/docs/google-docs/providers/google/networksecurity/gateway_security_policies/index.md b/docs/google-docs/providers/google/networksecurity/gateway_security_policies/index.md index 332398842d..a27e051d96 100644 --- a/docs/google-docs/providers/google/networksecurity/gateway_security_policies/index.md +++ b/docs/google-docs/providers/google/networksecurity/gateway_security_policies/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the resource. Name is of the form projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy} gateway_security_policy should match the pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). | | `description` | `string` | Optional. Free-text description of the resource. | -| `tlsInspectionPolicy` | `string` | Optional. Name of a TLS Inspection Policy resource that defines how TLS inspection will be performed for any rule(s) which enables it. | | `updateTime` | `string` | Output only. The timestamp when the resource was updated. | | `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `tlsInspectionPolicy` | `string` | Optional. Name of a TLS Inspection Policy resource that defines how TLS inspection will be performed for any rule(s) which enables it. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -39,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_gateway_security_policies_list` | `SELECT` | `locationsId, projectsId` | Lists GatewaySecurityPolicies in a given project and location. | | `projects_locations_gateway_security_policies_create` | `INSERT` | `locationsId, projectsId` | Creates a new GatewaySecurityPolicy in a given project and location. | | `projects_locations_gateway_security_policies_delete` | `DELETE` | `gatewaySecurityPoliciesId, locationsId, projectsId` | Deletes a single GatewaySecurityPolicy. | +| `_projects_locations_gateway_security_policies_list` | `EXEC` | `locationsId, projectsId` | Lists GatewaySecurityPolicies in a given project and location. | | `projects_locations_gateway_security_policies_patch` | `EXEC` | `gatewaySecurityPoliciesId, locationsId, projectsId` | Updates the parameters of a single GatewaySecurityPolicy. | diff --git a/docs/google-docs/providers/google/networksecurity/index.md b/docs/google-docs/providers/google/networksecurity/index.md index 86cf433dbe..2662053d3e 100644 --- a/docs/google-docs/providers/google/networksecurity/index.md +++ b/docs/google-docs/providers/google/networksecurity/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 16
total selectable resources: 15
-total methods: 75
+total methods: 89
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleNetwork Security API Description -Idnetworksecurity:v23.08.00155 +Idnetworksecurity:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/networksecurity/locations/index.md b/docs/google-docs/providers/google/networksecurity/locations/index.md index 9238bb6000..05fc8cc4ad 100644 --- a/docs/google-docs/providers/google/networksecurity/locations/index.md +++ b/docs/google-docs/providers/google/networksecurity/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `locations` | `array` | A list of locations that matches the specified filter in the request. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/networksecurity/operations/index.md b/docs/google-docs/providers/google/networksecurity/operations/index.md index 14a968d7ff..d3809231c7 100644 --- a/docs/google-docs/providers/google/networksecurity/operations/index.md +++ b/docs/google-docs/providers/google/networksecurity/operations/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +39,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `organizations_locations_operations_delete` | `DELETE` | `locationsId, operationsId, organizationsId` | 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`. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_organizations_locations_operations_list` | `EXEC` | `locationsId, organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `organizations_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, organizationsId` | 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`. | | `organizations_locations_operations_get` | `EXEC` | `locationsId, operationsId, organizationsId` | 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. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/networksecurity/rules/index.md b/docs/google-docs/providers/google/networksecurity/rules/index.md index 1330d401a9..d0d56d79f5 100644 --- a/docs/google-docs/providers/google/networksecurity/rules/index.md +++ b/docs/google-docs/providers/google/networksecurity/rules/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Immutable. Name of the resource. ame is the full resource name so projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}/rules/{rule} rule should match the pattern: (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). | | `description` | `string` | Optional. Free-text description of the resource. | -| `createTime` | `string` | Output only. Time when the rule was created. | | `sessionMatcher` | `string` | Required. CEL expression for matching on session criteria. | +| `createTime` | `string` | Output only. Time when the rule was created. | +| `tlsInspectionEnabled` | `boolean` | Optional. Flag to enable TLS inspection of traffic matching on , can only be true if the parent GatewaySecurityPolicy references a TLSInspectionConfig. | | `basicProfile` | `string` | Required. Profile which tells what the primitive action should be. | -| `enabled` | `boolean` | Required. Whether the rule is enforced. | | `updateTime` | `string` | Output only. Time when the rule was updated. | -| `tlsInspectionEnabled` | `boolean` | Optional. Flag to enable TLS inspection of traffic matching on , can only be true if the parent GatewaySecurityPolicy references a TLSInspectionConfig. | -| `applicationMatcher` | `string` | Optional. CEL expression for matching on L7/application level criteria. | | `priority` | `integer` | Required. Priority of the rule. Lower number corresponds to higher precedence. | +| `applicationMatcher` | `string` | Optional. CEL expression for matching on L7/application level criteria. | +| `enabled` | `boolean` | Required. Whether the rule is enforced. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,4 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_gateway_security_policies_rules_list` | `SELECT` | `gatewaySecurityPoliciesId, locationsId, projectsId` | Lists GatewaySecurityPolicyRules in a given project and location. | | `projects_locations_gateway_security_policies_rules_create` | `INSERT` | `gatewaySecurityPoliciesId, locationsId, projectsId` | Creates a new GatewaySecurityPolicy in a given project and location. | | `projects_locations_gateway_security_policies_rules_delete` | `DELETE` | `gatewaySecurityPoliciesId, locationsId, projectsId, rulesId` | Deletes a single GatewaySecurityPolicyRule. | +| `_projects_locations_gateway_security_policies_rules_list` | `EXEC` | `gatewaySecurityPoliciesId, locationsId, projectsId` | Lists GatewaySecurityPolicyRules in a given project and location. | | `projects_locations_gateway_security_policies_rules_patch` | `EXEC` | `gatewaySecurityPoliciesId, locationsId, projectsId, rulesId` | Updates the parameters of a single GatewaySecurityPolicyRule. | diff --git a/docs/google-docs/providers/google/networksecurity/server_tls_policies/index.md b/docs/google-docs/providers/google/networksecurity/server_tls_policies/index.md index 8a45c97351..7335393a11 100644 --- a/docs/google-docs/providers/google/networksecurity/server_tls_policies/index.md +++ b/docs/google-docs/providers/google/networksecurity/server_tls_policies/index.md @@ -27,13 +27,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | -| `serverTlsPolicies` | `array` | List of ServerTlsPolicy resources. | +| `name` | `string` | Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}` | +| `description` | `string` | Free-text description of the resource. | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | +| `allowOpen` | `boolean` | This field applies only for Traffic Director policies. It is must be set to false for external HTTPS load balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `labels` | `object` | Set of label tags associated with the resource. | +| `mtlsPolicy` | `object` | Specification of the MTLSPolicy. | +| `serverCertificate` | `object` | Specification of certificate provider. Defines the mechanism to obtain the certificate and private key for peer to peer authentication. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_server_tls_policies_list` | `SELECT` | `locationsId, projectsId` | Lists ServerTlsPolicies in a given project and location. | | `projects_locations_server_tls_policies_create` | `INSERT` | `locationsId, projectsId` | Creates a new ServerTlsPolicy in a given project and location. | | `projects_locations_server_tls_policies_delete` | `DELETE` | `locationsId, projectsId, serverTlsPoliciesId` | Deletes a single ServerTlsPolicy. | +| `_projects_locations_server_tls_policies_list` | `EXEC` | `locationsId, projectsId` | Lists ServerTlsPolicies in a given project and location. | | `projects_locations_server_tls_policies_get` | `EXEC` | `locationsId, projectsId, serverTlsPoliciesId` | Gets details of a single ServerTlsPolicy. | | `projects_locations_server_tls_policies_patch` | `EXEC` | `locationsId, projectsId, serverTlsPoliciesId` | Updates the parameters of a single ServerTlsPolicy. | diff --git a/docs/google-docs/providers/google/networksecurity/tls_inspection_policies/index.md b/docs/google-docs/providers/google/networksecurity/tls_inspection_policies/index.md index a40566e284..6e03703f0b 100644 --- a/docs/google-docs/providers/google/networksecurity/tls_inspection_policies/index.md +++ b/docs/google-docs/providers/google/networksecurity/tls_inspection_policies/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the resource. Name is of the form projects/{project}/locations/{location}/tlsInspectionPolicies/{tls_inspection_policy} tls_inspection_policy should match the pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). | | `description` | `string` | Optional. Free-text description of the resource. | -| `createTime` | `string` | Output only. The timestamp when the resource was created. | -| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | +| `excludePublicCaSet` | `boolean` | Optional. If FALSE (the default), use our default set of public CAs in addition to any CAs specified in trust_config. These public CAs are currently based on the Mozilla Root Program and are subject to change over time. If TRUE, do not accept our default set of public CAs. Only CAs specified in trust_config will be accepted. This defaults to FALSE (use public CAs in addition to trust_config) for backwards compatibility, but trusting public root CAs is *not recommended* unless the traffic in question is outbound to public web servers. When possible, prefer setting this to "false" and explicitly specifying trusted CAs and certificates in a TrustConfig. Note that Secure Web Proxy does not yet honor this field. | | `minTlsVersion` | `string` | Optional. Minimum TLS version that the firewall should use when negotiating connections with both clients and servers. If this is not set, then the default value is to allow the broadest set of clients and servers (TLS 1.0 or higher). Setting this to more restrictive values may improve security, but may also prevent the firewall from connecting to some clients or servers. Note that Secure Web Proxy does not yet honor this field. | -| `trustConfig` | `string` | Optional. A TrustConfig resource used when making a connection to the TLS server. This is a relative resource path following the form "projects/{project}/locations/{location}/trustConfigs/{trust_config}". This is necessary to intercept TLS connections to servers with certificates signed by a private CA or self-signed certificates. Note that Secure Web Proxy does not yet honor this field. | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | | `tlsFeatureProfile` | `string` | Optional. The selected Profile. If this is not set, then the default value is to allow the broadest set of clients and servers ("PROFILE_COMPATIBLE"). Setting this to more restrictive values may improve security, but may also prevent the TLS inspection proxy from connecting to some clients or servers. Note that Secure Web Proxy does not yet honor this field. | -| `caPool` | `string` | Required. A CA pool resource used to issue interception certificates. The CA pool string has a relative resource path following the form "projects/{project}/locations/{location}/caPools/{ca_pool}". | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | | `customTlsFeatures` | `array` | Optional. List of custom TLS cipher suites selected. This field is valid only if the selected tls_feature_profile is CUSTOM. The compute.SslPoliciesService.ListAvailableFeatures method returns the set of features that can be specified in this list. Note that Secure Web Proxy does not yet honor this field. | -| `excludePublicCaSet` | `boolean` | Optional. If FALSE (the default), use our default set of public CAs in addition to any CAs specified in trust_config. These public CAs are currently based on the Mozilla Root Program and are subject to change over time. If TRUE, do not accept our default set of public CAs. Only CAs specified in trust_config will be accepted. This defaults to FALSE (use public CAs in addition to trust_config) for backwards compatibility, but trusting public root CAs is *not recommended* unless the traffic in question is outbound to public web servers. When possible, prefer setting this to "false" and explicitly specifying trusted CAs and certificates in a TrustConfig. Note that Secure Web Proxy does not yet honor this field. | +| `trustConfig` | `string` | Optional. A TrustConfig resource used when making a connection to the TLS server. This is a relative resource path following the form "projects/{project}/locations/{location}/trustConfigs/{trust_config}". This is necessary to intercept TLS connections to servers with certificates signed by a private CA or self-signed certificates. Note that Secure Web Proxy does not yet honor this field. | +| `caPool` | `string` | Required. A CA pool resource used to issue interception certificates. The CA pool string has a relative resource path following the form "projects/{project}/locations/{location}/caPools/{ca_pool}". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,4 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_tls_inspection_policies_list` | `SELECT` | `locationsId, projectsId` | Lists TlsInspectionPolicies in a given project and location. | | `projects_locations_tls_inspection_policies_create` | `INSERT` | `locationsId, projectsId` | Creates a new TlsInspectionPolicy in a given project and location. | | `projects_locations_tls_inspection_policies_delete` | `DELETE` | `locationsId, projectsId, tlsInspectionPoliciesId` | Deletes a single TlsInspectionPolicy. | +| `_projects_locations_tls_inspection_policies_list` | `EXEC` | `locationsId, projectsId` | Lists TlsInspectionPolicies in a given project and location. | | `projects_locations_tls_inspection_policies_patch` | `EXEC` | `locationsId, projectsId, tlsInspectionPoliciesId` | Updates the parameters of a single TlsInspectionPolicy. | diff --git a/docs/google-docs/providers/google/networksecurity/url_lists/index.md b/docs/google-docs/providers/google/networksecurity/url_lists/index.md index 0b46086e31..bf68ea22a2 100644 --- a/docs/google-docs/providers/google/networksecurity/url_lists/index.md +++ b/docs/google-docs/providers/google/networksecurity/url_lists/index.md @@ -39,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_url_lists_list` | `SELECT` | `locationsId, projectsId` | Lists UrlLists in a given project and location. | | `projects_locations_url_lists_create` | `INSERT` | `locationsId, projectsId` | Creates a new UrlList in a given project and location. | | `projects_locations_url_lists_delete` | `DELETE` | `locationsId, projectsId, urlListsId` | Deletes a single UrlList. | +| `_projects_locations_url_lists_list` | `EXEC` | `locationsId, projectsId` | Lists UrlLists in a given project and location. | | `projects_locations_url_lists_patch` | `EXEC` | `locationsId, projectsId, urlListsId` | Updates the parameters of a single UrlList. | diff --git a/docs/google-docs/providers/google/networkservices/edge_cache_keysets_iam_policies/index.md b/docs/google-docs/providers/google/networkservices/edge_cache_keysets_iam_policies/index.md index bae24cdec1..9768f3fdc5 100644 --- a/docs/google-docs/providers/google/networkservices/edge_cache_keysets_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkservices/edge_cache_keysets_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/edge_cache_origins_iam_policies/index.md b/docs/google-docs/providers/google/networkservices/edge_cache_origins_iam_policies/index.md index 9c57477a3d..2f50471612 100644 --- a/docs/google-docs/providers/google/networkservices/edge_cache_origins_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkservices/edge_cache_origins_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/edge_cache_services_iam_policies/index.md b/docs/google-docs/providers/google/networkservices/edge_cache_services_iam_policies/index.md index 2c585263d4..39bdb750f0 100644 --- a/docs/google-docs/providers/google/networkservices/edge_cache_services_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkservices/edge_cache_services_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/endpoint_policies/index.md b/docs/google-docs/providers/google/networkservices/endpoint_policies/index.md index 1bf643ddb5..01b3e68db0 100644 --- a/docs/google-docs/providers/google/networkservices/endpoint_policies/index.md +++ b/docs/google-docs/providers/google/networkservices/endpoint_policies/index.md @@ -27,8 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `endpointPolicies` | `array` | List of EndpointPolicy resources. | -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | +| `name` | `string` | Required. Name of the EndpointPolicy resource. It matches pattern `projects/{project}/locations/global/endpointPolicies/{endpoint_policy}`. | +| `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | +| `trafficPortSelector` | `object` | Specification of a port-based selector. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `serverTlsPolicy` | `string` | Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. If this field is not set, authentication is disabled(open) for this endpoint. | +| `labels` | `object` | Optional. Set of label tags associated with the EndpointPolicy resource. | +| `authorizationPolicy` | `string` | Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint. | +| `clientTlsPolicy` | `string` | Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. | +| `type` | `string` | Required. The type of endpoint policy. This is primarily used to validate the configuration. | +| `endpointMatcher` | `object` | A definition of a matcher that selects endpoints to which the policies should be applied. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +45,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists EndpointPolicies in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new EndpointPolicy in a given project and location. | | `delete` | `DELETE` | `endpointPoliciesId, locationsId, projectsId` | Deletes a single EndpointPolicy. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists EndpointPolicies in a given project and location. | | `patch` | `EXEC` | `endpointPoliciesId, locationsId, projectsId` | Updates the parameters of a single EndpointPolicy. | diff --git a/docs/google-docs/providers/google/networkservices/endpoint_policies_iam_policies/index.md b/docs/google-docs/providers/google/networkservices/endpoint_policies_iam_policies/index.md index 4c4b7f4925..f7db60bb6d 100644 --- a/docs/google-docs/providers/google/networkservices/endpoint_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkservices/endpoint_policies_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/gateways/index.md b/docs/google-docs/providers/google/networkservices/gateways/index.md index 18ee61d5aa..0be13f1296 100644 --- a/docs/google-docs/providers/google/networkservices/gateways/index.md +++ b/docs/google-docs/providers/google/networkservices/gateways/index.md @@ -27,9 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `gateways` | `array` | List of Gateway resources. | -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | +| `name` | `string` | Required. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`. | +| `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | +| `scope` | `string` | Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `ports` | `array` | Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. | +| `addresses` | `array` | Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6. | +| `type` | `string` | Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned. | +| `selfLink` | `string` | Output only. Server-defined URL of this resource | +| `certificateUrls` | `array` | Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'. | +| `labels` | `object` | Optional. Set of label tags associated with the Gateway resource. | +| `network` | `string` | Optional. The relative resource name identifying the VPC network that is using this configuration. For example: `projects/*/global/networks/network-1`. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'. | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | +| `gatewaySecurityPolicy` | `string` | Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections. For example: `projects/*/locations/*/gatewaySecurityPolicies/swg-policy`. This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'. | +| `serverTlsPolicy` | `string` | Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. | +| `subnetwork` | `string` | Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example: `projects/*/regions/us-central1/subnetworks/network-1` Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +49,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists Gateways in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new Gateway in a given project and location. | | `delete` | `DELETE` | `gatewaysId, locationsId, projectsId` | Deletes a single Gateway. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Gateways in a given project and location. | | `patch` | `EXEC` | `gatewaysId, locationsId, projectsId` | Updates the parameters of a single Gateway. | diff --git a/docs/google-docs/providers/google/networkservices/grpc_routes/index.md b/docs/google-docs/providers/google/networkservices/grpc_routes/index.md index a05c0809c8..399439f05b 100644 --- a/docs/google-docs/providers/google/networkservices/grpc_routes/index.md +++ b/docs/google-docs/providers/google/networkservices/grpc_routes/index.md @@ -27,8 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `grpcRoutes` | `array` | List of GrpcRoute resources. | -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | +| `name` | `string` | Required. Name of the GrpcRoute resource. It matches pattern `projects/*/locations/global/grpcRoutes/` | +| `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | +| `rules` | `array` | Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied. | +| `gateways` | `array` | Optional. Gateways defines a list of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` | +| `meshes` | `array` | Optional. Meshes defines a list of meshes this GrpcRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: `projects/*/locations/global/meshes/` | +| `labels` | `object` | Optional. Set of label tags associated with the GrpcRoute resource. | +| `hostnames` | `array` | Required. Service hostnames with an optional port for which this route describes traffic. Format: [:] Hostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 2 notable exceptions: - IPs are not allowed. - A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. `foo.example.com`) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. `*.example.com`). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateway must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames `*.foo.bar.com` and `*.bar.com` to be associated with the same route, it is not possible to associate two routes both with `*.bar.com` or both with `bar.com`. If a port is specified, then gRPC clients must use the channel URI with the port to match this rule (i.e. "xds:///service:123"), otherwise they must supply the URI without a port (i.e. "xds:///service"). | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | +| `selfLink` | `string` | Output only. Server-defined URL of this resource | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists GrpcRoutes in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new GrpcRoute in a given project and location. | | `delete` | `DELETE` | `grpcRoutesId, locationsId, projectsId` | Deletes a single GrpcRoute. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists GrpcRoutes in a given project and location. | | `patch` | `EXEC` | `grpcRoutesId, locationsId, projectsId` | Updates the parameters of a single GrpcRoute. | diff --git a/docs/google-docs/providers/google/networkservices/http_routes/index.md b/docs/google-docs/providers/google/networkservices/http_routes/index.md index 6fee14f470..e1ef2bdfcd 100644 --- a/docs/google-docs/providers/google/networkservices/http_routes/index.md +++ b/docs/google-docs/providers/google/networkservices/http_routes/index.md @@ -27,8 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | -| `httpRoutes` | `array` | List of HttpRoute resources. | +| `name` | `string` | Required. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`. | +| `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | +| `selfLink` | `string` | Output only. Server-defined URL of this resource | +| `rules` | `array` | Required. Rules that define how traffic is routed and handled. Rules will be matched sequentially based on the RouteMatch specified for the rule. | +| `gateways` | `array` | Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` | +| `hostnames` | `array` | Required. Hostnames define a set of hosts that should match against the HTTP host header to select a HttpRoute to process the request. Hostname is the fully qualified domain name of a network host, as defined by RFC 1123 with the exception that: - IPs are not allowed. - A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. `foo.example.com`) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. `*.example.com`). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateways must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames `*.foo.bar.com` and `*.bar.com` to be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with `*.bar.com` or both with `bar.com`. | +| `labels` | `object` | Optional. Set of label tags associated with the HttpRoute resource. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `meshes` | `array` | Optional. Meshes defines a list of meshes this HttpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: `projects/*/locations/global/meshes/` The attached Mesh should be of a type SIDECAR | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists HttpRoute in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new HttpRoute in a given project and location. | | `delete` | `DELETE` | `httpRoutesId, locationsId, projectsId` | Deletes a single HttpRoute. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists HttpRoute in a given project and location. | | `patch` | `EXEC` | `httpRoutesId, locationsId, projectsId` | Updates the parameters of a single HttpRoute. | diff --git a/docs/google-docs/providers/google/networkservices/index.md b/docs/google-docs/providers/google/networkservices/index.md index a8767240dc..bf2df72f10 100644 --- a/docs/google-docs/providers/google/networkservices/index.md +++ b/docs/google-docs/providers/google/networkservices/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 17
total selectable resources: 17
-total methods: 66
+total methods: 76
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleNetwork Services API Description -Idnetworkservices:v23.08.00155 +Idnetworkservices:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/networkservices/locations/index.md b/docs/google-docs/providers/google/networkservices/locations/index.md index 8594263b84..ffea501771 100644 --- a/docs/google-docs/providers/google/networkservices/locations/index.md +++ b/docs/google-docs/providers/google/networkservices/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/networkservices/meshes/index.md b/docs/google-docs/providers/google/networkservices/meshes/index.md index ff179d4fc0..df78633ff8 100644 --- a/docs/google-docs/providers/google/networkservices/meshes/index.md +++ b/docs/google-docs/providers/google/networkservices/meshes/index.md @@ -27,8 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | -| `meshes` | `array` | List of Mesh resources. | +| `name` | `string` | Required. Name of the Mesh resource. It matches pattern `projects/*/locations/global/meshes/`. | +| `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `interceptionPort` | `integer` | Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the specified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to be redirected to this port regardless of its actual ip:port destination. If unset, a port '15001' is used as the interception port. This is applicable only for sidecar proxy deployments. | +| `labels` | `object` | Optional. Set of label tags associated with the Mesh resource. | +| `selfLink` | `string` | Output only. Server-defined URL of this resource | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +41,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists Meshes in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new Mesh in a given project and location. | | `delete` | `DELETE` | `locationsId, meshesId, projectsId` | Deletes a single Mesh. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Meshes in a given project and location. | | `patch` | `EXEC` | `locationsId, meshesId, projectsId` | Updates the parameters of a single Mesh. | diff --git a/docs/google-docs/providers/google/networkservices/meshes_iam_policies/index.md b/docs/google-docs/providers/google/networkservices/meshes_iam_policies/index.md index ba48fd9dd0..67dd4a4c07 100644 --- a/docs/google-docs/providers/google/networkservices/meshes_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkservices/meshes_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/operations/index.md b/docs/google-docs/providers/google/networkservices/operations/index.md index 085515c72b..f380faeb06 100644 --- a/docs/google-docs/providers/google/networkservices/operations/index.md +++ b/docs/google-docs/providers/google/networkservices/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/networkservices/service_bindings/index.md b/docs/google-docs/providers/google/networkservices/service_bindings/index.md index fe2753bfb8..004468620e 100644 --- a/docs/google-docs/providers/google/networkservices/service_bindings/index.md +++ b/docs/google-docs/providers/google/networkservices/service_bindings/index.md @@ -27,8 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | -| `serviceBindings` | `array` | List of ServiceBinding resources. | +| `name` | `string` | Required. Name of the ServiceBinding resource. It matches pattern `projects/*/locations/global/serviceBindings/service_binding_name`. | +| `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `labels` | `object` | Optional. Set of label tags associated with the ServiceBinding resource. | +| `service` | `string` | Required. The full Service Directory Service name of the format projects/*/locations/*/namespaces/*/services/* | +| `serviceId` | `string` | Output only. The unique identifier of the Service Directory Service against which the Service Binding resource is validated. This is populated when the Service Binding resource is used in another resource (like Backend Service). This is of the UUID4 format. | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,3 +41,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists ServiceBinding in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new ServiceBinding in a given project and location. | | `delete` | `DELETE` | `locationsId, projectsId, serviceBindingsId` | Deletes a single ServiceBinding. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists ServiceBinding in a given project and location. | diff --git a/docs/google-docs/providers/google/networkservices/tcp_routes/index.md b/docs/google-docs/providers/google/networkservices/tcp_routes/index.md index 20e6b9af1c..82da29bfe3 100644 --- a/docs/google-docs/providers/google/networkservices/tcp_routes/index.md +++ b/docs/google-docs/providers/google/networkservices/tcp_routes/index.md @@ -27,8 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. | -| `tcpRoutes` | `array` | List of TcpRoute resources. | +| `name` | `string` | Required. Name of the TcpRoute resource. It matches pattern `projects/*/locations/global/tcpRoutes/tcp_route_name>`. | +| `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | +| `rules` | `array` | Required. Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match. | +| `meshes` | `array` | Optional. Meshes defines a list of meshes this TcpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: `projects/*/locations/global/meshes/` The attached Mesh should be of a type SIDECAR | +| `selfLink` | `string` | Output only. Server-defined URL of this resource | +| `gateways` | `array` | Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `labels` | `object` | Optional. Set of label tags associated with the TcpRoute resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +43,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists TcpRoute in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new TcpRoute in a given project and location. | | `delete` | `DELETE` | `locationsId, projectsId, tcpRoutesId` | Deletes a single TcpRoute. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists TcpRoute in a given project and location. | | `patch` | `EXEC` | `locationsId, projectsId, tcpRoutesId` | Updates the parameters of a single TcpRoute. | diff --git a/docs/google-docs/providers/google/networkservices/tls_routes/index.md b/docs/google-docs/providers/google/networkservices/tls_routes/index.md index 9b40ea9f20..97bd8dd1ed 100644 --- a/docs/google-docs/providers/google/networkservices/tls_routes/index.md +++ b/docs/google-docs/providers/google/networkservices/tls_routes/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`. | | `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | -| `rules` | `array` | Required. Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match. | -| `selfLink` | `string` | Output only. Server-defined URL of this resource | -| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | | `createTime` | `string` | Output only. The timestamp when the resource was created. | | `gateways` | `array` | Optional. Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` | | `meshes` | `array` | Optional. Meshes defines a list of meshes this TlsRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: `projects/*/locations/global/meshes/` The attached Mesh should be of a type SIDECAR | +| `rules` | `array` | Required. Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match. | +| `selfLink` | `string` | Output only. Server-defined URL of this resource | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -42,4 +42,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists TlsRoute in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new TlsRoute in a given project and location. | | `delete` | `DELETE` | `locationsId, projectsId, tlsRoutesId` | Deletes a single TlsRoute. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists TlsRoute in a given project and location. | | `patch` | `EXEC` | `locationsId, projectsId, tlsRoutesId` | Updates the parameters of a single TlsRoute. | diff --git a/docs/google-docs/providers/google/notebooks/index.md b/docs/google-docs/providers/google/notebooks/index.md index 1154b8462e..7ef60d0371 100644 --- a/docs/google-docs/providers/google/notebooks/index.md +++ b/docs/google-docs/providers/google/notebooks/index.md @@ -21,7 +21,7 @@ Notebooks API Is Used To Manage Notebook Resources In Google Cloud.
total resources: 4
total selectable resources: 4
-total methods: 23
+total methods: 26
@@ -33,7 +33,7 @@ Notebooks API Is Used To Manage Notebook Resources In Google Cloud. TypeService TitleNotebooks API DescriptionNotebooks API Is Used To Manage Notebook Resources In Google Cloud. -Idnotebooks:v23.08.00155 +Idnotebooks:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/notebooks/instances/index.md b/docs/google-docs/providers/google/notebooks/instances/index.md index d32ab25978..451b2c326c 100644 --- a/docs/google-docs/providers/google/notebooks/instances/index.md +++ b/docs/google-docs/providers/google/notebooks/instances/index.md @@ -27,9 +27,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Page token that can be used to continue listing from the last result in the next list call. | -| `unreachable` | `array` | Locations that could not be reached. For example, ['us-west1-a', 'us-central1-b']. A ListInstancesResponse will only contain either instances or unreachables, | -| `instances` | `array` | A list of returned instances. | +| `id` | `string` | Output only. Unique ID of the resource. | +| `name` | `string` | Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` | +| `creator` | `string` | Output only. Email address of entity that sent original CreateInstance request. | +| `labels` | `object` | Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method. | +| `proxyUri` | `string` | Output only. The proxy endpoint that is used to access the Jupyter notebook. | +| `updateTime` | `string` | Output only. Instance update time. | +| `healthInfo` | `object` | Output only. Additional information about instance health. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" } | +| `gceSetup` | `object` | The definition of how to configure a VM instance outside of Resources and Identity. | +| `createTime` | `string` | Output only. Instance creation time. | +| `healthState` | `string` | Output only. Instance health_state. | +| `instanceOwners` | `array` | Optional. Input only. The owner of this instance after creation. Format: `alias@example.com` Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance. | +| `disableProxyAccess` | `boolean` | Optional. If true, the notebook instance will not register with the proxy. | +| `state` | `string` | Output only. The state of this instance. | +| `upgradeHistory` | `array` | Output only. The upgrade history of this instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +48,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists instances in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new Instance in a given project and location. | | `delete` | `DELETE` | `instancesId, locationsId, projectsId` | Deletes a single Instance. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists instances in a given project and location. | | `check_upgradability` | `EXEC` | `instancesId, locationsId, projectsId` | Checks whether a notebook instance is upgradable. | | `diagnose` | `EXEC` | `instancesId, locationsId, projectsId` | Creates a Diagnostic File and runs Diagnostic Tool given an Instance. | | `patch` | `EXEC` | `instancesId, locationsId, projectsId` | UpdateInstance updates an Instance. | diff --git a/docs/google-docs/providers/google/notebooks/instances_iam_policies/index.md b/docs/google-docs/providers/google/notebooks/instances_iam_policies/index.md index 7ed3000663..9eba0b7294 100644 --- a/docs/google-docs/providers/google/notebooks/instances_iam_policies/index.md +++ b/docs/google-docs/providers/google/notebooks/instances_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/notebooks/locations/index.md b/docs/google-docs/providers/google/notebooks/locations/index.md index e95968f236..f7903c647f 100644 --- a/docs/google-docs/providers/google/notebooks/locations/index.md +++ b/docs/google-docs/providers/google/notebooks/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/notebooks/operations/index.md b/docs/google-docs/providers/google/notebooks/operations/index.md index aa4917bbfe..ab05500f74 100644 --- a/docs/google-docs/providers/google/notebooks/operations/index.md +++ b/docs/google-docs/providers/google/notebooks/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/ondemandscanning/index.md b/docs/google-docs/providers/google/ondemandscanning/index.md index 5c8b5f1808..b04122be75 100644 --- a/docs/google-docs/providers/google/ondemandscanning/index.md +++ b/docs/google-docs/providers/google/ondemandscanning/index.md @@ -21,7 +21,7 @@ A Service To Scan Container Images For Vulnerabilities.
total resources: 3
total selectable resources: 2
-total methods: 7
+total methods: 9
@@ -33,7 +33,7 @@ A Service To Scan Container Images For Vulnerabilities. TypeService TitleOn-Demand Scanning API DescriptionA Service To Scan Container Images For Vulnerabilities. -Idondemandscanning:v23.08.00155 +Idondemandscanning:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/ondemandscanning/operations/index.md b/docs/google-docs/providers/google/ondemandscanning/operations/index.md index 07501ba006..e6487e7195 100644 --- a/docs/google-docs/providers/google/ondemandscanning/operations/index.md +++ b/docs/google-docs/providers/google/ondemandscanning/operations/index.md @@ -27,13 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | | `wait` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/ondemandscanning/vulnerabilities/index.md b/docs/google-docs/providers/google/ondemandscanning/vulnerabilities/index.md index d40a8d4bf7..21a8e0715a 100644 --- a/docs/google-docs/providers/google/ondemandscanning/vulnerabilities/index.md +++ b/docs/google-docs/providers/google/ondemandscanning/vulnerabilities/index.md @@ -27,9 +27,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A page token that can be used in a subsequent call to ListVulnerabilities to continue retrieving results. | -| `occurrences` | `array` | The list of Vulnerability Occurrences resulting from a scan. | +| `name` | `string` | Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. | +| `remediation` | `string` | A description of actions that can be taken to remedy the note. | +| `discovery` | `object` | Provides information about the analysis status of a discovered resource. | +| `deployment` | `object` | The period during which some deployable was active in a runtime. | +| `attestation` | `object` | Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. | +| `createTime` | `string` | Output only. The time this occurrence was created. | +| `upgrade` | `object` | An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. | +| `package` | `object` | Details on how a particular software package was installed on a system. | +| `compliance` | `object` | An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. | +| `image` | `object` | Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . | +| `updateTime` | `string` | Output only. The time this occurrence was last updated. | +| `resourceUri` | `string` | Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image. | +| `noteName` | `string` | Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests. | +| `vulnerability` | `object` | An occurrence of a severity vulnerability on a resource. | +| `build` | `object` | Details of a build occurrence. | +| `kind` | `string` | Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests. | +| `dsseAttestation` | `object` | Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. | +| `sbomReference` | `object` | The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. | +| `envelope` | `object` | MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `locationsId, projectsId, scansId` | +| `_list` | `EXEC` | `locationsId, projectsId, scansId` | diff --git a/docs/google-docs/providers/google/orgpolicy/constraints/index.md b/docs/google-docs/providers/google/orgpolicy/constraints/index.md index a69bd66dd2..8e82dfcba4 100644 --- a/docs/google-docs/providers/google/orgpolicy/constraints/index.md +++ b/docs/google-docs/providers/google/orgpolicy/constraints/index.md @@ -27,11 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `constraints` | `array` | The collection of constraints that are available on the targeted resource. | -| `nextPageToken` | `string` | Page token used to retrieve the next page. This is currently not used. | +| `name` | `string` | Immutable. The resource name of the constraint. Must be in one of the following forms: * `projects/{project_number}/constraints/{constraint_name}` * `folders/{folder_id}/constraints/{constraint_name}` * `organizations/{organization_id}/constraints/{constraint_name}` For example, "/projects/123/constraints/compute.disableSerialPortAccess". | +| `description` | `string` | Detailed description of what this constraint controls as well as how and where it is enforced. Mutable. | +| `supportsDryRun` | `boolean` | Shows if dry run is supported for this constraint or not. | +| `booleanConstraint` | `object` | A constraint that is either enforced or not. For example, a constraint `constraints/compute.disableSerialPortAccess`. If it is enforced on a VM instance, serial port connections will not be opened to that instance. | +| `constraintDefault` | `string` | The evaluation behavior of this constraint in the absence of a policy. | +| `displayName` | `string` | The human readable name. Mutable. | +| `listConstraint` | `object` | A constraint that allows or disallows a list of string values, which are configured by an Organization Policy administrator with a policy. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `folders_constraints_list` | `SELECT` | `foldersId` | | `organizations_constraints_list` | `SELECT` | `organizationsId` | | `projects_constraints_list` | `SELECT` | `projectsId` | +| `_folders_constraints_list` | `EXEC` | `foldersId` | +| `_organizations_constraints_list` | `EXEC` | `organizationsId` | +| `_projects_constraints_list` | `EXEC` | `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 09b9a4348a..a836965436 100644 --- a/docs/google-docs/providers/google/orgpolicy/custom_constraints/index.md +++ b/docs/google-docs/providers/google/orgpolicy/custom_constraints/index.md @@ -31,7 +31,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `description` | `string` | Detailed information about this custom policy constraint. The max length of the description is 2000 characters. | | `updateTime` | `string` | Output only. The last time this custom constraint was updated. This represents the last time that the `CreateCustomConstraint` or `UpdateCustomConstraint` RPC was called | | `actionType` | `string` | Allow or deny type. | -| `condition` | `string` | Org policy condition/expression. For example: `resource.instanceName.matches("[production\|test]_.*_(\d)+")'` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. | +| `condition` | `string` | Org policy condition/expression. For example: `resource.instanceName.matches("[production\|test]_.*_(\d)+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. | | `displayName` | `string` | One line display name for the UI. The max length of the display_name is 200 characters. | | `methodTypes` | `array` | All the operations being applied for this constraint. | | `resourceTypes` | `array` | Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. | @@ -42,4 +42,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_custom_constraints_list` | `SELECT` | `organizationsId` | Retrieves all of the custom constraints that exist on a particular organization resource. | | `organizations_custom_constraints_create` | `INSERT` | `organizationsId` | Creates a custom constraint. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the organization does not exist. Returns a `google.rpc.Status` with `google.rpc.Code.ALREADY_EXISTS` if the constraint already exists on the given organization. | | `organizations_custom_constraints_delete` | `DELETE` | `customConstraintsId, organizationsId` | Deletes a custom constraint. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint does not exist. | +| `_organizations_custom_constraints_list` | `EXEC` | `organizationsId` | Retrieves all of the custom constraints that exist on a particular organization resource. | | `organizations_custom_constraints_patch` | `EXEC` | `customConstraintsId, organizationsId` | Updates a custom constraint. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint does not exist. Note: the supplied policy will perform a full overwrite of all fields. | diff --git a/docs/google-docs/providers/google/orgpolicy/index.md b/docs/google-docs/providers/google/orgpolicy/index.md index 212259eaec..7be4fca6c6 100644 --- a/docs/google-docs/providers/google/orgpolicy/index.md +++ b/docs/google-docs/providers/google/orgpolicy/index.md @@ -21,7 +21,7 @@ The Organization Policy API Allows Users To Configure Governance Rules On Their
total resources: 4
total selectable resources: 4
-total methods: 26
+total methods: 33
@@ -33,7 +33,7 @@ The Organization Policy API Allows Users To Configure Governance Rules On Their TypeService TitleOrganization Policy API DescriptionThe Organization Policy API Allows Users To Configure Governance Rules On Their Google Cloud Resources Across The Resource Hierarchy. -Idorgpolicy:v23.08.00155 +Idorgpolicy:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/orgpolicy/policies/index.md b/docs/google-docs/providers/google/orgpolicy/policies/index.md index 8090c7b7ea..38d52084fd 100644 --- a/docs/google-docs/providers/google/orgpolicy/policies/index.md +++ b/docs/google-docs/providers/google/orgpolicy/policies/index.md @@ -27,8 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Page token used to retrieve the next page. This is currently not used, but the server may at any point start supplying a valid token. | -| `policies` | `array` | All policies that exist on the resource. It will be empty if no policies are set. | +| `name` | `string` | Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint which this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. | +| `alternate` | `object` | Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run/darklaunch. | +| `dryRunSpec` | `object` | Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources. | +| `spec` | `object` | Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,6 +46,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `folders_policies_delete` | `DELETE` | `foldersId, policiesId` | Deletes a policy. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint or organization policy does not exist. | | `organizations_policies_delete` | `DELETE` | `organizationsId, policiesId` | Deletes a policy. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint or organization policy does not exist. | | `projects_policies_delete` | `DELETE` | `policiesId, projectsId` | Deletes a policy. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint or organization policy does not exist. | +| `_folders_policies_list` | `EXEC` | `foldersId` | Retrieves all of the policies that exist on a particular resource. | +| `_organizations_policies_list` | `EXEC` | `organizationsId` | Retrieves all of the policies that exist on a particular resource. | +| `_projects_policies_list` | `EXEC` | `projectsId` | Retrieves all of the policies that exist on a particular resource. | | `folders_policies_patch` | `EXEC` | `foldersId, policiesId` | Updates a policy. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etag supplied in the request does not match the persisted etag of the policy Note: the supplied policy will perform a full overwrite of all fields. | | `organizations_policies_patch` | `EXEC` | `organizationsId, policiesId` | Updates a policy. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etag supplied in the request does not match the persisted etag of the policy Note: the supplied policy will perform a full overwrite of all fields. | | `projects_policies_patch` | `EXEC` | `policiesId, projectsId` | Updates a policy. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the constraint or the policy do not exist. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etag supplied in the request does not match the persisted etag of the policy Note: the supplied policy will perform a full overwrite of all fields. | diff --git a/docs/google-docs/providers/google/orgpolicy/policies_effective_policy/index.md b/docs/google-docs/providers/google/orgpolicy/policies_effective_policy/index.md index 64759c2eae..3c9ba55927 100644 --- a/docs/google-docs/providers/google/orgpolicy/policies_effective_policy/index.md +++ b/docs/google-docs/providers/google/orgpolicy/policies_effective_policy/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | Immutable. The resource name of the policy. Must be one of the following forms, where constraint_name is the name of the constraint which this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, "projects/123/policies/compute.disableSerialPortAccess". Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. | +| `name` | `string` | Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint which this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. | +| `alternate` | `object` | Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run/darklaunch. | | `dryRunSpec` | `object` | Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources. | | `spec` | `object` | Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources. | -| `alternate` | `object` | Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run/darklaunch. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/osconfig/index.md b/docs/google-docs/providers/google/osconfig/index.md index b4b0f7d818..38f0d7a60a 100644 --- a/docs/google-docs/providers/google/osconfig/index.md +++ b/docs/google-docs/providers/google/osconfig/index.md @@ -21,7 +21,7 @@ OS Management Tools That Can Be Used For Patch Management, Patch Compliance, And
total resources: 11
total selectable resources: 10
-total methods: 26
+total methods: 34
@@ -33,7 +33,7 @@ OS Management Tools That Can Be Used For Patch Management, Patch Compliance, And TypeService TitleOS Config API DescriptionOS Management Tools That Can Be Used For Patch Management, Patch Compliance, And Configuration Management On VM Instances. -Idosconfig:v23.08.00155 +Idosconfig:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/osconfig/instance_details/index.md b/docs/google-docs/providers/google/osconfig/instance_details/index.md index ebc87fae8b..bd5e682560 100644 --- a/docs/google-docs/providers/google/osconfig/instance_details/index.md +++ b/docs/google-docs/providers/google/osconfig/instance_details/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `patchJobInstanceDetails` | `array` | A list of instance status. | -| `nextPageToken` | `string` | A pagination token that can be used to get the next page of results. | +| `name` | `string` | The instance name in the form `projects/*/zones/*/instances/*` | +| `attemptCount` | `string` | The number of times the agent that the agent attempts to apply the patch. | +| `failureReason` | `string` | If the patch fails, this field provides the reason. | +| `instanceSystemId` | `string` | The unique identifier for the instance. This identifier is defined by the server. | +| `state` | `string` | Current state of instance patch. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `patchJobsId, projectsId` | +| `_list` | `EXEC` | `patchJobsId, projectsId` | diff --git a/docs/google-docs/providers/google/osconfig/inventories/index.md b/docs/google-docs/providers/google/osconfig/inventories/index.md index 3e7622dfec..efe21047cb 100644 --- a/docs/google-docs/providers/google/osconfig/inventories/index.md +++ b/docs/google-docs/providers/google/osconfig/inventories/index.md @@ -27,10 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `inventories` | `array` | List of inventory objects. | -| `nextPageToken` | `string` | The pagination token to retrieve the next page of inventory objects. | +| `name` | `string` | Output only. The `Inventory` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/inventory` | +| `updateTime` | `string` | Output only. Timestamp of the last reported inventory for the VM. | +| `items` | `object` | Inventory items related to the VM keyed by an opaque unique identifier for each inventory item. The identifier is unique to each distinct and addressable inventory item and will change, when there is a new package version. | +| `osInfo` | `object` | Operating system information for the VM. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `instancesId, locationsId, projectsId` | Get inventory data for the specified VM instance. If the VM has no associated inventory, the message `NOT_FOUND` is returned. | | `list` | `SELECT` | `instancesId, locationsId, projectsId` | List inventory data for all VM instances in the specified zone. | +| `_list` | `EXEC` | `instancesId, locationsId, projectsId` | List inventory data for all VM instances in the specified zone. | diff --git a/docs/google-docs/providers/google/osconfig/os_policy_assignments/index.md b/docs/google-docs/providers/google/osconfig/os_policy_assignments/index.md index 745ae444d0..570882224b 100644 --- a/docs/google-docs/providers/google/osconfig/os_policy_assignments/index.md +++ b/docs/google-docs/providers/google/osconfig/os_policy_assignments/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment. | | `description` | `string` | OS policy assignment description. Length of the description is limited to 1024 characters. | +| `rolloutState` | `string` | Output only. OS policy assignment rollout state | | `osPolicies` | `array` | Required. List of OS policies to be applied to the VMs. | -| `rollout` | `object` | Message to configure the rollout at the zonal level for the OS policy assignment. | +| `reconciling` | `boolean` | Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING | +| `etag` | `string` | The etag for this OS policy assignment. If this is provided on update, it must match the server's etag. | | `instanceFilter` | `object` | Filters to select target VMs for an assignment. If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them. | -| `rolloutState` | `string` | Output only. OS policy assignment rollout state | -| `uid` | `string` | Output only. Server generated unique id for the OS policy assignment resource. | -| `deleted` | `boolean` | Output only. Indicates that this revision deletes the OS policy assignment. | +| `rollout` | `object` | Message to configure the rollout at the zonal level for the OS policy assignment. | | `revisionId` | `string` | Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment | +| `uid` | `string` | Output only. Server generated unique id for the OS policy assignment resource. | | `baseline` | `boolean` | Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field. | -| `etag` | `string` | The etag for this OS policy assignment. If this is provided on update, it must match the server's etag. | +| `deleted` | `boolean` | Output only. Indicates that this revision deletes the OS policy assignment. | | `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | -| `reconciling` | `boolean` | Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,4 +47,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned. | | `create` | `INSERT` | `locationsId, projectsId` | Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel). | | `delete` | `DELETE` | `locationsId, osPolicyAssignmentsId, projectsId` | Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel). | +| `_list` | `EXEC` | `locationsId, projectsId` | List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned. | | `patch` | `EXEC` | `locationsId, osPolicyAssignmentsId, projectsId` | Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel). | diff --git a/docs/google-docs/providers/google/osconfig/os_policy_assignments_revisions/index.md b/docs/google-docs/providers/google/osconfig/os_policy_assignments_revisions/index.md index 7b978bbb2a..2e48d350c6 100644 --- a/docs/google-docs/providers/google/osconfig/os_policy_assignments_revisions/index.md +++ b/docs/google-docs/providers/google/osconfig/os_policy_assignments_revisions/index.md @@ -27,9 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `osPolicyAssignments` | `array` | The OS policy assignment revisions | -| `nextPageToken` | `string` | The pagination token to retrieve the next page of OS policy assignment revisions. | +| `name` | `string` | Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment. | +| `description` | `string` | OS policy assignment description. Length of the description is limited to 1024 characters. | +| `baseline` | `boolean` | Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field. | +| `revisionId` | `string` | Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment | +| `rollout` | `object` | Message to configure the rollout at the zonal level for the OS policy assignment. | +| `osPolicies` | `array` | Required. List of OS policies to be applied to the VMs. | +| `uid` | `string` | Output only. Server generated unique id for the OS policy assignment resource. | +| `instanceFilter` | `object` | Filters to select target VMs for an assignment. If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them. | +| `rolloutState` | `string` | Output only. OS policy assignment rollout state | +| `etag` | `string` | The etag for this OS policy assignment. If this is provided on update, it must match the server's etag. | +| `deleted` | `boolean` | Output only. Indicates that this revision deletes the OS policy assignment. | +| `reconciling` | `boolean` | Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING | +| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list_revisions` | `SELECT` | `locationsId, osPolicyAssignmentsId, projectsId` | +| `_list_revisions` | `EXEC` | `locationsId, osPolicyAssignmentsId, projectsId` | diff --git a/docs/google-docs/providers/google/osconfig/patch_deployments/index.md b/docs/google-docs/providers/google/osconfig/patch_deployments/index.md index 9641aef2a5..4977d574b8 100644 --- a/docs/google-docs/providers/google/osconfig/patch_deployments/index.md +++ b/docs/google-docs/providers/google/osconfig/patch_deployments/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. | | `description` | `string` | Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. | -| `recurringSchedule` | `object` | Sets the time for recurring patch deployments. | -| `rollout` | `object` | Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. | -| `updateTime` | `string` | Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | -| `patchConfig` | `object` | Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. | -| `oneTimeSchedule` | `object` | Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | -| `state` | `string` | Output only. Current state of the patch deployment. | | `duration` | `string` | Optional. Duration of the patch. After the duration ends, the patch times out. | | `instanceFilter` | `object` | A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. | +| `state` | `string` | Output only. Current state of the patch deployment. | | `lastExecuteTime` | `string` | Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | +| `oneTimeSchedule` | `object` | Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | +| `recurringSchedule` | `object` | Sets the time for recurring patch deployments. | +| `updateTime` | `string` | Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | | `createTime` | `string` | Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | +| `patchConfig` | `object` | Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. | +| `rollout` | `object` | Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -46,6 +46,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId` | Get a page of OS Config patch deployments. | | `create` | `INSERT` | `projectsId` | Create an OS Config patch deployment. | | `delete` | `DELETE` | `patchDeploymentsId, projectsId` | Delete an OS Config patch deployment. | +| `_list` | `EXEC` | `projectsId` | Get a page of OS Config patch deployments. | | `patch` | `EXEC` | `patchDeploymentsId, projectsId` | Update an OS Config patch deployment. | | `pause` | `EXEC` | `patchDeploymentsId, projectsId` | Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs. | | `resume` | `EXEC` | `patchDeploymentsId, projectsId` | Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs. | diff --git a/docs/google-docs/providers/google/osconfig/patch_jobs/index.md b/docs/google-docs/providers/google/osconfig/patch_jobs/index.md index 51e204804e..1b3d46d820 100644 --- a/docs/google-docs/providers/google/osconfig/patch_jobs/index.md +++ b/docs/google-docs/providers/google/osconfig/patch_jobs/index.md @@ -29,23 +29,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Unique identifier for this patch job in the form `projects/*/patchJobs/*` | | `description` | `string` | Description of the patch job. Length of the description is limited to 1024 characters. | -| `instanceDetailsSummary` | `object` | A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to `InstancePatchState`. List patch job instance details to see the specific states of each instance. | -| `errorMessage` | `string` | If this patch job failed, this message provides information about the failure. | +| `patchDeployment` | `string` | Output only. Name of the patch deployment that created this patch job. | +| `createTime` | `string` | Time this patch job was created. | | `percentComplete` | `number` | Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete. | -| `dryRun` | `boolean` | If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance. | | `displayName` | `string` | Display name for this patch job. This is not a unique identifier. | -| `rollout` | `object` | Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. | -| `patchConfig` | `object` | Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. | -| `instanceFilter` | `object` | A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. | +| `dryRun` | `boolean` | If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance. | +| `duration` | `string` | Duration of the patch job. After the duration ends, the patch job times out. | | `updateTime` | `string` | Last time this patch job was updated. | -| `patchDeployment` | `string` | Output only. Name of the patch deployment that created this patch job. | +| `instanceFilter` | `object` | A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. | +| `errorMessage` | `string` | If this patch job failed, this message provides information about the failure. | +| `instanceDetailsSummary` | `object` | A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to `InstancePatchState`. List patch job instance details to see the specific states of each instance. | +| `rollout` | `object` | Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. | | `state` | `string` | The current state of the PatchJob. | -| `duration` | `string` | Duration of the patch job. After the duration ends, the patch job times out. | -| `createTime` | `string` | Time this patch job was created. | +| `patchConfig` | `object` | Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `patchJobsId, projectsId` | Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs. | | `list` | `SELECT` | `projectsId` | Get a list of patch jobs. | +| `_list` | `EXEC` | `projectsId` | Get a list of patch jobs. | | `cancel` | `EXEC` | `patchJobsId, projectsId` | Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted. | | `execute` | `EXEC` | `projectsId` | Patch VM instances by creating and running a patch job. | diff --git a/docs/google-docs/providers/google/osconfig/report/index.md b/docs/google-docs/providers/google/osconfig/report/index.md index 4d620519e2..07f2997dbe 100644 --- a/docs/google-docs/providers/google/osconfig/report/index.md +++ b/docs/google-docs/providers/google/osconfig/report/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The `OSPolicyAssignmentReport` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/osPolicyAssignments/{os_policy_assignment_id}/report` | +| `osPolicyCompliances` | `array` | Compliance data for each `OSPolicy` that is applied to the VM. | | `updateTime` | `string` | Timestamp for when the report was last generated. | | `instance` | `string` | The Compute Engine VM instance name. | | `lastRunId` | `string` | Unique identifier of the last attempted run to apply the OS policies associated with this assignment on the VM. This ID is logged by the OS Config agent while applying the OS policies associated with this assignment on the VM. NOTE: If the service is unable to successfully connect to the agent for this run, then this id will not be available in the agent logs. | | `osPolicyAssignment` | `string` | Reference to the `OSPolicyAssignment` API resource that the `OSPolicy` belongs to. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}` | -| `osPolicyCompliances` | `array` | Compliance data for each `OSPolicy` that is applied to the VM. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/osconfig/reports/index.md b/docs/google-docs/providers/google/osconfig/reports/index.md index 3a532ba49c..0d65d902cf 100644 --- a/docs/google-docs/providers/google/osconfig/reports/index.md +++ b/docs/google-docs/providers/google/osconfig/reports/index.md @@ -27,9 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The pagination token to retrieve the next page of OS policy assignment report objects. | -| `osPolicyAssignmentReports` | `array` | List of OS policy assignment reports. | +| `name` | `string` | The `OSPolicyAssignmentReport` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/osPolicyAssignments/{os_policy_assignment_id}/report` | +| `instance` | `string` | The Compute Engine VM instance name. | +| `lastRunId` | `string` | Unique identifier of the last attempted run to apply the OS policies associated with this assignment on the VM. This ID is logged by the OS Config agent while applying the OS policies associated with this assignment on the VM. NOTE: If the service is unable to successfully connect to the agent for this run, then this id will not be available in the agent logs. | +| `osPolicyAssignment` | `string` | Reference to the `OSPolicyAssignment` API resource that the `OSPolicy` belongs to. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}` | +| `osPolicyCompliances` | `array` | Compliance data for each `OSPolicy` that is applied to the VM. | +| `updateTime` | `string` | Timestamp for when the report was last generated. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `instancesId, locationsId, osPolicyAssignmentsId, projectsId` | +| `_list` | `EXEC` | `instancesId, locationsId, osPolicyAssignmentsId, projectsId` | diff --git a/docs/google-docs/providers/google/osconfig/vulnerability_reports/index.md b/docs/google-docs/providers/google/osconfig/vulnerability_reports/index.md index dc22d0274a..08f6ac784d 100644 --- a/docs/google-docs/providers/google/osconfig/vulnerability_reports/index.md +++ b/docs/google-docs/providers/google/osconfig/vulnerability_reports/index.md @@ -27,9 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The pagination token to retrieve the next page of vulnerabilityReports object. | -| `vulnerabilityReports` | `array` | List of vulnerabilityReport objects. | +| `name` | `string` | Output only. The `vulnerabilityReport` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/vulnerabilityReport` | +| `updateTime` | `string` | Output only. The timestamp for when the last vulnerability report was generated for the VM. | +| `vulnerabilities` | `array` | Output only. List of vulnerabilities affecting the VM. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `instancesId, locationsId, projectsId` | +| `_list` | `EXEC` | `instancesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/oslogin/index.md b/docs/google-docs/providers/google/oslogin/index.md index 9eddd6f1cc..43ca3f4c66 100644 --- a/docs/google-docs/providers/google/oslogin/index.md +++ b/docs/google-docs/providers/google/oslogin/index.md @@ -33,7 +33,7 @@ You Can Use OS Login To Manage Access To Your VM Instances Using IAM Roles. TypeService TitleCloud OS Login API DescriptionYou Can Use OS Login To Manage Access To Your VM Instances Using IAM Roles. -Idoslogin:v23.08.00155 +Idoslogin:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/oslogin/ssh_public_keys/index.md b/docs/google-docs/providers/google/oslogin/ssh_public_keys/index.md index 6799262ba5..dcb944f51b 100644 --- a/docs/google-docs/providers/google/oslogin/ssh_public_keys/index.md +++ b/docs/google-docs/providers/google/oslogin/ssh_public_keys/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The canonical resource name. | +| `key` | `string` | Public key text in SSH format, defined by RFC4253 section 6.6. | | `expirationTimeUsec` | `string` | An expiration time in microseconds since epoch. | | `fingerprint` | `string` | Output only. The SHA-256 fingerprint of the SSH public key. | -| `key` | `string` | Public key text in SSH format, defined by RFC4253 section 6.6. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/places/index.md b/docs/google-docs/providers/google/places/index.md index 4555a3d2c6..29bdcd6a00 100644 --- a/docs/google-docs/providers/google/places/index.md +++ b/docs/google-docs/providers/google/places/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitlePlaces API (New) Description -Idplaces:v23.08.00155 +Idplaces:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/policyanalyzer/index.md b/docs/google-docs/providers/google/policyanalyzer/index.md index f788418b6f..cfa23b8781 100644 --- a/docs/google-docs/providers/google/policyanalyzer/index.md +++ b/docs/google-docs/providers/google/policyanalyzer/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitlePolicy Analyzer API Description -Idpolicyanalyzer:v23.08.00155 +Idpolicyanalyzer:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/policysimulator/index.md b/docs/google-docs/providers/google/policysimulator/index.md index c7fdc6205f..69678ddbf6 100644 --- a/docs/google-docs/providers/google/policysimulator/index.md +++ b/docs/google-docs/providers/google/policysimulator/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 3
total selectable resources: 3
-total methods: 17
+total methods: 24
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitlePolicy Simulator API Description Policy Simulator Is A Collection Of Endpoints For Creating, Running, And Viewing A Replay. A `Replay` Is A Type Of Simulation That Lets You See How Your Members' Access To Resources Might Change If You Changed Your IAM Policy. During A `Replay`, Policy Simulator Re-Evaluates, Or Replays, Past Access Attempts Under Both The Current Policy And Your Proposed Policy, And Compares Those Results To Determine How Your Members' Access Might Change Under The Proposed Policy. -Idpolicysimulator:v23.08.00155 +Idpolicysimulator:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/policysimulator/operations/index.md b/docs/google-docs/providers/google/policysimulator/operations/index.md index e1fc221827..d2b874e977 100644 --- a/docs/google-docs/providers/google/policysimulator/operations/index.md +++ b/docs/google-docs/providers/google/policysimulator/operations/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `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 | |:-----|:--------------|:----------------|:------------| @@ -36,6 +39,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `operations_list` | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `organizations_locations_replays_operations_list` | `SELECT` | `locationsId, organizationsId, replaysId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_replays_operations_list` | `SELECT` | `locationsId, projectsId, replaysId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_folders_locations_replays_operations_list` | `EXEC` | `foldersId, locationsId, replaysId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_operations_list` | `EXEC` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_organizations_locations_replays_operations_list` | `EXEC` | `locationsId, organizationsId, replaysId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_replays_operations_list` | `EXEC` | `locationsId, projectsId, replaysId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `folders_locations_replays_operations_get` | `EXEC` | `foldersId, locationsId, operationsId, replaysId` | 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. | | `operations_get` | `EXEC` | `operationsId` | 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. | | `organizations_locations_replays_operations_get` | `EXEC` | `locationsId, operationsId, organizationsId, replaysId` | 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. | diff --git a/docs/google-docs/providers/google/policysimulator/replays/index.md b/docs/google-docs/providers/google/policysimulator/replays/index.md index b036fc773e..740323be76 100644 --- a/docs/google-docs/providers/google/policysimulator/replays/index.md +++ b/docs/google-docs/providers/google/policysimulator/replays/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the `Replay`, which has the following format: `{projects\|folders\|organizations}/{resource-id}/locations/global/replays/{replay-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36` | +| `config` | `object` | The configuration used for a Replay. | | `resultsSummary` | `object` | Summary statistics about the replayed log entries. | | `state` | `string` | Output only. The current state of the `Replay`. | -| `config` | `object` | The configuration used for a Replay. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/policysimulator/results/index.md b/docs/google-docs/providers/google/policysimulator/results/index.md index 366f831075..6ef64e461f 100644 --- a/docs/google-docs/providers/google/policysimulator/results/index.md +++ b/docs/google-docs/providers/google/policysimulator/results/index.md @@ -27,11 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `replayResults` | `array` | The results of running a Replay. | -| `nextPageToken` | `string` | A token that you can use to retrieve the next page of ReplayResult objects. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | The resource name of the `ReplayResult`, in the following format: `{projects\|folders\|organizations}/{resource-id}/locations/global/replays/{replay-id}/results/{replay-result-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36/results/1234` | +| `parent` | `string` | The Replay that the access tuple was included in. | +| `accessTuple` | `object` | Information about the principal, resource, and permission to check. | +| `diff` | `object` | The difference between the results of evaluating an access tuple under the current (baseline) policies and under the proposed (simulated) policies. This difference explains how a principal's access could change if the proposed policies were applied. | +| `error` | `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). | +| `lastSeenDate` | `object` | Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `folders_locations_replays_results_list` | `SELECT` | `foldersId, locationsId, replaysId` | | `organizations_locations_replays_results_list` | `SELECT` | `locationsId, organizationsId, replaysId` | | `projects_locations_replays_results_list` | `SELECT` | `locationsId, projectsId, replaysId` | +| `_folders_locations_replays_results_list` | `EXEC` | `foldersId, locationsId, replaysId` | +| `_organizations_locations_replays_results_list` | `EXEC` | `locationsId, organizationsId, replaysId` | +| `_projects_locations_replays_results_list` | `EXEC` | `locationsId, projectsId, replaysId` | diff --git a/docs/google-docs/providers/google/policytroubleshooter/index.md b/docs/google-docs/providers/google/policytroubleshooter/index.md index c1e8c2f0c7..570eff8c30 100644 --- a/docs/google-docs/providers/google/policytroubleshooter/index.md +++ b/docs/google-docs/providers/google/policytroubleshooter/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitlePolicy Troubleshooter API Description -Idpolicytroubleshooter:v23.08.00155 +Idpolicytroubleshooter:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/privateca/ca_pools/index.md b/docs/google-docs/providers/google/privateca/ca_pools/index.md index 2979db1136..ff256363a1 100644 --- a/docs/google-docs/providers/google/privateca/ca_pools/index.md +++ b/docs/google-docs/providers/google/privateca/ca_pools/index.md @@ -27,9 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `caPools` | `array` | The list of CaPools. | -| `nextPageToken` | `string` | A token to retrieve next page of results. Pass this value in ListCertificateAuthoritiesRequest.next_page_token to retrieve the next page of results. | -| `unreachable` | `array` | A list of locations (e.g. "us-west1") that could not be reached. | +| `name` | `string` | Output only. The resource name for this CaPool in the format `projects/*/locations/*/caPools/*`. | +| `publishingOptions` | `object` | Options relating to the publication of each CertificateAuthority's CA certificate and CRLs and their inclusion as extensions in issued Certificates. The options set here apply to certificates issued by any CertificateAuthority in the CaPool. | +| `tier` | `string` | Required. Immutable. The Tier of this CaPool. | +| `issuancePolicy` | `object` | Defines controls over all certificate issuance within a CaPool. | +| `labels` | `object` | Optional. Labels with user-defined metadata. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists CaPools. | | `create` | `INSERT` | `locationsId, projectsId` | Create a CaPool. | | `delete` | `DELETE` | `caPoolsId, locationsId, projectsId` | Delete a CaPool. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists CaPools. | | `patch` | `EXEC` | `caPoolsId, locationsId, projectsId` | Update a CaPool. | diff --git a/docs/google-docs/providers/google/privateca/ca_pools_iam_policies/index.md b/docs/google-docs/providers/google/privateca/ca_pools_iam_policies/index.md index b0be676ea9..ba5ed4595b 100644 --- a/docs/google-docs/providers/google/privateca/ca_pools_iam_policies/index.md +++ b/docs/google-docs/providers/google/privateca/ca_pools_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/privateca/certificate_authorities/index.md b/docs/google-docs/providers/google/privateca/certificate_authorities/index.md index 4a7f5090c4..d01c0a7528 100644 --- a/docs/google-docs/providers/google/privateca/certificate_authorities/index.md +++ b/docs/google-docs/providers/google/privateca/certificate_authorities/index.md @@ -27,9 +27,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | A list of locations (e.g. "us-west1") that could not be reached. | -| `certificateAuthorities` | `array` | The list of CertificateAuthorities. | -| `nextPageToken` | `string` | A token to retrieve next page of results. Pass this value in ListCertificateAuthoritiesRequest.next_page_token to retrieve the next page of results. | +| `name` | `string` | Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. | +| `keySpec` | `object` | A Cloud KMS key configuration that a CertificateAuthority will use. | +| `gcsBucket` | `string` | Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will publish content, such as the CA certificate and CRLs. This must be a bucket name, without any prefixes (such as `gs://`) or suffixes (such as `.googleapis.com`). For example, to use a bucket named `my-bucket`, you would simply specify `my-bucket`. If not specified, a managed bucket will be created. | +| `tier` | `string` | Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority. | +| `state` | `string` | Output only. The State for this CertificateAuthority. | +| `caCertificateDescriptions` | `array` | Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root. | +| `deleteTime` | `string` | Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state. | +| `type` | `string` | Required. Immutable. The Type of this CertificateAuthority. | +| `expireTime` | `string` | Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state. | +| `accessUrls` | `object` | URLs where a CertificateAuthority will publish content. | +| `lifetime` | `string` | Required. Immutable. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. | +| `labels` | `object` | Optional. Labels with user-defined metadata. | +| `pemCaCertificates` | `array` | Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate. | +| `subordinateConfig` | `object` | Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain. | +| `config` | `object` | A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. | +| `updateTime` | `string` | Output only. The time at which this CertificateAuthority was last updated. | +| `createTime` | `string` | Output only. The time at which this CertificateAuthority was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +51,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `caPoolsId, locationsId, projectsId` | Lists CertificateAuthorities. | | `create` | `INSERT` | `caPoolsId, locationsId, projectsId` | Create a new CertificateAuthority in a given Project and Location. | | `delete` | `DELETE` | `caPoolsId, certificateAuthoritiesId, locationsId, projectsId` | Delete a CertificateAuthority. | +| `_list` | `EXEC` | `caPoolsId, locationsId, projectsId` | Lists CertificateAuthorities. | | `activate` | `EXEC` | `caPoolsId, certificateAuthoritiesId, locationsId, projectsId` | Activate a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process. | | `disable` | `EXEC` | `caPoolsId, certificateAuthoritiesId, locationsId, projectsId` | Disable a CertificateAuthority. | | `enable` | `EXEC` | `caPoolsId, certificateAuthoritiesId, locationsId, projectsId` | Enable a CertificateAuthority. | diff --git a/docs/google-docs/providers/google/privateca/certificate_revocation_lists/index.md b/docs/google-docs/providers/google/privateca/certificate_revocation_lists/index.md index d40365787f..5145d32206 100644 --- a/docs/google-docs/providers/google/privateca/certificate_revocation_lists/index.md +++ b/docs/google-docs/providers/google/privateca/certificate_revocation_lists/index.md @@ -27,12 +27,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `certificateRevocationLists` | `array` | The list of CertificateRevocationLists. | -| `nextPageToken` | `string` | A token to retrieve next page of results. Pass this value in ListCertificateRevocationListsRequest.next_page_token to retrieve the next page of results. | -| `unreachable` | `array` | A list of locations (e.g. "us-west1") that could not be reached. | +| `name` | `string` | Output only. The resource name for this CertificateRevocationList in the format `projects/*/locations/*/caPools/*certificateAuthorities/*/ certificateRevocationLists/*`. | +| `updateTime` | `string` | Output only. The time at which this CertificateRevocationList was updated. | +| `revisionId` | `string` | Output only. The revision ID of this CertificateRevocationList. A new revision is committed whenever a new CRL is published. The format is an 8-character hexadecimal string. | +| `state` | `string` | Output only. The State for this CertificateRevocationList. | +| `accessUrl` | `string` | Output only. The location where 'pem_crl' can be accessed. | +| `createTime` | `string` | Output only. The time at which this CertificateRevocationList was created. | +| `labels` | `object` | Optional. Labels with user-defined metadata. | +| `pemCrl` | `string` | Output only. The PEM-encoded X.509 CRL. | +| `revokedCertificates` | `array` | Output only. The revoked serial numbers that appear in pem_crl. | +| `sequenceNumber` | `string` | Output only. The CRL sequence number that appears in pem_crl. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `caPoolsId, certificateAuthoritiesId, certificateRevocationListsId, locationsId, projectsId` | Returns a CertificateRevocationList. | | `list` | `SELECT` | `caPoolsId, certificateAuthoritiesId, locationsId, projectsId` | Lists CertificateRevocationLists. | +| `_list` | `EXEC` | `caPoolsId, certificateAuthoritiesId, locationsId, projectsId` | Lists CertificateRevocationLists. | | `patch` | `EXEC` | `caPoolsId, certificateAuthoritiesId, certificateRevocationListsId, locationsId, projectsId` | Update a CertificateRevocationList. | diff --git a/docs/google-docs/providers/google/privateca/certificate_revocation_lists_iam_policies/index.md b/docs/google-docs/providers/google/privateca/certificate_revocation_lists_iam_policies/index.md index cf76178822..916efe7911 100644 --- a/docs/google-docs/providers/google/privateca/certificate_revocation_lists_iam_policies/index.md +++ b/docs/google-docs/providers/google/privateca/certificate_revocation_lists_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/privateca/certificate_templates/index.md b/docs/google-docs/providers/google/privateca/certificate_templates/index.md index 458540fd82..3387a70f63 100644 --- a/docs/google-docs/providers/google/privateca/certificate_templates/index.md +++ b/docs/google-docs/providers/google/privateca/certificate_templates/index.md @@ -27,9 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to retrieve next page of results. Pass this value in ListCertificateTemplatesRequest.next_page_token to retrieve the next page of results. | -| `unreachable` | `array` | A list of locations (e.g. "us-west1") that could not be reached. | -| `certificateTemplates` | `array` | The list of CertificateTemplates. | +| `name` | `string` | Output only. The resource name for this CertificateTemplate in the format `projects/*/locations/*/certificateTemplates/*`. | +| `description` | `string` | Optional. A human-readable description of scenarios this template is intended for. | +| `predefinedValues` | `object` | An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. | +| `updateTime` | `string` | Output only. The time at which this CertificateTemplate was updated. | +| `createTime` | `string` | Output only. The time at which this CertificateTemplate was created. | +| `identityConstraints` | `object` | Describes constraints on a Certificate's Subject and SubjectAltNames. | +| `labels` | `object` | Optional. Labels with user-defined metadata. | +| `passthroughExtensions` | `object` | Describes a set of X.509 extensions that may be part of some certificate issuance controls. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +42,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists CertificateTemplates. | | `create` | `INSERT` | `locationsId, projectsId` | Create a new CertificateTemplate in a given Project and Location. | | `delete` | `DELETE` | `certificateTemplatesId, locationsId, projectsId` | DeleteCertificateTemplate deletes a CertificateTemplate. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists CertificateTemplates. | | `patch` | `EXEC` | `certificateTemplatesId, locationsId, projectsId` | Update a CertificateTemplate. | diff --git a/docs/google-docs/providers/google/privateca/certificate_templates_iam_policies/index.md b/docs/google-docs/providers/google/privateca/certificate_templates_iam_policies/index.md index b8541d5c69..8532a13de2 100644 --- a/docs/google-docs/providers/google/privateca/certificate_templates_iam_policies/index.md +++ b/docs/google-docs/providers/google/privateca/certificate_templates_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/privateca/certificates/index.md b/docs/google-docs/providers/google/privateca/certificates/index.md index 33a1622e55..dc7f193272 100644 --- a/docs/google-docs/providers/google/privateca/certificates/index.md +++ b/docs/google-docs/providers/google/privateca/certificates/index.md @@ -27,14 +27,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to retrieve next page of results. Pass this value in ListCertificatesRequest.next_page_token to retrieve the next page of results. | -| `unreachable` | `array` | A list of locations (e.g. "us-west1") that could not be reached. | -| `certificates` | `array` | The list of Certificates. | +| `name` | `string` | Output only. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`. | +| `pemCsr` | `string` | Immutable. A pem-encoded X.509 certificate signing request (CSR). | +| `certificateTemplate` | `string` | Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format `projects/*/locations/*/certificateTemplates/*`. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate. | +| `issuerCertificateAuthority` | `string` | Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. | +| `revocationDetails` | `object` | Describes fields that are relavent to the revocation of a Certificate. | +| `config` | `object` | A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. | +| `createTime` | `string` | Output only. The time at which this Certificate was created. | +| `subjectMode` | `string` | Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the `DEFAULT` subject mode will be used. | +| `pemCertificate` | `string` | Output only. The pem-encoded, signed X.509 certificate. | +| `certificateDescription` | `object` | A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. | +| `updateTime` | `string` | Output only. The time at which this Certificate was updated. | +| `pemCertificateChain` | `array` | Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246. | +| `lifetime` | `string` | Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain. | +| `labels` | `object` | Optional. Labels with user-defined metadata. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `caPoolsId, certificatesId, locationsId, projectsId` | Returns a Certificate. | | `list` | `SELECT` | `caPoolsId, locationsId, projectsId` | Lists Certificates. | | `create` | `INSERT` | `caPoolsId, locationsId, projectsId` | Create a new Certificate in a given Project, Location from a particular CaPool. | +| `_list` | `EXEC` | `caPoolsId, locationsId, projectsId` | Lists Certificates. | | `patch` | `EXEC` | `caPoolsId, certificatesId, locationsId, projectsId` | Update a Certificate. Currently, the only field you can update is the labels field. | | `revoke` | `EXEC` | `caPoolsId, certificatesId, locationsId, projectsId` | Revoke a Certificate. | diff --git a/docs/google-docs/providers/google/privateca/index.md b/docs/google-docs/providers/google/privateca/index.md index 910ec5447e..745ab98b00 100644 --- a/docs/google-docs/providers/google/privateca/index.md +++ b/docs/google-docs/providers/google/privateca/index.md @@ -21,7 +21,7 @@ The Certificate Authority Service API Is A Highly-Available, Scalable Service Th
total resources: 11
total selectable resources: 10
-total methods: 44
+total methods: 51
@@ -33,7 +33,7 @@ The Certificate Authority Service API Is A Highly-Available, Scalable Service Th TypeService TitleCertificate Authority API DescriptionThe Certificate Authority Service API Is A Highly-Available, Scalable Service That Enables You To Simplify And Automate The Management Of Private Certificate Authorities (CAs) While Staying In Control Of Your Private Keys. -Idprivateca:v23.08.00155 +Idprivateca:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/privateca/locations/index.md b/docs/google-docs/providers/google/privateca/locations/index.md index aad777fa14..b4d4d31743 100644 --- a/docs/google-docs/providers/google/privateca/locations/index.md +++ b/docs/google-docs/providers/google/privateca/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/privateca/operations/index.md b/docs/google-docs/providers/google/privateca/operations/index.md index fbb56f6841..9085ab05d4 100644 --- a/docs/google-docs/providers/google/privateca/operations/index.md +++ b/docs/google-docs/providers/google/privateca/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/prod_tt_sasportal/customer_node/index.md b/docs/google-docs/providers/google/prod_tt_sasportal/customer_node/index.md index 0144c32dd4..550ac34187 100644 --- a/docs/google-docs/providers/google/prod_tt_sasportal/customer_node/index.md +++ b/docs/google-docs/providers/google/prod_tt_sasportal/customer_node/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name. | -| `displayName` | `string` | The node's display name. | | `sasUserIds` | `array` | User ids used by the devices belonging to this node. | +| `displayName` | `string` | The node's display name. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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 0c31878da4..d76969ac78 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 @@ -27,8 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A pagination token returned from a previous call to ListNodes that indicates from where listing should continue. If the field is missing or empty, it means there is no more nodes. | -| `nodes` | `array` | The nodes that match the request. | +| `name` | `string` | Output only. Resource name. | +| `sasUserIds` | `array` | User ids used by the devices belonging to this node. | +| `displayName` | `string` | The node's display name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,3 +38,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `customers_nodes_create` | `INSERT` | `customersId` | Creates a new node. | | `customers_nodes_nodes_create` | `INSERT` | `customersId, nodesId` | Creates a new node. | | `customers_nodes_delete` | `DELETE` | `customersId, nodesId` | Deletes a node. | +| `_customers_nodes_list` | `EXEC` | `customersId` | Lists nodes. | +| `_customers_nodes_nodes_list` | `EXEC` | `customersId, nodesId` | Lists nodes. | diff --git a/docs/google-docs/providers/google/prod_tt_sasportal/customers/index.md b/docs/google-docs/providers/google/prod_tt_sasportal/customers/index.md index 88aa813091..8eb955bb37 100644 --- a/docs/google-docs/providers/google/prod_tt_sasportal/customers/index.md +++ b/docs/google-docs/providers/google/prod_tt_sasportal/customers/index.md @@ -35,6 +35,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:--------------|:----------------|:------------| | `customers_get` | `SELECT` | `customersId` | Returns a requested customer. | | `customers_list` | `SELECT` | | Returns a list of requested customers. | +| `_customers_list` | `EXEC` | | Returns a list of requested customers. | | `customers_check_has_provisioned_deployment` | `EXEC` | | Checks whether a SAS deployment for the authentication context exists. | | `customers_migrate_organization` | `EXEC` | | Migrates a SAS organization to the cloud. This will create GCP projects for each deployment and associate them. The SAS Organization is linked to the gcp project that called the command. go/sas-legacy-customer-migration | | `customers_patch` | `EXEC` | `customersId` | Updates an existing customer. | 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 887188b0ce..fce012b842 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 @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name. | -| `displayName` | `string` | The deployment's display name. | | `frns` | `array` | Output only. The FCC Registration Numbers (FRNs) copied from its direct parent. | | `sasUserIds` | `array` | User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. | +| `displayName` | `string` | The deployment's display name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -46,6 +46,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `nodes_nodes_deployments_create` | `INSERT` | `nodesId, nodesId1` | Creates a new deployment. | | `customers_deployments_delete` | `DELETE` | `customersId, deploymentsId` | Deletes a deployment. | | `nodes_deployments_delete` | `DELETE` | `deploymentsId, nodesId` | Deletes a deployment. | +| `_customers_deployments_list` | `EXEC` | `customersId` | Lists deployments. | +| `_customers_nodes_deployments_list` | `EXEC` | `customersId, nodesId` | Lists deployments. | +| `_nodes_deployments_list` | `EXEC` | `nodesId` | Lists deployments. | +| `_nodes_nodes_deployments_list` | `EXEC` | `nodesId, nodesId1` | Lists deployments. | | `customers_deployments_move` | `EXEC` | `customersId, deploymentsId` | Moves a deployment under another node or customer. | | `customers_deployments_patch` | `EXEC` | `customersId, deploymentsId` | Updates an existing deployment. | | `nodes_deployments_move` | `EXEC` | `deploymentsId, nodesId` | Moves a deployment under another node or customer. | 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 6dce781fa5..f3bd03746f 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 @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource path name. | +| `fccId` | `string` | The FCC identifier of the device. | +| `deviceMetadata` | `object` | Device data overridable by both SAS Portal and registration requests. | +| `displayName` | `string` | Device display name. | | `grants` | `array` | Output only. Grants held by the device. | +| `state` | `string` | Output only. Device state. | | `grantRangeAllowlists` | `array` | Only ranges that are within the allowlists are available for new grants. | -| `preloadedConfig` | `object` | Information about the device configuration. | -| `currentChannels` | `array` | Output only. Current channels with scores. | -| `deviceMetadata` | `object` | Device data overridable by both SAS Portal and registration requests. | | `activeConfig` | `object` | Information about the device configuration. | +| `currentChannels` | `array` | Output only. Current channels with scores. | | `serialNumber` | `string` | A serial number assigned to the device by the device manufacturer. | -| `displayName` | `string` | Device display name. | -| `fccId` | `string` | The FCC identifier of the device. | -| `state` | `string` | Output only. Device state. | +| `preloadedConfig` | `object` | Information about the device configuration. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -59,6 +59,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `customers_devices_delete` | `DELETE` | `customersId, devicesId` | Deletes a device. | | `deployments_devices_delete` | `DELETE` | `deploymentsId, devicesId` | Deletes a device. | | `nodes_devices_delete` | `DELETE` | `devicesId, nodesId` | Deletes a device. | +| `_customers_deployments_devices_list` | `EXEC` | `customersId, deploymentsId` | Lists devices under a node or customer. | +| `_customers_devices_list` | `EXEC` | `customersId` | Lists devices under a node or customer. | +| `_customers_nodes_devices_list` | `EXEC` | `customersId, nodesId` | Lists devices under a node or customer. | +| `_nodes_deployments_devices_list` | `EXEC` | `deploymentsId, nodesId` | Lists devices under a node or customer. | +| `_nodes_devices_list` | `EXEC` | `nodesId` | Lists devices under a node or customer. | +| `_nodes_nodes_devices_list` | `EXEC` | `nodesId, nodesId1` | Lists devices under a node or customer. | | `customers_devices_move` | `EXEC` | `customersId, devicesId` | Moves a device under another node or customer. | | `customers_devices_patch` | `EXEC` | `customersId, devicesId` | Updates a device. | | `customers_devices_sign_device` | `EXEC` | `customersId, devicesId` | Signs a device. | diff --git a/docs/google-docs/providers/google/prod_tt_sasportal/index.md b/docs/google-docs/providers/google/prod_tt_sasportal/index.md index 11faa5a60d..b39ae7ee6f 100644 --- a/docs/google-docs/providers/google/prod_tt_sasportal/index.md +++ b/docs/google-docs/providers/google/prod_tt_sasportal/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 10
total selectable resources: 7
-total methods: 80
+total methods: 95
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleSAS Portal API (Testing) Description -Idprod_tt_sasportal:v23.08.00155 +Idprod_tt_sasportal:v23.08.00157 ## Resources 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 da9383d655..e267c92d95 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 @@ -27,8 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A pagination token returned from a previous call to ListNodes that indicates from where listing should continue. If the field is missing or empty, it means there is no more nodes. | -| `nodes` | `array` | The nodes that match the request. | +| `name` | `string` | Output only. Resource name. | +| `displayName` | `string` | The node's display name. | +| `sasUserIds` | `array` | User ids used by the devices belonging to this node. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +38,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `nodes_nodes_create` | `INSERT` | `nodesId` | Creates a new node. | | `nodes_nodes_nodes_create` | `INSERT` | `nodesId, nodesId1` | Creates a new node. | | `nodes_nodes_delete` | `DELETE` | `nodesId, nodesId1` | Deletes a node. | +| `_nodes_nodes_list` | `EXEC` | `nodesId` | Lists nodes. | +| `_nodes_nodes_nodes_list` | `EXEC` | `nodesId, nodesId1` | Lists nodes. | | `customers_nodes_move` | `EXEC` | `customersId, nodesId` | Moves a node under another node or customer. | | `customers_nodes_patch` | `EXEC` | `customersId, nodesId` | Updates an existing node. | | `nodes_nodes_move` | `EXEC` | `nodesId, nodesId1` | Moves a node under another node or customer. | diff --git a/docs/google-docs/providers/google/publicca/index.md b/docs/google-docs/providers/google/publicca/index.md index fe6025a421..0315135acb 100644 --- a/docs/google-docs/providers/google/publicca/index.md +++ b/docs/google-docs/providers/google/publicca/index.md @@ -33,7 +33,7 @@ The Public Certificate Authority API May Be Used To Create And Manage ACME Exter TypeService TitlePublic Certificate Authority API DescriptionThe Public Certificate Authority API May Be Used To Create And Manage ACME External Account Binding Keys Associated With Google Trust Services' Publicly Trusted Certificate Authority. -Idpublicca:v23.08.00155 +Idpublicca:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/pubsub/index.md b/docs/google-docs/providers/google/pubsub/index.md index 22a868c307..1268641208 100644 --- a/docs/google-docs/providers/google/pubsub/index.md +++ b/docs/google-docs/providers/google/pubsub/index.md @@ -21,7 +21,7 @@ Provides Reliable, Many-To-Many, Asynchronous Messaging Between Applications.
total resources: 10
total selectable resources: 9
-total methods: 46
+total methods: 53
@@ -33,7 +33,7 @@ Provides Reliable, Many-To-Many, Asynchronous Messaging Between Applications. TypeService TitleCloud Pub/Sub API DescriptionProvides Reliable, Many-To-Many, Asynchronous Messaging Between Applications. -Idpubsub:v23.08.00155 +Idpubsub:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/pubsub/schemas/index.md b/docs/google-docs/providers/google/pubsub/schemas/index.md index be87aec426..750616694b 100644 --- a/docs/google-docs/providers/google/pubsub/schemas/index.md +++ b/docs/google-docs/providers/google/pubsub/schemas/index.md @@ -39,6 +39,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_schemas_list` | `SELECT` | `projectsId` | Lists schemas in a project. | | `projects_schemas_create` | `INSERT` | `projectsId` | Creates a schema. | | `projects_schemas_delete` | `DELETE` | `projectsId, schemasId` | Deletes a schema. | +| `_projects_schemas_list` | `EXEC` | `projectsId` | Lists schemas in a project. | | `projects_schemas_commit` | `EXEC` | `projectsId, schemasId` | Commits a new schema revision to an existing schema. | | `projects_schemas_rollback` | `EXEC` | `projectsId, schemasId` | Creates a new schema revision that is a copy of the provided revision_id. | | `projects_schemas_validate` | `EXEC` | `projectsId` | Validates a schema. | diff --git a/docs/google-docs/providers/google/pubsub/schemas_iam_policies/index.md b/docs/google-docs/providers/google/pubsub/schemas_iam_policies/index.md index 5aa6ca19fd..03c843951d 100644 --- a/docs/google-docs/providers/google/pubsub/schemas_iam_policies/index.md +++ b/docs/google-docs/providers/google/pubsub/schemas_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/pubsub/schemas_revisions/index.md b/docs/google-docs/providers/google/pubsub/schemas_revisions/index.md index 9dafc3095f..6c2f5850fa 100644 --- a/docs/google-docs/providers/google/pubsub/schemas_revisions/index.md +++ b/docs/google-docs/providers/google/pubsub/schemas_revisions/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `schemas` | `array` | The revisions of the schema. | -| `nextPageToken` | `string` | A token that can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages. | +| `name` | `string` | Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. | +| `definition` | `string` | The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. | +| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | +| `revisionId` | `string` | Output only. Immutable. The revision ID of the schema. | +| `type` | `string` | The type of the schema definition. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_schemas_list_revisions` | `SELECT` | `projectsId, schemasId` | +| `_projects_schemas_list_revisions` | `EXEC` | `projectsId, schemasId` | diff --git a/docs/google-docs/providers/google/pubsub/snapshots/index.md b/docs/google-docs/providers/google/pubsub/snapshots/index.md index 06e14cc323..3fce13e244 100644 --- a/docs/google-docs/providers/google/pubsub/snapshots/index.md +++ b/docs/google-docs/providers/google/pubsub/snapshots/index.md @@ -27,14 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Optional. If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new `ListSnapshotsRequest`. | -| `snapshots` | `array` | Optional. The resulting snapshots. | +| `name` | `string` | Optional. The name of the snapshot. | +| `labels` | `object` | Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels). | +| `topic` | `string` | Optional. The name of the topic from which this snapshot is retaining messages. | +| `expireTime` | `string` | Optional. The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is `7 days - (age of oldest unacked message in the subscription)`. For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_snapshots_list` | `SELECT` | `projectsId` | Lists the existing snapshots. Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. | | `projects_topics_snapshots_list` | `SELECT` | `projectsId, topicsId` | Lists the names of the snapshots on this topic. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. | | `projects_snapshots_delete` | `DELETE` | `projectsId, snapshotsId` | Removes an existing snapshot. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified. | +| `_projects_snapshots_list` | `EXEC` | `projectsId` | Lists the existing snapshots. Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. | +| `_projects_topics_snapshots_list` | `EXEC` | `projectsId, topicsId` | Lists the names of the snapshots on this topic. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. | | `projects_snapshots_create` | `EXEC` | `projectsId, snapshotsId` | Creates a snapshot from the requested subscription. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. If the snapshot already exists, returns `ALREADY_EXISTS`. If the requested subscription doesn't exist, returns `NOT_FOUND`. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned. See also the `Snapshot.expire_time` field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request. | | `projects_snapshots_get` | `EXEC` | `projectsId, snapshotsId` | Gets the configuration details of a snapshot. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. | | `projects_snapshots_patch` | `EXEC` | `projectsId, snapshotsId` | Updates an existing snapshot. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. | diff --git a/docs/google-docs/providers/google/pubsub/subscriptions/index.md b/docs/google-docs/providers/google/pubsub/subscriptions/index.md index d7887b3b80..fdc0c93ba6 100644 --- a/docs/google-docs/providers/google/pubsub/subscriptions/index.md +++ b/docs/google-docs/providers/google/pubsub/subscriptions/index.md @@ -25,16 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | Optional. If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListTopicSubscriptionsRequest` to get more subscriptions. | -| `subscriptions` | `array` | Optional. The names of subscriptions attached to the topic specified in the request. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_subscriptions_list` | `SELECT` | `projectsId` | Lists matching subscriptions. | | `projects_topics_subscriptions_list` | `SELECT` | `projectsId, topicsId` | Lists the names of the attached subscriptions on this topic. | | `projects_subscriptions_delete` | `DELETE` | `projectsId, subscriptionsId` | Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified. | +| `_projects_subscriptions_list` | `EXEC` | `projectsId` | Lists matching subscriptions. | +| `_projects_topics_subscriptions_list` | `EXEC` | `projectsId, topicsId` | Lists the names of the attached subscriptions on this topic. | | `projects_subscriptions_acknowledge` | `EXEC` | `projectsId, subscriptionsId` | Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error. | | `projects_subscriptions_create` | `EXEC` | `projectsId, subscriptionsId` | Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request. | | `projects_subscriptions_detach` | `EXEC` | `projectsId, subscriptionsId` | Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop. | diff --git a/docs/google-docs/providers/google/pubsub/subscriptions_iam_policies/index.md b/docs/google-docs/providers/google/pubsub/subscriptions_iam_policies/index.md index 22d41e9633..4dee8a46a6 100644 --- a/docs/google-docs/providers/google/pubsub/subscriptions_iam_policies/index.md +++ b/docs/google-docs/providers/google/pubsub/subscriptions_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/pubsub/topics/index.md b/docs/google-docs/providers/google/pubsub/topics/index.md index 1c80d46567..9cf71e52ce 100644 --- a/docs/google-docs/providers/google/pubsub/topics/index.md +++ b/docs/google-docs/providers/google/pubsub/topics/index.md @@ -27,13 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `topics` | `array` | Optional. The resulting topics. | -| `nextPageToken` | `string` | Optional. If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`. | +| `name` | `string` | Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. | +| `messageRetentionDuration` | `string` | Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last `message_retention_duration` are always available to subscribers. For instance, it allows any attached subscription to [seek to a timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) that is up to `message_retention_duration` in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes. | +| `messageStoragePolicy` | `object` | A policy constraining the storage of messages published to the topic. | +| `satisfiesPzs` | `boolean` | Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. | +| `schemaSettings` | `object` | Settings for validating messages published against a schema. | +| `kmsKeyName` | `string` | Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. | +| `labels` | `object` | Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_topics_list` | `SELECT` | `projectsId` | Lists matching topics. | | `projects_topics_delete` | `DELETE` | `projectsId, topicsId` | Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`. | +| `_projects_topics_list` | `EXEC` | `projectsId` | Lists matching topics. | | `projects_topics_create` | `EXEC` | `projectsId, topicsId` | Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). | | `projects_topics_get` | `EXEC` | `projectsId, topicsId` | Gets the configuration of a topic. | | `projects_topics_patch` | `EXEC` | `projectsId, topicsId` | Updates an existing topic. Note that certain properties of a topic are not modifiable. | diff --git a/docs/google-docs/providers/google/pubsub/topics_iam_policies/index.md b/docs/google-docs/providers/google/pubsub/topics_iam_policies/index.md index c2986bb31f..661014075f 100644 --- a/docs/google-docs/providers/google/pubsub/topics_iam_policies/index.md +++ b/docs/google-docs/providers/google/pubsub/topics_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/pubsublite/cursors/index.md b/docs/google-docs/providers/google/pubsublite/cursors/index.md index 35b2838261..c3c0596fa4 100644 --- a/docs/google-docs/providers/google/pubsublite/cursors/index.md +++ b/docs/google-docs/providers/google/pubsublite/cursors/index.md @@ -27,9 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `partitionCursors` | `array` | The partition cursors from this request. | +| `partition` | `string` | The partition this is for. | +| `cursor` | `object` | A cursor that describes the position of a message within a topic partition. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `cursor_projects_locations_subscriptions_cursors_list` | `SELECT` | `locationsId, projectsId, subscriptionsId` | +| `_cursor_projects_locations_subscriptions_cursors_list` | `EXEC` | `locationsId, projectsId, subscriptionsId` | diff --git a/docs/google-docs/providers/google/pubsublite/index.md b/docs/google-docs/providers/google/pubsublite/index.md index 97eb027aa6..7700ac96c2 100644 --- a/docs/google-docs/providers/google/pubsublite/index.md +++ b/docs/google-docs/providers/google/pubsublite/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 6
total selectable resources: 6
-total methods: 28
+total methods: 35
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitlePub/Sub Lite API Description -Idpubsublite:v23.08.00155 +Idpubsublite:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/pubsublite/operations/index.md b/docs/google-docs/providers/google/pubsublite/operations/index.md index 0cd3a242ac..3b74559a0b 100644 --- a/docs/google-docs/providers/google/pubsublite/operations/index.md +++ b/docs/google-docs/providers/google/pubsublite/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `admin_projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `admin_projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_admin_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `admin_projects_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | | `admin_projects_locations_operations_get` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/pubsublite/reservations/index.md b/docs/google-docs/providers/google/pubsublite/reservations/index.md index 05114c5dac..6f07ff8a16 100644 --- a/docs/google-docs/providers/google/pubsublite/reservations/index.md +++ b/docs/google-docs/providers/google/pubsublite/reservations/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. | -| `reservations` | `array` | The list of reservation in the requested parent. The order of the reservations is unspecified. | +| `name` | `string` | The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} | +| `throughputCapacity` | `string` | The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared as using capacity from a Reservation will consume resources from this reservation instead of being charged individually. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +36,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `admin_projects_locations_reservations_list` | `SELECT` | `locationsId, projectsId` | Returns the list of reservations for the given project. | | `admin_projects_locations_reservations_create` | `INSERT` | `locationsId, projectsId` | Creates a new reservation. | | `admin_projects_locations_reservations_delete` | `DELETE` | `locationsId, projectsId, reservationsId` | Deletes the specified reservation. | +| `_admin_projects_locations_reservations_list` | `EXEC` | `locationsId, projectsId` | Returns the list of reservations for the given project. | | `admin_projects_locations_reservations_patch` | `EXEC` | `locationsId, projectsId, reservationsId` | Updates properties of the specified reservation. | diff --git a/docs/google-docs/providers/google/pubsublite/subscriptions/index.md b/docs/google-docs/providers/google/pubsublite/subscriptions/index.md index d296048d00..c66eb3db6f 100644 --- a/docs/google-docs/providers/google/pubsublite/subscriptions/index.md +++ b/docs/google-docs/providers/google/pubsublite/subscriptions/index.md @@ -27,8 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. | -| `subscriptions` | `array` | The names of subscriptions attached to the topic. The order of the subscriptions is unspecified. | +| `name` | `string` | The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} | +| `deliveryConfig` | `object` | The settings for a subscription's message delivery. | +| `exportConfig` | `object` | Configuration for a Pub/Sub Lite subscription that writes messages to a destination. User subscriber clients must not connect to this subscription. | +| `topic` | `string` | The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +39,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `admin_projects_locations_topics_subscriptions_list` | `SELECT` | `locationsId, projectsId, topicsId` | Lists the subscriptions attached to the specified topic. | | `admin_projects_locations_subscriptions_create` | `INSERT` | `locationsId, projectsId` | Creates a new subscription. | | `admin_projects_locations_subscriptions_delete` | `DELETE` | `locationsId, projectsId, subscriptionsId` | Deletes the specified subscription. | +| `_admin_projects_locations_subscriptions_list` | `EXEC` | `locationsId, projectsId` | Returns the list of subscriptions for the given project. | +| `_admin_projects_locations_topics_subscriptions_list` | `EXEC` | `locationsId, projectsId, topicsId` | Lists the subscriptions attached to the specified topic. | | `admin_projects_locations_subscriptions_patch` | `EXEC` | `locationsId, projectsId, subscriptionsId` | Updates properties of the specified subscription. | | `admin_projects_locations_subscriptions_seek` | `EXEC` | `locationsId, projectsId, subscriptionsId` | Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog. Seek translates these targets to cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors. If an operation is returned, the seek has been registered and subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients. If clients would like to know when subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online. If the previous seek operation has not yet completed, it will be aborted and the new invocation of seek will supersede it. | | `cursor_projects_locations_subscriptions_commit_cursor` | `EXEC` | `locationsId, projectsId, subscriptionsId` | Updates the committed cursor. | diff --git a/docs/google-docs/providers/google/pubsublite/topics/index.md b/docs/google-docs/providers/google/pubsublite/topics/index.md index 2cf8d12361..91aab2740b 100644 --- a/docs/google-docs/providers/google/pubsublite/topics/index.md +++ b/docs/google-docs/providers/google/pubsublite/topics/index.md @@ -25,10 +25,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. | -| `topics` | `array` | The list of topic in the requested parent. The order of the topics is unspecified. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +33,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `admin_projects_locations_topics_list` | `SELECT` | `locationsId, projectsId` | Returns the list of topics for the given project. | | `admin_projects_locations_topics_create` | `INSERT` | `locationsId, projectsId` | Creates a new topic. | | `admin_projects_locations_topics_delete` | `DELETE` | `locationsId, projectsId, topicsId` | Deletes the specified topic. | +| `_admin_projects_locations_reservations_topics_list` | `EXEC` | `locationsId, projectsId, reservationsId` | Lists the topics attached to the specified reservation. | +| `_admin_projects_locations_topics_list` | `EXEC` | `locationsId, projectsId` | Returns the list of topics for the given project. | | `admin_projects_locations_topics_patch` | `EXEC` | `locationsId, projectsId, topicsId` | Updates properties of the specified topic. | | `topic_stats_projects_locations_topics_compute_head_cursor` | `EXEC` | `locationsId, projectsId, topicsId` | Compute the head cursor for the partition. The head cursor's offset is guaranteed to be less than or equal to all messages which have not yet been acknowledged as published, and greater than the offset of any message whose publish has already been acknowledged. It is zero if there have never been messages in the partition. | | `topic_stats_projects_locations_topics_compute_message_stats` | `EXEC` | `locationsId, projectsId, topicsId` | Compute statistics about a range of messages in a given topic and partition. | diff --git a/docs/google-docs/providers/google/recaptchaenterprise/firewallpolicies/index.md b/docs/google-docs/providers/google/recaptchaenterprise/firewallpolicies/index.md index 16cc787651..5209fa8350 100644 --- a/docs/google-docs/providers/google/recaptchaenterprise/firewallpolicies/index.md +++ b/docs/google-docs/providers/google/recaptchaenterprise/firewallpolicies/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results. It is set to empty if no policies remain in results. | -| `firewallPolicies` | `array` | Policy details. | +| `name` | `string` | The resource name for the FirewallPolicy in the format "projects/{project}/firewallpolicies/{firewallpolicy}". | +| `description` | `string` | A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters. | +| `path` | `string` | The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters. | +| `actions` | `array` | The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions. | +| `condition` | `string` | A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId` | Returns the list of all firewall policies that belong to a project. | | `create` | `INSERT` | `projectsId` | Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies. | | `delete` | `DELETE` | `firewallpoliciesId, projectsId` | Deletes the specified firewall policy. | +| `_list` | `EXEC` | `projectsId` | Returns the list of all firewall policies that belong to a project. | | `patch` | `EXEC` | `firewallpoliciesId, projectsId` | Updates the specified firewall policy. | diff --git a/docs/google-docs/providers/google/recaptchaenterprise/index.md b/docs/google-docs/providers/google/recaptchaenterprise/index.md index 8c91f86159..8495ef203c 100644 --- a/docs/google-docs/providers/google/recaptchaenterprise/index.md +++ b/docs/google-docs/providers/google/recaptchaenterprise/index.md @@ -21,7 +21,7 @@ Help Protect Your Website From Fraudulent Activity, Spam, And Abuse Without Crea
total resources: 8
total selectable resources: 5
-total methods: 18
+total methods: 22
@@ -33,7 +33,7 @@ Help Protect Your Website From Fraudulent Activity, Spam, And Abuse Without Crea TypeService TitleReCAPTCHA Enterprise API DescriptionHelp Protect Your Website From Fraudulent Activity, Spam, And Abuse Without Creating Friction. -Idrecaptchaenterprise:v23.08.00155 +Idrecaptchaenterprise:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/recaptchaenterprise/keys/index.md b/docs/google-docs/providers/google/recaptchaenterprise/keys/index.md index a271368f7e..ee508a8a7b 100644 --- a/docs/google-docs/providers/google/recaptchaenterprise/keys/index.md +++ b/docs/google-docs/providers/google/recaptchaenterprise/keys/index.md @@ -27,8 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `keys` | `array` | Key details. | -| `nextPageToken` | `string` | Token to retrieve the next page of results. It is set to empty if no keys remain in results. | +| `name` | `string` | The resource name for the Key in the format "projects/{project}/keys/{key}". | +| `iosSettings` | `object` | Settings specific to keys that can be used by iOS apps. | +| `createTime` | `string` | Output only. The timestamp corresponding to the creation of this key. | +| `wafSettings` | `object` | Settings specific to keys that can be used for WAF (Web Application Firewall). | +| `androidSettings` | `object` | Settings specific to keys that can be used by Android apps. | +| `labels` | `object` | See Creating and managing labels. | +| `displayName` | `string` | Human-readable display name of this key. Modifiable by user. | +| `testingOptions` | `object` | Options for user acceptance testing. | +| `webSettings` | `object` | Settings specific to keys that can be used by websites. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +43,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId` | Returns the list of all keys that belong to a project. | | `create` | `INSERT` | `projectsId` | Creates a new reCAPTCHA Enterprise key. | | `delete` | `DELETE` | `keysId, projectsId` | Deletes the specified key. | +| `_list` | `EXEC` | `projectsId` | Returns the list of all keys that belong to a project. | | `migrate` | `EXEC` | `keysId, projectsId` | Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must be authenticated as one of the current owners of the reCAPTCHA Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project. | | `patch` | `EXEC` | `keysId, projectsId` | Updates the specified key. | diff --git a/docs/google-docs/providers/google/recaptchaenterprise/keys_metrics/index.md b/docs/google-docs/providers/google/recaptchaenterprise/keys_metrics/index.md index 9da6a370b4..50247d51e3 100644 --- a/docs/google-docs/providers/google/recaptchaenterprise/keys_metrics/index.md +++ b/docs/google-docs/providers/google/recaptchaenterprise/keys_metrics/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the metrics, in the format "projects/{project}/keys/{key}/metrics". | -| `challengeMetrics` | `array` | Metrics will be continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have challenge-based data. | | `scoreMetrics` | `array` | Metrics will be continuous and in order by dates, and in the granularity of day. All Key types should have score-based data. | | `startTime` | `string` | Inclusive start time aligned to a day (UTC). | +| `challengeMetrics` | `array` | Metrics will be continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have challenge-based data. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/recaptchaenterprise/memberships/index.md b/docs/google-docs/providers/google/recaptchaenterprise/memberships/index.md index f1ad819035..eaf7acae52 100644 --- a/docs/google-docs/providers/google/recaptchaenterprise/memberships/index.md +++ b/docs/google-docs/providers/google/recaptchaenterprise/memberships/index.md @@ -27,9 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `relatedAccountGroupMemberships` | `array` | The memberships listed by the query. | +| `name` | `string` | Required. The resource name for this membership in the format `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}`. | +| `hashedAccountId` | `string` | The unique stable hashed user identifier of the member. The identifier corresponds to a `hashed_account_id` provided in a previous `CreateAssessment` or `AnnotateAssessment` call. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `projectsId, relatedaccountgroupsId` | +| `_list` | `EXEC` | `projectsId, relatedaccountgroupsId` | diff --git a/docs/google-docs/providers/google/recaptchaenterprise/relatedaccountgroups/index.md b/docs/google-docs/providers/google/recaptchaenterprise/relatedaccountgroups/index.md index 4e525f580e..746ff67670 100644 --- a/docs/google-docs/providers/google/recaptchaenterprise/relatedaccountgroups/index.md +++ b/docs/google-docs/providers/google/recaptchaenterprise/relatedaccountgroups/index.md @@ -25,11 +25,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `relatedAccountGroups` | `array` | The groups of related accounts listed by the query. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `projectsId` | +| `_list` | `EXEC` | `projectsId` | diff --git a/docs/google-docs/providers/google/recommendationengine/catalog_items/index.md b/docs/google-docs/providers/google/recommendationengine/catalog_items/index.md index 579242b2de..570fc299af 100644 --- a/docs/google-docs/providers/google/recommendationengine/catalog_items/index.md +++ b/docs/google-docs/providers/google/recommendationengine/catalog_items/index.md @@ -27,8 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If empty, the list is complete. If nonempty, the token to pass to the next request's ListCatalogItemRequest.page_token. | -| `catalogItems` | `array` | The catalog items. | +| `id` | `string` | Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog. | +| `description` | `string` | Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB. | +| `categoryHierarchies` | `array` | Required. Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categoryHierarchies": [ { "categories": ["Shoes & Accessories", "Shoes"]}, { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] } ] | +| `itemAttributes` | `object` | FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features. | +| `languageCode` | `string` | Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance. | +| `itemGroupId` | `string` | Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id). | +| `title` | `string` | Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB. | +| `productMetadata` | `object` | ProductCatalogItem captures item metadata specific to retail products. | +| `tags` | `array` | Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +43,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_catalogs_catalog_items_list` | `SELECT` | `catalogsId, locationsId, projectsId` | Gets a list of catalog items. | | `projects_locations_catalogs_catalog_items_create` | `INSERT` | `catalogsId, locationsId, projectsId` | Creates a catalog item. | | `projects_locations_catalogs_catalog_items_delete` | `DELETE` | `catalogItemsId, catalogsId, locationsId, projectsId` | Deletes a catalog item. | +| `_projects_locations_catalogs_catalog_items_list` | `EXEC` | `catalogsId, locationsId, projectsId` | Gets a list of catalog items. | | `projects_locations_catalogs_catalog_items_import` | `EXEC` | `catalogsId, locationsId, projectsId` | Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated. | | `projects_locations_catalogs_catalog_items_patch` | `EXEC` | `catalogItemsId, catalogsId, locationsId, projectsId` | Updates a catalog item. Partial updating is supported. Non-existing items will be created. | diff --git a/docs/google-docs/providers/google/recommendationengine/catalogs/index.md b/docs/google-docs/providers/google/recommendationengine/catalogs/index.md index cb05130c54..75c298a991 100644 --- a/docs/google-docs/providers/google/recommendationengine/catalogs/index.md +++ b/docs/google-docs/providers/google/recommendationengine/catalogs/index.md @@ -27,10 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Pagination token, if not returned indicates the last page. | -| `catalogs` | `array` | Output only. All the customer's catalogs. | +| `name` | `string` | The fully qualified resource name of the catalog. | +| `catalogItemLevelConfig` | `object` | Configures the catalog level that users send events to, and the level at which predictions are made. | +| `defaultEventStoreId` | `string` | Required. The ID of the default event store. | +| `displayName` | `string` | Required. The catalog display name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_catalogs_list` | `SELECT` | `locationsId, projectsId` | Lists all the catalog configurations associated with the project. | +| `_projects_locations_catalogs_list` | `EXEC` | `locationsId, projectsId` | Lists all the catalog configurations associated with the project. | | `projects_locations_catalogs_patch` | `EXEC` | `catalogsId, locationsId, projectsId` | Updates the catalog configuration. | diff --git a/docs/google-docs/providers/google/recommendationengine/index.md b/docs/google-docs/providers/google/recommendationengine/index.md index c4ad490538..e1f0aadc26 100644 --- a/docs/google-docs/providers/google/recommendationengine/index.md +++ b/docs/google-docs/providers/google/recommendationengine/index.md @@ -21,7 +21,7 @@ Note That We Now Highly Recommend New Customers To Use Retail API, Which Incorpo
total resources: 6
total selectable resources: 5
-total methods: 22
+total methods: 28
@@ -33,7 +33,7 @@ Note That We Now Highly Recommend New Customers To Use Retail API, Which Incorpo TypeService TitleRecommendations AI (Beta) DescriptionNote That We Now Highly Recommend New Customers To Use Retail API, Which Incorporates The GA Version Of The Recommendations AI Funtionalities. To Enable Retail API, Please Visit Https://Console.Cloud.Google.Com/Apis/Library/Retail.Googleapis.Com. The Recommendations AI Service Enables Customers To Build End-To-End Personalized Recommendation Systems Without Requiring A High Level Of Expertise In Machine Learning, Recommendation System, Or Google Cloud. -Idrecommendationengine:v23.08.00155 +Idrecommendationengine:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/recommendationengine/operations/index.md b/docs/google-docs/providers/google/recommendationengine/operations/index.md index d9f314346e..3073f6fa79 100644 --- a/docs/google-docs/providers/google/recommendationengine/operations/index.md +++ b/docs/google-docs/providers/google/recommendationengine/operations/index.md @@ -27,12 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| | `projects_locations_catalogs_event_stores_operations_list` | `SELECT` | `catalogsId, eventStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_catalogs_operations_list` | `SELECT` | `catalogsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_catalogs_event_stores_operations_list` | `EXEC` | `catalogsId, eventStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_catalogs_operations_list` | `EXEC` | `catalogsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_catalogs_event_stores_operations_get` | `EXEC` | `catalogsId, eventStoresId, locationsId, operationsId, projectsId` | 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. | | `projects_locations_catalogs_operations_get` | `EXEC` | `catalogsId, locationsId, operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/recommendationengine/prediction_api_key_registrations/index.md b/docs/google-docs/providers/google/recommendationengine/prediction_api_key_registrations/index.md index 25b9ebac4d..adac90f118 100644 --- a/docs/google-docs/providers/google/recommendationengine/prediction_api_key_registrations/index.md +++ b/docs/google-docs/providers/google/recommendationengine/prediction_api_key_registrations/index.md @@ -25,13 +25,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | If empty, the list is complete. If nonempty, pass the token to the next request's `ListPredictionApiKeysRegistrationsRequest.pageToken`. | -| `predictionApiKeyRegistrations` | `array` | The list of registered API keys. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_catalogs_event_stores_prediction_api_key_registrations_list` | `SELECT` | `catalogsId, eventStoresId, locationsId, projectsId` | List the registered apiKeys for use with predict method. | | `projects_locations_catalogs_event_stores_prediction_api_key_registrations_create` | `INSERT` | `catalogsId, eventStoresId, locationsId, projectsId` | Register an API key for use with predict method. | | `projects_locations_catalogs_event_stores_prediction_api_key_registrations_delete` | `DELETE` | `catalogsId, eventStoresId, locationsId, predictionApiKeyRegistrationsId, projectsId` | Unregister an apiKey from using for predict method. | +| `_projects_locations_catalogs_event_stores_prediction_api_key_registrations_list` | `EXEC` | `catalogsId, eventStoresId, locationsId, projectsId` | List the registered apiKeys for use with predict method. | diff --git a/docs/google-docs/providers/google/recommendationengine/user_events/index.md b/docs/google-docs/providers/google/recommendationengine/user_events/index.md index 2b14b260ef..1a98a04ea0 100644 --- a/docs/google-docs/providers/google/recommendationengine/user_events/index.md +++ b/docs/google-docs/providers/google/recommendationengine/user_events/index.md @@ -27,12 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If empty, the list is complete. If nonempty, the token to pass to the next request's ListUserEvents.page_token. | -| `userEvents` | `array` | The user events. | +| `userInfo` | `object` | Information of end users. | +| `eventDetail` | `object` | User event details shared by all recommendation types. | +| `eventSource` | `string` | Optional. This field should *not* be set when using JavaScript pixel or the Recommendations AI Tag. Defaults to `EVENT_SOURCE_UNSPECIFIED`. | +| `eventTime` | `string` | Optional. Only required for ImportUserEvents method. Timestamp of user event created. | +| `eventType` | `string` | Required. User event type. Allowed values are: * `add-to-cart` Products being added to cart. * `add-to-list` Items being added to a list (shopping list, favorites etc). * `category-page-view` Special pages such as sale or promotion pages viewed. * `checkout-start` User starting a checkout process. * `detail-page-view` Products detail page viewed. * `home-page-view` Homepage viewed. * `page-visit` Generic page visits not included in the event types above. * `purchase-complete` User finishing a purchase. * `refund` Purchased items being refunded or returned. * `remove-from-cart` Products being removed from cart. * `remove-from-list` Items being removed from a list. * `search` Product search. * `shopping-cart-page-view` User viewing a shopping cart. * `impression` List of items displayed. Used by Google Tag Manager. | +| `productEventDetail` | `object` | ProductEventDetail captures user event information specific to retail products. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_catalogs_event_stores_user_events_list` | `SELECT` | `catalogsId, eventStoresId, locationsId, projectsId` | Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event. | +| `_projects_locations_catalogs_event_stores_user_events_list` | `EXEC` | `catalogsId, eventStoresId, locationsId, projectsId` | Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event. | | `projects_locations_catalogs_event_stores_user_events_collect` | `EXEC` | `catalogsId, eventStoresId, locationsId, projectsId` | Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Recommendations AI JavaScript pixel. Users should not call this method directly. | | `projects_locations_catalogs_event_stores_user_events_import` | `EXEC` | `catalogsId, eventStoresId, locationsId, projectsId` | Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. | | `projects_locations_catalogs_event_stores_user_events_purge` | `EXEC` | `catalogsId, eventStoresId, locationsId, projectsId` | Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. | diff --git a/docs/google-docs/providers/google/recommender/index.md b/docs/google-docs/providers/google/recommender/index.md index c763b93e4f..a00c28ccd7 100644 --- a/docs/google-docs/providers/google/recommender/index.md +++ b/docs/google-docs/providers/google/recommender/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 4
total selectable resources: 2
-total methods: 48
+total methods: 56
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleRecommender API Description -Idrecommender:v23.08.00155 +Idrecommender:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/recommender/insights/index.md b/docs/google-docs/providers/google/recommender/insights/index.md index 6aad3a1fdd..f86b48796a 100644 --- a/docs/google-docs/providers/google/recommender/insights/index.md +++ b/docs/google-docs/providers/google/recommender/insights/index.md @@ -27,8 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `insights` | `array` | The set of insights for the `parent` resource. | -| `nextPageToken` | `string` | A token that can be used to request the next page of results. This field is empty if there are no additional results. | +| `name` | `string` | Name of the insight. | +| `description` | `string` | Free-form human readable summary in English. The maximum length is 500 characters. | +| `lastRefreshTime` | `string` | Timestamp of the latest data used to generate the insight. | +| `etag` | `string` | Fingerprint of the Insight. Provides optimistic locking when updating states. | +| `targetResources` | `array` | Fully qualified resource names that this insight is targeting. | +| `associatedRecommendations` | `array` | Recommendations derived from this insight. | +| `severity` | `string` | Insight's severity. | +| `stateInfo` | `object` | Information related to insight state. | +| `insightSubtype` | `string` | Insight subtype. Insight content schema will be stable for a given subtype. | +| `observationPeriod` | `string` | Observation period that led to the insight. The source data used to generate the insight ends at last_refresh_time and begins at (last_refresh_time - observation_period). | +| `category` | `string` | Category being targeted by the insight. | +| `content` | `object` | A struct of custom fields to explain the insight. Example: "grantedPermissionsCount": "1000" | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +46,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `folders_locations_insight_types_insights_list` | `SELECT` | `foldersId, insightTypesId, locationsId` | Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. | | `organizations_locations_insight_types_insights_list` | `SELECT` | `insightTypesId, locationsId, organizationsId` | Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. | | `projects_locations_insight_types_insights_list` | `SELECT` | `insightTypesId, locationsId, projectsId` | Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. | +| `_billing_accounts_locations_insight_types_insights_list` | `EXEC` | `billingAccountsId, insightTypesId, locationsId` | Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. | +| `_folders_locations_insight_types_insights_list` | `EXEC` | `foldersId, insightTypesId, locationsId` | Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. | +| `_organizations_locations_insight_types_insights_list` | `EXEC` | `insightTypesId, locationsId, organizationsId` | Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. | +| `_projects_locations_insight_types_insights_list` | `EXEC` | `insightTypesId, locationsId, projectsId` | Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. | | `billing_accounts_locations_insight_types_insights_get` | `EXEC` | `billingAccountsId, insightTypesId, insightsId, locationsId` | Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. | | `billing_accounts_locations_insight_types_insights_mark_accepted` | `EXEC` | `billingAccountsId, insightTypesId, insightsId, locationsId` | Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight. | | `folders_locations_insight_types_insights_get` | `EXEC` | `foldersId, insightTypesId, insightsId, locationsId` | Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. | diff --git a/docs/google-docs/providers/google/recommender/recommendations/index.md b/docs/google-docs/providers/google/recommender/recommendations/index.md index 160a895d0b..4a18535470 100644 --- a/docs/google-docs/providers/google/recommender/recommendations/index.md +++ b/docs/google-docs/providers/google/recommender/recommendations/index.md @@ -27,8 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token that can be used to request the next page of results. This field is empty if there are no additional results. | -| `recommendations` | `array` | The set of recommendations for the `parent` resource. | +| `name` | `string` | Name of recommendation. | +| `description` | `string` | Free-form human readable summary in English. The maximum length is 500 characters. | +| `associatedInsights` | `array` | Insights that led to this recommendation. | +| `lastRefreshTime` | `string` | Last time this recommendation was refreshed by the system that created it in the first place. | +| `additionalImpact` | `array` | Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative. | +| `xorGroupId` | `string` | Corresponds to a mutually exclusive group ID within a recommender. A non-empty ID indicates that the recommendation belongs to a mutually exclusive group. This means that only one recommendation within the group is suggested to be applied. | +| `etag` | `string` | Fingerprint of the Recommendation. Provides optimistic locking when updating states. | +| `recommenderSubtype` | `string` | Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" | +| `content` | `object` | Contains what resources are changing and how they are changing. | +| `primaryImpact` | `object` | Contains the impact a recommendation can have for a given category. | +| `priority` | `string` | Recommendation's priority. | +| `stateInfo` | `object` | Information for state. Contains state and metadata. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -40,6 +50,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_locations_recommenders_recommendations_list` | `SELECT` | `locationsId, organizationsId, recommendersId` | Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender. | | `projects_locations_recommenders_recommendations_get` | `SELECT` | `locationsId, projectsId, recommendationsId, recommendersId` | Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender. | | `projects_locations_recommenders_recommendations_list` | `SELECT` | `locationsId, projectsId, recommendersId` | Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender. | +| `_billing_accounts_locations_recommenders_recommendations_list` | `EXEC` | `billingAccountsId, locationsId, recommendersId` | Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender. | +| `_folders_locations_recommenders_recommendations_list` | `EXEC` | `foldersId, locationsId, recommendersId` | Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender. | +| `_organizations_locations_recommenders_recommendations_list` | `EXEC` | `locationsId, organizationsId, recommendersId` | Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender. | +| `_projects_locations_recommenders_recommendations_list` | `EXEC` | `locationsId, projectsId, recommendersId` | Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender. | | `billing_accounts_locations_recommenders_recommendations_mark_claimed` | `EXEC` | `billingAccountsId, locationsId, recommendationsId, recommendersId` | Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. | | `billing_accounts_locations_recommenders_recommendations_mark_dismissed` | `EXEC` | `billingAccountsId, locationsId, recommendationsId, recommendersId` | Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. | | `billing_accounts_locations_recommenders_recommendations_mark_failed` | `EXEC` | `billingAccountsId, locationsId, recommendationsId, recommendersId` | Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. | diff --git a/docs/google-docs/providers/google/redis/index.md b/docs/google-docs/providers/google/redis/index.md index 8f4cef1cb9..420f4ab684 100644 --- a/docs/google-docs/providers/google/redis/index.md +++ b/docs/google-docs/providers/google/redis/index.md @@ -21,7 +21,7 @@ Creates And Manages Redis Instances On The Google Cloud Platform.
total resources: 4
total selectable resources: 4
-total methods: 17
+total methods: 20
@@ -33,7 +33,7 @@ Creates And Manages Redis Instances On The Google Cloud Platform. TypeService TitleGoogle Cloud Memorystore For Redis API DescriptionCreates And Manages Redis Instances On The Google Cloud Platform. -Idredis:v23.08.00155 +Idredis:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/redis/instances/index.md b/docs/google-docs/providers/google/redis/instances/index.md index b5ccb951a0..79e2b38899 100644 --- a/docs/google-docs/providers/google/redis/instances/index.md +++ b/docs/google-docs/providers/google/redis/instances/index.md @@ -27,9 +27,41 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `instances` | `array` | A list of Redis instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder Redis entry is included in the response with the `name` field set to a value of the form `projects/{project_id}/locations/{location_id}/instances/`- and the `status` field set to ERROR and `status_message` field set to "location not available for ListInstances". | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details. | +| `redisVersion` | `string` | Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility | +| `reservedIpRange` | `string` | Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28. | +| `memorySizeGb` | `integer` | Required. Redis memory size in GiB. | +| `currentLocationId` | `string` | Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance. | +| `readEndpointPort` | `integer` | Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. | +| `readReplicasMode` | `string` | Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. | +| `suspensionReasons` | `array` | Optional. reasons that causes instance in "SUSPENDED" state. | +| `transitEncryptionMode` | `string` | Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance. | +| `connectMode` | `string` | Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING. | +| `authorizedNetwork` | `string` | Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used. | +| `createTime` | `string` | Output only. The time the instance was created. | +| `customerManagedKey` | `string` | Optional. The KMS key reference that the customer provides when trying to create the instance. | +| `authEnabled` | `boolean` | Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled. | +| `alternativeLocationId` | `string` | Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service. | +| `state` | `string` | Output only. The current state of this instance. | +| `tier` | `string` | Required. The service tier of the instance. | +| `displayName` | `string` | An arbitrary and optional user-provided name for the instance. | +| `labels` | `object` | Resource labels to represent user provided metadata | +| `persistenceConfig` | `object` | Configuration of the persistence functionality. | +| `readEndpoint` | `string` | Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'. | +| `port` | `integer` | Output only. The port number of the exposed Redis endpoint. | +| `statusMessage` | `string` | Output only. Additional information about the current status of this instance, if available. | +| `redisConfigs` | `object` | Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries | +| `availableMaintenanceVersions` | `array` | Optional. The available maintenance versions that an instance could update to. | +| `maintenanceVersion` | `string` | Optional. The self service update maintenance version. The version is date based such as "20210712_00_00". | +| `secondaryIpRange` | `string` | Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto". | +| `replicaCount` | `integer` | Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0. | +| `serverCaCerts` | `array` | Output only. List of server CA certificates for the instance. | +| `host` | `string` | Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service. | +| `locationId` | `string` | Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone. | +| `maintenanceSchedule` | `object` | Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated. | +| `persistenceIamIdentity` | `string` | Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation. | +| `maintenancePolicy` | `object` | Maintenance policy for an instance. | +| `nodes` | `array` | Output only. Info per node. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +69,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's [default network](https://cloud.google.com/vpc/docs/vpc). The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. | | `delete` | `DELETE` | `instancesId, locationsId, projectsId` | Deletes a specific Redis instance. Instance stops serving and data is deleted. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated. | | `export` | `EXEC` | `instancesId, locationsId, projectsId` | Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. | | `failover` | `EXEC` | `instancesId, locationsId, projectsId` | Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance. | | `import` | `EXEC` | `instancesId, locationsId, projectsId` | Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. | diff --git a/docs/google-docs/providers/google/redis/locations/index.md b/docs/google-docs/providers/google/redis/locations/index.md index 09ccfe5c26..53de0ea7c8 100644 --- a/docs/google-docs/providers/google/redis/locations/index.md +++ b/docs/google-docs/providers/google/redis/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Full resource name for the region. For example: "projects/example-project/locations/us-east1". | +| `locationId` | `string` | Resource ID for the region. For example: "us-east1". | +| `metadata` | `object` | Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/redis/operations/index.md b/docs/google-docs/providers/google/redis/operations/index.md index f69eb974d1..b7f4bf0a80 100644 --- a/docs/google-docs/providers/google/redis/operations/index.md +++ b/docs/google-docs/providers/google/redis/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `object` | { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. } | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/resourcesettings/index.md b/docs/google-docs/providers/google/resourcesettings/index.md index 699082cef9..bb4b42853b 100644 --- a/docs/google-docs/providers/google/resourcesettings/index.md +++ b/docs/google-docs/providers/google/resourcesettings/index.md @@ -21,7 +21,7 @@ The Resource Settings API Allows Users To Control And Modify The Behavior Of The
total resources: 1
total selectable resources: 1
-total methods: 9
+total methods: 12
@@ -33,7 +33,7 @@ The Resource Settings API Allows Users To Control And Modify The Behavior Of The TypeService TitleResource Settings API DescriptionThe Resource Settings API Allows Users To Control And Modify The Behavior Of Their GCP Resources (E.G., VM, Firewall, Project, Etc.) Across The Cloud Resource Hierarchy. -Idresourcesettings:v23.08.00155 +Idresourcesettings:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/resourcesettings/settings/index.md b/docs/google-docs/providers/google/resourcesettings/settings/index.md index 4efa91871c..f74ff7bad0 100644 --- a/docs/google-docs/providers/google/resourcesettings/settings/index.md +++ b/docs/google-docs/providers/google/resourcesettings/settings/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the setting. Must be in one of the following forms: * `projects/{project_number}/settings/{setting_name}` * `folders/{folder_id}/settings/{setting_name}` * `organizations/{organization_id}/settings/{setting_name}` For example, "/projects/123/settings/gcp-enableMyFeature" | +| `effectiveValue` | `object` | The data in a setting value. | | `etag` | `string` | A fingerprint used for optimistic concurrency. See UpdateSetting for more details. | | `localValue` | `object` | The data in a setting value. | | `metadata` | `object` | Metadata about a setting which is not editable by the end user. | -| `effectiveValue` | `object` | The data in a setting value. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -41,6 +41,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_settings_list` | `SELECT` | `organizationsId` | Lists all the settings that are available on the Cloud resource `parent`. | | `projects_settings_get` | `SELECT` | `projectsId, settingsId` | Returns a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist. | | `projects_settings_list` | `SELECT` | `projectsId` | Lists all the settings that are available on the Cloud resource `parent`. | +| `_folders_settings_list` | `EXEC` | `foldersId` | Lists all the settings that are available on the Cloud resource `parent`. | +| `_organizations_settings_list` | `EXEC` | `organizationsId` | Lists all the settings that are available on the Cloud resource `parent`. | +| `_projects_settings_list` | `EXEC` | `projectsId` | Lists all the settings that are available on the Cloud resource `parent`. | | `folders_settings_patch` | `EXEC` | `foldersId, settingsId` | Updates a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist. Returns a `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if the setting is flagged as read only. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etag supplied in the request does not match the persisted etag of the setting value. On success, the response will contain only `name`, `local_value` and `etag`. The `metadata` and `effective_value` cannot be updated through this API. Note: the supplied setting will perform a full overwrite of the `local_value` field. | | `organizations_settings_patch` | `EXEC` | `organizationsId, settingsId` | Updates a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist. Returns a `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if the setting is flagged as read only. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etag supplied in the request does not match the persisted etag of the setting value. On success, the response will contain only `name`, `local_value` and `etag`. The `metadata` and `effective_value` cannot be updated through this API. Note: the supplied setting will perform a full overwrite of the `local_value` field. | | `projects_settings_patch` | `EXEC` | `projectsId, settingsId` | Updates a specified setting. Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist. Returns a `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if the setting is flagged as read only. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etag supplied in the request does not match the persisted etag of the setting value. On success, the response will contain only `name`, `local_value` and `etag`. The `metadata` and `effective_value` cannot be updated through this API. Note: the supplied setting will perform a full overwrite of the `local_value` field. | diff --git a/docs/google-docs/providers/google/retail/catalogs/index.md b/docs/google-docs/providers/google/retail/catalogs/index.md index c80e8856ca..eb8e1529ec 100644 --- a/docs/google-docs/providers/google/retail/catalogs/index.md +++ b/docs/google-docs/providers/google/retail/catalogs/index.md @@ -27,12 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token that can be sent as ListCatalogsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `catalogs` | `array` | All the customer's Catalogs. | +| `name` | `string` | Required. Immutable. The fully qualified resource name of the catalog. | +| `productLevelConfig` | `object` | Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made. | +| `displayName` | `string` | Required. Immutable. The catalog display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_catalogs_list` | `SELECT` | `locationsId, projectsId` | Lists all the Catalogs associated with the project. | +| `_projects_locations_catalogs_list` | `EXEC` | `locationsId, projectsId` | Lists all the Catalogs associated with the project. | | `projects_locations_catalogs_complete_query` | `EXEC` | `catalogsId, locationsId, projectsId` | Completes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature. | | `projects_locations_catalogs_patch` | `EXEC` | `catalogsId, locationsId, projectsId` | Updates the Catalogs. | | `projects_locations_catalogs_set_default_branch` | `EXEC` | `catalogsId, locationsId, projectsId` | Set a specified branch id as default branch. API methods such as SearchService.Search, ProductService.GetProduct, ProductService.ListProducts will treat requests using "default_branch" to the actual branch id set as default. For example, if `projects/*/locations/*/catalogs/*/branches/1` is set as default, setting SearchRequest.branch to `projects/*/locations/*/catalogs/*/branches/default_branch` is equivalent to setting SearchRequest.branch to `projects/*/locations/*/catalogs/*/branches/1`. Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using `projects/*/locations/*/catalogs/*/branches/default_branch` as SearchRequest.branch to route the traffic to this staging branch. CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one. More specifically: * PredictionService will only return product IDs from branch {newBranch}. * SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set). * UserEventService will only join events with products from branch {newBranch}. | diff --git a/docs/google-docs/providers/google/retail/catalogs_completion_config/index.md b/docs/google-docs/providers/google/retail/catalogs_completion_config/index.md index d82ba34ba5..40f7f67dc1 100644 --- a/docs/google-docs/providers/google/retail/catalogs_completion_config/index.md +++ b/docs/google-docs/providers/google/retail/catalogs_completion_config/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/completionConfig` | -| `minPrefixLength` | `integer` | The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20. | +| `lastDenylistImportOperation` | `string` | Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. | +| `matchingOrder` | `string` | Specifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s' with 'exact-prefix' specified would suggest "red shoes". Currently supported values: * 'out-of-order' * 'exact-prefix' Default value: 'exact-prefix'. | | `maxSuggestions` | `integer` | The maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20. | | `lastSuggestionsImportOperation` | `string` | Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API method to retrieve the latest state of the Long Running Operation. | -| `allowlistInputConfig` | `object` | The input config source for completion data. | +| `minPrefixLength` | `integer` | The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20. | | `suggestionsInputConfig` | `object` | The input config source for completion data. | -| `lastAllowlistImportOperation` | `string` | Output only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. | -| `matchingOrder` | `string` | Specifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s' with 'exact-prefix' specified would suggest "red shoes". Currently supported values: * 'out-of-order' * 'exact-prefix' Default value: 'exact-prefix'. | -| `autoLearning` | `boolean` | If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use `cloud-retail` data in CompleteQueryRequest. | -| `lastDenylistImportOperation` | `string` | Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. | +| `allowlistInputConfig` | `object` | The input config source for completion data. | | `denylistInputConfig` | `object` | The input config source for completion data. | +| `autoLearning` | `boolean` | If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use `cloud-retail` data in CompleteQueryRequest. | +| `lastAllowlistImportOperation` | `string` | Output only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/retail/controls/index.md b/docs/google-docs/providers/google/retail/controls/index.md index b86605a783..926941ea37 100644 --- a/docs/google-docs/providers/google/retail/controls/index.md +++ b/docs/google-docs/providers/google/retail/controls/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*` | -| `searchSolutionUseCase` | `array` | Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control. | -| `solutionTypes` | `array` | Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only `SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH. | | `associatedServingConfigIds` | `array` | Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view. | | `displayName` | `string` | Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown. | | `rule` | `object` | A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH. | +| `searchSolutionUseCase` | `array` | Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control. | +| `solutionTypes` | `array` | Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only `SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -40,4 +40,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_catalogs_controls_list` | `SELECT` | `catalogsId, locationsId, projectsId` | Lists all Controls by their parent Catalog. | | `projects_locations_catalogs_controls_create` | `INSERT` | `catalogsId, locationsId, projectsId` | Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned. | | `projects_locations_catalogs_controls_delete` | `DELETE` | `catalogsId, controlsId, locationsId, projectsId` | Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. | +| `_projects_locations_catalogs_controls_list` | `EXEC` | `catalogsId, locationsId, projectsId` | Lists all Controls by their parent Catalog. | | `projects_locations_catalogs_controls_patch` | `EXEC` | `catalogsId, controlsId, locationsId, projectsId` | Updates a Control. Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to update does not exist, a NOT_FOUND error is returned. | diff --git a/docs/google-docs/providers/google/retail/index.md b/docs/google-docs/providers/google/retail/index.md index 17b081cad9..6ba5780f83 100644 --- a/docs/google-docs/providers/google/retail/index.md +++ b/docs/google-docs/providers/google/retail/index.md @@ -21,7 +21,7 @@ Cloud Retail Service Enables Customers To Build End-To-End Personalized Recommen
total resources: 17
total selectable resources: 8
-total methods: 61
+total methods: 69
@@ -33,7 +33,7 @@ Cloud Retail Service Enables Customers To Build End-To-End Personalized Recommen TypeService TitleRetail API DescriptionCloud Retail Service Enables Customers To Build End-To-End Personalized Recommendation Systems Without Requiring A High Level Of Expertise In Machine Learning, Recommendation System, Or Google Cloud. -Idretail:v23.08.00155 +Idretail:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/retail/models/index.md b/docs/google-docs/providers/google/retail/models/index.md index cd74f82d50..6297bece9f 100644 --- a/docs/google-docs/providers/google/retail/models/index.md +++ b/docs/google-docs/providers/google/retail/models/index.md @@ -27,8 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `models` | `array` | List of Models. | -| `nextPageToken` | `string` | Pagination token, if not returned indicates the last page. | +| `name` | `string` | Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40. | +| `periodicTuningState` | `string` | Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`. | +| `displayName` | `string` | Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters. | +| `dataState` | `string` | Output only. The state of data requirements for this model: `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be trained if the data is in `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if serving state is `ACTIVE`: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training. | +| `trainingState` | `string` | Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for `CreateModel` method is `TRAINING`. The default value for `UpdateModel` method is to keep the state the same as before. | +| `type` | `string` | Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`, `similar-items`, `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value). This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs. | +| `filteringOption` | `string` | Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by attributes is enabled for the model. | +| `createTime` | `string` | Output only. Timestamp the Recommendation Model was created at. | +| `tuningOperation` | `string` | Output only. The tune operation associated with the model. Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on. | +| `optimizationObjective` | `string` | Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs. | +| `servingState` | `string` | Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`. | +| `modelFeaturesConfig` | `object` | Additional model features config. | +| `lastTuneTime` | `string` | Output only. The timestamp when the latest successful tune finished. | +| `servingConfigLists` | `array` | Output only. The list of valid serving configs associated with the PageOptimizationConfig. | +| `updateTime` | `string` | Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +49,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_catalogs_models_list` | `SELECT` | `catalogsId, locationsId, projectsId` | Lists all the models linked to this event store. | | `projects_locations_catalogs_models_create` | `INSERT` | `catalogsId, locationsId, projectsId` | Creates a new model. | | `projects_locations_catalogs_models_delete` | `DELETE` | `catalogsId, locationsId, modelsId, projectsId` | Deletes an existing model. | +| `_projects_locations_catalogs_models_list` | `EXEC` | `catalogsId, locationsId, projectsId` | Lists all the models linked to this event store. | | `projects_locations_catalogs_models_patch` | `EXEC` | `catalogsId, locationsId, modelsId, projectsId` | Update of model metadata. Only fields that currently can be updated are: `filtering_option` and `periodic_tuning_state`. If other values are provided, this API method ignores them. | | `projects_locations_catalogs_models_pause` | `EXEC` | `catalogsId, locationsId, modelsId, projectsId` | Pauses the training of an existing model. | | `projects_locations_catalogs_models_resume` | `EXEC` | `catalogsId, locationsId, modelsId, projectsId` | Resumes the training of an existing model. | diff --git a/docs/google-docs/providers/google/retail/operations/index.md b/docs/google-docs/providers/google/retail/operations/index.md index 35c2d6ec6f..0ade325f75 100644 --- a/docs/google-docs/providers/google/retail/operations/index.md +++ b/docs/google-docs/providers/google/retail/operations/index.md @@ -27,14 +27,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_catalogs_operations_list` | `SELECT` | `catalogsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_operations_list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_catalogs_operations_list` | `EXEC` | `catalogsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_operations_list` | `EXEC` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_catalogs_branches_operations_get` | `EXEC` | `branchesId, catalogsId, locationsId, operationsId, projectsId` | 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. | | `projects_locations_catalogs_operations_get` | `EXEC` | `catalogsId, locationsId, operationsId, projectsId` | 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. | | `projects_locations_operations_get` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/retail/products/index.md b/docs/google-docs/providers/google/retail/products/index.md index 5148601305..218019921d 100644 --- a/docs/google-docs/providers/google/retail/products/index.md +++ b/docs/google-docs/providers/google/retail/products/index.md @@ -27,14 +27,47 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token that can be sent as ListProductsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `products` | `array` | The Products. | +| `id` | `string` | Immutable. Product identifier, which is the final component of name. For example, this field is "id_1", if name is `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [id](https://support.google.com/merchants/answer/6324405). Schema.org property [Product.sku](https://schema.org/sku). | +| `name` | `string` | Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`. | +| `description` | `string` | Product description. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [description](https://support.google.com/merchants/answer/6324468). Schema.org property [Product.description](https://schema.org/description). | +| `sizes` | `array` | The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). | +| `colorInfo` | `object` | The color information of a Product. | +| `attributes` | `object` | Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here. Features that can take on one of a limited number of possible values. Two types of features can be set are: Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer. For example: `{ "vendor": {"text": ["vendor123", "vendor456"]}, "lengths_cm": {"numbers":[2.3, 15.4]}, "heights_cm": {"numbers":[8.1, 6.4]} }`. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must be a UTF-8 encoded string with a length limit of 128 characters. * For indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example, `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a non-empty UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. | +| `title` | `string` | Required. Product title. This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [title](https://support.google.com/merchants/answer/6324415). Schema.org property [Product.name](https://schema.org/name). | +| `images` | `array` | Product images for the product. We highly recommend putting the main image first. A maximum of 300 images are allowed. Corresponding properties: Google Merchant Center property [image_link](https://support.google.com/merchants/answer/6324350). Schema.org property [Product.image](https://schema.org/image). | +| `availableQuantity` | `integer` | The available quantity of the item. | +| `availability` | `string` | The online availability of the Product. Default to Availability.IN_STOCK. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). | +| `primaryProductId` | `string` | Variant group identifier. Must be an id, with the same parent branch with this product. Otherwise, an error is thrown. For Type.PRIMARY Products, this field can only be empty or set to the same value as id. For VARIANT Products, this field cannot be empty. A maximum of 2,000 products are allowed to share the same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [item_group_id](https://support.google.com/merchants/answer/6324507). Schema.org property [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID). | +| `publishTime` | `string` | The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products. Note that this field is different from available_time, given it purely describes product freshness regardless of when it is available on search and recommendation. | +| `collectionMemberIds` | `array` | The id of the collection members when type is Type.COLLECTION. Non-existent product ids are allowed. The type of the members must be either Type.PRIMARY or Type.VARIANT otherwise an INVALID_ARGUMENT error is thrown. Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return. | +| `audience` | `object` | An intended audience of the Product for whom it's sold. | +| `priceInfo` | `object` | The price information of a Product. | +| `materials` | `array` | The material of the product. For example, "leather", "wooden". A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [material](https://support.google.com/merchants/answer/6324410). Schema.org property [Product.material](https://schema.org/material). | +| `expireTime` | `string` | The timestamp when this product becomes unavailable for SearchService.Search. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, the Product is not available for SearchService.Search after expire_time. However, the product can still be retrieved by ProductService.GetProduct and ProductService.ListProducts. expire_time must be later than available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown. Corresponding properties: Google Merchant Center property [expiration_date](https://support.google.com/merchants/answer/6324499). | +| `patterns` | `array` | The pattern or graphic print of the product. For example, "striped", "polka dot", "paisley". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [pattern](https://support.google.com/merchants/answer/6324483). Schema.org property [Product.pattern](https://schema.org/pattern). | +| `categories` | `array` | Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic Clothing > Shoes" ] Must be set for Type.PRIMARY Product otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property google_product_category. Schema.org property [Product.category] (https://schema.org/category). [mc_google_product_category]: https://support.google.com/merchants/answer/6324436 | +| `fulfillmentInfo` | `array` | Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods. All the elements must have distinct FulfillmentInfo.type. Otherwise, an INVALID_ARGUMENT error is returned. | +| `gtin` | `string` | The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [gtin](https://support.google.com/merchants/answer/6324461). Schema.org property [Product.isbn](https://schema.org/isbn), [Product.gtin8](https://schema.org/gtin8), [Product.gtin12](https://schema.org/gtin12), [Product.gtin13](https://schema.org/gtin13), or [Product.gtin14](https://schema.org/gtin14). If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned. | +| `brands` | `array` | The brands of the product. A maximum of 30 brands are allowed unless overridden through the Google Cloud console. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [brand](https://support.google.com/merchants/answer/6324351). Schema.org property [Product.brand](https://schema.org/brand). | +| `promotions` | `array` | The promotions applied to the product. A maximum of 10 values are allowed per Product. Only Promotion.promotion_id will be used, other fields will be ignored if set. | +| `tags` | `array` | Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). | +| `type` | `string` | Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset. | +| `conditions` | `array` | The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used". A maximum of 1 value is allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [condition](https://support.google.com/merchants/answer/6324469). Schema.org property [Offer.itemCondition](https://schema.org/itemCondition). | +| `retrievableFields` | `string` | Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. | +| `localInventories` | `array` | Output only. A list of local inventories specific to different places. This field can be managed by ProductService.AddLocalInventories and ProductService.RemoveLocalInventories APIs if fine-grained, high-volume updates are necessary. | +| `uri` | `string` | Canonical URL directly linking to the product detail page. It is strongly recommended to provide a valid uri for the product, otherwise the service performance could be significantly degraded. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [link](https://support.google.com/merchants/answer/6324416). Schema.org property [Offer.url](https://schema.org/url). | +| `variants` | `array` | Output only. Product variants grouped together on primary product which share similar product attributes. It's automatically grouped by primary_product_id for all the product variants. Only populated for Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. | +| `availableTime` | `string` | The timestamp when this Product becomes available for SearchService.Search. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT. | +| `rating` | `object` | The rating of a Product. | +| `ttl` | `string` | Input only. The TTL (time to live) of the product. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, it must be a non-negative value, and expire_time is set as current timestamp plus ttl. The derived expire_time is returned in the output and ttl is left blank when retrieving the Product. If it is set, the product is not available for SearchService.Search after current timestamp plus ttl. However, the product can still be retrieved by ProductService.GetProduct and ProductService.ListProducts. | +| `languageCode` | `string` | Language of the title/description and other string attributes. Use language tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). For product prediction, this field is ignored and the model automatically detects the text language. The Product can include text in different languages, but duplicating Products to provide text in multiple languages can result in degraded model performance. For product search this field is in use. It defaults to "en-US" if unset. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_catalogs_branches_products_list` | `SELECT` | `branchesId, catalogsId, locationsId, projectsId` | Gets a list of Products. | | `projects_locations_catalogs_branches_products_create` | `INSERT` | `branchesId, catalogsId, locationsId, projectsId` | Creates a Product. | | `projects_locations_catalogs_branches_products_delete` | `DELETE` | `branchesId, catalogsId, locationsId, productsId, projectsId` | Deletes a Product. | +| `_projects_locations_catalogs_branches_products_list` | `EXEC` | `branchesId, catalogsId, locationsId, projectsId` | Gets a list of Products. | | `projects_locations_catalogs_branches_products_get` | `EXEC` | `branchesId, catalogsId, locationsId, productsId, projectsId` | Gets a Product. | | `projects_locations_catalogs_branches_products_import` | `EXEC` | `branchesId, catalogsId, locationsId, projectsId` | Bulk import of multiple Products. Request processing may be synchronous. Non-existing items are created. Note that it is possible for a subset of the Products to be successfully updated. | | `projects_locations_catalogs_branches_products_patch` | `EXEC` | `branchesId, catalogsId, locationsId, productsId, projectsId` | Updates a Product. | diff --git a/docs/google-docs/providers/google/retail/serving_configs/index.md b/docs/google-docs/providers/google/retail/serving_configs/index.md index aef47a5eb2..a39f8758fd 100644 --- a/docs/google-docs/providers/google/retail/serving_configs/index.md +++ b/docs/google-docs/providers/google/retail/serving_configs/index.md @@ -27,8 +27,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Pagination token, if not returned indicates the last page. | -| `servingConfigs` | `array` | All the ServingConfigs for a given catalog. | +| `name` | `string` | Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/servingConfig/*` | +| `doNotAssociateControlIds` | `array` | Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. - Order does not matter. - Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | +| `personalizationSpec` | `object` | The specification for personalization. | +| `diversityType` | `string` | What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY. | +| `displayName` | `string` | Required. The human readable serving config display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. | +| `dynamicFacetSpec` | `object` | The specifications of dynamically generated facets. | +| `facetControlIds` | `array` | Facet specifications for faceted search. If empty, no facets are returned. The ids refer to the ids of Control resources with only the Facet control set. These controls are assumed to be in the same Catalog as the ServingConfig. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | +| `ignoreControlIds` | `array` | Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. - Order does not matter. - Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | +| `onewaySynonymsControlIds` | `array` | Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | +| `solutionTypes` | `array` | Required. Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution. | +| `priceRerankingLevel` | `string` | How much price ranking we want in serving results. Price reranking causes product items with a similar recommendation probability to be ordered by price, with the highest-priced items first. This setting could result in a decrease in click-through and conversion rates. Allowed values are: * `no-price-reranking` * `low-price-reranking` * `medium-price-reranking` * `high-price-reranking` If not specified, we choose default based on model type. Default value: `no-price-reranking`. Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION. | +| `modelId` | `string` | The id of the model in the same Catalog to use at serving time. Currently only RecommendationModels are supported: https://cloud.google.com/retail/recommendations-ai/docs/create-models Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when solution_types is SOLUTION_TYPE_RECOMMENDATION. | +| `filterControlIds` | `array` | Condition filter specifications. If a product matches multiple conditions in the specifications, filters from these specifications are all applied and combined via the AND operator. Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | +| `redirectControlIds` | `array` | Condition redirect specifications. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 1000. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | +| `twowaySynonymsControlIds` | `array` | Condition synonyms specifications. If multiple syonyms conditions match, all matching synonyms control in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | +| `diversityLevel` | `string` | How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION. | +| `boostControlIds` | `array` | Condition boost specifications. If a product matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 100. Notice that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | +| `enableCategoryFilterLevel` | `string` | Whether to add additional category filters on the `similar-items` model. If not specified, we enable it by default. Allowed values are: * `no-category-match`: No additional filtering of original results from the model and the customer's filters. * `relaxed-category-match`: Only keep results with categories that match at least one item categories in the PredictRequests's context item. * If customer also sends filters in the PredictRequest, then the results will satisfy both conditions (user given and category match). Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION. | +| `replacementControlIds` | `array` | Condition replacement specifications. - Applied according to the order in the list. - A previously replaced term can not be re-replaced. - Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,6 +53,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_catalogs_serving_configs_list` | `SELECT` | `catalogsId, locationsId, projectsId` | Lists all ServingConfigs linked to this catalog. | | `projects_locations_catalogs_serving_configs_create` | `INSERT` | `catalogsId, locationsId, projectsId` | Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned. | | `projects_locations_catalogs_serving_configs_delete` | `DELETE` | `catalogsId, locationsId, projectsId, servingConfigsId` | Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. | +| `_projects_locations_catalogs_serving_configs_list` | `EXEC` | `catalogsId, locationsId, projectsId` | Lists all ServingConfigs linked to this catalog. | | `projects_locations_catalogs_serving_configs_patch` | `EXEC` | `catalogsId, locationsId, projectsId, servingConfigsId` | Updates a ServingConfig. | | `projects_locations_catalogs_serving_configs_predict` | `EXEC` | `catalogsId, locationsId, projectsId, servingConfigsId` | Makes a recommendation prediction. | | `projects_locations_catalogs_serving_configs_search` | `EXEC` | `catalogsId, locationsId, projectsId, servingConfigsId` | Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature. | diff --git a/docs/google-docs/providers/google/run/executions/index.md b/docs/google-docs/providers/google/run/executions/index.md index 316581f4c0..cdf6629b77 100644 --- a/docs/google-docs/providers/google/run/executions/index.md +++ b/docs/google-docs/providers/google/run/executions/index.md @@ -27,11 +27,37 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `executions` | `array` | The resulting list of Executions. | -| `nextPageToken` | `string` | A token indicating there are more items than page_size. Use it in the next ListExecutions request to continue. | +| `name` | `string` | Output only. The unique name of this Execution. | +| `updateTime` | `string` | Output only. The last-modified time. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `deleteTime` | `string` | Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. | +| `failedCount` | `integer` | Output only. The number of tasks which reached phase Failed. | +| `template` | `object` | TaskTemplate describes the data a task should have when created from a template. | +| `reconciling` | `boolean` | Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run. | +| `job` | `string` | Output only. The name of the parent Job. | +| `observedGeneration` | `string` | Output only. The generation of this Execution. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | +| `labels` | `object` | Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels | +| `startTime` | `string` | Output only. Represents time when the execution started to run. It is not guaranteed to be set in happens-before order across separate operations. | +| `retriedCount` | `integer` | Output only. The number of tasks which have retried at least once. | +| `cancelledCount` | `integer` | Output only. The number of tasks which reached phase Cancelled. | +| `taskCount` | `integer` | Output only. Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. | +| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | +| `launchStage` | `string` | The least stable launch stage needed to create this resource, as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA. | +| `annotations` | `object` | Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. | +| `logUri` | `string` | Output only. URI where logs for this execution can be found in Cloud Console. | +| `runningCount` | `integer` | Output only. The number of actively running tasks. | +| `completionTime` | `string` | Output only. Represents time when the execution was completed. It is not guaranteed to be set in happens-before order across separate operations. | +| `parallelism` | `integer` | Output only. Specifies the maximum desired number of tasks the execution should run at any given time. Must be <= task_count. The actual number of tasks running in steady state will be less than this number when ((.spec.task_count - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. | +| `uid` | `string` | Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | +| `expireTime` | `string` | Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request. | +| `succeededCount` | `integer` | Output only. The number of tasks which reached phase Succeeded. | +| `createTime` | `string` | Output only. Represents time when the execution was acknowledged by the execution controller. It is not guaranteed to be set in happens-before order across separate operations. | +| `conditions` | `array` | Output only. The Condition of this Execution, containing its readiness status, and detailed error information in case it did not reach the desired state. | +| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `executionsId, jobsId, locationsId, projectsId` | Gets information about an Execution. | | `list` | `SELECT` | `jobsId, locationsId, projectsId` | Lists Executions from a Job. | | `delete` | `DELETE` | `executionsId, jobsId, locationsId, projectsId` | Deletes an Execution. | +| `_list` | `EXEC` | `jobsId, locationsId, projectsId` | Lists Executions from a Job. | diff --git a/docs/google-docs/providers/google/run/index.md b/docs/google-docs/providers/google/run/index.md index 0098b860ed..e515783115 100644 --- a/docs/google-docs/providers/google/run/index.md +++ b/docs/google-docs/providers/google/run/index.md @@ -21,7 +21,7 @@ Deploy And Manage User Provided Container Images That Scale Automatically Based
total resources: 8
total selectable resources: 8
-total methods: 29
+total methods: 35
@@ -33,7 +33,7 @@ Deploy And Manage User Provided Container Images That Scale Automatically Based TypeService TitleCloud Run Admin API DescriptionDeploy And Manage User Provided Container Images That Scale Automatically Based On Incoming Requests. The Cloud Run Admin API V1 Follows The Knative Serving API Specification, While V2 Is Aligned With Google Cloud AIP-Based API Standards, As Described In Https://Google.Aip.Dev/. -Idrun:v23.08.00155 +Idrun:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/run/jobs/index.md b/docs/google-docs/providers/google/run/jobs/index.md index c41c26fb9e..72d9340a71 100644 --- a/docs/google-docs/providers/google/run/jobs/index.md +++ b/docs/google-docs/providers/google/run/jobs/index.md @@ -27,8 +27,30 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `jobs` | `array` | The resulting list of Jobs. | -| `nextPageToken` | `string` | A token indicating there are more items than page_size. Use it in the next ListJobs request to continue. | +| `name` | `string` | The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job} | +| `reconciling` | `boolean` | Output only. Returns true if the Job is currently being acted upon by the system to bring it into the desired state. When a new Job is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Job to the desired state. This process is called reconciliation. While reconciliation is in process, `observed_generation` and `latest_succeeded_execution`, will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the state matches the Job, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `observed_generation` and `generation`, `latest_succeeded_execution` and `latest_created_execution`. If reconciliation failed, `observed_generation` and `latest_succeeded_execution` will have the state of the last succeeded execution or empty for newly created Job. Additional information on the failure can be found in `terminal_condition` and `conditions`. | +| `executionCount` | `integer` | Output only. Number of executions created for this job. | +| `expireTime` | `string` | Output only. For a deleted resource, the time after which it will be permamently deleted. | +| `template` | `object` | ExecutionTemplate describes the data an execution should have when created from a template. | +| `lastModifier` | `string` | Output only. Email address of the last authenticated modifier. | +| `conditions` | `array` | Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | +| `creator` | `string` | Output only. Email address of the authenticated creator. | +| `latestCreatedExecution` | `object` | Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status. | +| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | +| `labels` | `object` | Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job. | +| `clientVersion` | `string` | Arbitrary version identifier for the API client. | +| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | +| `binaryAuthorization` | `object` | Settings for Binary Authorization feature. | +| `observedGeneration` | `string` | Output only. The generation of this Job. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | +| `deleteTime` | `string` | Output only. The deletion time. | +| `updateTime` | `string` | Output only. The last-modified time. | +| `client` | `string` | Arbitrary identifier for the API client. | +| `launchStage` | `string` | The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. | +| `terminalCondition` | `object` | Defines a status condition for a resource. | +| `createTime` | `string` | Output only. The creation time. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `annotations` | `object` | Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job. This field follows Kubernetes annotations' namespacing, limits, and rules. | +| `uid` | `string` | Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +58,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists Jobs. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a Job. | | `delete` | `DELETE` | `jobsId, locationsId, projectsId` | Deletes a Job. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Jobs. | | `patch` | `EXEC` | `jobsId, locationsId, projectsId` | Updates a Job. | | `run` | `EXEC` | `jobsId, locationsId, projectsId` | Triggers creation of a new Execution of this Job. | diff --git a/docs/google-docs/providers/google/run/operations/index.md b/docs/google-docs/providers/google/run/operations/index.md index 7025a32cc1..e16fa31214 100644 --- a/docs/google-docs/providers/google/run/operations/index.md +++ b/docs/google-docs/providers/google/run/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `wait` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/run/revisions/index.md b/docs/google-docs/providers/google/run/revisions/index.md index 3bf22da6ee..fcc90b29c6 100644 --- a/docs/google-docs/providers/google/run/revisions/index.md +++ b/docs/google-docs/providers/google/run/revisions/index.md @@ -27,11 +27,39 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token indicating there are more items than page_size. Use it in the next ListRevisions request to continue. | -| `revisions` | `array` | The resulting list of Revisions. | +| `name` | `string` | Output only. The unique name of this Revision. | +| `logUri` | `string` | Output only. The Google Console URI to obtain logs for the Revision. | +| `labels` | `object` | Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. | +| `service` | `string` | Output only. The name of the parent service. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `expireTime` | `string` | Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request. | +| `volumes` | `array` | A list of Volumes to make available to containers. | +| `executionEnvironment` | `string` | The execution environment being used to host this Revision. | +| `sessionAffinity` | `boolean` | Enable session affinity. | +| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | +| `createTime` | `string` | Output only. The creation time. | +| `encryptionKeyShutdownDuration` | `string` | If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour. | +| `uid` | `string` | Output only. Server assigned unique identifier for the Revision. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | +| `encryptionKeyRevocationAction` | `string` | The action to take if the encryption key is revoked. | +| `updateTime` | `string` | Output only. The last-modified time. | +| `reconciling` | `boolean` | Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Service.reconciling` for additional information on reconciliation process in Cloud Run. | +| `deleteTime` | `string` | Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. | +| `timeout` | `string` | Max allowed time for an instance to respond to a request. | +| `containers` | `array` | Holds the single container that defines the unit of execution for this Revision. | +| `scaling` | `object` | Settings for revision-level scaling settings. | +| `annotations` | `object` | Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. | +| `serviceAccount` | `string` | Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. | +| `launchStage` | `string` | The least stable launch stage needed to create this resource, as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA. | +| `observedGeneration` | `string` | Output only. The generation of this Revision currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | +| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | +| `maxInstanceRequestConcurrency` | `integer` | Sets the maximum number of requests that each serving instance can receive. | +| `vpcAccess` | `object` | VPC Access settings. For more information on creating a VPC Connector, visit https://cloud.google.com/vpc/docs/configure-serverless-vpc-access For information on how to configure Cloud Run with an existing VPC Connector, visit https://cloud.google.com/run/docs/configuring/connecting-vpc | +| `conditions` | `array` | Output only. The Condition of this Revision, containing its readiness status, and detailed error information in case it did not reach a serving state. | +| `encryptionKey` | `string` | A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId, revisionsId, servicesId` | Gets information about a Revision. | | `list` | `SELECT` | `locationsId, projectsId, servicesId` | Lists Revisions from a given Service, or from a given location. | | `delete` | `DELETE` | `locationsId, projectsId, revisionsId, servicesId` | Deletes a Revision. | +| `_list` | `EXEC` | `locationsId, projectsId, servicesId` | Lists Revisions from a given Service, or from a given location. | diff --git a/docs/google-docs/providers/google/run/services/index.md b/docs/google-docs/providers/google/run/services/index.md index 1ca92106d9..82c4c9b907 100644 --- a/docs/google-docs/providers/google/run/services/index.md +++ b/docs/google-docs/providers/google/run/services/index.md @@ -27,8 +27,36 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token indicating there are more items than page_size. Use it in the next ListServices request to continue. | -| `services` | `array` | The resulting list of Services. | +| `name` | `string` | The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id} | +| `description` | `string` | User-provided description of the Service. This field currently has a 512-character limit. | +| `ingress` | `string` | Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `reconciling` | `boolean` | Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in `terminal_condition` and `conditions`. | +| `client` | `string` | Arbitrary identifier for the API client. | +| `latestReadyRevision` | `string` | Output only. Name of the latest revision that is serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | +| `lastModifier` | `string` | Output only. Email address of the last authenticated modifier. | +| `clientVersion` | `string` | Arbitrary version identifier for the API client. | +| `binaryAuthorization` | `object` | Settings for Binary Authorization feature. | +| `expireTime` | `string` | Output only. For a deleted resource, the time after which it will be permamently deleted. | +| `conditions` | `array` | Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | +| `latestCreatedRevision` | `string` | Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | +| `traffic` | `array` | Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest `Ready` Revision. | +| `customAudiences` | `array` | One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences. | +| `launchStage` | `string` | The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. | +| `annotations` | `object` | Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 Service. This field follows Kubernetes annotations' namespacing, limits, and rules. | +| `uid` | `string` | Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | +| `updateTime` | `string` | Output only. The last-modified time. | +| `observedGeneration` | `string` | Output only. The generation of this Service currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. | +| `template` | `object` | RevisionTemplate describes the data a revision should have when created from a template. | +| `terminalCondition` | `object` | Defines a status condition for a resource. | +| `creator` | `string` | Output only. Email address of the authenticated creator. | +| `trafficStatuses` | `array` | Output only. Detailed status information for corresponding traffic targets. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | +| `deleteTime` | `string` | Output only. The deletion time. | +| `createTime` | `string` | Output only. The creation time. | +| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. | +| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | +| `uri` | `string` | Output only. The main URI in which this Service is serving traffic. | +| `labels` | `object` | Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +64,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists Services. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new Service in a given project and location. | | `delete` | `DELETE` | `locationsId, projectsId, servicesId` | Deletes a Service. This will cause the Service to stop serving traffic and will delete all revisions. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Services. | | `patch` | `EXEC` | `locationsId, projectsId, servicesId` | Updates a Service. | diff --git a/docs/google-docs/providers/google/run/services_iam_policies/index.md b/docs/google-docs/providers/google/run/services_iam_policies/index.md index 90b88dc0a6..04cedc401e 100644 --- a/docs/google-docs/providers/google/run/services_iam_policies/index.md +++ b/docs/google-docs/providers/google/run/services_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/run/tasks/index.md b/docs/google-docs/providers/google/run/tasks/index.md index bac0d8affc..e85bb9b99e 100644 --- a/docs/google-docs/providers/google/run/tasks/index.md +++ b/docs/google-docs/providers/google/run/tasks/index.md @@ -27,10 +27,39 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `tasks` | `array` | The resulting list of Tasks. | -| `nextPageToken` | `string` | A token indicating there are more items than page_size. Use it in the next ListTasks request to continue. | +| `name` | `string` | Output only. The unique name of this Task. | +| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | +| `vpcAccess` | `object` | VPC Access settings. For more information on creating a VPC Connector, visit https://cloud.google.com/vpc/docs/configure-serverless-vpc-access For information on how to configure Cloud Run with an existing VPC Connector, visit https://cloud.google.com/run/docs/configuring/connecting-vpc | +| `createTime` | `string` | Output only. Represents time when the task was created by the job controller. It is not guaranteed to be set in happens-before order across separate operations. | +| `observedGeneration` | `string` | Output only. The generation of this Task. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run. | +| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | +| `execution` | `string` | Output only. The name of the parent Execution. | +| `maxRetries` | `integer` | Number of retries allowed per Task, before marking this Task failed. | +| `retried` | `integer` | Output only. The number of times this Task was retried. Tasks are retried when they fail up to the maxRetries limit. | +| `updateTime` | `string` | Output only. The last-modified time. | +| `timeout` | `string` | Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. | +| `job` | `string` | Output only. The name of the parent Job. | +| `completionTime` | `string` | Output only. Represents time when the Task was completed. It is not guaranteed to be set in happens-before order across separate operations. | +| `lastAttemptResult` | `object` | Result of a task attempt. | +| `encryptionKey` | `string` | Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek | +| `expireTime` | `string` | Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `volumes` | `array` | A list of Volumes to make available to containers. | +| `reconciling` | `boolean` | Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run. | +| `startTime` | `string` | Output only. Represents time when the task started to run. It is not guaranteed to be set in happens-before order across separate operations. | +| `labels` | `object` | Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels | +| `executionEnvironment` | `string` | The execution environment being used to host this Task. | +| `uid` | `string` | Output only. Server assigned unique identifier for the Task. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | +| `serviceAccount` | `string` | Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. | +| `annotations` | `object` | Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. | +| `containers` | `array` | Holds the single container that defines the unit of execution for this task. | +| `conditions` | `array` | Output only. The Condition of this Task, containing its readiness status, and detailed error information in case it did not reach the desired state. | +| `logUri` | `string` | Output only. URI where logs for this execution can be found in Cloud Console. | +| `deleteTime` | `string` | Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. | +| `index` | `integer` | Output only. Index of the Task, unique per execution, and beginning at 0. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `executionsId, jobsId, locationsId, projectsId, tasksId` | Gets information about a Task. | | `list` | `SELECT` | `executionsId, jobsId, locationsId, projectsId` | Lists Tasks from an Execution of a Job. | +| `_list` | `EXEC` | `executionsId, jobsId, locationsId, projectsId` | Lists Tasks from an Execution of a Job. | diff --git a/docs/google-docs/providers/google/runtimeconfig/index.md b/docs/google-docs/providers/google/runtimeconfig/index.md index 4c2fe80f03..d2a2c8d77a 100644 --- a/docs/google-docs/providers/google/runtimeconfig/index.md +++ b/docs/google-docs/providers/google/runtimeconfig/index.md @@ -21,7 +21,7 @@ The Runtime Configurator Allows You To Dynamically Configure And Expose Variable
total resources: 1
total selectable resources: 1
-total methods: 3
+total methods: 4
@@ -33,7 +33,7 @@ The Runtime Configurator Allows You To Dynamically Configure And Expose Variable TypeService TitleCloud Runtime Configuration API DescriptionThe Runtime Configurator Allows You To Dynamically Configure And Expose Variables Through Google Cloud Platform. In Addition, You Can Also Set Watchers And Waiters That Will Watch For Changes To Your Data And Return Based On Certain Conditions. -Idruntimeconfig:v23.08.00155 +Idruntimeconfig:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/runtimeconfig/operations/index.md b/docs/google-docs/providers/google/runtimeconfig/operations/index.md index fb8729de4b..3593e926a1 100644 --- a/docs/google-docs/providers/google/runtimeconfig/operations/index.md +++ b/docs/google-docs/providers/google/runtimeconfig/operations/index.md @@ -27,11 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `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 | |:-----|:--------------|:----------------|:------------| | `list` | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `operationsId` | 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`. | +| `_list` | `EXEC` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `operationsId` | 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`. | 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 b03e6229ba..335b231a9d 100644 --- a/docs/google-docs/providers/google/sasportal/customer_nodes/index.md +++ b/docs/google-docs/providers/google/sasportal/customer_nodes/index.md @@ -27,8 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A pagination token returned from a previous call to ListNodes that indicates from where listing should continue. If the field is missing or empty, it means there is no more nodes. | -| `nodes` | `array` | The nodes that match the request. | +| `name` | `string` | Output only. Resource name. | +| `displayName` | `string` | The node's display name. | +| `sasUserIds` | `array` | User ids used by the devices belonging to this node. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,3 +38,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `customers_nodes_create` | `INSERT` | `customersId` | Creates a new node. | | `customers_nodes_nodes_create` | `INSERT` | `customersId, nodesId` | Creates a new node. | | `customers_nodes_delete` | `DELETE` | `customersId, nodesId` | Deletes a node. | +| `_customers_nodes_list` | `EXEC` | `customersId` | Lists nodes. | +| `_customers_nodes_nodes_list` | `EXEC` | `customersId, nodesId` | Lists nodes. | diff --git a/docs/google-docs/providers/google/sasportal/customers/index.md b/docs/google-docs/providers/google/sasportal/customers/index.md index a835f82a1c..65fa44b882 100644 --- a/docs/google-docs/providers/google/sasportal/customers/index.md +++ b/docs/google-docs/providers/google/sasportal/customers/index.md @@ -35,6 +35,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:--------------|:----------------|:------------| | `customers_get` | `SELECT` | `customersId` | Returns a requested customer. | | `customers_list` | `SELECT` | | Returns a list of requested customers. | +| `_customers_list` | `EXEC` | | Returns a list of requested customers. | | `customers_check_has_provisioned_deployment` | `EXEC` | | Checks whether a SAS deployment for the authentication context exists. | | `customers_migrate_organization` | `EXEC` | | Migrates a SAS organization to the cloud. This will create GCP projects for each deployment and associate them. The SAS Organization is linked to the gcp project that called the command. go/sas-legacy-customer-migration | | `customers_patch` | `EXEC` | `customersId` | Updates an existing customer. | diff --git a/docs/google-docs/providers/google/sasportal/deployments/index.md b/docs/google-docs/providers/google/sasportal/deployments/index.md index afc6456570..fef51077f0 100644 --- a/docs/google-docs/providers/google/sasportal/deployments/index.md +++ b/docs/google-docs/providers/google/sasportal/deployments/index.md @@ -27,8 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A pagination token returned from a previous call to ListDeployments that indicates from where listing should continue. If the field is missing or empty, it means there are no more deployments. | -| `deployments` | `array` | The deployments that match the request. | +| `name` | `string` | Output only. Resource name. | +| `frns` | `array` | Output only. The FCC Registration Numbers (FRNs) copied from its direct parent. | +| `sasUserIds` | `array` | User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. | +| `displayName` | `string` | The deployment's display name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,6 +46,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `nodes_nodes_deployments_create` | `INSERT` | `nodesId, nodesId1` | Creates a new deployment. | | `customers_deployments_delete` | `DELETE` | `customersId, deploymentsId` | Deletes a deployment. | | `nodes_deployments_delete` | `DELETE` | `deploymentsId, nodesId` | Deletes a deployment. | +| `_customers_deployments_list` | `EXEC` | `customersId` | Lists deployments. | +| `_customers_nodes_deployments_list` | `EXEC` | `customersId, nodesId` | Lists deployments. | +| `_nodes_deployments_list` | `EXEC` | `nodesId` | Lists deployments. | +| `_nodes_nodes_deployments_list` | `EXEC` | `nodesId, nodesId1` | Lists deployments. | | `customers_deployments_move` | `EXEC` | `customersId, deploymentsId` | Moves a deployment under another node or customer. | | `customers_deployments_patch` | `EXEC` | `customersId, deploymentsId` | Updates an existing deployment. | | `nodes_deployments_move` | `EXEC` | `deploymentsId, nodesId` | Moves a deployment under another node or customer. | diff --git a/docs/google-docs/providers/google/sasportal/devices/index.md b/docs/google-docs/providers/google/sasportal/devices/index.md index fabd8cdd5c..aa94155b8f 100644 --- a/docs/google-docs/providers/google/sasportal/devices/index.md +++ b/docs/google-docs/providers/google/sasportal/devices/index.md @@ -27,8 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `devices` | `array` | The devices that match the request. | -| `nextPageToken` | `string` | A pagination token returned from a previous call to ListDevices that indicates from where listing should continue. If the field is missing or empty, it means there is no more devices. | +| `name` | `string` | Output only. The resource path name. | +| `state` | `string` | Output only. Device state. | +| `displayName` | `string` | Device display name. | +| `serialNumber` | `string` | A serial number assigned to the device by the device manufacturer. | +| `preloadedConfig` | `object` | Information about the device configuration. | +| `grants` | `array` | Output only. Grants held by the device. | +| `deviceMetadata` | `object` | Device data overridable by both SAS Portal and registration requests. | +| `grantRangeAllowlists` | `array` | Only ranges that are within the allowlists are available for new grants. | +| `activeConfig` | `object` | Information about the device configuration. | +| `currentChannels` | `array` | Output only. Current channels with scores. | +| `fccId` | `string` | The FCC identifier of the device. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -50,6 +59,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `customers_devices_delete` | `DELETE` | `customersId, devicesId` | Deletes a device. | | `deployments_devices_delete` | `DELETE` | `deploymentsId, devicesId` | Deletes a device. | | `nodes_devices_delete` | `DELETE` | `devicesId, nodesId` | Deletes a device. | +| `_customers_deployments_devices_list` | `EXEC` | `customersId, deploymentsId` | Lists devices under a node or customer. | +| `_customers_devices_list` | `EXEC` | `customersId` | Lists devices under a node or customer. | +| `_customers_nodes_devices_list` | `EXEC` | `customersId, nodesId` | Lists devices under a node or customer. | +| `_nodes_deployments_devices_list` | `EXEC` | `deploymentsId, nodesId` | Lists devices under a node or customer. | +| `_nodes_devices_list` | `EXEC` | `nodesId` | Lists devices under a node or customer. | +| `_nodes_nodes_devices_list` | `EXEC` | `nodesId, nodesId1` | Lists devices under a node or customer. | | `customers_devices_move` | `EXEC` | `customersId, devicesId` | Moves a device under another node or customer. | | `customers_devices_patch` | `EXEC` | `customersId, devicesId` | Updates a device. | | `customers_devices_sign_device` | `EXEC` | `customersId, devicesId` | Signs a device. | diff --git a/docs/google-docs/providers/google/sasportal/index.md b/docs/google-docs/providers/google/sasportal/index.md index 77b2bfb56f..dc6ee79dad 100644 --- a/docs/google-docs/providers/google/sasportal/index.md +++ b/docs/google-docs/providers/google/sasportal/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 10
total selectable resources: 7
-total methods: 80
+total methods: 95
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleSAS Portal API Description -Idsasportal:v23.08.00155 +Idsasportal:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/sasportal/nodes/index.md b/docs/google-docs/providers/google/sasportal/nodes/index.md index 1bc67f08ed..fe4adabdbb 100644 --- a/docs/google-docs/providers/google/sasportal/nodes/index.md +++ b/docs/google-docs/providers/google/sasportal/nodes/index.md @@ -27,8 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A pagination token returned from a previous call to ListNodes that indicates from where listing should continue. If the field is missing or empty, it means there is no more nodes. | -| `nodes` | `array` | The nodes that match the request. | +| `name` | `string` | Output only. Resource name. | +| `sasUserIds` | `array` | User ids used by the devices belonging to this node. | +| `displayName` | `string` | The node's display name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +38,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `nodes_nodes_create` | `INSERT` | `nodesId` | Creates a new node. | | `nodes_nodes_nodes_create` | `INSERT` | `nodesId, nodesId1` | Creates a new node. | | `nodes_nodes_delete` | `DELETE` | `nodesId, nodesId1` | Deletes a node. | +| `_nodes_nodes_list` | `EXEC` | `nodesId` | Lists nodes. | +| `_nodes_nodes_nodes_list` | `EXEC` | `nodesId, nodesId1` | Lists nodes. | | `customers_nodes_move` | `EXEC` | `customersId, nodesId` | Moves a node under another node or customer. | | `customers_nodes_patch` | `EXEC` | `customersId, nodesId` | Updates an existing node. | | `nodes_nodes_move` | `EXEC` | `nodesId, nodesId1` | Moves a node under another node or customer. | diff --git a/docs/google-docs/providers/google/secretmanager/index.md b/docs/google-docs/providers/google/secretmanager/index.md index 726748cec4..44578db042 100644 --- a/docs/google-docs/providers/google/secretmanager/index.md +++ b/docs/google-docs/providers/google/secretmanager/index.md @@ -21,7 +21,7 @@ Stores Sensitive Data Such As API Keys, Passwords, And Certificates. Provides Co
total resources: 5
total selectable resources: 4
-total methods: 17
+total methods: 20
@@ -33,7 +33,7 @@ Stores Sensitive Data Such As API Keys, Passwords, And Certificates. Provides Co TypeService TitleSecret Manager API DescriptionStores Sensitive Data Such As API Keys, Passwords, And Certificates. Provides Convenience While Improving Security. -Idsecretmanager:v23.08.00155 +Idsecretmanager:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/secretmanager/locations/index.md b/docs/google-docs/providers/google/secretmanager/locations/index.md index d8606e1c50..46661e4a61 100644 --- a/docs/google-docs/providers/google/secretmanager/locations/index.md +++ b/docs/google-docs/providers/google/secretmanager/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/secretmanager/secrets/index.md b/docs/google-docs/providers/google/secretmanager/secrets/index.md index 7558f88ca4..455aad4aaf 100644 --- a/docs/google-docs/providers/google/secretmanager/secrets/index.md +++ b/docs/google-docs/providers/google/secretmanager/secrets/index.md @@ -27,9 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `totalSize` | `integer` | The total number of Secrets but 0 when the ListSecretsRequest.filter field is set. | -| `nextPageToken` | `string` | A token to retrieve the next page of results. Pass this value in ListSecretsRequest.page_token to retrieve the next page. | -| `secrets` | `array` | The list of Secrets sorted in reverse by create_time (newest first). | +| `name` | `string` | Output only. The resource name of the Secret in the format `projects/*/secrets/*`. | +| `rotation` | `object` | The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. | +| `labels` | `object` | The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `\p{Ll}\p{Lo}{0,62}` Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}` No more than 64 labels can be assigned to a given resource. | +| `ttl` | `string` | Input only. The TTL for the Secret. | +| `etag` | `string` | Optional. Etag of the currently stored Secret. | +| `versionAliases` | `object` | Optional. Mapping from version alias to version name. A version alias is a string with a maximum length of 63 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and underscore ('_') characters. An alias string must start with a letter and cannot be the string 'latest' or 'NEW'. No more than 50 aliases can be assigned to a given secret. Version-Alias pairs will be viewable via GetSecret and modifiable via UpdateSecret. At launch Access by Allias will only be supported on GetSecretVersion and AccessSecretVersion. | +| `expireTime` | `string` | Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input. | +| `annotations` | `object` | Optional. Custom metadata about the secret. Annotations are distinct from various forms of labels. Annotations exist to allow client tools to store their own state information without requiring a database. Annotation keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, begin and end with an alphanumeric character ([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and alphanumerics in between these symbols. The total size of annotation keys and values must be less than 16KiB. | +| `replication` | `object` | A policy that defines the replication and encryption configuration of data. | +| `topics` | `array` | Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. | +| `createTime` | `string` | Output only. The time at which the Secret was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +45,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId` | Lists Secrets. | | `create` | `INSERT` | `projectsId` | Creates a new Secret containing no SecretVersions. | | `delete` | `DELETE` | `projectsId, secretsId` | Deletes a Secret. | +| `_list` | `EXEC` | `projectsId` | Lists Secrets. | | `patch` | `EXEC` | `projectsId, secretsId` | Updates metadata of an existing Secret. | diff --git a/docs/google-docs/providers/google/secretmanager/secrets_iam_policies/index.md b/docs/google-docs/providers/google/secretmanager/secrets_iam_policies/index.md index 92ad954c67..4f564c4b18 100644 --- a/docs/google-docs/providers/google/secretmanager/secrets_iam_policies/index.md +++ b/docs/google-docs/providers/google/secretmanager/secrets_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/secretmanager/versions/index.md b/docs/google-docs/providers/google/secretmanager/versions/index.md index 30a1b61791..f28b170eaa 100644 --- a/docs/google-docs/providers/google/secretmanager/versions/index.md +++ b/docs/google-docs/providers/google/secretmanager/versions/index.md @@ -27,14 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `totalSize` | `integer` | The total number of SecretVersions but 0 when the ListSecretsRequest.filter field is set. | -| `versions` | `array` | The list of SecretVersions sorted in reverse by create_time (newest first). | -| `nextPageToken` | `string` | A token to retrieve the next page of results. Pass this value in ListSecretVersionsRequest.page_token to retrieve the next page. | +| `name` | `string` | Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret. | +| `etag` | `string` | Output only. Etag of the currently stored SecretVersion. | +| `replicationStatus` | `object` | The replication status of a SecretVersion. | +| `state` | `string` | Output only. The current state of the SecretVersion. | +| `clientSpecifiedPayloadChecksum` | `boolean` | Output only. True if payload checksum specified in SecretPayload object has been received by SecretManagerService on SecretManagerService.AddSecretVersion. | +| `createTime` | `string` | Output only. The time at which the SecretVersion was created. | +| `destroyTime` | `string` | Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `projectsId, secretsId, versionsId` | Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion. | | `list` | `SELECT` | `projectsId, secretsId` | Lists SecretVersions. This call does not return secret data. | +| `_list` | `EXEC` | `projectsId, secretsId` | Lists SecretVersions. This call does not return secret data. | | `access` | `EXEC` | `projectsId, secretsId, versionsId` | Accesses a SecretVersion. This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion. | | `destroy` | `EXEC` | `projectsId, secretsId, versionsId` | Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data. | | `disable` | `EXEC` | `projectsId, secretsId, versionsId` | Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED. | diff --git a/docs/google-docs/providers/google/securitycenter/assets/index.md b/docs/google-docs/providers/google/securitycenter/assets/index.md index c9dc3ad975..2e270dcc0d 100644 --- a/docs/google-docs/providers/google/securitycenter/assets/index.md +++ b/docs/google-docs/providers/google/securitycenter/assets/index.md @@ -27,16 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results. | -| `readTime` | `string` | Time used for executing the list request. | -| `totalSize` | `integer` | The total number of assets matching the query. | -| `listAssetsResults` | `array` | Assets matching the list request. | +| `asset` | `object` | Security Command Center representation of a Google Cloud resource. The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource. | +| `stateChange` | `string` | State change of the asset between the points in time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `folders_assets_list` | `SELECT` | `foldersId` | Lists an organization's assets. | | `organizations_assets_list` | `SELECT` | `organizationsId` | Lists an organization's assets. | | `projects_assets_list` | `SELECT` | `projectsId` | Lists an organization's assets. | +| `_folders_assets_list` | `EXEC` | `foldersId` | Lists an organization's assets. | +| `_organizations_assets_list` | `EXEC` | `organizationsId` | Lists an organization's assets. | +| `_projects_assets_list` | `EXEC` | `projectsId` | Lists an organization's assets. | | `folders_assets_group` | `EXEC` | `foldersId` | Filters an organization's assets and groups them by their specified properties. | | `organizations_assets_group` | `EXEC` | `organizationsId` | Filters an organization's assets and groups them by their specified properties. | | `organizations_assets_run_discovery` | `EXEC` | `organizationsId` | Runs asset discovery. The discovery is tracked with a long-running operation. This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error. | diff --git a/docs/google-docs/providers/google/securitycenter/attack_paths/index.md b/docs/google-docs/providers/google/securitycenter/attack_paths/index.md index ff5018b49a..9a52cc2c89 100644 --- a/docs/google-docs/providers/google/securitycenter/attack_paths/index.md +++ b/docs/google-docs/providers/google/securitycenter/attack_paths/index.md @@ -27,11 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results. | -| `attackPaths` | `array` | The attack paths that the attack path simulation identified. | +| `name` | `string` | The attack path name, for example, `organizations/12/simulation/34/valuedResources/56/attackPaths/78` | +| `edges` | `array` | A list of the edges between nodes in this attack path. | +| `pathNodes` | `array` | A list of nodes that exist in this attack path. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `organizations_simulations_attack_exposure_results_attack_paths_list` | `SELECT` | `attackExposureResultsId, organizationsId, simulationsId` | | `organizations_simulations_attack_paths_list` | `SELECT` | `organizationsId, simulationsId` | | `organizations_simulations_valued_resources_attack_paths_list` | `SELECT` | `organizationsId, simulationsId, valuedResourcesId` | +| `_organizations_simulations_attack_exposure_results_attack_paths_list` | `EXEC` | `attackExposureResultsId, organizationsId, simulationsId` | +| `_organizations_simulations_attack_paths_list` | `EXEC` | `organizationsId, simulationsId` | +| `_organizations_simulations_valued_resources_attack_paths_list` | `EXEC` | `organizationsId, simulationsId, valuedResourcesId` | diff --git a/docs/google-docs/providers/google/securitycenter/big_query_exports/index.md b/docs/google-docs/providers/google/securitycenter/big_query_exports/index.md index 768bc1856e..ed55132eb2 100644 --- a/docs/google-docs/providers/google/securitycenter/big_query_exports/index.md +++ b/docs/google-docs/providers/google/securitycenter/big_query_exports/index.md @@ -27,8 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bigQueryExports` | `array` | The BigQuery exports from the specified parent. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. | +| `description` | `string` | The description of the export (max of 1024 characters). | +| `principal` | `string` | Output only. The service account that needs permission to create table and upload data to the BigQuery dataset. | +| `updateTime` | `string` | Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update. | +| `createTime` | `string` | Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation. | +| `dataset` | `string` | The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). | +| `filter` | `string` | Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. | +| `mostRecentEditor` | `string` | Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,6 +50,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `folders_big_query_exports_delete` | `DELETE` | `bigQueryExportsId, foldersId` | Deletes an existing BigQuery export. | | `organizations_big_query_exports_delete` | `DELETE` | `bigQueryExportsId, organizationsId` | Deletes an existing BigQuery export. | | `projects_big_query_exports_delete` | `DELETE` | `bigQueryExportsId, projectsId` | Deletes an existing BigQuery export. | +| `_folders_big_query_exports_list` | `EXEC` | `foldersId` | Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned. | +| `_organizations_big_query_exports_list` | `EXEC` | `organizationsId` | Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned. | +| `_projects_big_query_exports_list` | `EXEC` | `projectsId` | Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned. | | `folders_big_query_exports_patch` | `EXEC` | `bigQueryExportsId, foldersId` | Updates a BigQuery export. | | `organizations_big_query_exports_patch` | `EXEC` | `bigQueryExportsId, organizationsId` | Updates a BigQuery export. | | `projects_big_query_exports_patch` | `EXEC` | `bigQueryExportsId, projectsId` | Updates a BigQuery export. | diff --git a/docs/google-docs/providers/google/securitycenter/custom_modules_descendant/index.md b/docs/google-docs/providers/google/securitycenter/custom_modules_descendant/index.md index b4df257c46..baa19411cc 100644 --- a/docs/google-docs/providers/google/securitycenter/custom_modules_descendant/index.md +++ b/docs/google-docs/providers/google/securitycenter/custom_modules_descendant/index.md @@ -27,11 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | If not empty, indicates that there may be more custom modules to be returned. | -| `securityHealthAnalyticsCustomModules` | `array` | Custom modules belonging to the requested parent and its descendants. | +| `name` | `string` | Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. | +| `displayName` | `string` | The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. | +| `enablementState` | `string` | The enablement state of the custom module. | +| `lastEditor` | `string` | Output only. The editor that last updated the custom module. | +| `updateTime` | `string` | Output only. The time at which the custom module was last updated. | +| `ancestorModule` | `string` | Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. | +| `customConfig` | `object` | Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `folders_security_health_analytics_settings_custom_modules_list_descendant` | `SELECT` | `foldersId` | | `organizations_security_health_analytics_settings_custom_modules_list_descendant` | `SELECT` | `organizationsId` | | `projects_security_health_analytics_settings_custom_modules_list_descendant` | `SELECT` | `projectsId` | +| `_folders_security_health_analytics_settings_custom_modules_list_descendant` | `EXEC` | `foldersId` | +| `_organizations_security_health_analytics_settings_custom_modules_list_descendant` | `EXEC` | `organizationsId` | +| `_projects_security_health_analytics_settings_custom_modules_list_descendant` | `EXEC` | `projectsId` | diff --git a/docs/google-docs/providers/google/securitycenter/effective_custom_modules/index.md b/docs/google-docs/providers/google/securitycenter/effective_custom_modules/index.md index 60954a5874..7106939e45 100644 --- a/docs/google-docs/providers/google/securitycenter/effective_custom_modules/index.md +++ b/docs/google-docs/providers/google/securitycenter/effective_custom_modules/index.md @@ -40,3 +40,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_security_health_analytics_settings_effective_custom_modules_list` | `SELECT` | `organizationsId` | Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors. | | `projects_security_health_analytics_settings_effective_custom_modules_get` | `SELECT` | `effectiveCustomModulesId, projectsId` | Retrieves an EffectiveSecurityHealthAnalyticsCustomModule. | | `projects_security_health_analytics_settings_effective_custom_modules_list` | `SELECT` | `projectsId` | Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors. | +| `_folders_security_health_analytics_settings_effective_custom_modules_list` | `EXEC` | `foldersId` | Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors. | +| `_organizations_security_health_analytics_settings_effective_custom_modules_list` | `EXEC` | `organizationsId` | Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors. | +| `_projects_security_health_analytics_settings_effective_custom_modules_list` | `EXEC` | `projectsId` | Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors. | diff --git a/docs/google-docs/providers/google/securitycenter/event_threat_detection_modules/index.md b/docs/google-docs/providers/google/securitycenter/event_threat_detection_modules/index.md index 76766e468d..94b680f1e5 100644 --- a/docs/google-docs/providers/google/securitycenter/event_threat_detection_modules/index.md +++ b/docs/google-docs/providers/google/securitycenter/event_threat_detection_modules/index.md @@ -27,11 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `eventThreatDetectionCustomModules` | `array` | Custom modules belonging to the requested parent. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". | +| `description` | `string` | The description for the module. | +| `type` | `string` | Type for the module. e.g. CONFIGURABLE_BAD_IP. | +| `updateTime` | `string` | Output only. The time the module was last updated. | +| `config` | `object` | Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. | +| `displayName` | `string` | The human readable name to be displayed for the module. | +| `enablementState` | `string` | The state of enablement for the module at the given level of the hierarchy. | +| `lastEditor` | `string` | Output only. The editor the module was last updated by. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `organizations_event_threat_detection_settings_custom_modules_list` | `SELECT` | `organizationsId` | Lists Event Threat Detection custom modules. | | `organizations_event_threat_detection_settings_custom_modules_create` | `INSERT` | `organizationsId` | Creates an Event Threat Detection custom module. | | `organizations_event_threat_detection_settings_custom_modules_delete` | `DELETE` | `customModulesId, organizationsId` | Deletes an Event Threat Detection custom module. | +| `_organizations_event_threat_detection_settings_custom_modules_list` | `EXEC` | `organizationsId` | Lists Event Threat Detection custom modules. | diff --git a/docs/google-docs/providers/google/securitycenter/findings/index.md b/docs/google-docs/providers/google/securitycenter/findings/index.md index e2157ad912..385b83b224 100644 --- a/docs/google-docs/providers/google/securitycenter/findings/index.md +++ b/docs/google-docs/providers/google/securitycenter/findings/index.md @@ -27,10 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `readTime` | `string` | Time used for executing the list request. | -| `totalSize` | `integer` | The total number of findings matching the query. | -| `listFindingsResults` | `array` | Findings matching the list request. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results. | +| `finding` | `object` | Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. | +| `resource` | `object` | Information related to the Google Cloud resource that is associated with this finding. | +| `stateChange` | `string` | State change of the finding between the points in time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,6 +37,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_sources_findings_list` | `SELECT` | `organizationsId, sourcesId` | Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings | | `projects_sources_findings_list` | `SELECT` | `projectsId, sourcesId` | Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings | | `organizations_sources_findings_create` | `INSERT` | `organizationsId, sourcesId` | Creates a finding. The corresponding source must exist for finding creation to succeed. | +| `_folders_sources_findings_list` | `EXEC` | `foldersId, sourcesId` | Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings | +| `_organizations_sources_findings_list` | `EXEC` | `organizationsId, sourcesId` | Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings | +| `_projects_sources_findings_list` | `EXEC` | `projectsId, sourcesId` | Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings | | `folders_findings_bulk_mute` | `EXEC` | `foldersId` | Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done. | | `folders_sources_findings_group` | `EXEC` | `foldersId, sourcesId` | Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings | | `folders_sources_findings_patch` | `EXEC` | `findingsId, foldersId, sourcesId` | Creates or updates a finding. The corresponding source must exist for a finding creation to succeed. | diff --git a/docs/google-docs/providers/google/securitycenter/index.md b/docs/google-docs/providers/google/securitycenter/index.md index 629abffb4e..b1ea5f2c8c 100644 --- a/docs/google-docs/providers/google/securitycenter/index.md +++ b/docs/google-docs/providers/google/securitycenter/index.md @@ -20,8 +20,8 @@ Security Command Center API Provides Access To Temporal Views Of Assets And Find
total resources: 22
-total selectable resources: 16
-total methods: 136
+total selectable resources: 17
+total methods: 171
@@ -33,7 +33,7 @@ Security Command Center API Provides Access To Temporal Views Of Assets And Find TypeService TitleSecurity Command Center API DescriptionSecurity Command Center API Provides Access To Temporal Views Of Assets And Findings Within An Organization. -Idsecuritycenter:v23.08.00155 +Idsecuritycenter:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/securitycenter/mute_configs/index.md b/docs/google-docs/providers/google/securitycenter/mute_configs/index.md index f4dd10c5c6..8b5227eafa 100644 --- a/docs/google-docs/providers/google/securitycenter/mute_configs/index.md +++ b/docs/google-docs/providers/google/securitycenter/mute_configs/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" | | `description` | `string` | A description of the mute config. | -| `mostRecentEditor` | `string` | Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. | | `updateTime` | `string` | Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. | | `createTime` | `string` | Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. | | `displayName` | `string` | The human readable name to be displayed for the mute config. | | `filter` | `string` | Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` | +| `mostRecentEditor` | `string` | Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -49,6 +49,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `folders_mute_configs_delete` | `DELETE` | `foldersId, muteConfigsId` | Deletes an existing mute config. | | `organizations_mute_configs_delete` | `DELETE` | `muteConfigsId, organizationsId` | Deletes an existing mute config. | | `projects_mute_configs_delete` | `DELETE` | `muteConfigsId, projectsId` | Deletes an existing mute config. | +| `_folders_mute_configs_list` | `EXEC` | `foldersId` | Lists mute configs. | +| `_organizations_mute_configs_list` | `EXEC` | `organizationsId` | Lists mute configs. | +| `_projects_mute_configs_list` | `EXEC` | `projectsId` | Lists mute configs. | | `folders_mute_configs_patch` | `EXEC` | `foldersId, muteConfigsId` | Updates a mute config. | | `organizations_mute_configs_patch` | `EXEC` | `muteConfigsId, organizationsId` | Updates a mute config. | | `projects_mute_configs_patch` | `EXEC` | `muteConfigsId, projectsId` | Updates a mute config. | diff --git a/docs/google-docs/providers/google/securitycenter/notification_configs/index.md b/docs/google-docs/providers/google/securitycenter/notification_configs/index.md index 1649ddfa61..71851aa2dd 100644 --- a/docs/google-docs/providers/google/securitycenter/notification_configs/index.md +++ b/docs/google-docs/providers/google/securitycenter/notification_configs/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". | | `description` | `string` | The description of the notification config (max of 1024 characters). | +| `streamingConfig` | `object` | The config for streaming-based notifications, which send each event as soon as it is detected. | | `pubsubTopic` | `string` | The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". | | `serviceAccount` | `string` | Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic. | -| `streamingConfig` | `object` | The config for streaming-based notifications, which send each event as soon as it is detected. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,6 +47,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `folders_notification_configs_delete` | `DELETE` | `foldersId, notificationConfigsId` | Deletes a notification config. | | `organizations_notification_configs_delete` | `DELETE` | `notificationConfigsId, organizationsId` | Deletes a notification config. | | `projects_notification_configs_delete` | `DELETE` | `notificationConfigsId, projectsId` | Deletes a notification config. | +| `_folders_notification_configs_list` | `EXEC` | `foldersId` | Lists notification configs. | +| `_organizations_notification_configs_list` | `EXEC` | `organizationsId` | Lists notification configs. | +| `_projects_notification_configs_list` | `EXEC` | `projectsId` | Lists notification configs. | | `folders_notification_configs_patch` | `EXEC` | `foldersId, notificationConfigsId` | Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter | | `organizations_notification_configs_patch` | `EXEC` | `notificationConfigsId, organizationsId` | Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter | | `projects_notification_configs_patch` | `EXEC` | `notificationConfigsId, projectsId` | Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter | diff --git a/docs/google-docs/providers/google/securitycenter/operations/index.md b/docs/google-docs/providers/google/securitycenter/operations/index.md index 88e6ec9e4f..9e59856ca4 100644 --- a/docs/google-docs/providers/google/securitycenter/operations/index.md +++ b/docs/google-docs/providers/google/securitycenter/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `organizations_operations_list` | `SELECT` | `organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `organizations_operations_delete` | `DELETE` | `operationsId, organizationsId` | 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`. | +| `_organizations_operations_list` | `EXEC` | `organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `organizations_operations_cancel` | `EXEC` | `operationsId, organizationsId` | 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`. | | `organizations_operations_get` | `EXEC` | `operationsId, organizationsId` | 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. | diff --git a/docs/google-docs/providers/google/securitycenter/organization_settings/index.md b/docs/google-docs/providers/google/securitycenter/organization_settings/index.md index b2c2c9adae..7bbb898ccf 100644 --- a/docs/google-docs/providers/google/securitycenter/organization_settings/index.md +++ b/docs/google-docs/providers/google/securitycenter/organization_settings/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings". | -| `enableAssetDiscovery` | `boolean` | A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false`, all historical assets will remain, but discovery of future assets will not occur. | | `assetDiscoveryConfig` | `object` | The configuration used for Asset Discovery runs. | +| `enableAssetDiscovery` | `boolean` | A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false`, all historical assets will remain, but discovery of future assets will not occur. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/securitycenter/resource_value_configs/index.md b/docs/google-docs/providers/google/securitycenter/resource_value_configs/index.md index a390e7942a..35320af893 100644 --- a/docs/google-docs/providers/google/securitycenter/resource_value_configs/index.md +++ b/docs/google-docs/providers/google/securitycenter/resource_value_configs/index.md @@ -27,13 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages. | -| `resourceValueConfigs` | `array` | The resource value configs from the specified parent. | +| `name` | `string` | Name for the resource value config | +| `description` | `string` | Description of the resource value config. | +| `tagValues` | `array` | Required. Tag values combined with AND to check against. Values in the form "tagValues/123" E.g. [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing | +| `createTime` | `string` | Output only. Timestamp this resource value config was created. | +| `resourceLabelsSelector` | `object` | List of resource labels to search for, evaluated with AND. E.g. "resource_labels_selector": {"key": "value", "env": "prod"} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels | +| `resourceValue` | `string` | Required. Resource value level this expression represents | +| `scope` | `string` | Project or folder to scope this config to. For example, "project/456" would apply this config only to resources in "project/456" scope will be checked with "AND" of other resources. | +| `updateTime` | `string` | Output only. Timestamp this resource value config was last updated. | +| `resourceType` | `string` | Apply resource_value only to resources that match resource_type. resource_type will be checked with "AND" of other resources. E.g. "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `organizations_resource_value_configs_list` | `SELECT` | `organizationsId` | Lists all ResourceValueConfigs. | | `organizations_resource_value_configs_delete` | `DELETE` | `organizationsId, resourceValueConfigsId` | Deletes a ResourceValueConfig. | +| `_organizations_resource_value_configs_list` | `EXEC` | `organizationsId` | Lists all ResourceValueConfigs. | | `organizations_resource_value_configs_batch_create` | `EXEC` | `organizationsId` | Creates a ResourceValueConfig for an organization. Maps user's tags to difference resource values for use by the attack path simulation. | | `organizations_resource_value_configs_get` | `EXEC` | `organizationsId, resourceValueConfigsId` | Gets a ResourceValueConfig. | | `organizations_resource_value_configs_patch` | `EXEC` | `organizationsId, resourceValueConfigsId` | Updates an existing ResourceValueConfigs with new rules. | diff --git a/docs/google-docs/providers/google/securitycenter/security_health_analytics_modules/index.md b/docs/google-docs/providers/google/securitycenter/security_health_analytics_modules/index.md index 9e74926d20..acfd2aea75 100644 --- a/docs/google-docs/providers/google/securitycenter/security_health_analytics_modules/index.md +++ b/docs/google-docs/providers/google/securitycenter/security_health_analytics_modules/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. | +| `ancestorModule` | `string` | Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. | +| `customConfig` | `object` | Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. | | `displayName` | `string` | The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. | | `enablementState` | `string` | The enablement state of the custom module. | | `lastEditor` | `string` | Output only. The editor that last updated the custom module. | | `updateTime` | `string` | Output only. The time at which the custom module was last updated. | -| `ancestorModule` | `string` | Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. | -| `customConfig` | `object` | Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -49,3 +49,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `folders_security_health_analytics_settings_custom_modules_delete` | `DELETE` | `customModulesId, foldersId` | Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules. | | `organizations_security_health_analytics_settings_custom_modules_delete` | `DELETE` | `customModulesId, organizationsId` | Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules. | | `projects_security_health_analytics_settings_custom_modules_delete` | `DELETE` | `customModulesId, projectsId` | Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules. | +| `_folders_security_health_analytics_settings_custom_modules_list` | `EXEC` | `foldersId` | Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors. | +| `_organizations_security_health_analytics_settings_custom_modules_list` | `EXEC` | `organizationsId` | Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors. | +| `_projects_security_health_analytics_settings_custom_modules_list` | `EXEC` | `projectsId` | Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors. | diff --git a/docs/google-docs/providers/google/securitycenter/simulations/index.md b/docs/google-docs/providers/google/securitycenter/simulations/index.md index bd60a2ab45..9f1ae1fbde 100644 --- a/docs/google-docs/providers/google/securitycenter/simulations/index.md +++ b/docs/google-docs/providers/google/securitycenter/simulations/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Full resource name of the Simulation: organizations/123/simulations/456 | -| `createTime` | `string` | Output only. Time simulation was created | | `resourceValueConfigsMetadata` | `array` | Resource value configurations' metadata used in this simulation. Maximum of 100. | +| `createTime` | `string` | Output only. Time simulation was created | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/securitycenter/sources/index.md b/docs/google-docs/providers/google/securitycenter/sources/index.md index c6079719f8..2ab8d536ad 100644 --- a/docs/google-docs/providers/google/securitycenter/sources/index.md +++ b/docs/google-docs/providers/google/securitycenter/sources/index.md @@ -27,8 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results. | -| `sources` | `array` | Sources belonging to the requested parent. | +| `name` | `string` | The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" | +| `description` | `string` | The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated or insecure libraries." | +| `canonicalName` | `string` | The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}", "folders/{folder_id}/sources/{source_id}" or "projects/{project_number}/sources/{source_id}", depending on the closest CRM ancestor of the resource associated with the finding. | +| `displayName` | `string` | The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +39,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_sources_list` | `SELECT` | `organizationsId` | Lists all sources belonging to an organization. | | `projects_sources_list` | `SELECT` | `projectsId` | Lists all sources belonging to an organization. | | `organizations_sources_create` | `INSERT` | `organizationsId` | Creates a source. | +| `_folders_sources_list` | `EXEC` | `foldersId` | Lists all sources belonging to an organization. | +| `_organizations_sources_list` | `EXEC` | `organizationsId` | Lists all sources belonging to an organization. | +| `_projects_sources_list` | `EXEC` | `projectsId` | Lists all sources belonging to an organization. | | `organizations_sources_patch` | `EXEC` | `organizationsId, sourcesId` | Updates a source. | diff --git a/docs/google-docs/providers/google/securitycenter/sources_iam_policies/index.md b/docs/google-docs/providers/google/securitycenter/sources_iam_policies/index.md index a3603d6720..b4f3a2fca3 100644 --- a/docs/google-docs/providers/google/securitycenter/sources_iam_policies/index.md +++ b/docs/google-docs/providers/google/securitycenter/sources_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `organizations_sources_get_iam_policy` | `EXEC` | `organizationsId, sourcesId` | Gets the access control policy on the specified Source. | +| `organizations_sources_get_iam_policy` | `SELECT` | `organizationsId, sourcesId` | Gets the access control policy on the specified Source. | | `organizations_sources_set_iam_policy` | `EXEC` | `organizationsId, sourcesId` | Sets the access control policy on the specified Source. | | `organizations_sources_test_iam_permissions` | `EXEC` | `organizationsId, sourcesId` | Returns the permissions that a caller has on the specified source. | diff --git a/docs/google-docs/providers/google/securitycenter/valued_resources/index.md b/docs/google-docs/providers/google/securitycenter/valued_resources/index.md index 8c6a3fbbbe..576dd8665c 100644 --- a/docs/google-docs/providers/google/securitycenter/valued_resources/index.md +++ b/docs/google-docs/providers/google/securitycenter/valued_resources/index.md @@ -27,11 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `totalSize` | `integer` | The estimated total number of results matching the query. | -| `valuedResources` | `array` | The valued resources that the attack path simulation identified. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results. | +| `name` | `string` | Valued resource name, for example, e.g.: `organizations/123/simulations/456/valuedResources/789` | +| `resourceValue` | `string` | How valuable this resource is. | +| `resourceValueConfigsUsed` | `array` | List of resource value configurations' metadata used to determine the value of this resource. Maximum of 100. | +| `displayName` | `string` | Human-readable name of the valued resource. | +| `exposedScore` | `number` | Exposed score for this valued resource. A value of 0 means no exposure was detected exposure. | +| `resource` | `string` | The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) of the valued resource. | +| `resourceType` | `string` | The [resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) of the valued resource. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `organizations_simulations_attack_exposure_results_valued_resources_list` | `SELECT` | `attackExposureResultsId, organizationsId, simulationsId` | | `organizations_simulations_valued_resources_list` | `SELECT` | `organizationsId, simulationsId` | +| `_organizations_simulations_attack_exposure_results_valued_resources_list` | `EXEC` | `attackExposureResultsId, organizationsId, simulationsId` | +| `_organizations_simulations_valued_resources_list` | `EXEC` | `organizationsId, simulationsId` | diff --git a/docs/google-docs/providers/google/serviceconsumermanagement/index.md b/docs/google-docs/providers/google/serviceconsumermanagement/index.md index e120f72a59..427ed4ed4c 100644 --- a/docs/google-docs/providers/google/serviceconsumermanagement/index.md +++ b/docs/google-docs/providers/google/serviceconsumermanagement/index.md @@ -21,7 +21,7 @@ Manages The Service Consumers Of A Service Infrastructure Service.
total resources: 4
total selectable resources: 2
-total methods: 14
+total methods: 16
@@ -33,7 +33,7 @@ Manages The Service Consumers Of A Service Infrastructure Service. TypeService TitleService Consumer Management API DescriptionManages The Service Consumers Of A Service Infrastructure Service. -Idserviceconsumermanagement:v23.08.00155 +Idserviceconsumermanagement:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/serviceconsumermanagement/operations/index.md b/docs/google-docs/providers/google/serviceconsumermanagement/operations/index.md index 07473d8a40..69baf0e54e 100644 --- a/docs/google-docs/providers/google/serviceconsumermanagement/operations/index.md +++ b/docs/google-docs/providers/google/serviceconsumermanagement/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operationsId` | 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. | | `list` | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `operationsId` | 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`. | +| `_list` | `EXEC` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `operationsId` | 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`. | diff --git a/docs/google-docs/providers/google/serviceconsumermanagement/tenancy_units/index.md b/docs/google-docs/providers/google/serviceconsumermanagement/tenancy_units/index.md index 8deb76a236..9eb2c5da6a 100644 --- a/docs/google-docs/providers/google/serviceconsumermanagement/tenancy_units/index.md +++ b/docs/google-docs/providers/google/serviceconsumermanagement/tenancy_units/index.md @@ -27,14 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Pagination token for large results. | -| `tenancyUnits` | `array` | Tenancy units matching the request. | +| `name` | `string` | Globally unique identifier of this tenancy unit "services/{service}/{collection id}/{resource id}/tenancyUnits/{unit}" | +| `createTime` | `string` | Output only. @OutputOnly The time this tenancy unit was created. | +| `service` | `string` | Output only. Google Cloud API name of the managed service owning this tenancy unit. For example 'serviceconsumermanagement.googleapis.com'. | +| `tenantResources` | `array` | Resources constituting the tenancy unit. There can be at most 512 tenant resources in a tenancy unit. | +| `consumer` | `string` | Output only. @OutputOnly Cloud resource name of the consumer of this service. For example 'projects/123456'. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `list` | `SELECT` | `servicesId, servicesId1, servicesId2` | Find the tenancy unit for a managed service and service consumer. This method shouldn't be used in a service producer's runtime path, for example to find the tenant project number when creating VMs. Service producers must persist the tenant project's information after the project is created. | | `create` | `INSERT` | `servicesId, servicesId1, servicesId2` | Creates a tenancy unit with no tenant resources. If tenancy unit already exists, it will be returned, however, in this case, returned TenancyUnit does not have tenant_resources field set and ListTenancyUnits has to be used to get a complete TenancyUnit with all fields populated. | | `delete` | `DELETE` | `servicesId, servicesId1, servicesId2, tenancyUnitsId` | Delete a tenancy unit. Before you delete the tenancy unit, there should be no tenant resources in it that aren't in a DELETED state. Operation. | +| `_list` | `EXEC` | `servicesId, servicesId1, servicesId2` | Find the tenancy unit for a managed service and service consumer. This method shouldn't be used in a service producer's runtime path, for example to find the tenant project number when creating VMs. Service producers must persist the tenant project's information after the project is created. | | `apply_project_config` | `EXEC` | `servicesId, servicesId1, servicesId2, tenancyUnitsId` | Apply a configuration to an existing tenant project. This project must exist in an active state and have the original owner account. The caller must have permission to add a project to the given tenancy unit. The configuration is applied, but any existing settings on the project aren't modified. Specified policy bindings are applied. Existing bindings aren't modified. Specified services are activated. No service is deactivated. If specified, new billing configuration is applied. Omit a billing configuration to keep the existing one. A service account in the project is created if previously non existed. Specified labels will be appended to tenant project, note that the value of existing label key will be updated if the same label key is requested. The specified folder is ignored, as moving a tenant project to a different folder isn't supported. The operation fails if any of the steps fail, but no rollback of already applied configuration changes is attempted. Operation. | | `attach_project` | `EXEC` | `servicesId, servicesId1, servicesId2, tenancyUnitsId` | Attach an existing project to the tenancy unit as a new tenant resource. The project could either be the tenant project reserved by calling `AddTenantProject` under a tenancy unit of a service producer's project of a managed service, or from a separate project. The caller is checked against a set of permissions as if calling `AddTenantProject` on the same service consumer. To trigger the attachment, the targeted tenant project must be in a folder. Make sure the ServiceConsumerManagement service account is the owner of that project. These two requirements are already met if the project is reserved by calling `AddTenantProject`. Operation. | | `undelete_project` | `EXEC` | `servicesId, servicesId1, servicesId2, tenancyUnitsId` | Attempts to undelete a previously deleted tenant project. The project must be in a DELETED state. There are no guarantees that an undeleted project will be in a fully restored and functional state. Call the `ApplyTenantProjectConfig` method to update its configuration and then validate all managed service resources. Operation. | diff --git a/docs/google-docs/providers/google/servicecontrol/index.md b/docs/google-docs/providers/google/servicecontrol/index.md index 69142bd79c..cee56c7d81 100644 --- a/docs/google-docs/providers/google/servicecontrol/index.md +++ b/docs/google-docs/providers/google/servicecontrol/index.md @@ -33,7 +33,7 @@ Provides Admission Control And Telemetry Reporting For Services Integrated With TypeService TitleService Control API DescriptionProvides Admission Control And Telemetry Reporting For Services Integrated With Service Infrastructure. -Idservicecontrol:v23.08.00155 +Idservicecontrol:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/servicedirectory/endpoints/index.md b/docs/google-docs/providers/google/servicedirectory/endpoints/index.md index 4180b42883..9fe328638f 100644 --- a/docs/google-docs/providers/google/servicedirectory/endpoints/index.md +++ b/docs/google-docs/providers/google/servicedirectory/endpoints/index.md @@ -27,8 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `endpoints` | `array` | The list of endpoints. | +| `name` | `string` | Immutable. The resource name for the endpoint in the format `projects/*/locations/*/namespaces/*/services/*/endpoints/*`. | +| `network` | `string` | Immutable. The Google Compute Engine network (VPC) of the endpoint in the format `projects//locations/global/networks/*`. The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified. | +| `port` | `integer` | Optional. Service Directory rejects values outside of `[0, 65535]`. | +| `uid` | `string` | Output only. The globally unique identifier of the endpoint in the UUID4 format. | +| `address` | `string` | Optional. An IPv4 or IPv6 address. Service Directory rejects bad addresses like: * `8.8.8` * `8.8.8.8:53` * `test:bad:address` * `[::1]` * `[::1]:8080` Limited to 45 characters. | +| `annotations` | `object` | Optional. Annotations for the endpoint. This data can be consumed by service clients. Restrictions: * The entire annotations dictionary may contain up to 512 characters, spread accoss all key-value pairs. Annotations that go beyond this limit are rejected * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/) Annotations that fails to meet these requirements are rejected. Note: This field is equivalent to the `metadata` field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +40,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, namespacesId, projectsId, servicesId` | Lists all endpoints. | | `create` | `INSERT` | `locationsId, namespacesId, projectsId, servicesId` | Creates an endpoint, and returns the new endpoint. | | `delete` | `DELETE` | `endpointsId, locationsId, namespacesId, projectsId, servicesId` | Deletes an endpoint. | +| `_list` | `EXEC` | `locationsId, namespacesId, projectsId, servicesId` | Lists all endpoints. | | `patch` | `EXEC` | `endpointsId, locationsId, namespacesId, projectsId, servicesId` | Updates an endpoint. | diff --git a/docs/google-docs/providers/google/servicedirectory/index.md b/docs/google-docs/providers/google/servicedirectory/index.md index f39e3b1656..b30e7a9c8e 100644 --- a/docs/google-docs/providers/google/servicedirectory/index.md +++ b/docs/google-docs/providers/google/servicedirectory/index.md @@ -20,8 +20,8 @@ Service Directory Is A Platform For Discovering, Publishing, And Connecting Serv
total resources: 6
-total selectable resources: 4
-total methods: 24
+total selectable resources: 6
+total methods: 28
@@ -33,7 +33,7 @@ Service Directory Is A Platform For Discovering, Publishing, And Connecting Serv TypeService TitleService Directory API DescriptionService Directory Is A Platform For Discovering, Publishing, And Connecting Services. -Idservicedirectory:v23.08.00155 +Idservicedirectory:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/servicedirectory/locations/index.md b/docs/google-docs/providers/google/servicedirectory/locations/index.md index 910efc26a6..8ddeef2bc6 100644 --- a/docs/google-docs/providers/google/servicedirectory/locations/index.md +++ b/docs/google-docs/providers/google/servicedirectory/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/servicedirectory/namespaces/index.md b/docs/google-docs/providers/google/servicedirectory/namespaces/index.md index 744ad4ba5e..b98ec98109 100644 --- a/docs/google-docs/providers/google/servicedirectory/namespaces/index.md +++ b/docs/google-docs/providers/google/servicedirectory/namespaces/index.md @@ -27,8 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `namespaces` | `array` | The list of namespaces. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Immutable. The resource name for the namespace in the format `projects/*/locations/*/namespaces/*`. | +| `labels` | `object` | Optional. Resource labels associated with this namespace. No more than 64 user labels can be associated with a given resource. Label keys and values can be no longer than 63 characters. | +| `uid` | `string` | Output only. The globally unique identifier of the namespace in the UUID4 format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +37,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists all namespaces. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a namespace, and returns the new namespace. | | `delete` | `DELETE` | `locationsId, namespacesId, projectsId` | Deletes a namespace. This also deletes all services and endpoints in the namespace. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists all namespaces. | | `patch` | `EXEC` | `locationsId, namespacesId, projectsId` | Updates a namespace. | diff --git a/docs/google-docs/providers/google/servicedirectory/namespaces_iam_policies/index.md b/docs/google-docs/providers/google/servicedirectory/namespaces_iam_policies/index.md index 590ddd360d..69c777b96b 100644 --- a/docs/google-docs/providers/google/servicedirectory/namespaces_iam_policies/index.md +++ b/docs/google-docs/providers/google/servicedirectory/namespaces_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `locationsId, namespacesId, projectsId` | Gets the IAM Policy for a resource (namespace or service only). | +| `get_iam_policy` | `SELECT` | `locationsId, namespacesId, projectsId` | Gets the IAM Policy for a resource (namespace or service only). | | `set_iam_policy` | `EXEC` | `locationsId, namespacesId, projectsId` | Sets the IAM Policy for a resource (namespace or service only). | | `test_iam_permissions` | `EXEC` | `locationsId, namespacesId, projectsId` | Tests IAM permissions for a resource (namespace or service only). | diff --git a/docs/google-docs/providers/google/servicedirectory/services/index.md b/docs/google-docs/providers/google/servicedirectory/services/index.md index 7cd7143e2e..1b70777e27 100644 --- a/docs/google-docs/providers/google/servicedirectory/services/index.md +++ b/docs/google-docs/providers/google/servicedirectory/services/index.md @@ -27,8 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `services` | `array` | The list of services. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Immutable. The resource name for the service in the format `projects/*/locations/*/namespaces/*/services/*`. | +| `uid` | `string` | Output only. The globally unique identifier of the service in the UUID4 format. | +| `annotations` | `object` | Optional. Annotations for the service. This data can be consumed by service clients. Restrictions: * The entire annotations dictionary may contain up to 2000 characters, spread accoss all key-value pairs. Annotations that go beyond this limit are rejected * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/). Annotations that fails to meet these requirements are rejected Note: This field is equivalent to the `metadata` field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory. | +| `endpoints` | `array` | Output only. Endpoints associated with this service. Returned on LookupService.ResolveService. Control plane clients should use RegistrationService.ListEndpoints. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +38,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, namespacesId, projectsId` | Lists all services belonging to a namespace. | | `create` | `INSERT` | `locationsId, namespacesId, projectsId` | Creates a service, and returns the new service. | | `delete` | `DELETE` | `locationsId, namespacesId, projectsId, servicesId` | Deletes a service. This also deletes all endpoints associated with the service. | +| `_list` | `EXEC` | `locationsId, namespacesId, projectsId` | Lists all services belonging to a namespace. | | `patch` | `EXEC` | `locationsId, namespacesId, projectsId, servicesId` | Updates a service. | | `resolve` | `EXEC` | `locationsId, namespacesId, projectsId, servicesId` | Returns a service and its associated endpoints. Resolving a service is not considered an active developer method. | diff --git a/docs/google-docs/providers/google/servicedirectory/services_iam_policies/index.md b/docs/google-docs/providers/google/servicedirectory/services_iam_policies/index.md index 67d3a5943f..ade95c5732 100644 --- a/docs/google-docs/providers/google/servicedirectory/services_iam_policies/index.md +++ b/docs/google-docs/providers/google/servicedirectory/services_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `locationsId, namespacesId, projectsId, servicesId` | Gets the IAM Policy for a resource (namespace or service only). | +| `get_iam_policy` | `SELECT` | `locationsId, namespacesId, projectsId, servicesId` | Gets the IAM Policy for a resource (namespace or service only). | | `set_iam_policy` | `EXEC` | `locationsId, namespacesId, projectsId, servicesId` | Sets the IAM Policy for a resource (namespace or service only). | | `test_iam_permissions` | `EXEC` | `locationsId, namespacesId, projectsId, servicesId` | Tests IAM permissions for a resource (namespace or service only). | diff --git a/docs/google-docs/providers/google/servicemanagement/configs/index.md b/docs/google-docs/providers/google/servicemanagement/configs/index.md index 976a94e9aa..d5ebccdb30 100644 --- a/docs/google-docs/providers/google/servicemanagement/configs/index.md +++ b/docs/google-docs/providers/google/servicemanagement/configs/index.md @@ -27,12 +27,39 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `serviceConfigs` | `array` | The list of service configuration resources. | -| `nextPageToken` | `string` | The token of the next page of results. | +| `id` | `string` | A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead. | +| `name` | `string` | The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. | +| `usage` | `object` | Configuration controlling usage of a service. | +| `logs` | `array` | Defines the logs used by this service. | +| `monitoring` | `object` | Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/num_overdue` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/Branch display_name: "Library Branch" description: "A branch of a library." launch_stage: GA labels: - key: resource_container description: "The Cloud container (ie. project id) for the Branch." - key: location description: "The location of the library branch." - key: branch_id description: "The id of the branch." metrics: - name: library.googleapis.com/book/returned_count display_name: "Books Returned" description: "The count of books that have been returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." - name: library.googleapis.com/book/num_overdue display_name: "Books Overdue" description: "The current number of overdue books." launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." monitoring: producer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/num_overdue | +| `backend` | `object` | `Backend` defines the backend configuration for a service. | +| `publishing` | `object` | This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config. | +| `billing` | `object` | Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: \| Predefined label to support billing location restriction. - key: city description: \| Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count | +| `types` | `array` | A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 | +| `endpoints` | `array` | Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. | +| `configVersion` | `integer` | Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`. | +| `quota` | `object` | Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 | +| `http` | `object` | Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. | +| `systemParameters` | `object` | ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. | +| `producerProjectId` | `string` | The Google project that owns this service. | +| `monitoredResources` | `array` | Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. | +| `authentication` | `object` | `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read | +| `control` | `object` | Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com | +| `logging` | `object` | Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history | +| `apis` | `array` | A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. | +| `enums` | `array` | A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum | +| `title` | `string` | The product title for this service, it is the name displayed in Google Cloud Console. | +| `metrics` | `array` | Defines the metrics used by this service. | +| `documentation` | `object` | `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. | +| `customError` | `object` | Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError | +| `sourceInfo` | `object` | Source information used to create a Service Config | +| `context` | `object` | `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. | +| `systemTypes` | `array` | A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `configId, serviceName` | Gets a service configuration (version) for a managed service. | | `list` | `SELECT` | `serviceName` | Lists the history of the service configuration for a managed service, from the newest to the oldest. | | `create` | `INSERT` | `serviceName` | Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call CreateServiceRollout. Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually. | +| `_list` | `EXEC` | `serviceName` | Lists the history of the service configuration for a managed service, from the newest to the oldest. | | `submit` | `EXEC` | `serviceName` | Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call CreateServiceRollout. Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually. Operation | diff --git a/docs/google-docs/providers/google/servicemanagement/consumers_iam_policies/index.md b/docs/google-docs/providers/google/servicemanagement/consumers_iam_policies/index.md index cdcd352292..2dfeb39d93 100644 --- a/docs/google-docs/providers/google/servicemanagement/consumers_iam_policies/index.md +++ b/docs/google-docs/providers/google/servicemanagement/consumers_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `consumersId, servicesId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | +| `get_iam_policy` | `SELECT` | `consumersId, servicesId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | | `set_iam_policy` | `EXEC` | `consumersId, servicesId` | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. | | `test_iam_permissions` | `EXEC` | `consumersId, servicesId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | diff --git a/docs/google-docs/providers/google/servicemanagement/index.md b/docs/google-docs/providers/google/servicemanagement/index.md index 9aedd1600c..e83e3c7203 100644 --- a/docs/google-docs/providers/google/servicemanagement/index.md +++ b/docs/google-docs/providers/google/servicemanagement/index.md @@ -20,8 +20,8 @@ Google Service Management Allows Service Producers To Publish Their Services On
total resources: 7
-total selectable resources: 5
-total methods: 22
+total selectable resources: 7
+total methods: 26
@@ -33,7 +33,7 @@ Google Service Management Allows Service Producers To Publish Their Services On TypeService TitleService Management API DescriptionGoogle Service Management Allows Service Producers To Publish Their Services On Google Cloud Platform So That They Can Be Discovered And Used By Service Consumers. -Idservicemanagement:v23.08.00155 +Idservicemanagement:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/servicemanagement/operations/index.md b/docs/google-docs/providers/google/servicemanagement/operations/index.md index 01b8e288f4..a1e206846f 100644 --- a/docs/google-docs/providers/google/servicemanagement/operations/index.md +++ b/docs/google-docs/providers/google/servicemanagement/operations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operationsId` | 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. | | `list` | `SELECT` | | Lists service operations that match the specified filter in the request. | +| `_list` | `EXEC` | | Lists service operations that match the specified filter in the request. | diff --git a/docs/google-docs/providers/google/servicemanagement/rollouts/index.md b/docs/google-docs/providers/google/servicemanagement/rollouts/index.md index 9ca631ef77..aac319f3da 100644 --- a/docs/google-docs/providers/google/servicemanagement/rollouts/index.md +++ b/docs/google-docs/providers/google/servicemanagement/rollouts/index.md @@ -27,11 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The token of the next page of results. | -| `rollouts` | `array` | The list of rollout resources. | +| `deleteServiceStrategy` | `object` | Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service. | +| `rolloutId` | `string` | Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of , where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1' | +| `serviceName` | `string` | The name of the service associated with this Rollout. | +| `status` | `string` | The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly. | +| `trafficPercentStrategy` | `object` | Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured percentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: "example.googleapis.com/rollout_20160206" traffic_percent_strategy { percentages: { "example.googleapis.com/20160201": 70.00 "example.googleapis.com/20160206": 30.00 } } } Day 2 Rollout { id: "example.googleapis.com/rollout_20160207" traffic_percent_strategy: { percentages: { "example.googleapis.com/20160206": 100.00 } } } | +| `createTime` | `string` | Creation time of the rollout. Readonly. | +| `createdBy` | `string` | The user who created the Rollout. Readonly. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `rolloutId, serviceName` | Gets a service configuration rollout. | | `list` | `SELECT` | `serviceName` | Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest. | | `create` | `INSERT` | `serviceName` | Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging. Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts. Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually. Operation | +| `_list` | `EXEC` | `serviceName` | Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest. | diff --git a/docs/google-docs/providers/google/servicemanagement/services/index.md b/docs/google-docs/providers/google/servicemanagement/services/index.md index d715ac1365..e5c901c6c7 100644 --- a/docs/google-docs/providers/google/servicemanagement/services/index.md +++ b/docs/google-docs/providers/google/servicemanagement/services/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `serviceName` | `string` | The name of the service. See the [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. | | `producerProjectId` | `string` | ID of the project that produces and owns this service. | +| `serviceName` | `string` | The name of the service. See the [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +36,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | | Lists managed services. Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for. | | `create` | `INSERT` | | Creates a new managed service. A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion. One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project. Operation | | `delete` | `DELETE` | `serviceName` | Deletes a managed service. This method will change the service to the `Soft-Delete` state for 30 days. Within this period, service producers may call UndeleteService to restore the service. After 30 days, the service will be permanently deleted. Operation | +| `_list` | `EXEC` | | Lists managed services. Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for. | | `generate_config_report` | `EXEC` | | Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value If GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration. | | `undelete` | `EXEC` | `serviceName` | Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days. Operation | diff --git a/docs/google-docs/providers/google/servicemanagement/services_config/index.md b/docs/google-docs/providers/google/servicemanagement/services_config/index.md index 9d7568e2cf..22bb5cf13d 100644 --- a/docs/google-docs/providers/google/servicemanagement/services_config/index.md +++ b/docs/google-docs/providers/google/servicemanagement/services_config/index.md @@ -29,32 +29,32 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead. | | `name` | `string` | The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. | -| `sourceInfo` | `object` | Source information used to create a Service Config | -| `systemParameters` | `object` | ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. | -| `enums` | `array` | A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum | -| `customError` | `object` | Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError | | `apis` | `array` | A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. | -| `backend` | `object` | `Backend` defines the backend configuration for a service. | | `authentication` | `object` | `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read | +| `quota` | `object` | Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 | +| `sourceInfo` | `object` | Source information used to create a Service Config | +| `backend` | `object` | `Backend` defines the backend configuration for a service. | +| `producerProjectId` | `string` | The Google project that owns this service. | +| `customError` | `object` | Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError | +| `usage` | `object` | Configuration controlling usage of a service. | +| `endpoints` | `array` | Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. | | `logging` | `object` | Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history | | `metrics` | `array` | Defines the metrics used by this service. | -| `billing` | `object` | Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: \| Predefined label to support billing location restriction. - key: city description: \| Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count | -| `context` | `object` | `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. | -| `usage` | `object` | Configuration controlling usage of a service. | -| `systemTypes` | `array` | A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. | -| `logs` | `array` | Defines the logs used by this service. | +| `types` | `array` | A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 | | `documentation` | `object` | `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. | +| `monitoring` | `object` | Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/num_overdue` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/Branch display_name: "Library Branch" description: "A branch of a library." launch_stage: GA labels: - key: resource_container description: "The Cloud container (ie. project id) for the Branch." - key: location description: "The location of the library branch." - key: branch_id description: "The id of the branch." metrics: - name: library.googleapis.com/book/returned_count display_name: "Books Returned" description: "The count of books that have been returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." - name: library.googleapis.com/book/num_overdue display_name: "Books Overdue" description: "The current number of overdue books." launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." monitoring: producer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/num_overdue | +| `monitoredResources` | `array` | Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. | +| `enums` | `array` | A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum | | `http` | `object` | Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. | -| `quota` | `object` | Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 | -| `types` | `array` | A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 | -| `endpoints` | `array` | Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. | -| `producerProjectId` | `string` | The Google project that owns this service. | +| `systemTypes` | `array` | A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. | +| `control` | `object` | Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com | +| `context` | `object` | `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. | +| `logs` | `array` | Defines the logs used by this service. | +| `billing` | `object` | Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: \| Predefined label to support billing location restriction. - key: city description: \| Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count | +| `systemParameters` | `object` | ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. | +| `configVersion` | `integer` | Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`. | | `title` | `string` | The product title for this service, it is the name displayed in Google Cloud Console. | | `publishing` | `object` | This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config. | -| `configVersion` | `integer` | Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`. | -| `control` | `object` | Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com | -| `monitoredResources` | `array` | Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. | -| `monitoring` | `object` | Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/num_overdue` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/Branch display_name: "Library Branch" description: "A branch of a library." launch_stage: GA labels: - key: resource_container description: "The Cloud container (ie. project id) for the Branch." - key: location description: "The location of the library branch." - key: branch_id description: "The id of the branch." metrics: - name: library.googleapis.com/book/returned_count display_name: "Books Returned" description: "The count of books that have been returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." - name: library.googleapis.com/book/num_overdue display_name: "Books Overdue" description: "The current number of overdue books." launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." monitoring: producer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/num_overdue | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/servicemanagement/services_iam_policies/index.md b/docs/google-docs/providers/google/servicemanagement/services_iam_policies/index.md index 5a08779e34..85685b8deb 100644 --- a/docs/google-docs/providers/google/servicemanagement/services_iam_policies/index.md +++ b/docs/google-docs/providers/google/servicemanagement/services_iam_policies/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_iam_policy` | `EXEC` | `servicesId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | +| `get_iam_policy` | `SELECT` | `servicesId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | | `set_iam_policy` | `EXEC` | `servicesId` | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. | | `test_iam_permissions` | `EXEC` | `servicesId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | diff --git a/docs/google-docs/providers/google/servicenetworking/dns_zones/index.md b/docs/google-docs/providers/google/servicenetworking/dns_zones/index.md index dcc76f5c67..ea50114ebd 100644 --- a/docs/google-docs/providers/google/servicenetworking/dns_zones/index.md +++ b/docs/google-docs/providers/google/servicenetworking/dns_zones/index.md @@ -25,9 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields +| Name | Datatype | +|:-----|:---------| +| `producerPrivateZone` | `object` | +| `consumerPeeringZone` | `object` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `list` | `SELECT` | `servicesId` | * Service producers can use this method to retrieve a list of available DNS zones in the shared producer host project and the matching peering zones in the consumer project. * | +| `get` | `SELECT` | `dnsZonesId, networksId, projectsId, servicesId` | Service producers can use this method to retrieve a DNS zone in the shared producer host project and the matching peering zones in consumer project | +| `list` | `SELECT` | `networksId, projectsId, servicesId` | * Service producers can use this method to retrieve a list of available DNS zones in the shared producer host project and the matching peering zones in the consumer project. * | | `add` | `EXEC` | `servicesId` | Service producers can use this method to add private DNS zones in the shared producer host project and matching peering zones in the consumer project. | | `remove` | `EXEC` | `servicesId` | Service producers can use this method to remove private DNS zones in the shared producer host project and matching peering zones in the consumer project. | diff --git a/docs/google-docs/providers/google/servicenetworking/index.md b/docs/google-docs/providers/google/servicenetworking/index.md index dbf590e013..4e784326ac 100644 --- a/docs/google-docs/providers/google/servicenetworking/index.md +++ b/docs/google-docs/providers/google/servicenetworking/index.md @@ -19,9 +19,9 @@ Provides Automatic Management Of Network Configurations Necessary For Certain Se
-total resources: 13
-total selectable resources: 8
-total methods: 28
+total resources: 12
+total selectable resources: 7
+total methods: 29
@@ -33,7 +33,7 @@ Provides Automatic Management Of Network Configurations Necessary For Certain Se TypeService TitleService Networking API DescriptionProvides Automatic Management Of Network Configurations Necessary For Certain Services. -Idservicenetworking:v23.08.00155 +Idservicenetworking:v23.08.00157 ## Resources @@ -43,7 +43,6 @@ Provides Automatic Management Of Network Configurations Necessary For Certain Se connections_connection
dns_record_set
dns_record_sets
-dns_zone
dns_zones
networks
diff --git a/docs/google-docs/providers/google/servicenetworking/networks/index.md b/docs/google-docs/providers/google/servicenetworking/networks/index.md index 25e64232cb..aa0facadde 100644 --- a/docs/google-docs/providers/google/servicenetworking/networks/index.md +++ b/docs/google-docs/providers/google/servicenetworking/networks/index.md @@ -27,19 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `producerImportSubnetRoutesWithPublicIp` | `boolean` | Import subnet routes with public ip flag value for peering from producer to consumer. | -| `producerImportCustomRoutes` | `boolean` | Import custom routes flag value for peering from producer to consumer. | | `producerExportCustomRoutes` | `boolean` | Export custom routes flag value for peering from producer to consumer. | -| `consumerImportCustomRoutes` | `boolean` | Import custom routes flag value for peering from consumer to producer. | -| `usedIpRanges` | `array` | Output only. The IP ranges already in use by consumer or producer | -| `consumerExportSubnetRoutesWithPublicIp` | `boolean` | Export subnet routes with public ip flag value for peering from consumer to producer. | -| `reservedRanges` | `array` | Output only. The reserved ranges associated with this private service access connection. | | `vpcScReferenceArchitectureEnabled` | `boolean` | Output only. Indicates whether the VPC Service Controls reference architecture is configured for the producer VPC host network. | -| `producerExportSubnetRoutesWithPublicIp` | `boolean` | Export subnet routes with public ip flag value for peering from producer to consumer. | +| `consumerExportCustomRoutes` | `boolean` | Export custom routes flag value for peering from consumer to producer. | | `consumerImportSubnetRoutesWithPublicIp` | `boolean` | Import subnet routes with public ip flag value for peering from consumer to producer. | +| `producerImportSubnetRoutesWithPublicIp` | `boolean` | Import subnet routes with public ip flag value for peering from producer to consumer. | | `producerNetwork` | `string` | Output only. The VPC host network that is used to host managed service instances. In the format, projects/{project}/global/networks/{network} where {project} is the project number e.g. '12345' and {network} is the network name. | | `cloudsqlConfigs` | `array` | Represents one or multiple Cloud SQL configurations. | -| `consumerExportCustomRoutes` | `boolean` | Export custom routes flag value for peering from consumer to producer. | +| `consumerExportSubnetRoutesWithPublicIp` | `boolean` | Export subnet routes with public ip flag value for peering from consumer to producer. | +| `consumerImportCustomRoutes` | `boolean` | Import custom routes flag value for peering from consumer to producer. | +| `reservedRanges` | `array` | Output only. The reserved ranges associated with this private service access connection. | +| `producerExportSubnetRoutesWithPublicIp` | `boolean` | Export subnet routes with public ip flag value for peering from producer to consumer. | +| `producerImportCustomRoutes` | `boolean` | Import custom routes flag value for peering from producer to consumer. | +| `usedIpRanges` | `array` | Output only. The IP ranges already in use by consumer or producer | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/servicenetworking/operations/index.md b/docs/google-docs/providers/google/servicenetworking/operations/index.md index ddb67e190b..6ff0cda11a 100644 --- a/docs/google-docs/providers/google/servicenetworking/operations/index.md +++ b/docs/google-docs/providers/google/servicenetworking/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operationsId` | 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. | | `list` | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `operationsId` | 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`. | +| `_list` | `EXEC` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `operationsId` | 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`. | diff --git a/docs/google-docs/providers/google/serviceusage/index.md b/docs/google-docs/providers/google/serviceusage/index.md index 81d00c0341..3eeaaf360e 100644 --- a/docs/google-docs/providers/google/serviceusage/index.md +++ b/docs/google-docs/providers/google/serviceusage/index.md @@ -21,7 +21,7 @@ Enables Services That Service Consumers Want To Use On Google Cloud Platform, Li
total resources: 2
total selectable resources: 2
-total methods: 8
+total methods: 9
@@ -33,7 +33,7 @@ Enables Services That Service Consumers Want To Use On Google Cloud Platform, Li TypeService TitleService Usage API DescriptionEnables Services That Service Consumers Want To Use On Google Cloud Platform, Lists The Available Or Enabled Services, Or Disables Services That Service Consumers No Longer Use. -Idserviceusage:v23.08.00155 +Idserviceusage:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/serviceusage/operations/index.md b/docs/google-docs/providers/google/serviceusage/operations/index.md index aaa0dd4622..cd125a8aa7 100644 --- a/docs/google-docs/providers/google/serviceusage/operations/index.md +++ b/docs/google-docs/providers/google/serviceusage/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operationsId` | 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. | | `list` | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `operationsId` | 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`. | +| `_list` | `EXEC` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `operationsId` | 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`. | diff --git a/docs/google-docs/providers/google/serviceusage/services/index.md b/docs/google-docs/providers/google/serviceusage/services/index.md index 5fae1fc064..d5c82276ee 100644 --- a/docs/google-docs/providers/google/serviceusage/services/index.md +++ b/docs/google-docs/providers/google/serviceusage/services/index.md @@ -37,4 +37,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `get` | `SELECT` | `name` | Returns the service configuration and enabled state for a given service. | | `batch_enable` | `EXEC` | `parent` | 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. | | `batch_get` | `EXEC` | `parent` | Returns the service configurations and enabled states for a given list of services. | -| `disable` | `EXEC` | `name` | 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. | +| `enable` | `EXEC` | `name` | Enable a service so that it can be used with a project. | diff --git a/docs/google-docs/providers/google/sourcerepo/index.md b/docs/google-docs/providers/google/sourcerepo/index.md index 5ed543a1b9..ba77496fe2 100644 --- a/docs/google-docs/providers/google/sourcerepo/index.md +++ b/docs/google-docs/providers/google/sourcerepo/index.md @@ -21,7 +21,7 @@ Accesses Source Code Repositories Hosted By Google.
total resources: 3
total selectable resources: 2
-total methods: 11
+total methods: 12
@@ -33,7 +33,7 @@ Accesses Source Code Repositories Hosted By Google. TypeService TitleCloud Source Repositories API DescriptionAccesses Source Code Repositories Hosted By Google. -Idsourcerepo:v23.08.00155 +Idsourcerepo:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/sourcerepo/repos/index.md b/docs/google-docs/providers/google/sourcerepo/repos/index.md index eeb157cffa..68748128a1 100644 --- a/docs/google-docs/providers/google/sourcerepo/repos/index.md +++ b/docs/google-docs/providers/google/sourcerepo/repos/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `repos` | `array` | The listed repos. | -| `nextPageToken` | `string` | If non-empty, additional repositories exist within the project. These can be retrieved by including this value in the next ListReposRequest's page_token field. | +| `name` | `string` | Resource name of the repository, of the form `projects//repos/`. The repo name may contain slashes. eg, `projects/myproject/repos/name/with/slash` | +| `pubsubConfigs` | `object` | How this repository publishes a change in the repository through Cloud Pub/Sub. Keyed by the topic names. | +| `size` | `string` | The disk usage of the repo, in bytes. Read-only field. Size is only returned by GetRepo. | +| `url` | `string` | URL to clone the repository from Google Cloud Source Repositories. Read-only field. | +| `mirrorConfig` | `object` | Configuration to automatically mirror a repository from another hosting service, for example GitHub or Bitbucket. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +39,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId` | Returns all repos belonging to a project. The sizes of the repos are not set by ListRepos. To get the size of a repo, use GetRepo. | | `create` | `INSERT` | `projectsId` | Creates a repo in the given project with the given name. If the named repository already exists, `CreateRepo` returns `ALREADY_EXISTS`. | | `delete` | `DELETE` | `projectsId, reposId` | Deletes a repo. | +| `_list` | `EXEC` | `projectsId` | Returns all repos belonging to a project. The sizes of the repos are not set by ListRepos. To get the size of a repo, use GetRepo. | | `patch` | `EXEC` | `projectsId, reposId` | Updates information about a repo. | | `sync` | `EXEC` | `projectsId, reposId` | Synchronize a connected repo. The response contains SyncRepoMetadata in the metadata field. | diff --git a/docs/google-docs/providers/google/spanner/backup_operations/index.md b/docs/google-docs/providers/google/spanner/backup_operations/index.md index b365e51cfd..05636382e8 100644 --- a/docs/google-docs/providers/google/spanner/backup_operations/index.md +++ b/docs/google-docs/providers/google/spanner/backup_operations/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | `next_page_token` can be sent in a subsequent ListBackupOperations call to fetch more of the matching metadata. | -| `operations` | `array` | The list of matching backup long-running operations. Each operation's name will be prefixed by the backup's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that are pending or have completed/failed/canceled within the last 7 days. Operations returned are ordered by `operation.metadata.value.progress.start_time` in descending order starting from the most recently started operation. | +| `name` | `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}`. | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_instances_backup_operations_list` | `SELECT` | `instancesId, projectsId` | +| `_projects_instances_backup_operations_list` | `EXEC` | `instancesId, projectsId` | diff --git a/docs/google-docs/providers/google/spanner/backups/index.md b/docs/google-docs/providers/google/spanner/backups/index.md index aa00867f91..d444250128 100644 --- a/docs/google-docs/providers/google/spanner/backups/index.md +++ b/docs/google-docs/providers/google/spanner/backups/index.md @@ -28,17 +28,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`. | -| `state` | `string` | Output only. The current state of the backup. | -| `sizeBytes` | `string` | Output only. Size of the backup in bytes. | -| `expireTime` | `string` | Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. | -| `referencingBackups` | `array` | Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed. | -| `databaseDialect` | `string` | Output only. The database dialect information for the backup. | | `maxExpireTime` | `string` | Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. | -| `database` | `string` | Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. | -| `createTime` | `string` | Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. | +| `sizeBytes` | `string` | Output only. Size of the backup in bytes. | | `referencingDatabases` | `array` | Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed. | -| `encryptionInfo` | `object` | Encryption information for a Cloud Spanner database or backup. | +| `createTime` | `string` | Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. | +| `database` | `string` | Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. | +| `referencingBackups` | `array` | Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed. | +| `state` | `string` | Output only. The current state of the backup. | | `versionTime` | `string` | The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set `version_time` to the `create_time` of the backup. | +| `encryptionInfo` | `object` | Encryption information for a Cloud Spanner database or backup. | +| `expireTime` | `string` | Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. | +| `databaseDialect` | `string` | Output only. The database dialect information for the backup. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -46,5 +46,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_instances_backups_list` | `SELECT` | `instancesId, projectsId` | Lists completed and pending backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`. | | `projects_instances_backups_create` | `INSERT` | `instancesId, projectsId` | Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format `projects//instances//backups//operations/` and can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently. | | `projects_instances_backups_delete` | `DELETE` | `backupsId, instancesId, projectsId` | Deletes a pending or completed Backup. | +| `_projects_instances_backups_list` | `EXEC` | `instancesId, projectsId` | Lists completed and pending backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`. | | `projects_instances_backups_copy` | `EXEC` | `instancesId, projectsId` | Starts copying a Cloud Spanner Backup. The returned backup long-running operation will have a name of the format `projects//instances//backups//operations/` and can be used to track copying of the backup. The operation is associated with the destination backup. The metadata field type is CopyBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the copying and delete the destination backup. Concurrent CopyBackup requests can run on the same source backup. | | `projects_instances_backups_patch` | `EXEC` | `backupsId, instancesId, projectsId` | Updates a pending or completed Backup. | diff --git a/docs/google-docs/providers/google/spanner/backups_iam_policies/index.md b/docs/google-docs/providers/google/spanner/backups_iam_policies/index.md index 87185d0d9c..3d2a8558b6 100644 --- a/docs/google-docs/providers/google/spanner/backups_iam_policies/index.md +++ b/docs/google-docs/providers/google/spanner/backups_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_instances_backups_get_iam_policy` | `EXEC` | `backupsId, instancesId, projectsId` | Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource. | +| `projects_instances_backups_get_iam_policy` | `SELECT` | `backupsId, instancesId, projectsId` | Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource. | | `projects_instances_backups_set_iam_policy` | `EXEC` | `backupsId, instancesId, projectsId` | Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource. | | `projects_instances_backups_test_iam_permissions` | `EXEC` | `backupsId, instancesId, projectsId` | Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. | diff --git a/docs/google-docs/providers/google/spanner/database_operations/index.md b/docs/google-docs/providers/google/spanner/database_operations/index.md index f8cc2fe770..1f37932764 100644 --- a/docs/google-docs/providers/google/spanner/database_operations/index.md +++ b/docs/google-docs/providers/google/spanner/database_operations/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | `next_page_token` can be sent in a subsequent ListDatabaseOperations call to fetch more of the matching metadata. | -| `operations` | `array` | The list of matching database long-running operations. Each operation's name will be prefixed by the database's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata. | +| `name` | `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}`. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_instances_database_operations_list` | `SELECT` | `instancesId, projectsId` | +| `_projects_instances_database_operations_list` | `EXEC` | `instancesId, projectsId` | diff --git a/docs/google-docs/providers/google/spanner/database_roles/index.md b/docs/google-docs/providers/google/spanner/database_roles/index.md index 52239cb0b1..ee7212fcc8 100644 --- a/docs/google-docs/providers/google/spanner/database_roles/index.md +++ b/docs/google-docs/providers/google/spanner/database_roles/index.md @@ -25,11 +25,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `databaseRoles` | `array` | Database roles that matched the request. | -| `nextPageToken` | `string` | `next_page_token` can be sent in a subsequent ListDatabaseRoles call to fetch more of the matching roles. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_instances_databases_database_roles_list` | `SELECT` | `databasesId, instancesId, projectsId` | +| `_projects_instances_databases_database_roles_list` | `EXEC` | `databasesId, instancesId, projectsId` | diff --git a/docs/google-docs/providers/google/spanner/databases/index.md b/docs/google-docs/providers/google/spanner/databases/index.md index 557f7c860a..dae0d3e00a 100644 --- a/docs/google-docs/providers/google/spanner/databases/index.md +++ b/docs/google-docs/providers/google/spanner/databases/index.md @@ -28,23 +28,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database. | -| `restoreInfo` | `object` | Information about the database restore. | -| `defaultLeader` | `string` | Output only. The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty. | -| `enableDropProtection` | `boolean` | Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to [prevent accidental database deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion). | -| `databaseDialect` | `string` | Output only. The dialect of the Cloud Spanner Database. | -| `earliestVersionTime` | `string` | Output only. Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. | | `state` | `string` | Output only. The current database state. | -| `encryptionConfig` | `object` | Encryption configuration for a Cloud Spanner database. | -| `reconciling` | `boolean` | Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database. | +| `earliestVersionTime` | `string` | Output only. Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. | | `versionRetentionPeriod` | `string` | Output only. The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set. | +| `databaseDialect` | `string` | Output only. The dialect of the Cloud Spanner Database. | | `createTime` | `string` | Output only. If exists, the time at which the database creation started. | +| `enableDropProtection` | `boolean` | Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to [prevent accidental database deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion). | | `encryptionInfo` | `array` | Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The `encryption_status' field inside of each `EncryptionInfo` is not populated. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field. | +| `defaultLeader` | `string` | Output only. The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty. | +| `encryptionConfig` | `object` | Encryption configuration for a Cloud Spanner database. | +| `restoreInfo` | `object` | Information about the database restore. | +| `reconciling` | `boolean` | Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_instances_databases_get` | `SELECT` | `databasesId, instancesId, projectsId` | Gets the state of a Cloud Spanner database. | | `projects_instances_databases_list` | `SELECT` | `instancesId, projectsId` | Lists Cloud Spanner databases. | | `projects_instances_databases_create` | `INSERT` | `instancesId, projectsId` | Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful. | +| `_projects_instances_databases_list` | `EXEC` | `instancesId, projectsId` | Lists Cloud Spanner databases. | | `projects_instances_databases_drop_database` | `EXEC` | `databasesId, instancesId, projectsId` | Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted. | | `projects_instances_databases_patch` | `EXEC` | `databasesId, instancesId, projectsId` | Updates a Cloud Spanner database. The returned long-running operation can be used to track the progress of updating the database. If the named database does not exist, returns `NOT_FOUND`. While the operation is pending: * The database's reconciling field is set to true. * Cancelling the operation is best-effort. If the cancellation succeeds, the operation metadata's cancel_time is set, the updates are reverted, and the operation terminates with a `CANCELLED` status. * New UpdateDatabase requests will return a `FAILED_PRECONDITION` error until the pending operation is done (returns successfully or with error). * Reading the database via the API continues to give the pre-request values. Upon completion of the returned operation: * The new values are in effect and readable via the API. * The database's reconciling field becomes false. The returned long-running operation will have a name of the format `projects//instances//databases//operations/` and can be used to track the database modification. The metadata field type is UpdateDatabaseMetadata. The response field type is Database, if successful. | | `projects_instances_databases_restore` | `EXEC` | `instancesId, projectsId` | Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database long-running operation has a name of the format `projects//instances//databases//operations/`, and can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreDatabaseMetadata. The response type is Database, if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete. | diff --git a/docs/google-docs/providers/google/spanner/databases_ddl/index.md b/docs/google-docs/providers/google/spanner/databases_ddl/index.md index ba598013ee..c036e46a6d 100644 --- a/docs/google-docs/providers/google/spanner/databases_ddl/index.md +++ b/docs/google-docs/providers/google/spanner/databases_ddl/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `protoDescriptors` | `string` | Proto descriptors stored in the database. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). | | `statements` | `array` | A list of formatted DDL statements defining the schema of the database specified in the request. | +| `protoDescriptors` | `string` | Proto descriptors stored in the database. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/spanner/databases_iam_policies/index.md b/docs/google-docs/providers/google/spanner/databases_iam_policies/index.md index 5a22720c11..69a5d229dd 100644 --- a/docs/google-docs/providers/google/spanner/databases_iam_policies/index.md +++ b/docs/google-docs/providers/google/spanner/databases_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_instances_databases_get_iam_policy` | `EXEC` | `databasesId, instancesId, projectsId` | Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource. | +| `projects_instances_databases_get_iam_policy` | `SELECT` | `databasesId, instancesId, projectsId` | Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource. | | `projects_instances_databases_set_iam_policy` | `EXEC` | `databasesId, instancesId, projectsId` | Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource. | | `projects_instances_databases_test_iam_permissions` | `EXEC` | `databasesId, instancesId, projectsId` | Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. | diff --git a/docs/google-docs/providers/google/spanner/index.md b/docs/google-docs/providers/google/spanner/index.md index b78058b55e..032b61799c 100644 --- a/docs/google-docs/providers/google/spanner/index.md +++ b/docs/google-docs/providers/google/spanner/index.md @@ -20,8 +20,8 @@ Cloud Spanner Is A Managed, Mission-Critical, Globally Consistent And Scalable R
total resources: 17
-total selectable resources: 12
-total methods: 75
+total selectable resources: 15
+total methods: 90
@@ -33,7 +33,7 @@ Cloud Spanner Is A Managed, Mission-Critical, Globally Consistent And Scalable R TypeService TitleCloud Spanner API DescriptionCloud Spanner Is A Managed, Mission-Critical, Globally Consistent And Scalable Relational Database Service. -Idspanner:v23.08.00155 +Idspanner:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/spanner/instance_config_operations/index.md b/docs/google-docs/providers/google/spanner/instance_config_operations/index.md index 910a86de88..8d9c7866d1 100644 --- a/docs/google-docs/providers/google/spanner/instance_config_operations/index.md +++ b/docs/google-docs/providers/google/spanner/instance_config_operations/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | `next_page_token` can be sent in a subsequent ListInstanceConfigOperations call to fetch more of the matching metadata. | -| `operations` | `array` | The list of matching instance config long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------| | `projects_instance_config_operations_list` | `SELECT` | `projectsId` | +| `_projects_instance_config_operations_list` | `EXEC` | `projectsId` | diff --git a/docs/google-docs/providers/google/spanner/instance_configs/index.md b/docs/google-docs/providers/google/spanner/instance_configs/index.md index 735331e8ea..9e97bd8c4f 100644 --- a/docs/google-docs/providers/google/spanner/instance_configs/index.md +++ b/docs/google-docs/providers/google/spanner/instance_configs/index.md @@ -27,13 +27,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `instanceConfigs` | `array` | The list of requested instance configurations. | -| `nextPageToken` | `string` | `next_page_token` can be sent in a subsequent ListInstanceConfigs call to fetch more of the matching instance configurations. | +| `name` | `string` | A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. | +| `state` | `string` | Output only. The current instance config state. Applicable only for USER_MANAGED configs. | +| `baseConfig` | `string` | Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. `base_config` must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration. | +| `freeInstanceAvailability` | `string` | Output only. Describes whether free instances are available to be created in this instance config. | +| `displayName` | `string` | The name of this instance configuration as it appears in UIs. | +| `leaderOptions` | `array` | Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. | +| `replicas` | `array` | The geographic placement of nodes in this instance configuration and their replication properties. | +| `configType` | `string` | Output only. Whether this instance config is a Google or User Managed Configuration. | +| `reconciling` | `boolean` | Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. | +| `labels` | `object` | Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly. | +| `optionalReplicas` | `array` | Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_instance_configs_list` | `SELECT` | `projectsId` | Lists the supported instance configurations for a given project. | | `projects_instance_configs_create` | `INSERT` | `projectsId` | Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent. | | `projects_instance_configs_delete` | `DELETE` | `instanceConfigsId, projectsId` | Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name. | +| `_projects_instance_configs_list` | `EXEC` | `projectsId` | Lists the supported instance configurations for a given project. | | `projects_instance_configs_get` | `EXEC` | `instanceConfigsId, projectsId` | Gets information about a particular instance configuration. | | `projects_instance_configs_patch` | `EXEC` | `instanceConfigsId, projectsId` | Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name. | diff --git a/docs/google-docs/providers/google/spanner/instances/index.md b/docs/google-docs/providers/google/spanner/instances/index.md index bcf98389cb..3c53d806e8 100644 --- a/docs/google-docs/providers/google/spanner/instances/index.md +++ b/docs/google-docs/providers/google/spanner/instances/index.md @@ -27,14 +27,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `instances` | `array` | The list of requested instances. | -| `nextPageToken` | `string` | `next_page_token` can be sent in a subsequent ListInstances call to fetch more of the matching instances. | -| `unreachable` | `array` | The list of unreachable instances. It includes the names of instances whose metadata could not be retrieved within instance_deadline. | +| `name` | `string` | Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. | +| `createTime` | `string` | Output only. The time at which the instance was created. | +| `endpointUris` | `array` | Deprecated. This field is not populated. | +| `freeInstanceMetadata` | `object` | Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes. | +| `config` | `string` | Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs. | +| `displayName` | `string` | Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. | +| `instanceType` | `string` | The `InstanceType` of the current instance. | +| `updateTime` | `string` | Output only. The time at which the instance was most recently updated. | +| `state` | `string` | Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`. | +| `labels` | `object` | Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release. | +| `nodeCount` | `integer` | The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. | +| `processingUnits` | `integer` | The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_instances_list` | `SELECT` | `projectsId` | Lists all instances in the given project. | | `projects_instances_create` | `INSERT` | `projectsId` | Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, `CreateInstance` returns `ALREADY_EXISTS`. Immediately upon completion of this request: * The instance is readable via the API, with all requested attributes but no allocated resources. Its state is `CREATING`. Until completion of the returned operation: * Cancelling the operation renders the instance immediately unreadable via the API. * The instance can be deleted. * All other attempts to modify the instance are rejected. Upon completion of the returned operation: * Billing for all successfully-allocated resources begins (some types may have lower than the requested levels). * Databases can be created in the instance. * The instance's allocated resource levels are readable via the API. * The instance's state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful. | | `projects_instances_delete` | `DELETE` | `instancesId, projectsId` | Deletes an instance. Immediately upon completion of the request: * Billing ceases for all of the instance's reserved resources. Soon afterward: * The instance and *all of its databases* immediately and irrevocably disappear from the API. All data in the databases is permanently deleted. | +| `_projects_instances_list` | `EXEC` | `projectsId` | Lists all instances in the given project. | | `projects_instances_get` | `EXEC` | `instancesId, projectsId` | Gets information about a particular instance. | | `projects_instances_patch` | `EXEC` | `instancesId, projectsId` | Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: * For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: * Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance are rejected. * Reading the instance via the API continues to give the pre-request resource levels. Upon completion of the returned operation: * Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources are available for serving the instance's tables. * The instance's new resource levels are readable via the API. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requires `spanner.instances.update` permission on the resource name. | diff --git a/docs/google-docs/providers/google/spanner/instances_iam_policies/index.md b/docs/google-docs/providers/google/spanner/instances_iam_policies/index.md index 3dd624e4b0..04655a39db 100644 --- a/docs/google-docs/providers/google/spanner/instances_iam_policies/index.md +++ b/docs/google-docs/providers/google/spanner/instances_iam_policies/index.md @@ -25,10 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_instances_get_iam_policy` | `EXEC` | `instancesId, projectsId` | Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set. Authorization requires `spanner.instances.getIamPolicy` on resource. | +| `projects_instances_get_iam_policy` | `SELECT` | `instancesId, projectsId` | Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set. Authorization requires `spanner.instances.getIamPolicy` on resource. | | `projects_instances_set_iam_policy` | `EXEC` | `instancesId, projectsId` | Sets the access control policy on an instance resource. Replaces any existing policy. Authorization requires `spanner.instances.setIamPolicy` on resource. | | `projects_instances_test_iam_permissions` | `EXEC` | `instancesId, projectsId` | Returns permissions that the caller has on the specified instance resource. Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions. | diff --git a/docs/google-docs/providers/google/spanner/operations/index.md b/docs/google-docs/providers/google/spanner/operations/index.md index c0d35013ae..f0d46a4c47 100644 --- a/docs/google-docs/providers/google/spanner/operations/index.md +++ b/docs/google-docs/providers/google/spanner/operations/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -42,6 +45,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_instances_databases_operations_delete` | `DELETE` | `databasesId, instancesId, operationsId, projectsId` | 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`. | | `projects_instances_instance_partitions_operations_delete` | `DELETE` | `instancePartitionsId, instancesId, operationsId, projectsId` | 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`. | | `projects_instances_operations_delete` | `DELETE` | `instancesId, operationsId, projectsId` | 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`. | +| `_projects_instance_configs_operations_list` | `EXEC` | `instanceConfigsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_instances_backups_operations_list` | `EXEC` | `backupsId, instancesId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_instances_databases_operations_list` | `EXEC` | `databasesId, instancesId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_instances_instance_partitions_operations_list` | `EXEC` | `instancePartitionsId, instancesId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_instances_operations_list` | `EXEC` | `instancesId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_instance_configs_operations_cancel` | `EXEC` | `instanceConfigsId, operationsId, projectsId` | 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`. | | `projects_instance_configs_operations_get` | `EXEC` | `instanceConfigsId, operationsId, projectsId` | 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. | | `projects_instances_backups_operations_cancel` | `EXEC` | `backupsId, instancesId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/spanner/scans/index.md b/docs/google-docs/providers/google/spanner/scans/index.md index 4293b29d0e..c8fcd41237 100644 --- a/docs/google-docs/providers/google/spanner/scans/index.md +++ b/docs/google-docs/providers/google/spanner/scans/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `scans` | `array` | Available scans based on the list query parameters. | +| `name` | `string` | The unique name of the scan, specific to the Database service implementing this interface. | +| `scanData` | `object` | ScanData contains Cloud Key Visualizer scan data used by the caller to construct a visualization. | +| `startTime` | `string` | A range of time (inclusive) for when the scan is defined. The lower bound for when the scan is defined. | +| `details` | `object` | Additional information provided by the implementer. | +| `endTime` | `string` | The upper bound for when the scan is defined. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `scans_list` | `SELECT` | | +| `_scans_list` | `EXEC` | | diff --git a/docs/google-docs/providers/google/spanner/sessions/index.md b/docs/google-docs/providers/google/spanner/sessions/index.md index 193c0404eb..6ca8e57d64 100644 --- a/docs/google-docs/providers/google/spanner/sessions/index.md +++ b/docs/google-docs/providers/google/spanner/sessions/index.md @@ -27,14 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | `next_page_token` can be sent in a subsequent ListSessions call to fetch more of the matching sessions. | -| `sessions` | `array` | The list of requested sessions. | +| `name` | `string` | Output only. The name of the session. This is always system-assigned. | +| `approximateLastUseTime` | `string` | Output only. The approximate timestamp when the session is last used. It is typically earlier than the actual last use time. | +| `createTime` | `string` | Output only. The timestamp when the session is created. | +| `creatorRole` | `string` | The database role which created this session. | +| `labels` | `object` | The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_instances_databases_sessions_list` | `SELECT` | `databasesId, instancesId, projectsId` | Lists all sessions in a given database. | | `projects_instances_databases_sessions_create` | `INSERT` | `databasesId, instancesId, projectsId` | Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`. | | `projects_instances_databases_sessions_delete` | `DELETE` | `databasesId, instancesId, projectsId, sessionsId` | Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session. | +| `_projects_instances_databases_sessions_list` | `EXEC` | `databasesId, instancesId, projectsId` | Lists all sessions in a given database. | | `projects_instances_databases_sessions_batch_create` | `EXEC` | `databasesId, instancesId, projectsId` | Creates multiple new sessions. This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management. | | `projects_instances_databases_sessions_begin_transaction` | `EXEC` | `databasesId, instancesId, projectsId, sessionsId` | Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect. | | `projects_instances_databases_sessions_commit` | `EXEC` | `databasesId, instancesId, projectsId, sessionsId` | Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the beginning, re-using the same session. On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now. | diff --git a/docs/google-docs/providers/google/speech/custom_classes/index.md b/docs/google-docs/providers/google/speech/custom_classes/index.md index 1259ca200f..a814737de5 100644 --- a/docs/google-docs/providers/google/speech/custom_classes/index.md +++ b/docs/google-docs/providers/google/speech/custom_classes/index.md @@ -25,6 +25,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | The resource name of the custom class. | +| `items` | `array` | A collection of class items. | +| `kmsKeyName` | `string` | Output only. The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. | +| `kmsKeyVersionName` | `string` | Output only. The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`. | +| `customClassId` | `string` | If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -32,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | List custom classes. | | `create` | `INSERT` | `locationsId, projectsId` | Create a custom class. | | `delete` | `DELETE` | `customClassesId, locationsId, projectsId` | Delete a custom class. | +| `_list` | `EXEC` | `locationsId, projectsId` | List custom classes. | | `patch` | `EXEC` | `customClassesId, locationsId, projectsId` | Update a custom class. | diff --git a/docs/google-docs/providers/google/speech/index.md b/docs/google-docs/providers/google/speech/index.md index 65bb065731..d521e993ad 100644 --- a/docs/google-docs/providers/google/speech/index.md +++ b/docs/google-docs/providers/google/speech/index.md @@ -21,7 +21,7 @@ Converts Audio To Text By Applying Powerful Neural Network Models.
total resources: 4
total selectable resources: 3
-total methods: 14
+total methods: 17
@@ -33,7 +33,7 @@ Converts Audio To Text By Applying Powerful Neural Network Models. TypeService TitleCloud Speech-To-Text API DescriptionConverts Audio To Text By Applying Powerful Neural Network Models. -Idspeech:v23.08.00155 +Idspeech:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/speech/operations/index.md b/docs/google-docs/providers/google/speech/operations/index.md index 74afc0e2e9..0abf40ea7d 100644 --- a/docs/google-docs/providers/google/speech/operations/index.md +++ b/docs/google-docs/providers/google/speech/operations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operationsId` | 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. | | `list` | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_list` | `EXEC` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | diff --git a/docs/google-docs/providers/google/speech/phrase_sets/index.md b/docs/google-docs/providers/google/speech/phrase_sets/index.md index 8292e4a97c..bf95dd98f0 100644 --- a/docs/google-docs/providers/google/speech/phrase_sets/index.md +++ b/docs/google-docs/providers/google/speech/phrase_sets/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the phrase set. | -| `boost` | `number` | Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests. | -| `kmsKeyName` | `string` | Output only. The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. | | `kmsKeyVersionName` | `string` | Output only. The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`. | | `phrases` | `array` | A list of word and phrases. | +| `boost` | `number` | Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests. | +| `kmsKeyName` | `string` | Output only. The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -39,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | List phrase sets. | | `create` | `INSERT` | `locationsId, projectsId` | Create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet. | | `delete` | `DELETE` | `locationsId, phraseSetsId, projectsId` | Delete a phrase set. | +| `_list` | `EXEC` | `locationsId, projectsId` | List phrase sets. | | `patch` | `EXEC` | `locationsId, phraseSetsId, projectsId` | Update a phrase set. | diff --git a/docs/google-docs/providers/google/sqladmin/backup_runs/index.md b/docs/google-docs/providers/google/sqladmin/backup_runs/index.md index d96c89c4e8..f907619a24 100644 --- a/docs/google-docs/providers/google/sqladmin/backup_runs/index.md +++ b/docs/google-docs/providers/google/sqladmin/backup_runs/index.md @@ -29,21 +29,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | The identifier for this backup run. Unique only for a specific Cloud SQL instance. | | `description` | `string` | The description of this run, only applicable to on-demand backups. | +| `backupKind` | `string` | Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. | | `type` | `string` | The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests. | -| `kind` | `string` | This is always `sql#backupRun`. | -| `diskEncryptionStatus` | `object` | Disk encryption status for an instance. | -| `instance` | `string` | Name of the database instance. | -| `selfLink` | `string` | The URI of this resource. | -| `diskEncryptionConfiguration` | `object` | Disk encryption configuration for an instance. | -| `status` | `string` | The status of this run. | -| `windowStartTime` | `string` | The start time of the backup window during which this the backup was attempted in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | | `startTime` | `string` | The time the backup operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | -| `enqueuedTime` | `string` | The time the run was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | +| `windowStartTime` | `string` | The start time of the backup window during which this the backup was attempted in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | | `timeZone` | `string` | Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server. | -| `backupKind` | `string` | Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. | -| `location` | `string` | Location of the backups. | | `error` | `object` | Database instance operation error. | +| `enqueuedTime` | `string` | The time the run was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | +| `kind` | `string` | This is always `sql#backupRun`. | +| `location` | `string` | Location of the backups. | +| `diskEncryptionConfiguration` | `object` | Disk encryption configuration for an instance. | +| `diskEncryptionStatus` | `object` | Disk encryption status for an instance. | | `endTime` | `string` | The time the backup operation completed in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | +| `instance` | `string` | Name of the database instance. | +| `status` | `string` | The status of this run. | +| `selfLink` | `string` | The URI of this resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -51,3 +51,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `instance, project` | Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time. | | `insert` | `INSERT` | `instance, project` | Creates a new backup run on demand. | | `delete` | `DELETE` | `id, instance, project` | Deletes the backup taken by a backup run. | +| `_list` | `EXEC` | `instance, project` | Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time. | diff --git a/docs/google-docs/providers/google/sqladmin/connect/index.md b/docs/google-docs/providers/google/sqladmin/connect/index.md index 88c59cca47..f527891280 100644 --- a/docs/google-docs/providers/google/sqladmin/connect/index.md +++ b/docs/google-docs/providers/google/sqladmin/connect/index.md @@ -27,14 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `databaseVersion` | `string` | The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. MySQL instances: `MYSQL_8_0`, `MYSQL_5_7` (default), or `MYSQL_5_6`. PostgreSQL instances: `POSTGRES_9_6`, `POSTGRES_10`, `POSTGRES_11`, `POSTGRES_12` (default), `POSTGRES_13`, or `POSTGRES_14`. SQL Server instances: `SQLSERVER_2017_STANDARD` (default), `SQLSERVER_2017_ENTERPRISE`, `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`, `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or `SQLSERVER_2019_WEB`. | -| `dnsName` | `string` | The dns name of the instance. | -| `ipAddresses` | `array` | The assigned IP addresses for the instance. | | `kind` | `string` | This is always `sql#connectSettings`. | | `pscEnabled` | `boolean` | Whether PSC connectivity is enabled for this instance. | | `region` | `string` | The cloud region for the instance. For example, `us-central1`, `europe-west1`. The region cannot be changed after instance creation. | | `serverCaCert` | `object` | SslCerts Resource | | `backendType` | `string` | `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. | +| `databaseVersion` | `string` | The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. MySQL instances: `MYSQL_8_0`, `MYSQL_5_7` (default), or `MYSQL_5_6`. PostgreSQL instances: `POSTGRES_9_6`, `POSTGRES_10`, `POSTGRES_11`, `POSTGRES_12` (default), `POSTGRES_13`, or `POSTGRES_14`. SQL Server instances: `SQLSERVER_2017_STANDARD` (default), `SQLSERVER_2017_ENTERPRISE`, `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`, `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or `SQLSERVER_2019_WEB`. | +| `dnsName` | `string` | The dns name of the instance. | +| `ipAddresses` | `array` | The assigned IP addresses for the instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sqladmin/databases/index.md b/docs/google-docs/providers/google/sqladmin/databases/index.md index 3c6a82ae62..c234fec604 100644 --- a/docs/google-docs/providers/google/sqladmin/databases/index.md +++ b/docs/google-docs/providers/google/sqladmin/databases/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. | -| `sqlserverDatabaseDetails` | `object` | Represents a Sql Server database on the Cloud SQL instance. | -| `instance` | `string` | The name of the Cloud SQL instance. This does not include the project ID. | -| `charset` | `string` | The Cloud SQL charset value. | +| `collation` | `string` | The Cloud SQL collation value. | +| `kind` | `string` | This is always `sql#database`. | | `project` | `string` | The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. | -| `selfLink` | `string` | The URI of this resource. | +| `instance` | `string` | The name of the Cloud SQL instance. This does not include the project ID. | +| `sqlserverDatabaseDetails` | `object` | Represents a Sql Server database on the Cloud SQL instance. | | `etag` | `string` | This field is deprecated and will be removed from a future version of the API. | -| `kind` | `string` | This is always `sql#database`. | -| `collation` | `string` | The Cloud SQL collation value. | +| `selfLink` | `string` | The URI of this resource. | +| `charset` | `string` | The Cloud SQL charset value. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sqladmin/flags/index.md b/docs/google-docs/providers/google/sqladmin/flags/index.md index d8fa07dc19..bd2a540554 100644 --- a/docs/google-docs/providers/google/sqladmin/flags/index.md +++ b/docs/google-docs/providers/google/sqladmin/flags/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | This is the name of the flag. Flag names always use underscores, not hyphens, for example: `max_allowed_packet` | -| `maxValue` | `string` | For `INTEGER` flags, the maximum allowed value. | | `appliesTo` | `array` | The database version this flag applies to. Can be MySQL instances: `MYSQL_8_0`, `MYSQL_8_0_18`, `MYSQL_8_0_26`, `MYSQL_5_7`, or `MYSQL_5_6`. PostgreSQL instances: `POSTGRES_9_6`, `POSTGRES_10`, `POSTGRES_11` or `POSTGRES_12`. SQL Server instances: `SQLSERVER_2017_STANDARD`, `SQLSERVER_2017_ENTERPRISE`, `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`, `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or `SQLSERVER_2019_WEB`. See [the complete list](/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). | +| `kind` | `string` | This is always `sql#flag`. | +| `inBeta` | `boolean` | Whether or not the flag is considered in beta. | +| `maxValue` | `string` | For `INTEGER` flags, the maximum allowed value. | | `type` | `string` | The type of the flag. Flags are typed to being `BOOLEAN`, `STRING`, `INTEGER` or `NONE`. `NONE` is used for flags that do not take a value, such as `skip_grant_tables`. | | `allowedIntValues` | `array` | Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values. | -| `kind` | `string` | This is always `sql#flag`. | -| `minValue` | `string` | For `INTEGER` flags, the minimum allowed value. | | `requiresRestart` | `boolean` | Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances. | | `allowedStringValues` | `array` | For `STRING` flags, a list of strings that the value can be set to. | -| `inBeta` | `boolean` | Whether or not the flag is considered in beta. | +| `minValue` | `string` | For `INTEGER` flags, the minimum allowed value. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/sqladmin/index.md b/docs/google-docs/providers/google/sqladmin/index.md index 85d048df0c..fb41f26b4e 100644 --- a/docs/google-docs/providers/google/sqladmin/index.md +++ b/docs/google-docs/providers/google/sqladmin/index.md @@ -21,7 +21,7 @@ API For Cloud SQL Database Instance Management
total resources: 14
total selectable resources: 12
-total methods: 56
+total methods: 60
@@ -33,7 +33,7 @@ API For Cloud SQL Database Instance Management TypeService TitleCloud SQL Admin API DescriptionAPI For Cloud SQL Database Instance Management -Idsqladmin:v23.08.00155 +Idsqladmin:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/sqladmin/instances/index.md b/docs/google-docs/providers/google/sqladmin/instances/index.md index ab4d07b82a..22ae3c1a7d 100644 --- a/docs/google-docs/providers/google/sqladmin/instances/index.md +++ b/docs/google-docs/providers/google/sqladmin/instances/index.md @@ -28,43 +28,43 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Name of the Cloud SQL instance. This does not include the project ID. | -| `dnsName` | `string` | Output only. The dns name of the instance. | -| `state` | `string` | The current serving state of the Cloud SQL instance. | -| `availableMaintenanceVersions` | `array` | Output only. List all maintenance versions applicable on the instance | -| `serverCaCert` | `object` | SslCerts Resource | -| `rootPassword` | `string` | Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. | +| `instanceType` | `string` | The instance type. | +| `secondaryGceZone` | `string` | The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. | | `failoverReplica` | `object` | The name and status of the failover replica. | -| `maxDiskSize` | `string` | The maximum disk size of the instance in bytes. | -| `currentDiskSize` | `string` | The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. | -| `satisfiesPzs` | `boolean` | The status indicating if instance satisfiesPzs. Reserved for future use. | -| `region` | `string` | The geographical region. Can be: * `us-central` (`FIRST_GEN` instances only) * `us-central1` (`SECOND_GEN` instances only) * `asia-east1` or `europe-west1`. Defaults to `us-central` or `us-central1` depending on the instance type. The region cannot be changed after instance creation. | -| `ipv6Address` | `string` | The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. | -| `replicaNames` | `array` | The replicas of the instance. | -| `ipAddresses` | `array` | The assigned IP addresses for the instance. | -| `etag` | `string` | This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. | +| `rootPassword` | `string` | Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. | | `replicaConfiguration` | `object` | Read-replica configuration for connecting to the primary instance. | -| `selfLink` | `string` | The URI of this resource. | -| `databaseInstalledVersion` | `string` | Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. | -| `outOfDiskReport` | `object` | This message wraps up the information written by out-of-disk detection job. | +| `databaseVersion` | `string` | The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. | +| `region` | `string` | The geographical region. Can be: * `us-central` (`FIRST_GEN` instances only) * `us-central1` (`SECOND_GEN` instances only) * `asia-east1` or `europe-west1`. Defaults to `us-central` or `us-central1` depending on the instance type. The region cannot be changed after instance creation. | +| `diskEncryptionConfiguration` | `object` | Disk encryption configuration for an instance. | +| `pscServiceAttachmentLink` | `string` | Output only. The link to service attachment of PSC instance. | | `onPremisesConfiguration` | `object` | On-premises instance configuration. | -| `secondaryGceZone` | `string` | The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. | +| `ipv6Address` | `string` | The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. | +| `satisfiesPzs` | `boolean` | The status indicating if instance satisfiesPzs. Reserved for future use. | +| `scheduledMaintenance` | `object` | Any scheduled maintenance for this instance. | +| `availableMaintenanceVersions` | `array` | Output only. List all maintenance versions applicable on the instance | +| `backendType` | `string` | The backend type. `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. | | `kind` | `string` | This is always `sql#instance`. | -| `pscServiceAttachmentLink` | `string` | Output only. The link to service attachment of PSC instance. | +| `serverCaCert` | `object` | SslCerts Resource | | `maintenanceVersion` | `string` | The current software version on the instance. | -| `backendType` | `string` | The backend type. `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. | +| `currentDiskSize` | `string` | The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. | | `diskEncryptionStatus` | `object` | Disk encryption status for an instance. | -| `gceZone` | `string` | The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. | -| `instanceType` | `string` | The instance type. | -| `databaseVersion` | `string` | The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. | -| `settings` | `object` | Database instance settings. | -| `connectionName` | `string` | Connection name of the Cloud SQL instance used in connection strings. | +| `selfLink` | `string` | The URI of this resource. | | `createTime` | `string` | Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | -| `scheduledMaintenance` | `object` | Any scheduled maintenance for this instance. | +| `etag` | `string` | This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. | +| `maxDiskSize` | `string` | The maximum disk size of the instance in bytes. | +| `dnsName` | `string` | Output only. The dns name of the instance. | +| `serviceAccountEmailAddress` | `string` | The service account email address assigned to the instance.\This property is read-only. | +| `state` | `string` | The current serving state of the Cloud SQL instance. | +| `masterInstanceName` | `string` | The name of the instance which will act as primary in the replication setup. | +| `connectionName` | `string` | Connection name of the Cloud SQL instance used in connection strings. | +| `gceZone` | `string` | The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. | +| `replicaNames` | `array` | The replicas of the instance. | | `project` | `string` | The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. | | `suspensionReason` | `array` | If the instance state is SUSPENDED, the reason for the suspension. | -| `diskEncryptionConfiguration` | `object` | Disk encryption configuration for an instance. | -| `masterInstanceName` | `string` | The name of the instance which will act as primary in the replication setup. | -| `serviceAccountEmailAddress` | `string` | The service account email address assigned to the instance.\This property is read-only. | +| `databaseInstalledVersion` | `string` | Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. | +| `ipAddresses` | `array` | The assigned IP addresses for the instance. | +| `outOfDiskReport` | `object` | This message wraps up the information written by out-of-disk detection job. | +| `settings` | `object` | Database instance settings. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -72,6 +72,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Lists instances under a given project. | | `insert` | `INSERT` | `project` | Creates a new Cloud SQL instance. | | `delete` | `DELETE` | `instance, project` | Deletes a Cloud SQL instance. | +| `_list` | `EXEC` | `project` | Lists instances under a given project. | | `clone` | `EXEC` | `instance, project` | Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart. | | `demote_master` | `EXEC` | `instance, project` | Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server. | | `export` | `EXEC` | `instance, project` | Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file. | diff --git a/docs/google-docs/providers/google/sqladmin/instances_disk_shrink_config/index.md b/docs/google-docs/providers/google/sqladmin/instances_disk_shrink_config/index.md index 676d44755e..5ee0855b89 100644 --- a/docs/google-docs/providers/google/sqladmin/instances_disk_shrink_config/index.md +++ b/docs/google-docs/providers/google/sqladmin/instances_disk_shrink_config/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `kind` | `string` | This is always `sql#getDiskShrinkConfig`. | | `message` | `string` | Additional message to customers. | | `minimalTargetSizeGb` | `string` | The minimum size to which a disk can be shrunk in GigaBytes. | +| `kind` | `string` | This is always `sql#getDiskShrinkConfig`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/sqladmin/instances_server_cas/index.md b/docs/google-docs/providers/google/sqladmin/instances_server_cas/index.md index 0f93f45ab8..da2f979679 100644 --- a/docs/google-docs/providers/google/sqladmin/instances_server_cas/index.md +++ b/docs/google-docs/providers/google/sqladmin/instances_server_cas/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `activeVersion` | `string` | | | `certs` | `array` | List of server CA certificates for the instance. | | `kind` | `string` | This is always `sql#instancesListServerCas`. | -| `activeVersion` | `string` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/sqladmin/operations/index.md b/docs/google-docs/providers/google/sqladmin/operations/index.md index a17d06feda..bf560d2eef 100644 --- a/docs/google-docs/providers/google/sqladmin/operations/index.md +++ b/docs/google-docs/providers/google/sqladmin/operations/index.md @@ -28,24 +28,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. | -| `targetProject` | `string` | The project ID of the target instance related to this operation. | -| `targetId` | `string` | Name of the database instance related to this operation. | -| `user` | `string` | The email address of the user who initiated this operation. | -| `importContext` | `object` | Database instance import context. | -| `status` | `string` | The status of an operation. | -| `exportContext` | `object` | Database instance export context. | -| `operationType` | `string` | The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` | | `kind` | `string` | This is always `sql#operation`. | -| `endTime` | `string` | The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | -| `error` | `object` | Database instance operation errors list wrapper. | -| `backupContext` | `object` | Backup context. | | `startTime` | `string` | The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | -| `insertTime` | `string` | The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | +| `backupContext` | `object` | Backup context. | +| `operationType` | `string` | The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` | | `targetLink` | `string` | | +| `targetId` | `string` | Name of the database instance related to this operation. | +| `status` | `string` | The status of an operation. | +| `targetProject` | `string` | The project ID of the target instance related to this operation. | +| `insertTime` | `string` | The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | | `selfLink` | `string` | The URI of this resource. | +| `endTime` | `string` | The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | +| `importContext` | `object` | Database instance import context. | +| `exportContext` | `object` | Database instance export context. | +| `error` | `object` | Database instance operation errors list wrapper. | +| `user` | `string` | The email address of the user who initiated this operation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operation, project` | Retrieves an instance operation that has been performed on an instance. | | `list` | `SELECT` | `project` | Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time. | +| `_list` | `EXEC` | `project` | Lists all instance operations that have been performed on the given Cloud SQL instance in the reverse chronological order of the start time. | | `cancel` | `EXEC` | `operation, project` | Cancels an instance operation that has been performed on an instance. | diff --git a/docs/google-docs/providers/google/sqladmin/ssl_certs/index.md b/docs/google-docs/providers/google/sqladmin/ssl_certs/index.md index d456712840..e793b1d882 100644 --- a/docs/google-docs/providers/google/sqladmin/ssl_certs/index.md +++ b/docs/google-docs/providers/google/sqladmin/ssl_certs/index.md @@ -27,15 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `expirationTime` | `string` | The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | | `selfLink` | `string` | The URI of this resource. | -| `sha1Fingerprint` | `string` | Sha1 Fingerprint. | -| `createTime` | `string` | The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z` | -| `instance` | `string` | Name of the database instance. | -| `kind` | `string` | This is always `sql#sslCert`. | | `cert` | `string` | PEM representation. | | `certSerialNumber` | `string` | Serial number, as extracted from the certificate. | +| `sha1Fingerprint` | `string` | Sha1 Fingerprint. | | `commonName` | `string` | User supplied name. Constrained to [a-zA-Z.-_ ]+. | +| `kind` | `string` | This is always `sql#sslCert`. | +| `instance` | `string` | Name of the database instance. | +| `expirationTime` | `string` | The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | +| `createTime` | `string` | The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sqladmin/users/index.md b/docs/google-docs/providers/google/sqladmin/users/index.md index 3796229e84..3ecf5d9062 100644 --- a/docs/google-docs/providers/google/sqladmin/users/index.md +++ b/docs/google-docs/providers/google/sqladmin/users/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name of the user in the Cloud SQL instance. Can be omitted for `update` because it is already specified in the URL. | -| `sqlserverUserDetails` | `object` | Represents a Sql Server user on the Cloud SQL instance. | -| `dualPasswordType` | `string` | Dual password status for the user. | | `kind` | `string` | This is always `sql#user`. | -| `passwordPolicy` | `object` | User level password validation policy. | | `project` | `string` | The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for `update` because it is already specified on the URL. | -| `type` | `string` | The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type. | +| `dualPasswordType` | `string` | Dual password status for the user. | +| `sqlserverUserDetails` | `object` | Represents a Sql Server user on the Cloud SQL instance. | | `etag` | `string` | This field is deprecated and will be removed from a future version of the API. | -| `password` | `string` | The password for the user. | | `host` | `string` | Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional. | +| `passwordPolicy` | `object` | User level password validation policy. | | `instance` | `string` | The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL. | +| `password` | `string` | The password for the user. | +| `type` | `string` | The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -45,4 +45,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `instance, project` | Lists users in the specified Cloud SQL instance. | | `insert` | `INSERT` | `instance, project` | Creates a new user in a Cloud SQL instance. | | `delete` | `DELETE` | `instance, project` | Deletes a user from a Cloud SQL instance. | +| `_list` | `EXEC` | `instance, project` | Lists users in the specified Cloud SQL instance. | | `update` | `EXEC` | `instance, project` | Updates an existing user in a Cloud SQL instance. | diff --git a/docs/google-docs/providers/google/storage/bucket_access_controls/index.md b/docs/google-docs/providers/google/storage/bucket_access_controls/index.md index 4675073e8e..318e812fab 100644 --- a/docs/google-docs/providers/google/storage/bucket_access_controls/index.md +++ b/docs/google-docs/providers/google/storage/bucket_access_controls/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | The ID of the access-control entry. | -| `projectTeam` | `object` | The project team associated with the entity, if any. | -| `bucket` | `string` | The name of the bucket. | -| `role` | `string` | The access permission for the entity. | -| `email` | `string` | The email address associated with the entity, if any. | | `selfLink` | `string` | The link to this access-control entry. | -| `entity` | `string` | The entity holding the permission, in one of the following forms:
- user-userId
- user-email
- group-groupId
- group-email
- domain-domain
- project-team-projectId
- allUsers
- allAuthenticatedUsers Examples:
- The user liz@example.com would be user-liz@example.com.
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. | +| `role` | `string` | The access permission for the entity. | | `etag` | `string` | HTTP 1.1 Entity tag for the access-control entry. | +| `entity` | `string` | The entity holding the permission, in one of the following forms:
- user-userId
- user-email
- group-groupId
- group-email
- domain-domain
- project-team-projectId
- allUsers
- allAuthenticatedUsers Examples:
- The user liz@example.com would be user-liz@example.com.
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. | +| `email` | `string` | The email address associated with the entity, if any. | +| `kind` | `string` | The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. | +| `bucket` | `string` | The name of the bucket. | | `entityId` | `string` | The ID for the entity, if any. | +| `projectTeam` | `object` | The project team associated with the entity, if any. | | `domain` | `string` | The domain associated with the entity, if any. | -| `kind` | `string` | The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storage/buckets/index.md b/docs/google-docs/providers/google/storage/buckets/index.md index 57547a138e..795d455f40 100644 --- a/docs/google-docs/providers/google/storage/buckets/index.md +++ b/docs/google-docs/providers/google/storage/buckets/index.md @@ -29,34 +29,34 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | The ID of the bucket. For buckets, the id and name properties are the same. | | `name` | `string` | The name of the bucket. | -| `acl` | `array` | Access controls on the bucket. | -| `defaultObjectAcl` | `array` | Default access controls to apply to new objects when no ACL is provided. | -| `storageClass` | `string` | The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes. | -| `etag` | `string` | HTTP 1.1 Entity tag for the bucket. | -| `cors` | `array` | The bucket's Cross-Origin Resource Sharing (CORS) configuration. | -| `labels` | `object` | User-provided labels, in key/value pairs. | -| `timeCreated` | `string` | The creation time of the bucket in RFC 3339 format. | +| `autoclass` | `object` | The bucket's Autoclass configuration. | +| `owner` | `object` | The owner of the bucket. This is always the project team's owner group. | +| `satisfiesPZS` | `boolean` | Reserved for future use. | | `defaultEventBasedHold` | `boolean` | The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed. | -| `billing` | `object` | The bucket's billing configuration. | +| `customPlacementConfig` | `object` | The bucket's custom placement configuration for Custom Dual Regions. | | `versioning` | `object` | The bucket's versioning configuration. | -| `projectNumber` | `string` | The project number of the project the bucket belongs to. | +| `metageneration` | `string` | The metadata generation of this bucket. | | `retentionPolicy` | `object` | The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error. | -| `locationType` | `string` | The type of the bucket location. | -| `logging` | `object` | The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. | -| `website` | `object` | The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information. | -| `autoclass` | `object` | The bucket's Autoclass configuration. | -| `rpo` | `string` | The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket. | -| `iamConfiguration` | `object` | The bucket's IAM configuration. | -| `owner` | `object` | The owner of the bucket. This is always the project team's owner group. | +| `timeCreated` | `string` | The creation time of the bucket in RFC 3339 format. | | `updated` | `string` | The modification time of the bucket in RFC 3339 format. | -| `selfLink` | `string` | The URI of this bucket. | -| `metageneration` | `string` | The metadata generation of this bucket. | +| `iamConfiguration` | `object` | The bucket's IAM configuration. | +| `rpo` | `string` | The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket. | +| `website` | `object` | The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information. | | `kind` | `string` | The kind of item this is. For buckets, this is always storage#bucket. | +| `logging` | `object` | The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. | +| `labels` | `object` | User-provided labels, in key/value pairs. | +| `billing` | `object` | The bucket's billing configuration. | +| `acl` | `array` | Access controls on the bucket. | +| `storageClass` | `string` | The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes. | +| `location` | `string` | The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list. | | `lifecycle` | `object` | The bucket's lifecycle configuration. See lifecycle management for more information. | +| `selfLink` | `string` | The URI of this bucket. | +| `defaultObjectAcl` | `array` | Default access controls to apply to new objects when no ACL is provided. | +| `projectNumber` | `string` | The project number of the project the bucket belongs to. | +| `cors` | `array` | The bucket's Cross-Origin Resource Sharing (CORS) configuration. | +| `etag` | `string` | HTTP 1.1 Entity tag for the bucket. | | `encryption` | `object` | Encryption configuration for a bucket. | -| `location` | `string` | The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list. | -| `satisfiesPZS` | `boolean` | Reserved for future use. | -| `customPlacementConfig` | `object` | The bucket's custom placement configuration for Custom Dual Regions. | +| `locationType` | `string` | The type of the bucket location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -64,6 +64,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves a list of buckets for a given project. | | `insert` | `INSERT` | `project` | Creates a new bucket. | | `delete` | `DELETE` | `bucket` | Permanently deletes an empty bucket. | +| `_list` | `EXEC` | `project` | Retrieves a list of buckets for a given project. | | `lock_retention_policy` | `EXEC` | `bucket, ifMetagenerationMatch` | Locks retention policy on a bucket. | | `patch` | `EXEC` | `bucket` | Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. | | `update` | `EXEC` | `bucket` | Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. | diff --git a/docs/google-docs/providers/google/storage/buckets_iam_policies/index.md b/docs/google-docs/providers/google/storage/buckets_iam_policies/index.md index 51c3f5b844..29beb9c428 100644 --- a/docs/google-docs/providers/google/storage/buckets_iam_policies/index.md +++ b/docs/google-docs/providers/google/storage/buckets_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | An association between a role, which comes with a set of permissions, and members who may assume that role. | -| `etag` | `string` | HTTP 1.1 Entity tag for the policy. | | `kind` | `string` | The kind of item this is. For policies, this is always storage#policy. This field is ignored on input. | | `resourceId` | `string` | The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, and projects/_/buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input. | | `version` | `integer` | The IAM policy format version. | +| `bindings` | `array` | An association between a role, which comes with a set of permissions, and members who may assume that role. | +| `etag` | `string` | HTTP 1.1 Entity tag for the policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storage/default_object_access_controls/index.md b/docs/google-docs/providers/google/storage/default_object_access_controls/index.md index af47165270..f429ebfe22 100644 --- a/docs/google-docs/providers/google/storage/default_object_access_controls/index.md +++ b/docs/google-docs/providers/google/storage/default_object_access_controls/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | The ID of the access-control entry. | -| `object` | `string` | The name of the object, if applied to an object. | -| `generation` | `string` | The content generation of the object, if applied to an object. | -| `kind` | `string` | The kind of item this is. For object access control entries, this is always storage#objectAccessControl. | | `etag` | `string` | HTTP 1.1 Entity tag for the access-control entry. | -| `domain` | `string` | The domain associated with the entity, if any. | +| `selfLink` | `string` | The link to this access-control entry. | | `bucket` | `string` | The name of the bucket. | | `entity` | `string` | The entity holding the permission, in one of the following forms:
- user-userId
- user-email
- group-groupId
- group-email
- domain-domain
- project-team-projectId
- allUsers
- allAuthenticatedUsers Examples:
- The user liz@example.com would be user-liz@example.com.
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. | -| `projectTeam` | `object` | The project team associated with the entity, if any. | -| `role` | `string` | The access permission for the entity. | -| `selfLink` | `string` | The link to this access-control entry. | | `email` | `string` | The email address associated with the entity, if any. | | `entityId` | `string` | The ID for the entity, if any. | +| `projectTeam` | `object` | The project team associated with the entity, if any. | +| `role` | `string` | The access permission for the entity. | +| `domain` | `string` | The domain associated with the entity, if any. | +| `object` | `string` | The name of the object, if applied to an object. | +| `generation` | `string` | The content generation of the object, if applied to an object. | +| `kind` | `string` | The kind of item this is. For object access control entries, this is always storage#objectAccessControl. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storage/hmac_keys/index.md b/docs/google-docs/providers/google/storage/hmac_keys/index.md index ae13582616..00434b2b21 100644 --- a/docs/google-docs/providers/google/storage/hmac_keys/index.md +++ b/docs/google-docs/providers/google/storage/hmac_keys/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | The ID of the HMAC key, including the Project ID and the Access ID. | +| `projectId` | `string` | Project ID owning the service account to which the key authenticates. | +| `etag` | `string` | HTTP 1.1 Entity tag for the HMAC key. | | `timeCreated` | `string` | The creation time of the HMAC key in RFC 3339 format. | -| `accessId` | `string` | The ID of the HMAC Key. | +| `updated` | `string` | The last modification time of the HMAC key metadata in RFC 3339 format. | | `selfLink` | `string` | The link to this resource. | | `serviceAccountEmail` | `string` | The email address of the key's associated service account. | | `state` | `string` | The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED. | -| `etag` | `string` | HTTP 1.1 Entity tag for the HMAC key. | -| `projectId` | `string` | Project ID owning the service account to which the key authenticates. | -| `updated` | `string` | The last modification time of the HMAC key metadata in RFC 3339 format. | +| `accessId` | `string` | The ID of the HMAC Key. | | `kind` | `string` | The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata. | ## Methods | Name | Accessible by | Required Params | Description | @@ -44,4 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectId` | Retrieves a list of HMAC keys matching the criteria. | | `create` | `INSERT` | `projectId, serviceAccountEmail` | Creates a new HMAC key for the specified service account. | | `delete` | `DELETE` | `accessId, projectId` | Deletes an HMAC key. | +| `_list` | `EXEC` | `projectId` | Retrieves a list of HMAC keys matching the criteria. | | `update` | `EXEC` | `accessId, projectId` | Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states. | diff --git a/docs/google-docs/providers/google/storage/index.md b/docs/google-docs/providers/google/storage/index.md index db47558f97..35529800e1 100644 --- a/docs/google-docs/providers/google/storage/index.md +++ b/docs/google-docs/providers/google/storage/index.md @@ -21,7 +21,7 @@ Stores And Retrieves Potentially Large, Immutable Data Objects.
total resources: 11
total selectable resources: 10
-total methods: 52
+total methods: 55
@@ -33,7 +33,7 @@ Stores And Retrieves Potentially Large, Immutable Data Objects. TypeService TitleCloud Storage JSON API DescriptionStores And Retrieves Potentially Large, Immutable Data Objects. -Idstorage:v23.08.00155 +Idstorage:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/storage/notifications/index.md b/docs/google-docs/providers/google/storage/notifications/index.md index 8880b84d6f..12a82e5124 100644 --- a/docs/google-docs/providers/google/storage/notifications/index.md +++ b/docs/google-docs/providers/google/storage/notifications/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | The ID of the notification. | -| `event_types` | `array` | If present, only send notifications about listed event types. If empty, sent notifications for all event types. | +| `topic` | `string` | The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}' | +| `object_name_prefix` | `string` | If present, only apply this notification configuration to object names that begin with this prefix. | | `custom_attributes` | `object` | An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription. | -| `kind` | `string` | The kind of item this is. For notifications, this is always storage#notification. | -| `payload_format` | `string` | The desired content of the Payload. | | `etag` | `string` | HTTP 1.1 Entity tag for this subscription notification. | +| `kind` | `string` | The kind of item this is. For notifications, this is always storage#notification. | | `selfLink` | `string` | The canonical URL of this notification. | -| `topic` | `string` | The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}' | -| `object_name_prefix` | `string` | If present, only apply this notification configuration to object names that begin with this prefix. | +| `event_types` | `array` | If present, only send notifications about listed event types. If empty, sent notifications for all event types. | +| `payload_format` | `string` | The desired content of the Payload. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storage/object_access_controls/index.md b/docs/google-docs/providers/google/storage/object_access_controls/index.md index ca4e9c50f2..fcd921e058 100644 --- a/docs/google-docs/providers/google/storage/object_access_controls/index.md +++ b/docs/google-docs/providers/google/storage/object_access_controls/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | The ID of the access-control entry. | +| `bucket` | `string` | The name of the bucket. | +| `role` | `string` | The access permission for the entity. | +| `selfLink` | `string` | The link to this access-control entry. | +| `entityId` | `string` | The ID for the entity, if any. | | `object` | `string` | The name of the object, if applied to an object. | +| `kind` | `string` | The kind of item this is. For object access control entries, this is always storage#objectAccessControl. | | `email` | `string` | The email address associated with the entity, if any. | | `generation` | `string` | The content generation of the object, if applied to an object. | -| `kind` | `string` | The kind of item this is. For object access control entries, this is always storage#objectAccessControl. | -| `bucket` | `string` | The name of the bucket. | +| `domain` | `string` | The domain associated with the entity, if any. | | `entity` | `string` | The entity holding the permission, in one of the following forms:
- user-userId
- user-email
- group-groupId
- group-email
- domain-domain
- project-team-projectId
- allUsers
- allAuthenticatedUsers Examples:
- The user liz@example.com would be user-liz@example.com.
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. | | `etag` | `string` | HTTP 1.1 Entity tag for the access-control entry. | | `projectTeam` | `object` | The project team associated with the entity, if any. | -| `role` | `string` | The access permission for the entity. | -| `domain` | `string` | The domain associated with the entity, if any. | -| `selfLink` | `string` | The link to this access-control entry. | -| `entityId` | `string` | The ID for the entity, if any. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storage/objects/index.md b/docs/google-docs/providers/google/storage/objects/index.md index 9670a62346..c9ed1b449b 100644 --- a/docs/google-docs/providers/google/storage/objects/index.md +++ b/docs/google-docs/providers/google/storage/objects/index.md @@ -25,40 +25,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `id` | `string` | The ID of the object, including the bucket name, object name, and generation number. | -| `name` | `string` | The name of the object. Required if not specified by URL parameter. | -| `updated` | `string` | The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. | -| `kind` | `string` | The kind of item this is. For objects, this is always storage#object. | -| `generation` | `string` | The content generation of this object. Used for object versioning. | -| `customerEncryption` | `object` | Metadata of customer-supplied encryption key, if the object is encrypted by such a key. | -| `bucket` | `string` | The name of the bucket containing this object. | -| `cacheControl` | `string` | Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600. | -| `eventBasedHold` | `boolean` | Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. | -| `timeStorageClassUpdated` | `string` | The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. | -| `md5Hash` | `string` | MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. | -| `contentLanguage` | `string` | Content-Language of the object data. | -| `storageClass` | `string` | Storage class of the object. | -| `size` | `string` | Content-Length of the data in bytes. | -| `crc32c` | `string` | CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. | -| `kmsKeyName` | `string` | Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request. | -| `metadata` | `object` | User-provided metadata, in key/value pairs. | -| `componentCount` | `integer` | Number of underlying components that make up this object. Components are accumulated by compose operations. | -| `metageneration` | `string` | The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. | -| `acl` | `array` | Access controls on the object. | -| `retentionExpirationTime` | `string` | A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold). | -| `temporaryHold` | `boolean` | Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object. | -| `etag` | `string` | HTTP 1.1 Entity tag for the object. | -| `timeDeleted` | `string` | The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. | -| `selfLink` | `string` | The link to this object. | -| `timeCreated` | `string` | The creation time of the object in RFC 3339 format. | -| `customTime` | `string` | A timestamp in RFC 3339 format specified by the user for an object. | -| `contentDisposition` | `string` | Content-Disposition of the object data. | -| `mediaLink` | `string` | Media download link. | -| `contentEncoding` | `string` | Content-Encoding of the object data. | -| `contentType` | `string` | Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream. | -| `owner` | `object` | The owner of the object. This will always be the uploader of the object. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -66,6 +32,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `bucket` | Retrieves a list of objects matching the criteria. | | `insert` | `INSERT` | `bucket` | Stores a new object and metadata. | | `delete` | `DELETE` | `bucket, object` | Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used. | +| `_list` | `EXEC` | `bucket` | Retrieves a list of objects matching the criteria. | | `compose` | `EXEC` | `destinationBucket, destinationObject` | Concatenates a list of existing objects into a new object in the same bucket. | | `copy` | `EXEC` | `destinationBucket, destinationObject, sourceBucket, sourceObject` | Copies a source object to a destination object. Optionally overrides metadata. | | `patch` | `EXEC` | `bucket, object` | Patches an object's metadata. | diff --git a/docs/google-docs/providers/google/storage/objects_iam_policies/index.md b/docs/google-docs/providers/google/storage/objects_iam_policies/index.md index 0943da52ec..9217184fc2 100644 --- a/docs/google-docs/providers/google/storage/objects_iam_policies/index.md +++ b/docs/google-docs/providers/google/storage/objects_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `resourceId` | `string` | The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, and projects/_/buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input. | | `version` | `integer` | The IAM policy format version. | | `bindings` | `array` | An association between a role, which comes with a set of permissions, and members who may assume that role. | | `etag` | `string` | HTTP 1.1 Entity tag for the policy. | | `kind` | `string` | The kind of item this is. For policies, this is always storage#policy. This field is ignored on input. | -| `resourceId` | `string` | The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, and projects/_/buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storage/service_account/index.md b/docs/google-docs/providers/google/storage/service_account/index.md index 25e7621fda..cca3f08866 100644 --- a/docs/google-docs/providers/google/storage/service_account/index.md +++ b/docs/google-docs/providers/google/storage/service_account/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `kind` | `string` | The kind of item this is. For notifications, this is always storage#notification. | | `email_address` | `string` | The ID of the notification. | +| `kind` | `string` | The kind of item this is. For notifications, this is always storage#notification. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/storagetransfer/agent_pools/index.md b/docs/google-docs/providers/google/storagetransfer/agent_pools/index.md index f2fc0d07e7..ba72deab6d 100644 --- a/docs/google-docs/providers/google/storagetransfer/agent_pools/index.md +++ b/docs/google-docs/providers/google/storagetransfer/agent_pools/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}` | +| `displayName` | `string` | Specifies the client-specified AgentPool description. | | `state` | `string` | Output only. Specifies the state of the AgentPool. | | `bandwidthLimit` | `object` | Specifies a bandwidth limit for an agent pool. | -| `displayName` | `string` | Specifies the client-specified AgentPool description. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -38,4 +38,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId` | Lists agent pools. | | `create` | `INSERT` | `projectsId` | Creates an agent pool resource. | | `delete` | `DELETE` | `agentPoolsId, projectsId` | Deletes an agent pool. | +| `_list` | `EXEC` | `projectsId` | Lists agent pools. | | `patch` | `EXEC` | `agentPoolsId, projectsId` | Updates an existing agent pool resource. | diff --git a/docs/google-docs/providers/google/storagetransfer/index.md b/docs/google-docs/providers/google/storagetransfer/index.md index b3e05a0a37..58d3857ffe 100644 --- a/docs/google-docs/providers/google/storagetransfer/index.md +++ b/docs/google-docs/providers/google/storagetransfer/index.md @@ -21,7 +21,7 @@ Transfers Data From External Data Sources To A Google Cloud Storage Bucket Or Be
total resources: 4
total selectable resources: 4
-total methods: 17
+total methods: 20
@@ -33,7 +33,7 @@ Transfers Data From External Data Sources To A Google Cloud Storage Bucket Or Be TypeService TitleStorage Transfer API DescriptionTransfers Data From External Data Sources To A Google Cloud Storage Bucket Or Between Google Cloud Storage Buckets. -Idstoragetransfer:v23.08.00155 +Idstoragetransfer:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/storagetransfer/transfer_jobs/index.md b/docs/google-docs/providers/google/storagetransfer/transfer_jobs/index.md index 2508359492..71663e2e4b 100644 --- a/docs/google-docs/providers/google/storagetransfer/transfer_jobs/index.md +++ b/docs/google-docs/providers/google/storagetransfer/transfer_jobs/index.md @@ -27,8 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The list next page token. | -| `transferJobs` | `array` | A list of transfer jobs. | +| `name` | `string` | A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service assigns a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. For transfers involving PosixFilesystem, this name must start with `transferJobs/OPI` specifically. For all other transfer types, this name must not start with `transferJobs/OPI`. Non-PosixFilesystem example: `"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"` PosixFilesystem example: `"transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Applications must not rely on the enforcement of naming requirements involving OPI. Invalid job names fail with an INVALID_ARGUMENT error. | +| `description` | `string` | A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded. | +| `deletionTime` | `string` | Output only. The time that the transfer job was deleted. | +| `eventStream` | `object` | Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files. | +| `loggingConfig` | `object` | Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details. | +| `projectId` | `string` | The ID of the Google Cloud project that owns the job. | +| `status` | `string` | Status of the job. This value MUST be specified for `CreateTransferJobRequests`. **Note:** The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation. | +| `latestOperationName` | `string` | The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig. | +| `notificationConfig` | `object` | Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following `PubsubMessage.attributes`: * `"eventType"`: one of the EventType values * `"payloadFormat"`: one of the PayloadFormat values * `"projectId"`: the project_id of the `TransferOperation` * `"transferJobName"`: the transfer_job_name of the `TransferOperation` * `"transferOperationName"`: the name of the `TransferOperation` The `PubsubMessage.data` contains a TransferOperation resource formatted according to the specified `PayloadFormat`. | +| `creationTime` | `string` | Output only. The time that the transfer job was created. | +| `lastModificationTime` | `string` | Output only. The time that the transfer job was last modified. | +| `schedule` | `object` | Transfers can be scheduled to recur or to run just once. | +| `transferSpec` | `object` | Configuration for running a transfer. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +47,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `filter` | Lists transfer jobs. | | `create` | `INSERT` | | Creates a transfer job that runs periodically. | | `delete` | `DELETE` | `projectId, transferJobsId` | Deletes a transfer job. Deleting a transfer job sets its status to DELETED. | +| `_list` | `EXEC` | `filter` | Lists transfer jobs. | | `patch` | `EXEC` | `transferJobsId` | Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. **Note:** The job's status field can be modified using this RPC (for example, to set a job's status to DELETED, DISABLED, or ENABLED). | | `run` | `EXEC` | `transferJobsId` | Starts a new operation for the specified transfer job. A `TransferJob` has a maximum of one active `TransferOperation`. If this method is called while a `TransferOperation` is active, an error is returned. | diff --git a/docs/google-docs/providers/google/storagetransfer/transfer_operations/index.md b/docs/google-docs/providers/google/storagetransfer/transfer_operations/index.md index 1596a8c1b5..2f7356b86c 100644 --- a/docs/google-docs/providers/google/storagetransfer/transfer_operations/index.md +++ b/docs/google-docs/providers/google/storagetransfer/transfer_operations/index.md @@ -27,13 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | The server-assigned unique name. The format of `name` is `transferOperations/some/unique/name`. | +| `response` | `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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `object` | Represents the transfer operation object. To request a TransferOperation object, use transferOperations.get. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `transferOperationsId` | 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. | | `list` | `SELECT` | `filter` | Lists transfer operations. Operations are ordered by their creation time in reverse chronological order. | +| `_list` | `EXEC` | `filter` | Lists transfer operations. Operations are ordered by their creation time in reverse chronological order. | | `cancel` | `EXEC` | `transferOperationsId` | Cancels a transfer. Use the transferOperations.get method to check if the cancellation succeeded or if the operation completed despite the `cancel` request. When you cancel an operation, the currently running transfer is interrupted. For recurring transfer jobs, the next instance of the transfer job will still run. For example, if your job is configured to run every day at 1pm and you cancel Monday's operation at 1:05pm, Monday's transfer will stop. However, a transfer job will still be attempted on Tuesday. This applies only to currently running operations. If an operation is not currently running, `cancel` does nothing. *Caution:* Canceling a transfer job can leave your data in an unknown state. We recommend that you restore the state at both the destination and the source after the `cancel` request completes so that your data is in a consistent state. When you cancel a job, the next job computes a delta of files and may repair any inconsistent state. For instance, if you run a job every day, and today's job found 10 new files and transferred five files before you canceled the job, tomorrow's transfer operation will compute a new delta with the five files that were not copied today plus any new files discovered tomorrow. | | `pause` | `EXEC` | `transferOperationsId` | Pauses a transfer operation. | | `resume` | `EXEC` | `transferOperationsId` | Resumes a transfer operation that is paused. | diff --git a/docs/google-docs/providers/google/testing/index.md b/docs/google-docs/providers/google/testing/index.md index e7ee118267..84060b7076 100644 --- a/docs/google-docs/providers/google/testing/index.md +++ b/docs/google-docs/providers/google/testing/index.md @@ -33,7 +33,7 @@ Allows Developers To Run Automated Tests For Their Mobile Applications On Google TypeService TitleCloud Testing API DescriptionAllows Developers To Run Automated Tests For Their Mobile Applications On Google Infrastructure. -Idtesting:v23.08.00155 +Idtesting:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/testing/test_environment_catalog/index.md b/docs/google-docs/providers/google/testing/test_environment_catalog/index.md index c6da20be7a..1ab94a334b 100644 --- a/docs/google-docs/providers/google/testing/test_environment_catalog/index.md +++ b/docs/google-docs/providers/google/testing/test_environment_catalog/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `deviceIpBlockCatalog` | `object` | List of IP blocks used by the Firebase Test Lab | | `iosDeviceCatalog` | `object` | The currently supported iOS devices. | | `networkConfigurationCatalog` | `object` | | | `softwareCatalog` | `object` | The currently provided software environment on the devices under test. | | `androidDeviceCatalog` | `object` | The currently supported Android devices. | +| `deviceIpBlockCatalog` | `object` | List of IP blocks used by the Firebase Test Lab | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/testing/test_matrices/index.md b/docs/google-docs/providers/google/testing/test_matrices/index.md index 90090c71db..e78530b661 100644 --- a/docs/google-docs/providers/google/testing/test_matrices/index.md +++ b/docs/google-docs/providers/google/testing/test_matrices/index.md @@ -27,19 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `flakyTestAttempts` | `integer` | The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns. | -| `testExecutions` | `array` | Output only. The list of test executions that the service creates for this matrix. | -| `timestamp` | `string` | Output only. The time this test matrix was initially created. | | `environmentMatrix` | `object` | The matrix of environments in which the test is to be executed. | -| `invalidMatrixDetails` | `string` | Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state. | -| `testMatrixId` | `string` | Output only. Unique id set by the service. | | `state` | `string` | Output only. Indicates the current progress of the test matrix. | -| `clientInfo` | `object` | Information about the client which invoked the test. | | `failFast` | `boolean` | If true, only a single attempt at most will be made to run each execution/shard in the matrix. Flaky test attempts are not affected. Normally, 2 or more attempts are made if a potential infrastructure issue is detected. This feature is for latency sensitive workloads. The incidence of execution failures may be significantly greater for fail-fast matrices and support is more limited because of that expectation. | -| `outcomeSummary` | `string` | Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED. | -| `resultStorage` | `object` | Locations where the results of running the test are stored. | +| `testExecutions` | `array` | Output only. The list of test executions that the service creates for this matrix. | | `testSpecification` | `object` | A description of how to run the test. | +| `invalidMatrixDetails` | `string` | Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state. | +| `testMatrixId` | `string` | Output only. Unique id set by the service. | +| `timestamp` | `string` | Output only. The time this test matrix was initially created. | +| `outcomeSummary` | `string` | Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED. | +| `flakyTestAttempts` | `integer` | The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns. | | `projectId` | `string` | The cloud project that owns the test matrix. | +| `resultStorage` | `object` | Locations where the results of running the test are stored. | +| `clientInfo` | `object` | Information about the client which invoked the test. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/texttospeech/index.md b/docs/google-docs/providers/google/texttospeech/index.md index b24bda66a6..ce9fc92949 100644 --- a/docs/google-docs/providers/google/texttospeech/index.md +++ b/docs/google-docs/providers/google/texttospeech/index.md @@ -21,7 +21,7 @@ Synthesizes Natural-Sounding Speech By Applying Powerful Neural Network Models.
total resources: 4
total selectable resources: 2
-total methods: 7
+total methods: 8
@@ -33,7 +33,7 @@ Synthesizes Natural-Sounding Speech By Applying Powerful Neural Network Models. TypeService TitleCloud Text-To-Speech API DescriptionSynthesizes Natural-Sounding Speech By Applying Powerful Neural Network Models. -Idtexttospeech:v23.08.00155 +Idtexttospeech:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/texttospeech/operations/index.md b/docs/google-docs/providers/google/texttospeech/operations/index.md index e9422a5e63..762d8c2c14 100644 --- a/docs/google-docs/providers/google/texttospeech/operations/index.md +++ b/docs/google-docs/providers/google/texttospeech/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `response` | `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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `operationsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `operationsId` | 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`. | diff --git a/docs/google-docs/providers/google/tpu/accelerator_types/index.md b/docs/google-docs/providers/google/tpu/accelerator_types/index.md index b0113e562a..224b6901e3 100644 --- a/docs/google-docs/providers/google/tpu/accelerator_types/index.md +++ b/docs/google-docs/providers/google/tpu/accelerator_types/index.md @@ -28,10 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name. | -| `type` | `string` | The accelerator type. | | `acceleratorConfigs` | `array` | The accelerator config. | +| `type` | `string` | The accelerator type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `acceleratorTypesId, locationsId, projectsId` | Gets AcceleratorType. | | `list` | `SELECT` | `locationsId, projectsId` | Lists accelerator types supported by this API. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists accelerator types supported by this API. | diff --git a/docs/google-docs/providers/google/tpu/index.md b/docs/google-docs/providers/google/tpu/index.md index 0cbfde1c65..57fe6a7f2c 100644 --- a/docs/google-docs/providers/google/tpu/index.md +++ b/docs/google-docs/providers/google/tpu/index.md @@ -21,7 +21,7 @@ TPU API Provides Customers With Access To Google TPU Technology.
total resources: 6
total selectable resources: 5
-total methods: 19
+total methods: 24
@@ -33,7 +33,7 @@ TPU API Provides Customers With Access To Google TPU Technology. TypeService TitleCloud TPU API DescriptionTPU API Provides Customers With Access To Google TPU Technology. -Idtpu:v23.08.00155 +Idtpu:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/tpu/locations/index.md b/docs/google-docs/providers/google/tpu/locations/index.md index 6c9b3b7512..54e885bd44 100644 --- a/docs/google-docs/providers/google/tpu/locations/index.md +++ b/docs/google-docs/providers/google/tpu/locations/index.md @@ -27,11 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `generate_service_identity` | `EXEC` | `locationsId, projectsId` | Generates the Cloud TPU service identity for the project. | diff --git a/docs/google-docs/providers/google/tpu/nodes/index.md b/docs/google-docs/providers/google/tpu/nodes/index.md index 78b07fbbfa..8c3ebde4a4 100644 --- a/docs/google-docs/providers/google/tpu/nodes/index.md +++ b/docs/google-docs/providers/google/tpu/nodes/index.md @@ -27,9 +27,30 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `nextPageToken` | `string` | The next page token or empty if none. | -| `nodes` | `array` | The listed nodes. | +| `id` | `string` | Output only. The unique identifier for the TPU Node. | +| `name` | `string` | Output only. Immutable. The name of the TPU. | +| `description` | `string` | The user-supplied description of the TPU. Maximum of 512 characters. | +| `serviceAccount` | `object` | A service account. | +| `createTime` | `string` | Output only. The time when the node was created. | +| `state` | `string` | Output only. The current state for the TPU Node. | +| `symptoms` | `array` | Output only. The Symptoms that have occurred to the TPU Node. | +| `health` | `string` | The health status of the TPU node. | +| `networkEndpoints` | `array` | Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that runtime clients of the node reach out to the 0th entry in this map first. | +| `healthDescription` | `string` | Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy. | +| `metadata` | `object` | Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script | +| `multisliceNode` | `boolean` | Output only. Whether the Node belongs to a Multislice group. | +| `acceleratorConfig` | `object` | A TPU accelerator configuration. | +| `dataDisks` | `array` | The additional data disks for the Node. | +| `apiVersion` | `string` | Output only. The API version that created this Node. | +| `runtimeVersion` | `string` | Required. The runtime version running in the Node. | +| `tags` | `array` | Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls. | +| `networkConfig` | `object` | Network related configurations. | +| `schedulingConfig` | `object` | Sets the scheduling options for this node. | +| `shieldedInstanceConfig` | `object` | A set of Shielded Instance options. | +| `acceleratorType` | `string` | Optional. The type of hardware accelerators associated with this node. | +| `labels` | `object` | Resource labels to represent user-provided metadata. | +| `cidrBlock` | `string` | The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. | +| `queuedResource` | `string` | Output only. The qualified name of the QueuedResource that requested this Node. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +58,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists nodes. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a node. | | `delete` | `DELETE` | `locationsId, nodesId, projectsId` | Deletes a node. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists nodes. | | `patch` | `EXEC` | `locationsId, nodesId, projectsId` | Updates the configurations of a node. | | `start` | `EXEC` | `locationsId, nodesId, projectsId` | Starts a node. | | `stop` | `EXEC` | `locationsId, nodesId, projectsId` | Stops a node. This operation is only available with single TPU nodes. | diff --git a/docs/google-docs/providers/google/tpu/operations/index.md b/docs/google-docs/providers/google/tpu/operations/index.md index 562fdc4405..3aa1d04978 100644 --- a/docs/google-docs/providers/google/tpu/operations/index.md +++ b/docs/google-docs/providers/google/tpu/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/tpu/runtime_versions/index.md b/docs/google-docs/providers/google/tpu/runtime_versions/index.md index 99a02f7e7b..b23ce1e38b 100644 --- a/docs/google-docs/providers/google/tpu/runtime_versions/index.md +++ b/docs/google-docs/providers/google/tpu/runtime_versions/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The next page token or empty if none. | -| `runtimeVersions` | `array` | The listed nodes. | -| `unreachable` | `array` | Locations that could not be reached. | +| `name` | `string` | The resource name. | +| `version` | `string` | The runtime version. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId, runtimeVersionsId` | Gets a runtime version. | | `list` | `SELECT` | `locationsId, projectsId` | Lists runtime versions supported by this API. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists runtime versions supported by this API. | diff --git a/docs/google-docs/providers/google/trafficdirector/index.md b/docs/google-docs/providers/google/trafficdirector/index.md index 66bee4644d..8ea3277609 100644 --- a/docs/google-docs/providers/google/trafficdirector/index.md +++ b/docs/google-docs/providers/google/trafficdirector/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleTraffic Director API Description -Idtrafficdirector:v23.08.00155 +Idtrafficdirector:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/transcoder/index.md b/docs/google-docs/providers/google/transcoder/index.md index 3d8e7471d3..ab649cf6b5 100644 --- a/docs/google-docs/providers/google/transcoder/index.md +++ b/docs/google-docs/providers/google/transcoder/index.md @@ -21,7 +21,7 @@ This API Converts Video Files Into Formats Suitable For Consumer Distribution. F
total resources: 2
total selectable resources: 2
-total methods: 8
+total methods: 10
@@ -33,7 +33,7 @@ This API Converts Video Files Into Formats Suitable For Consumer Distribution. F TypeService TitleTranscoder API DescriptionThis API Converts Video Files Into Formats Suitable For Consumer Distribution. For More Information, See The Transcoder API Overview. -Idtranscoder:v23.08.00155 +Idtranscoder:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/transcoder/job_templates/index.md b/docs/google-docs/providers/google/transcoder/job_templates/index.md index 84f63138e1..97fc74a5ef 100644 --- a/docs/google-docs/providers/google/transcoder/job_templates/index.md +++ b/docs/google-docs/providers/google/transcoder/job_templates/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The pagination token. | -| `unreachable` | `array` | List of regions that could not be reached. | -| `jobTemplates` | `array` | List of job templates in the specified region. | +| `name` | `string` | The resource name of the job template. Format: `projects/{project_number}/locations/{location}/jobTemplates/{job_template}` | +| `labels` | `object` | The labels associated with this job template. You can use these to organize and group your job templates. | +| `config` | `object` | Job configuration | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,3 +37,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists job templates in the specified region. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a job template in the specified region. | | `delete` | `DELETE` | `jobTemplatesId, locationsId, projectsId` | Deletes a job template. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists job templates in the specified region. | diff --git a/docs/google-docs/providers/google/transcoder/jobs/index.md b/docs/google-docs/providers/google/transcoder/jobs/index.md index c03038e812..b32119e6e1 100644 --- a/docs/google-docs/providers/google/transcoder/jobs/index.md +++ b/docs/google-docs/providers/google/transcoder/jobs/index.md @@ -27,9 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | List of regions that could not be reached. | -| `jobs` | `array` | List of jobs in the specified region. | -| `nextPageToken` | `string` | The pagination token. | +| `name` | `string` | The resource name of the job. Format: `projects/{project_number}/locations/{location}/jobs/{job}` | +| `inputUri` | `string` | Input only. Specify the `input_uri` to populate empty `uri` fields in each element of `Job.config.inputs` or `JobTemplate.config.inputs` when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats). | +| `labels` | `object` | The labels associated with this job. You can use these to organize and group your jobs. | +| `error` | `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). | +| `startTime` | `string` | Output only. The time the transcoding started. | +| `endTime` | `string` | Output only. The time the transcoding finished. | +| `templateId` | `string` | Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`, which is the only supported preset. User defined JobTemplate: `{job_template_id}` | +| `createTime` | `string` | Output only. The time the job was created. | +| `state` | `string` | Output only. The current state of the job. | +| `config` | `object` | Job configuration | +| `ttlAfterCompletionDays` | `integer` | Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30. | +| `optimization` | `string` | Optional. The optimization strategy of the job. The default is `AUTODETECT`. | +| `mode` | `string` | The processing mode of the job. The default is `PROCESSING_MODE_INTERACTIVE`. | +| `batchModePriority` | `integer` | The processing priority of a batch job. This field can only be set for batch mode jobs. The default value is 0. This value cannot be negative. Higher values correspond to higher priorities for the job. | +| `outputUri` | `string` | Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`. See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,3 +49,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists jobs in the specified region. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a job in the specified region. | | `delete` | `DELETE` | `jobsId, locationsId, projectsId` | Deletes a job. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists jobs in the specified region. | diff --git a/docs/google-docs/providers/google/translate/datasets/index.md b/docs/google-docs/providers/google/translate/datasets/index.md index cf4c3f96bf..cb34f4be70 100644 --- a/docs/google-docs/providers/google/translate/datasets/index.md +++ b/docs/google-docs/providers/google/translate/datasets/index.md @@ -27,8 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `datasets` | `array` | The datasets read. | -| `nextPageToken` | `string` | A token to retrieve next page of results. Pass this token to the page_token field in the ListDatasetsRequest to obtain the corresponding page. | +| `name` | `string` | The resource name of the dataset, in form of `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}` | +| `updateTime` | `string` | Output only. Timestamp when this dataset was last updated. | +| `displayName` | `string` | The name of the dataset to show in the interface. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores (_), and ASCII digits 0-9. | +| `targetLanguageCode` | `string` | The BCP-47 language code of the target language. | +| `createTime` | `string` | Output only. Timestamp when this dataset was created. | +| `sourceLanguageCode` | `string` | The BCP-47 language code of the source language. | +| `trainExampleCount` | `integer` | Output only. Number of training examples (sentence pairs). | +| `exampleCount` | `integer` | Output only. The number of examples in the dataset. | +| `validateExampleCount` | `integer` | Output only. Number of validation examples (sentence pairs). | +| `testExampleCount` | `integer` | Output only. Number of test examples (sentence pairs). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +44,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_datasets_list` | `SELECT` | `locationsId, projectsId` | Lists datasets. | | `projects_locations_datasets_create` | `INSERT` | `locationsId, projectsId` | Creates a Dataset. | | `projects_locations_datasets_delete` | `DELETE` | `datasetsId, locationsId, projectsId` | Deletes a dataset and all of its contents. | +| `_projects_locations_datasets_list` | `EXEC` | `locationsId, projectsId` | Lists datasets. | | `projects_locations_datasets_export_data` | `EXEC` | `datasetsId, locationsId, projectsId` | Exports dataset's data to the provided output location. | | `projects_locations_datasets_import_data` | `EXEC` | `datasetsId, locationsId, projectsId` | Import sentence pairs into translation Dataset. | diff --git a/docs/google-docs/providers/google/translate/examples/index.md b/docs/google-docs/providers/google/translate/examples/index.md index 979494ee42..022ed7eef7 100644 --- a/docs/google-docs/providers/google/translate/examples/index.md +++ b/docs/google-docs/providers/google/translate/examples/index.md @@ -27,9 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to retrieve next page of results. Pass this token to the page_token field in the ListExamplesRequest to obtain the corresponding page. | -| `examples` | `array` | The sentence pairs. | +| `name` | `string` | Output only. The resource name of the example, in form of `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}/examples/{example_id}' | +| `usage` | `string` | Output only. Usage of the sentence pair. Options are TRAIN\|VALIDATION\|TEST. | +| `sourceText` | `string` | Sentence in source language. | +| `targetText` | `string` | Sentence in target language. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `projects_locations_datasets_examples_list` | `SELECT` | `datasetsId, locationsId, projectsId` | +| `_projects_locations_datasets_examples_list` | `EXEC` | `datasetsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/translate/glossaries/index.md b/docs/google-docs/providers/google/translate/glossaries/index.md index 667681f313..6738210fd0 100644 --- a/docs/google-docs/providers/google/translate/glossaries/index.md +++ b/docs/google-docs/providers/google/translate/glossaries/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. The resource name of the glossary. Glossary names have the form `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`. | -| `languageCodesSet` | `object` | Used with equivalent term set glossaries. | -| `languagePair` | `object` | Used with unidirectional glossaries. | -| `submitTime` | `string` | Output only. When CreateGlossary was called. | | `displayName` | `string` | Optional. The display name of the glossary. | | `endTime` | `string` | Output only. When the glossary creation was finished. | | `entryCount` | `integer` | Output only. The number of entries defined in the glossary. | | `inputConfig` | `object` | Input configuration for glossaries. | +| `languageCodesSet` | `object` | Used with equivalent term set glossaries. | +| `languagePair` | `object` | Used with unidirectional glossaries. | +| `submitTime` | `string` | Output only. When CreateGlossary was called. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -42,4 +42,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_glossaries_list` | `SELECT` | `locationsId, projectsId` | Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist. | | `projects_locations_glossaries_create` | `INSERT` | `locationsId, projectsId` | Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist. | | `projects_locations_glossaries_delete` | `DELETE` | `glossariesId, locationsId, projectsId` | Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist. | +| `_projects_locations_glossaries_list` | `EXEC` | `locationsId, projectsId` | Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist. | | `projects_locations_glossaries_patch` | `EXEC` | `glossariesId, locationsId, projectsId` | Updates a glossary. A LRO is used since the update can be async if the glossary's entry file is updated. | diff --git a/docs/google-docs/providers/google/translate/glossary_entries/index.md b/docs/google-docs/providers/google/translate/glossary_entries/index.md index 5e2b54e4da..d0e970b9de 100644 --- a/docs/google-docs/providers/google/translate/glossary_entries/index.md +++ b/docs/google-docs/providers/google/translate/glossary_entries/index.md @@ -27,8 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Optional. A token to retrieve a page of results. Pass this value in the [ListGLossaryEntriesRequest.page_token] field in the subsequent calls. | -| `glossaryEntries` | `array` | Optional. The Glossary Entries | +| `name` | `string` | Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" | +| `description` | `string` | Describes the glossary entry. | +| `termsPair` | `object` | Represents a single entry for an unidirectional glossary. | +| `termsSet` | `object` | Represents a single entry for an equivalent term set glossary. This is used for equivalent term sets where each term can be replaced by the other terms in the set. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,4 +38,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_glossaries_glossary_entries_list` | `SELECT` | `glossariesId, locationsId, projectsId` | List the entries for the glossary. | | `projects_locations_glossaries_glossary_entries_create` | `INSERT` | `glossariesId, locationsId, projectsId` | Creates a glossary entry. | | `projects_locations_glossaries_glossary_entries_delete` | `DELETE` | `glossariesId, glossaryEntriesId, locationsId, projectsId` | Deletes a single entry from the glossary | +| `_projects_locations_glossaries_glossary_entries_list` | `EXEC` | `glossariesId, locationsId, projectsId` | List the entries for the glossary. | | `projects_locations_glossaries_glossary_entries_patch` | `EXEC` | `glossariesId, glossaryEntriesId, locationsId, projectsId` | Updates a glossary entry. | diff --git a/docs/google-docs/providers/google/translate/index.md b/docs/google-docs/providers/google/translate/index.md index cac3ae89ab..795ac4cf8c 100644 --- a/docs/google-docs/providers/google/translate/index.md +++ b/docs/google-docs/providers/google/translate/index.md @@ -21,7 +21,7 @@ Integrates Text Translation Into Your Website Or Application.
total resources: 9
total selectable resources: 8
-total methods: 39
+total methods: 46
@@ -33,7 +33,7 @@ Integrates Text Translation Into Your Website Or Application. TypeService TitleCloud Translation API DescriptionIntegrates Text Translation Into Your Website Or Application. -Idtranslate:v23.08.00155 +Idtranslate:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/translate/locations/index.md b/docs/google-docs/providers/google/translate/locations/index.md index 40b9b232d7..631b4a3ff8 100644 --- a/docs/google-docs/providers/google/translate/locations/index.md +++ b/docs/google-docs/providers/google/translate/locations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `projects_locations_batch_translate_document` | `EXEC` | `locationsId, projectsId` | Translates a large volume of document in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location. This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call. | | `projects_locations_batch_translate_text` | `EXEC` | `locationsId, projectsId` | Translates a large volume of text in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location. This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call. | | `projects_locations_detect_language` | `EXEC` | `locationsId, projectsId` | Detects the language of text within a request. | diff --git a/docs/google-docs/providers/google/translate/models/index.md b/docs/google-docs/providers/google/translate/models/index.md index 008811b121..a998ee1411 100644 --- a/docs/google-docs/providers/google/translate/models/index.md +++ b/docs/google-docs/providers/google/translate/models/index.md @@ -27,8 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `models` | `array` | The models read. | -| `nextPageToken` | `string` | A token to retrieve next page of results. Pass this token to the page_token field in the ListModelsRequest to obtain the corresponding page. | +| `name` | `string` | The resource name of the model, in form of `projects/{project-number-or-id}/locations/{location_id}/models/{model_id}` | +| `trainExampleCount` | `integer` | Output only. Number of examples (sentence pairs) used to train the model. | +| `validateExampleCount` | `integer` | Output only. Number of examples (sentence pairs) used to validate the model. | +| `dataset` | `string` | The dataset from which the model is trained, in form of `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}` | +| `displayName` | `string` | The name of the model to show in the interface. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores (_), and ASCII digits 0-9. | +| `updateTime` | `string` | Output only. Timestamp when this model was last updated. | +| `targetLanguageCode` | `string` | Output only. The BCP-47 language code of the target language. | +| `testExampleCount` | `integer` | Output only. Number of examples (sentence pairs) used to test the model. | +| `createTime` | `string` | Output only. Timestamp when the model resource was created, which is also when the training started. | +| `sourceLanguageCode` | `string` | Output only. The BCP-47 language code of the source language. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,3 +44,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_models_list` | `SELECT` | `locationsId, projectsId` | Lists models. | | `projects_locations_models_create` | `INSERT` | `locationsId, projectsId` | Creates a Model. | | `projects_locations_models_delete` | `DELETE` | `locationsId, modelsId, projectsId` | Deletes a model. | +| `_projects_locations_models_list` | `EXEC` | `locationsId, projectsId` | Lists models. | diff --git a/docs/google-docs/providers/google/translate/operations/index.md b/docs/google-docs/providers/google/translate/operations/index.md index 3d09ecd613..74c40812ab 100644 --- a/docs/google-docs/providers/google/translate/operations/index.md +++ b/docs/google-docs/providers/google/translate/operations/index.md @@ -27,13 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | | `projects_locations_operations_get` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | | `projects_locations_operations_wait` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/videointelligence/index.md b/docs/google-docs/providers/google/videointelligence/index.md index cc6ad0aad2..754077b516 100644 --- a/docs/google-docs/providers/google/videointelligence/index.md +++ b/docs/google-docs/providers/google/videointelligence/index.md @@ -21,7 +21,7 @@ Detects Objects, Explicit Content, And Scene Changes In Videos. It Also Specifie
total resources: 3
total selectable resources: 1
-total methods: 8
+total methods: 9
@@ -33,7 +33,7 @@ Detects Objects, Explicit Content, And Scene Changes In Videos. It Also Specifie TypeService TitleCloud Video Intelligence API DescriptionDetects Objects, Explicit Content, And Scene Changes In Videos. It Also Specifies The Region For Annotation And Transcribes Speech To Text. Supports Both Asynchronous API And Streaming API. -Idvideointelligence:v23.08.00155 +Idvideointelligence:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/videointelligence/operations/index.md b/docs/google-docs/providers/google/videointelligence/operations/index.md index f23737d4d0..f6eb9e0e3f 100644 --- a/docs/google-docs/providers/google/videointelligence/operations/index.md +++ b/docs/google-docs/providers/google/videointelligence/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | | `projects_locations_operations_get` | `EXEC` | `locationsId, operationsId, projectsId` | 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. | diff --git a/docs/google-docs/providers/google/vision/index.md b/docs/google-docs/providers/google/vision/index.md index b097fca375..d7d13aaaf7 100644 --- a/docs/google-docs/providers/google/vision/index.md +++ b/docs/google-docs/providers/google/vision/index.md @@ -21,7 +21,7 @@ Integrates Google Vision Features, Including Image Labeling, Face, Logo, And Lan
total resources: 7
total selectable resources: 4
-total methods: 38
+total methods: 43
@@ -33,7 +33,7 @@ Integrates Google Vision Features, Including Image Labeling, Face, Logo, And Lan TypeService TitleCloud Vision API DescriptionIntegrates Google Vision Features, Including Image Labeling, Face, Logo, And Landmark Detection, Optical Character Recognition (OCR), And Detection Of Explicit Content, Into Applications. -Idvision:v23.08.00155 +Idvision:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/vision/operations/index.md b/docs/google-docs/providers/google/vision/operations/index.md index a0785195fc..af61a7e6ea 100644 --- a/docs/google-docs/providers/google/vision/operations/index.md +++ b/docs/google-docs/providers/google/vision/operations/index.md @@ -27,13 +27,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| | `operations_list` | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `operations_delete` | `DELETE` | `operationsId` | 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`. | +| `_operations_list` | `EXEC` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `locations_operations_get` | `EXEC` | `locationsId, operationsId` | 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. | | `operations_cancel` | `EXEC` | `operationsId` | 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`. | | `operations_get` | `EXEC` | `operationsId` | 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. | diff --git a/docs/google-docs/providers/google/vision/product_sets/index.md b/docs/google-docs/providers/google/vision/product_sets/index.md index 293813d1eb..b93bd87ee5 100644 --- a/docs/google-docs/providers/google/vision/product_sets/index.md +++ b/docs/google-docs/providers/google/vision/product_sets/index.md @@ -27,8 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `productSets` | `array` | List of ProductSets. | +| `name` | `string` | The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet. | +| `displayName` | `string` | The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long. | +| `indexError` | `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). | +| `indexTime` | `string` | Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -36,5 +38,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_product_sets_list` | `SELECT` | `locationsId, projectsId` | Lists ProductSets in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1. | | `projects_locations_product_sets_create` | `INSERT` | `locationsId, projectsId` | Creates and returns a new ProductSet resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters. | | `projects_locations_product_sets_delete` | `DELETE` | `locationsId, productSetsId, projectsId` | Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted. The actual image files are not deleted from Google Cloud Storage. | +| `_projects_locations_product_sets_list` | `EXEC` | `locationsId, projectsId` | Lists ProductSets in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1. | | `projects_locations_product_sets_import` | `EXEC` | `locationsId, projectsId` | Asynchronous API that imports a list of reference images to specified product sets based on a list of image information. The google.longrunning.Operation API can be used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) `Operation.response` contains `ImportProductSetsResponse`. (results) The input source of this method is a csv file on Google Cloud Storage. For the format of the csv file please see ImportProductSetsGcsSource.csv_file_uri. | | `projects_locations_product_sets_patch` | `EXEC` | `locationsId, productSetsId, projectsId` | Makes changes to a ProductSet resource. Only display_name can be updated currently. Possible errors: * Returns NOT_FOUND if the ProductSet does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but missing from the request or longer than 4096 characters. | diff --git a/docs/google-docs/providers/google/vision/products/index.md b/docs/google-docs/providers/google/vision/products/index.md index 59f7f1a52e..daac9fa432 100644 --- a/docs/google-docs/providers/google/vision/products/index.md +++ b/docs/google-docs/providers/google/vision/products/index.md @@ -27,8 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `products` | `array` | The list of Products. | +| `name` | `string` | The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. | +| `description` | `string` | User-provided metadata to be stored with this product. Must be at most 4096 characters long. | +| `productCategory` | `string` | Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. | +| `productLabels` | `array` | Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. | +| `displayName` | `string` | The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,5 +40,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_products_list` | `SELECT` | `locationsId, projectsId` | Lists products in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. | | `projects_locations_products_create` | `INSERT` | `locationsId, projectsId` | Creates and returns a new product resource. Possible errors: * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is missing or invalid. | | `projects_locations_products_delete` | `DELETE` | `locationsId, productsId, projectsId` | Permanently deletes a product and its reference images. Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work until all related caches are refreshed. | +| `_projects_locations_product_sets_products_list` | `EXEC` | `locationsId, productSetsId, projectsId` | Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. | +| `_projects_locations_products_list` | `EXEC` | `locationsId, projectsId` | Lists products in an unspecified order. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. | | `projects_locations_products_patch` | `EXEC` | `locationsId, productsId, projectsId` | Makes changes to a Product resource. Only the `display_name`, `description`, and `labels` fields can be updated right now. If labels are updated, the change will not be reflected in queries until the next index time. Possible errors: * Returns NOT_FOUND if the Product does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but is missing from the request or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is present in update_mask but is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is present in update_mask. | | `projects_locations_products_purge` | `EXEC` | `locationsId, projectsId` | Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet. If a Product is a member of the specified ProductSet in addition to other ProductSets, the Product will still be deleted. It is recommended to not delete the specified ProductSet until after this operation has completed. It is also recommended to not add any of the Products involved in the batch delete to a new ProductSet while this operation is running because those Products may still end up deleted. It's not possible to undo the PurgeProducts operation. Therefore, it is recommended to keep the csv files used in ImportProductSets (if that was how you originally built the Product Set) before starting PurgeProducts, in case you need to re-import the data after deletion. If the plan is to purge all of the Products from a ProductSet and then re-use the empty ProductSet to re-import new Products into the empty ProductSet, you must wait until the PurgeProducts operation has finished for that ProductSet. The google.longrunning.Operation API can be used to keep track of the progress and results of the request. `Operation.metadata` contains `BatchOperationMetadata`. (progress) | diff --git a/docs/google-docs/providers/google/vision/reference_images/index.md b/docs/google-docs/providers/google/vision/reference_images/index.md index ccd8639b0c..193579914e 100644 --- a/docs/google-docs/providers/google/vision/reference_images/index.md +++ b/docs/google-docs/providers/google/vision/reference_images/index.md @@ -37,3 +37,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_products_reference_images_list` | `SELECT` | `locationsId, productsId, projectsId` | Lists reference images. Possible errors: * Returns NOT_FOUND if the parent product does not exist. * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less than 1. | | `projects_locations_products_reference_images_create` | `INSERT` | `locationsId, productsId, projectsId` | Creates and returns a new ReferenceImage resource. The `bounding_poly` field is optional. If `bounding_poly` is not specified, the system will try to detect regions of interest in the image that are compatible with the product_category on the parent product. If it is specified, detection is ALWAYS skipped. The system converts polygons into non-rotated rectangles. Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP). Possible errors: * Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if the product does not exist. * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected. * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons. | | `projects_locations_products_reference_images_delete` | `DELETE` | `locationsId, productsId, projectsId, referenceImagesId` | Permanently deletes a reference image. The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed. The actual image files are not deleted from Google Cloud Storage. | +| `_projects_locations_products_reference_images_list` | `EXEC` | `locationsId, productsId, projectsId` | Lists reference images. Possible errors: * Returns NOT_FOUND if the parent product does not exist. * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less than 1. | diff --git a/docs/google-docs/providers/google/vmmigration/clone_jobs/index.md b/docs/google-docs/providers/google/vmmigration/clone_jobs/index.md index e07ef5f35b..ff85da7c66 100644 --- a/docs/google-docs/providers/google/vmmigration/clone_jobs/index.md +++ b/docs/google-docs/providers/google/vmmigration/clone_jobs/index.md @@ -27,13 +27,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Output only. Locations that could not be reached. | -| `cloneJobs` | `array` | Output only. The list of clone jobs response. | -| `nextPageToken` | `string` | Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `name` | `string` | Output only. The name of the clone. | +| `stateTime` | `string` | Output only. The time the state was last updated. | +| `steps` | `array` | Output only. The clone steps list representing its progress. | +| `computeEngineDisksTargetDetails` | `object` | ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. | +| `computeEngineTargetDetails` | `object` | ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. | +| `endTime` | `string` | Output only. The time the clone job was ended. | +| `state` | `string` | Output only. State of the clone job. | +| `createTime` | `string` | Output only. The time the clone job was created (as an API call, not when it was actually created in the target). | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `cloneJobsId, locationsId, migratingVmsId, projectsId, sourcesId` | Gets details of a single CloneJob. | | `list` | `SELECT` | `locationsId, migratingVmsId, projectsId, sourcesId` | Lists CloneJobs of a given migrating VM. | | `create` | `INSERT` | `locationsId, migratingVmsId, projectsId, sourcesId` | Initiates a Clone of a specific migrating VM. | +| `_list` | `EXEC` | `locationsId, migratingVmsId, projectsId, sourcesId` | Lists CloneJobs of a given migrating VM. | | `cancel` | `EXEC` | `cloneJobsId, locationsId, migratingVmsId, projectsId, sourcesId` | Initiates the cancellation of a running clone job. | diff --git a/docs/google-docs/providers/google/vmmigration/cutover_jobs/index.md b/docs/google-docs/providers/google/vmmigration/cutover_jobs/index.md index 7a6df6a607..79e60f5f5f 100644 --- a/docs/google-docs/providers/google/vmmigration/cutover_jobs/index.md +++ b/docs/google-docs/providers/google/vmmigration/cutover_jobs/index.md @@ -27,13 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `cutoverJobs` | `array` | Output only. The list of cutover jobs response. | -| `nextPageToken` | `string` | Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `unreachable` | `array` | Output only. Locations that could not be reached. | +| `name` | `string` | Output only. The name of the cutover job. | +| `createTime` | `string` | Output only. The time the cutover job was created (as an API call, not when it was actually created in the target). | +| `progressPercent` | `integer` | Output only. The current progress in percentage of the cutover job. | +| `state` | `string` | Output only. State of the cutover job. | +| `steps` | `array` | Output only. The cutover steps list representing its progress. | +| `stateTime` | `string` | Output only. The time the state was last updated. | +| `endTime` | `string` | Output only. The time the cutover job had finished. | +| `error` | `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). | +| `computeEngineDisksTargetDetails` | `object` | ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. | +| `stateMessage` | `string` | Output only. A message providing possible extra details about the current state. | +| `computeEngineTargetDetails` | `object` | ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `cutoverJobsId, locationsId, migratingVmsId, projectsId, sourcesId` | Gets details of a single CutoverJob. | | `list` | `SELECT` | `locationsId, migratingVmsId, projectsId, sourcesId` | Lists CutoverJobs of a given migrating VM. | | `create` | `INSERT` | `locationsId, migratingVmsId, projectsId, sourcesId` | Initiates a Cutover of a specific migrating VM. The returned LRO is completed when the cutover job resource is created and the job is initiated. | +| `_list` | `EXEC` | `locationsId, migratingVmsId, projectsId, sourcesId` | Lists CutoverJobs of a given migrating VM. | | `cancel` | `EXEC` | `cutoverJobsId, locationsId, migratingVmsId, projectsId, sourcesId` | Initiates the cancellation of a running cutover job. | diff --git a/docs/google-docs/providers/google/vmmigration/datacenter_connectors/index.md b/docs/google-docs/providers/google/vmmigration/datacenter_connectors/index.md index 72f32cc12b..feb030fc51 100644 --- a/docs/google-docs/providers/google/vmmigration/datacenter_connectors/index.md +++ b/docs/google-docs/providers/google/vmmigration/datacenter_connectors/index.md @@ -27,9 +27,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `datacenterConnectors` | `array` | Output only. The list of sources response. | -| `nextPageToken` | `string` | Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `unreachable` | `array` | Output only. Locations that could not be reached. | +| `name` | `string` | Output only. The connector's name. | +| `state` | `string` | Output only. State of the DatacenterConnector, as determined by the health checks. | +| `version` | `string` | The version running in the DatacenterConnector. This is supplied by the OVA connector during the registration process and can not be modified. | +| `serviceAccount` | `string` | The service account to use in the connector when communicating with the cloud. | +| `upgradeStatus` | `object` | UpgradeStatus contains information about upgradeAppliance operation. | +| `registrationId` | `string` | Immutable. A unique key for this connector. This key is internal to the OVA connector and is supplied with its creation during the registration process and can not be modified. | +| `updateTime` | `string` | Output only. The last time the connector was updated with an API call. | +| `availableVersions` | `object` | Holds informatiom about the available versions for upgrade. | +| `error` | `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). | +| `stateTime` | `string` | Output only. The time the state was last set. | +| `applianceInfrastructureVersion` | `string` | Output only. Appliance OVA version. This is the OVA which is manually installed by the user and contains the infrastructure for the automatically updatable components on the appliance. | +| `applianceSoftwareVersion` | `string` | Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance. | +| `bucket` | `string` | Output only. The communication channel between the datacenter connector and Google Cloud. | +| `createTime` | `string` | Output only. The time the connector was created (as an API call, not when it was actually installed). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +48,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId, sourcesId` | Lists DatacenterConnectors in a given Source. | | `create` | `INSERT` | `locationsId, projectsId, sourcesId` | Creates a new DatacenterConnector in a given Source. | | `delete` | `DELETE` | `datacenterConnectorsId, locationsId, projectsId, sourcesId` | Deletes a single DatacenterConnector. | +| `_list` | `EXEC` | `locationsId, projectsId, sourcesId` | Lists DatacenterConnectors in a given Source. | | `upgrade_appliance` | `EXEC` | `datacenterConnectorsId, locationsId, projectsId, sourcesId` | Upgrades the appliance relate to this DatacenterConnector to the in-place updateable version. | diff --git a/docs/google-docs/providers/google/vmmigration/groups/index.md b/docs/google-docs/providers/google/vmmigration/groups/index.md index 31a72e150e..3fd8c0b22c 100644 --- a/docs/google-docs/providers/google/vmmigration/groups/index.md +++ b/docs/google-docs/providers/google/vmmigration/groups/index.md @@ -40,4 +40,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists Groups in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new Group in a given project and location. | | `delete` | `DELETE` | `groupsId, locationsId, projectsId` | Deletes a single Group. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Groups in a given project and location. | | `patch` | `EXEC` | `groupsId, locationsId, projectsId` | Updates the parameters of a single Group. | diff --git a/docs/google-docs/providers/google/vmmigration/index.md b/docs/google-docs/providers/google/vmmigration/index.md index b60887e95a..1e460d0246 100644 --- a/docs/google-docs/providers/google/vmmigration/index.md +++ b/docs/google-docs/providers/google/vmmigration/index.md @@ -21,7 +21,7 @@ Use The Migrate To Virtual Machines API To Programmatically Migrate Workloads.
total resources: 13
total selectable resources: 11
-total methods: 52
+total methods: 63
@@ -33,7 +33,7 @@ Use The Migrate To Virtual Machines API To Programmatically Migrate Workloads. TypeService TitleVM Migration API DescriptionUse The Migrate To Virtual Machines API To Programmatically Migrate Workloads. -Idvmmigration:v23.08.00155 +Idvmmigration:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/vmmigration/locations/index.md b/docs/google-docs/providers/google/vmmigration/locations/index.md index ee32c27778..aa065ddbf9 100644 --- a/docs/google-docs/providers/google/vmmigration/locations/index.md +++ b/docs/google-docs/providers/google/vmmigration/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/vmmigration/migrating_vms/index.md b/docs/google-docs/providers/google/vmmigration/migrating_vms/index.md index c64c264127..4be85e59c3 100644 --- a/docs/google-docs/providers/google/vmmigration/migrating_vms/index.md +++ b/docs/google-docs/providers/google/vmmigration/migrating_vms/index.md @@ -27,9 +27,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `migratingVms` | `array` | Output only. The list of Migrating VMs response. | -| `nextPageToken` | `string` | Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `unreachable` | `array` | Output only. Locations that could not be reached. | +| `name` | `string` | Output only. The identifier of the MigratingVm. | +| `description` | `string` | The description attached to the migrating VM by the user. | +| `computeEngineTargetDefaults` | `object` | ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. | +| `cutoverForecast` | `object` | CutoverForecast holds information about future CutoverJobs of a MigratingVm. | +| `displayName` | `string` | The display name attached to the MigratingVm by the user. | +| `group` | `string` | Output only. The group this migrating vm is included in, if any. The group is represented by the full path of the appropriate Group resource. | +| `computeEngineDisksTargetDefaults` | `object` | ComputeEngineDisksTargetDefaults is a collection of details for creating Persistent Disks in a target Compute Engine project. | +| `labels` | `object` | The labels of the migrating VM. | +| `recentCutoverJobs` | `array` | Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. | +| `stateTime` | `string` | Output only. The last time the migrating VM state was updated. | +| `createTime` | `string` | Output only. The time the migrating VM was created (this refers to this resource and not to the time it was installed in the source). | +| `awsSourceVmDetails` | `object` | Represent the source AWS VM details. | +| `lastReplicationCycle` | `object` | ReplicationCycle contains information about the current replication cycle status. | +| `recentCloneJobs` | `array` | Output only. The recent clone jobs performed on the migrating VM. This field holds the vm's last completed clone job and the vm's running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. | +| `state` | `string` | Output only. State of the MigratingVm. | +| `updateTime` | `string` | Output only. The last time the migrating VM resource was updated. | +| `currentSyncInfo` | `object` | ReplicationCycle contains information about the current replication cycle status. | +| `lastSync` | `object` | ReplicationSync contain information about the last replica sync to the cloud. | +| `sourceVmId` | `string` | The unique ID of the VM in the source. The VM's name in vSphere can be changed, so this is not the VM's name but rather its moRef id. This id is of the form vm-. | +| `policy` | `object` | A policy for scheduling replications. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +55,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId, sourcesId` | Lists MigratingVms in a given Source. | | `create` | `INSERT` | `locationsId, projectsId, sourcesId` | Creates a new MigratingVm in a given Source. | | `delete` | `DELETE` | `locationsId, migratingVmsId, projectsId, sourcesId` | Deletes a single MigratingVm. | +| `_list` | `EXEC` | `locationsId, projectsId, sourcesId` | Lists MigratingVms in a given Source. | | `finalize_migration` | `EXEC` | `locationsId, migratingVmsId, projectsId, sourcesId` | Marks a migration as completed, deleting migration resources that are no longer being used. Only applicable after cutover is done. | | `patch` | `EXEC` | `locationsId, migratingVmsId, projectsId, sourcesId` | Updates the parameters of a single MigratingVm. | | `pause_migration` | `EXEC` | `locationsId, migratingVmsId, projectsId, sourcesId` | Pauses a migration for a VM. If cycle tasks are running they will be cancelled, preserving source task data. Further replication cycles will not be triggered while the VM is paused. | diff --git a/docs/google-docs/providers/google/vmmigration/operations/index.md b/docs/google-docs/providers/google/vmmigration/operations/index.md index 05ab841ca5..13fcfee184 100644 --- a/docs/google-docs/providers/google/vmmigration/operations/index.md +++ b/docs/google-docs/providers/google/vmmigration/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/vmmigration/replication_cycles/index.md b/docs/google-docs/providers/google/vmmigration/replication_cycles/index.md index 77c283240c..6248375351 100644 --- a/docs/google-docs/providers/google/vmmigration/replication_cycles/index.md +++ b/docs/google-docs/providers/google/vmmigration/replication_cycles/index.md @@ -27,11 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `replicationCycles` | `array` | Output only. The list of replication cycles response. | -| `unreachable` | `array` | Output only. Locations that could not be reached. | +| `name` | `string` | The identifier of the ReplicationCycle. | +| `progressPercent` | `integer` | The current progress in percentage of this cycle. Was replaced by 'steps' field, which breaks down the cycle progression more accurately. | +| `totalPauseDuration` | `string` | The accumulated duration the replication cycle was paused. | +| `error` | `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). | +| `cycleNumber` | `integer` | The cycle's ordinal number. | +| `state` | `string` | State of the ReplicationCycle. | +| `steps` | `array` | The cycle's steps list representing its progress. | +| `endTime` | `string` | The time the replication cycle has ended. | +| `startTime` | `string` | The time the replication cycle has started. | +| `warnings` | `array` | Output only. Warnings that occurred during the cycle. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, migratingVmsId, projectsId, replicationCyclesId, sourcesId` | Gets details of a single ReplicationCycle. | | `list` | `SELECT` | `locationsId, migratingVmsId, projectsId, sourcesId` | Lists ReplicationCycles in a given MigratingVM. | +| `_list` | `EXEC` | `locationsId, migratingVmsId, projectsId, sourcesId` | Lists ReplicationCycles in a given MigratingVM. | diff --git a/docs/google-docs/providers/google/vmmigration/sources/index.md b/docs/google-docs/providers/google/vmmigration/sources/index.md index a7cdf39984..cc32d48f0a 100644 --- a/docs/google-docs/providers/google/vmmigration/sources/index.md +++ b/docs/google-docs/providers/google/vmmigration/sources/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `sources` | `array` | Output only. The list of sources response. | -| `unreachable` | `array` | Output only. Locations that could not be reached. | +| `name` | `string` | Output only. The Source name. | +| `description` | `string` | User-provided description of the source. | +| `labels` | `object` | The labels of the source. | +| `updateTime` | `string` | Output only. The update time timestamp. | +| `vmware` | `object` | VmwareSourceDetails message describes a specific source details for the vmware source type. | +| `aws` | `object` | AwsSourceDetails message describes a specific source details for the AWS source type. | +| `createTime` | `string` | Output only. The create time timestamp. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +41,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists Sources in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new Source in a given project and location. | | `delete` | `DELETE` | `locationsId, projectsId, sourcesId` | Deletes a single Source. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Sources in a given project and location. | | `patch` | `EXEC` | `locationsId, projectsId, sourcesId` | Updates the parameters of a single Source. | diff --git a/docs/google-docs/providers/google/vmmigration/target_projects/index.md b/docs/google-docs/providers/google/vmmigration/target_projects/index.md index 10a462873c..ee528f2599 100644 --- a/docs/google-docs/providers/google/vmmigration/target_projects/index.md +++ b/docs/google-docs/providers/google/vmmigration/target_projects/index.md @@ -27,9 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `targetProjects` | `array` | Output only. The list of target response. | -| `unreachable` | `array` | Output only. Locations that could not be reached. | +| `name` | `string` | Output only. The name of the target project. | +| `description` | `string` | The target project's description. | +| `project` | `string` | The target project ID (number) or project name. | +| `updateTime` | `string` | Output only. The last time the target project resource was updated. | +| `createTime` | `string` | Output only. The time this target project resource was created (not related to when the Compute Engine project it points to was created). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +39,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists TargetProjects in a given project. NOTE: TargetProject is a global resource; hence the only supported value for location is `global`. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new TargetProject in a given project. NOTE: TargetProject is a global resource; hence the only supported value for location is `global`. | | `delete` | `DELETE` | `locationsId, projectsId, targetProjectsId` | Deletes a single TargetProject. NOTE: TargetProject is a global resource; hence the only supported value for location is `global`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists TargetProjects in a given project. NOTE: TargetProject is a global resource; hence the only supported value for location is `global`. | | `patch` | `EXEC` | `locationsId, projectsId, targetProjectsId` | Updates the parameters of a single TargetProject. NOTE: TargetProject is a global resource; hence the only supported value for location is `global`. | diff --git a/docs/google-docs/providers/google/vmmigration/utilization_reports/index.md b/docs/google-docs/providers/google/vmmigration/utilization_reports/index.md index 9bb7e8e6cd..af140237af 100644 --- a/docs/google-docs/providers/google/vmmigration/utilization_reports/index.md +++ b/docs/google-docs/providers/google/vmmigration/utilization_reports/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The report unique name. | +| `state` | `string` | Output only. Current state of the report. | +| `frameEndTime` | `string` | Output only. The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frame_end_time" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14. | | `stateTime` | `string` | Output only. The time the state was last set. | -| `vms` | `array` | List of utilization information per VM. When sent as part of the request, the "vm_id" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored. | | `timeFrame` | `string` | Time frame of the report. | +| `vms` | `array` | List of utilization information per VM. When sent as part of the request, the "vm_id" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored. | +| `createTime` | `string` | Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed). | | `vmCount` | `integer` | Output only. Total number of VMs included in the report. | | `displayName` | `string` | The report display name, as assigned by the user. | | `error` | `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). | -| `createTime` | `string` | Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed). | -| `frameEndTime` | `string` | Output only. The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frame_end_time" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14. | -| `state` | `string` | Output only. Current state of the report. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,3 +44,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId, sourcesId` | Lists Utilization Reports of the given Source. | | `create` | `INSERT` | `locationsId, projectsId, sourcesId` | Creates a new UtilizationReport. | | `delete` | `DELETE` | `locationsId, projectsId, sourcesId, utilizationReportsId` | Deletes a single Utilization Report. | +| `_list` | `EXEC` | `locationsId, projectsId, sourcesId` | Lists Utilization Reports of the given Source. | diff --git a/docs/google-docs/providers/google/vpcaccess/connectors/index.md b/docs/google-docs/providers/google/vpcaccess/connectors/index.md index 2e5960ba7a..57e2c71118 100644 --- a/docs/google-docs/providers/google/vpcaccess/connectors/index.md +++ b/docs/google-docs/providers/google/vpcaccess/connectors/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name in the format `projects/*/locations/*/connectors/*`. | +| `machineType` | `string` | Machine type of VM Instance underlying connector. Default is e2-micro | | `maxThroughput` | `integer` | Maximum throughput of the connector in Mbps. Default is 300, max is 1000. | +| `minThroughput` | `integer` | Minimum throughput of the connector in Mbps. Default and min is 200. | +| `network` | `string` | Name of a VPC network. | | `subnet` | `object` | The subnet in which to house the connector | -| `machineType` | `string` | Machine type of VM Instance underlying connector. Default is e2-micro | | `connectedProjects` | `array` | Output only. List of projects using the connector. | -| `ipCidrRange` | `string` | The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`. | -| `maxInstances` | `integer` | Maximum value of instances in autoscaling group underlying the connector. | | `minInstances` | `integer` | Minimum value of instances in autoscaling group underlying the connector. | -| `minThroughput` | `integer` | Minimum throughput of the connector in Mbps. Default and min is 200. | | `state` | `string` | Output only. State of the VPC access connector. | -| `network` | `string` | Name of a VPC network. | +| `ipCidrRange` | `string` | The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`. | +| `maxInstances` | `integer` | Maximum value of instances in autoscaling group underlying the connector. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -45,4 +45,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists Serverless VPC Access connectors. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a Serverless VPC Access connector, returns an operation. | | `delete` | `DELETE` | `connectorsId, locationsId, projectsId` | Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Serverless VPC Access connectors. | | `patch` | `EXEC` | `connectorsId, locationsId, projectsId` | Updates a Serverless VPC Access connector, returns an operation. | diff --git a/docs/google-docs/providers/google/vpcaccess/index.md b/docs/google-docs/providers/google/vpcaccess/index.md index 721666ec0a..7a533bf787 100644 --- a/docs/google-docs/providers/google/vpcaccess/index.md +++ b/docs/google-docs/providers/google/vpcaccess/index.md @@ -21,7 +21,7 @@ API For Managing VPC Access Connectors.
total resources: 3
total selectable resources: 3
-total methods: 8
+total methods: 11
@@ -33,7 +33,7 @@ API For Managing VPC Access Connectors. TypeService TitleServerless VPC Access API DescriptionAPI For Managing VPC Access Connectors. -Idvpcaccess:v23.08.00155 +Idvpcaccess:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/vpcaccess/locations/index.md b/docs/google-docs/providers/google/vpcaccess/locations/index.md index 4c32a06f41..7969b88d4b 100644 --- a/docs/google-docs/providers/google/vpcaccess/locations/index.md +++ b/docs/google-docs/providers/google/vpcaccess/locations/index.md @@ -27,9 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `projectsId` | +| `_list` | `EXEC` | `projectsId` | diff --git a/docs/google-docs/providers/google/vpcaccess/operations/index.md b/docs/google-docs/providers/google/vpcaccess/operations/index.md index b45e3dd7cc..cce181b563 100644 --- a/docs/google-docs/providers/google/vpcaccess/operations/index.md +++ b/docs/google-docs/providers/google/vpcaccess/operations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | diff --git a/docs/google-docs/providers/google/webrisk/index.md b/docs/google-docs/providers/google/webrisk/index.md index b9271431a4..d4c70c40d9 100644 --- a/docs/google-docs/providers/google/webrisk/index.md +++ b/docs/google-docs/providers/google/webrisk/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 5
total selectable resources: 1
-total methods: 8
+total methods: 9
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleWeb Risk API Description -Idwebrisk:v23.08.00155 +Idwebrisk:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/webrisk/operations/index.md b/docs/google-docs/providers/google/webrisk/operations/index.md index b68c66d1fc..f79383e2fe 100644 --- a/docs/google-docs/providers/google/webrisk/operations/index.md +++ b/docs/google-docs/providers/google/webrisk/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `operations` | `array` | A list of operations that matches the specified filter in the request. | +| `name` | `string` | Matches the `/v1/{project-name}/operations/{operation-id}` pattern. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `object` | Contains a `SubmitUriMetadata` object. | +| `response` | `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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operationsId, projectsId` | 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. | | `list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/websecurityscanner/crawled_urls/index.md b/docs/google-docs/providers/google/websecurityscanner/crawled_urls/index.md index 31e5e8f2ba..f1ae409db7 100644 --- a/docs/google-docs/providers/google/websecurityscanner/crawled_urls/index.md +++ b/docs/google-docs/providers/google/websecurityscanner/crawled_urls/index.md @@ -27,9 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `crawledUrls` | `array` | The list of CrawledUrls returned. | +| `body` | `string` | Output only. The body of the request that was used to visit the URL. | +| `httpMethod` | `string` | Output only. The http method of the request that was used to visit the URL, in uppercase. | +| `url` | `string` | Output only. The URL that was crawled. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `projectsId, scanConfigsId, scanRunsId` | +| `_list` | `EXEC` | `projectsId, scanConfigsId, scanRunsId` | diff --git a/docs/google-docs/providers/google/websecurityscanner/findings/index.md b/docs/google-docs/providers/google/websecurityscanner/findings/index.md index 2c136cba27..4a43d66d7d 100644 --- a/docs/google-docs/providers/google/websecurityscanner/findings/index.md +++ b/docs/google-docs/providers/google/websecurityscanner/findings/index.md @@ -27,10 +27,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `findings` | `array` | The list of Findings returned. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Output only. The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system. | +| `description` | `string` | Output only. The description of the vulnerability. | +| `vulnerableHeaders` | `object` | Information about vulnerable or missing HTTP Headers. | +| `severity` | `string` | Output only. The severity level of the reported vulnerability. | +| `form` | `object` | ! Information about a vulnerability with an HTML. | +| `body` | `string` | Output only. The body of the request that triggered the vulnerability. | +| `xss` | `object` | Information reported for an XSS. | +| `outdatedLibrary` | `object` | Information reported for an outdated library. | +| `httpMethod` | `string` | Output only. The http method of the request that triggered the vulnerability, in uppercase. | +| `violatingResource` | `object` | Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. | +| `frameUrl` | `string` | Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. | +| `finalUrl` | `string` | Output only. The URL where the browser lands when the vulnerability is detected. | +| `reproductionUrl` | `string` | Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability. | +| `vulnerableParameters` | `object` | Information about vulnerable request parameters. | +| `trackingId` | `string` | Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. | +| `findingType` | `string` | Output only. The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings | +| `xxe` | `object` | Information reported for an XXE. | +| `fuzzedUrl` | `string` | Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `findingsId, projectsId, scanConfigsId, scanRunsId` | Gets a Finding. | | `list` | `SELECT` | `projectsId, scanConfigsId, scanRunsId` | List Findings under a given ScanRun. | +| `_list` | `EXEC` | `projectsId, scanConfigsId, scanRunsId` | List Findings under a given ScanRun. | diff --git a/docs/google-docs/providers/google/websecurityscanner/index.md b/docs/google-docs/providers/google/websecurityscanner/index.md index c233a9965f..eeb8eb2a9d 100644 --- a/docs/google-docs/providers/google/websecurityscanner/index.md +++ b/docs/google-docs/providers/google/websecurityscanner/index.md @@ -21,7 +21,7 @@ Scans Your Compute And App Engine Apps For Common Web Vulnerabilities.
total resources: 5
total selectable resources: 5
-total methods: 13
+total methods: 17
@@ -33,7 +33,7 @@ Scans Your Compute And App Engine Apps For Common Web Vulnerabilities. TypeService TitleWeb Security Scanner API DescriptionScans Your Compute And App Engine Apps For Common Web Vulnerabilities. -Idwebsecurityscanner:v23.08.00155 +Idwebsecurityscanner:v23.08.00157 ## Resources 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 82e0030e39..3075b42e22 100644 --- a/docs/google-docs/providers/google/websecurityscanner/scan_configs/index.md +++ b/docs/google-docs/providers/google/websecurityscanner/scan_configs/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. | -| `authentication` | `object` | Scan authentication configuration. | -| `userAgent` | `string` | The user agent used during scanning. | -| `blacklistPatterns` | `array` | The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls | -| `riskLevel` | `string` | The risk level selected for the scan | -| `displayName` | `string` | Required. The user provided display name of the ScanConfig. | | `ignoreHttpStatusErrors` | `boolean` | Whether to keep scanning even if most requests return HTTP error codes. | -| `exportToSecurityCommandCenter` | `string` | Controls export of scan configurations and results to Security Command Center. | | `schedule` | `object` | Scan schedule configuration. | -| `staticIpScan` | `boolean` | Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses. | | `startingUrls` | `array` | Required. The starting URLs from which the scanner finds site pages. | -| `maxQps` | `integer` | The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. | +| `blacklistPatterns` | `array` | The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls | +| `exportToSecurityCommandCenter` | `string` | Controls export of scan configurations and results to Security Command Center. | +| `userAgent` | `string` | The user agent used during scanning. | | `managedScan` | `boolean` | Whether the scan config is managed by Web Security Scanner, output only. | +| `staticIpScan` | `boolean` | Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses. | +| `authentication` | `object` | Scan authentication configuration. | +| `maxQps` | `integer` | The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. | +| `displayName` | `string` | Required. The user provided display name of the ScanConfig. | +| `riskLevel` | `string` | The risk level selected for the scan | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,5 +47,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `projectsId` | Lists ScanConfigs under a given project. | | `create` | `INSERT` | `projectsId` | Creates a new ScanConfig. | | `delete` | `DELETE` | `projectsId, scanConfigsId` | Deletes an existing ScanConfig and its child resources. | +| `_list` | `EXEC` | `projectsId` | Lists ScanConfigs under a given project. | | `patch` | `EXEC` | `projectsId, scanConfigsId` | Updates a ScanConfig. This method support partial update of a ScanConfig. | | `start` | `EXEC` | `projectsId, scanConfigsId` | Start a ScanRun according to the given ScanConfig. | diff --git a/docs/google-docs/providers/google/websecurityscanner/scan_runs/index.md b/docs/google-docs/providers/google/websecurityscanner/scan_runs/index.md index ce80683b9a..651763e31b 100644 --- a/docs/google-docs/providers/google/websecurityscanner/scan_runs/index.md +++ b/docs/google-docs/providers/google/websecurityscanner/scan_runs/index.md @@ -28,19 +28,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. | -| `executionState` | `string` | Output only. The execution state of the ScanRun. | | `hasVulnerabilities` | `boolean` | Output only. Whether the scan run has found any vulnerabilities. | -| `progressPercent` | `integer` | Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. | -| `startTime` | `string` | Output only. The time at which the ScanRun started. | -| `urlsCrawledCount` | `string` | Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. | -| `warningTraces` | `array` | Output only. A list of warnings, if such are encountered during this scan run. | -| `endTime` | `string` | Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. | | `resultState` | `string` | Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". | +| `executionState` | `string` | Output only. The execution state of the ScanRun. | +| `warningTraces` | `array` | Output only. A list of warnings, if such are encountered during this scan run. | +| `progressPercent` | `integer` | Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. | | `errorTrace` | `object` | Output only. Defines an error trace message for a ScanRun. | | `urlsTestedCount` | `string` | Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. | +| `endTime` | `string` | Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. | +| `startTime` | `string` | Output only. The time at which the ScanRun started. | +| `urlsCrawledCount` | `string` | Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `projectsId, scanConfigsId, scanRunsId` | Gets a ScanRun. | | `list` | `SELECT` | `projectsId, scanConfigsId` | Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time. | +| `_list` | `EXEC` | `projectsId, scanConfigsId` | Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time. | | `stop` | `EXEC` | `projectsId, scanConfigsId, scanRunsId` | Stops a ScanRun. The stopped ScanRun is returned. | diff --git a/docs/google-docs/providers/google/workflowexecutions/executions/index.md b/docs/google-docs/providers/google/workflowexecutions/executions/index.md index db4083aad4..35aaf03972 100644 --- a/docs/google-docs/providers/google/workflowexecutions/executions/index.md +++ b/docs/google-docs/providers/google/workflowexecutions/executions/index.md @@ -27,12 +27,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `executions` | `array` | The executions which match the request. | +| `name` | `string` | Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} | +| `status` | `object` | Represents the current status of this execution. | +| `workflowRevisionId` | `string` | Output only. Revision of the workflow this execution is using. | +| `labels` | `object` | Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. | +| `state` | `string` | Output only. Current state of the execution. | +| `callLogLevel` | `string` | The call logging level associated to this execution. | +| `startTime` | `string` | Output only. Marks the beginning of execution. | +| `error` | `object` | Error describes why the execution was abnormally terminated. | +| `argument` | `string` | Input parameters of the execution represented as a JSON string. The size limit is 32KB. *Note*: If you are using the REST API directly to run your workflow, you must escape any JSON string value of `argument`. Example: `'{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'` | +| `duration` | `string` | Output only. Measures the duration of the execution. | +| `stateError` | `object` | Describes an error related to the current state of the Execution resource. | +| `endTime` | `string` | Output only. Marks the end of execution, successful or not. | +| `result` | `string` | Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is `SUCCEEDED`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `executionsId, locationsId, projectsId, workflowsId` | Returns an execution of the given name. | | `list` | `SELECT` | `locationsId, projectsId, workflowsId` | Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first). | | `create` | `INSERT` | `locationsId, projectsId, workflowsId` | Creates a new execution using the latest revision of the given workflow. | +| `_list` | `EXEC` | `locationsId, projectsId, workflowsId` | Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first). | | `cancel` | `EXEC` | `executionsId, locationsId, projectsId, workflowsId` | Cancels an execution of the given name. | diff --git a/docs/google-docs/providers/google/workflowexecutions/index.md b/docs/google-docs/providers/google/workflowexecutions/index.md index 2d4ce2edb6..90c6713a09 100644 --- a/docs/google-docs/providers/google/workflowexecutions/index.md +++ b/docs/google-docs/providers/google/workflowexecutions/index.md @@ -21,7 +21,7 @@ Execute Workflows Created With Workflows API.
total resources: 2
total selectable resources: 1
-total methods: 5
+total methods: 6
@@ -33,7 +33,7 @@ Execute Workflows Created With Workflows API. TypeService TitleWorkflow Executions API DescriptionExecute Workflows Created With Workflows API. -Idworkflowexecutions:v23.08.00155 +Idworkflowexecutions:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/workflows/index.md b/docs/google-docs/providers/google/workflows/index.md index f7121dcaa8..ea1bfe87db 100644 --- a/docs/google-docs/providers/google/workflows/index.md +++ b/docs/google-docs/providers/google/workflows/index.md @@ -21,7 +21,7 @@ Manage Workflow Definitions. To Execute Workflows And Manage Executions, See The
total resources: 3
total selectable resources: 3
-total methods: 10
+total methods: 13
@@ -33,7 +33,7 @@ Manage Workflow Definitions. To Execute Workflows And Manage Executions, See The TypeService TitleWorkflows API DescriptionManage Workflow Definitions. To Execute Workflows And Manage Executions, See The Workflows Executions API. -Idworkflows:v23.08.00155 +Idworkflows:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/workflows/locations/index.md b/docs/google-docs/providers/google/workflows/locations/index.md index 19279a1f4a..abfa76ce21 100644 --- a/docs/google-docs/providers/google/workflows/locations/index.md +++ b/docs/google-docs/providers/google/workflows/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `locations` | `array` | A list of locations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/workflows/operations/index.md b/docs/google-docs/providers/google/workflows/operations/index.md index e42b36809d..b97c3a2c7b 100644 --- a/docs/google-docs/providers/google/workflows/operations/index.md +++ b/docs/google-docs/providers/google/workflows/operations/index.md @@ -27,11 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | diff --git a/docs/google-docs/providers/google/workflows/workflows/index.md b/docs/google-docs/providers/google/workflows/workflows/index.md index 54b7ad2e59..6d67c72a5e 100644 --- a/docs/google-docs/providers/google/workflows/workflows/index.md +++ b/docs/google-docs/providers/google/workflows/workflows/index.md @@ -27,9 +27,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `unreachable` | `array` | Unreachable resources. | -| `workflows` | `array` | The workflows that match the request. | +| `name` | `string` | The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow} | +| `description` | `string` | Description of the workflow provided by the user. Must be at most 1000 unicode characters long. | +| `sourceContents` | `string` | Workflow code to be executed. The size limit is 128KB. | +| `stateError` | `object` | Describes an error related to the current state of the workflow. | +| `updateTime` | `string` | Output only. The timestamp for when the workflow was last updated. | +| `state` | `string` | Output only. State of the workflow deployment. | +| `userEnvVars` | `object` | Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 40KiB. Keys cannot be empty strings and cannot start with “GOOGLE” or “WORKFLOWS". | +| `cryptoKeyName` | `string` | Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted. | +| `revisionId` | `string` | Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters. | +| `revisionCreateTime` | `string` | Output only. The timestamp for the latest revision of the workflow's creation. | +| `labels` | `object` | Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. | +| `serviceAccount` | `string` | The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. The `{account}` value can be the `email` address or the `unique_id` of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision. | +| `callLogLevel` | `string` | Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence. | +| `createTime` | `string` | Output only. The timestamp for when the workflow was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +48,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Lists workflows in a given project and location. The default order is not specified. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation returns a ALREADY_EXISTS error. | | `delete` | `DELETE` | `locationsId, projectsId, workflowsId` | Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists workflows in a given project and location. The default order is not specified. | | `patch` | `EXEC` | `locationsId, projectsId, workflowsId` | Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow might be created as a result of a successful update operation. In that case, the new revision is used in new workflow executions. | diff --git a/docs/google-docs/providers/google/workloadmanager/evaluations/index.md b/docs/google-docs/providers/google/workloadmanager/evaluations/index.md index f7ee291fe9..4894e7e532 100644 --- a/docs/google-docs/providers/google/workloadmanager/evaluations/index.md +++ b/docs/google-docs/providers/google/workloadmanager/evaluations/index.md @@ -27,12 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | A token identifying a page of results the server should return. | -| `unreachable` | `array` | Locations that could not be reached. | -| `evaluations` | `array` | The list of Evaluation | +| `name` | `string` | name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}' | +| `description` | `string` | Description of the Evaluation | +| `ruleVersions` | `array` | Output only. [Output only] The updated rule ids if exist. | +| `customRulesBucket` | `string` | The Cloud Storage bucket name for custom rules. | +| `updateTime` | `string` | Output only. [Output only] Update time stamp | +| `createTime` | `string` | Output only. [Output only] Create time stamp | +| `schedule` | `string` | crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *", | +| `labels` | `object` | Labels as key value pairs | +| `resourceFilter` | `object` | Message describing resource filters | +| `resourceStatus` | `object` | Message describing resource status | +| `ruleNames` | `array` | the name of the rule | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `evaluationsId, locationsId, projectsId` | Gets details of a single Evaluation. | | `list` | `SELECT` | `locationsId, projectsId` | Lists Evaluations in a given project and location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new Evaluation in a given project and location. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists Evaluations in a given project and location. | diff --git a/docs/google-docs/providers/google/workloadmanager/executions/index.md b/docs/google-docs/providers/google/workloadmanager/executions/index.md index 6900b73cd5..fe22adba48 100644 --- a/docs/google-docs/providers/google/workloadmanager/executions/index.md +++ b/docs/google-docs/providers/google/workloadmanager/executions/index.md @@ -27,12 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Locations that could not be reached. | -| `executions` | `array` | The list of Execution | -| `nextPageToken` | `string` | A token identifying a page of results the server should return. | +| `name` | `string` | The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution} | +| `inventoryTime` | `string` | Output only. [Output only] Inventory time stamp | +| `labels` | `object` | Labels as key value pairs | +| `runType` | `string` | type represent whether the execution executed directly by user or scheduled according evaluation.schedule field. | +| `startTime` | `string` | Output only. [Output only] Start time stamp | +| `state` | `string` | Output only. [Output only] State | +| `endTime` | `string` | Output only. [Output only] End time stamp | +| `evaluationId` | `string` | Output only. [Output only] Evaluation ID | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `evaluationsId, executionsId, locationsId, projectsId` | Gets details of a single Execution. | | `list` | `SELECT` | `evaluationsId, locationsId, projectsId` | Lists Executions in a given project and location. | +| `_list` | `EXEC` | `evaluationsId, locationsId, projectsId` | Lists Executions in a given project and location. | | `run` | `EXEC` | `evaluationsId, locationsId, projectsId` | Creates a new Execution in a given project and location. | diff --git a/docs/google-docs/providers/google/workloadmanager/index.md b/docs/google-docs/providers/google/workloadmanager/index.md index b287e875e1..ff22a65232 100644 --- a/docs/google-docs/providers/google/workloadmanager/index.md +++ b/docs/google-docs/providers/google/workloadmanager/index.md @@ -21,7 +21,7 @@ Workload Manager Is A Service That Provides Tooling For Enterprise Workloads To
total resources: 8
total selectable resources: 7
-total methods: 16
+total methods: 23
@@ -33,7 +33,7 @@ Workload Manager Is A Service That Provides Tooling For Enterprise Workloads To TypeService TitleWorkload Manager API DescriptionWorkload Manager Is A Service That Provides Tooling For Enterprise Workloads To Automate The Deployment And Validation Of Your Workloads Against Best Practices And Recommendations. -Idworkloadmanager:v23.08.00155 +Idworkloadmanager:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/workloadmanager/locations/index.md b/docs/google-docs/providers/google/workloadmanager/locations/index.md index e81b9ad4fe..6337857c15 100644 --- a/docs/google-docs/providers/google/workloadmanager/locations/index.md +++ b/docs/google-docs/providers/google/workloadmanager/locations/index.md @@ -27,10 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | The standard List next-page token. | -| `locations` | `array` | A list of locations that matches the specified filter in the request. | +| `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | +| `_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | diff --git a/docs/google-docs/providers/google/workloadmanager/operations/index.md b/docs/google-docs/providers/google/workloadmanager/operations/index.md index cc9b4a6391..f5f1250db6 100644 --- a/docs/google-docs/providers/google/workloadmanager/operations/index.md +++ b/docs/google-docs/providers/google/workloadmanager/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/workloadmanager/results/index.md b/docs/google-docs/providers/google/workloadmanager/results/index.md index 7aa2a7d141..e40bf31bf7 100644 --- a/docs/google-docs/providers/google/workloadmanager/results/index.md +++ b/docs/google-docs/providers/google/workloadmanager/results/index.md @@ -27,9 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `executionResults` | `array` | The versions from the specified publisher. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | +| `severity` | `string` | severity of violation | +| `violationDetails` | `object` | Message describing the violdation in execution result | +| `violationMessage` | `string` | the violation message of an execution | +| `documentationUrl` | `string` | the document url of the rule | +| `resource` | `object` | Message represent resource in execution result | +| `rule` | `string` | the rule which violate in execution | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `evaluationsId, executionsId, locationsId, projectsId` | +| `_list` | `EXEC` | `evaluationsId, executionsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/workloadmanager/rules/index.md b/docs/google-docs/providers/google/workloadmanager/rules/index.md index 80f90d7f2a..d70a9bd306 100644 --- a/docs/google-docs/providers/google/workloadmanager/rules/index.md +++ b/docs/google-docs/providers/google/workloadmanager/rules/index.md @@ -27,9 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `rules` | `array` | all rules in response | -| `nextPageToken` | `string` | A token identifying a page of results the server should return. | +| `name` | `string` | rule name | +| `description` | `string` | descrite rule in plain language | +| `errorMessage` | `string` | the message template for rule | +| `secondaryCategory` | `string` | the secondary category | +| `uri` | `string` | the docuement url for the rule | +| `primaryCategory` | `string` | the primary category | +| `severity` | `string` | the severity of the rule | +| `displayName` | `string` | the name display in UI | +| `remediation` | `string` | the remediation for the rule | +| `revisionId` | `string` | Output only. the version of the rule | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `locationsId, projectsId` | +| `_list` | `EXEC` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/workloadmanager/scanned_resources/index.md b/docs/google-docs/providers/google/workloadmanager/scanned_resources/index.md index 86476f9938..0fdcd70905 100644 --- a/docs/google-docs/providers/google/workloadmanager/scanned_resources/index.md +++ b/docs/google-docs/providers/google/workloadmanager/scanned_resources/index.md @@ -25,11 +25,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `scannedResources` | `array` | All scanned resources in response | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list` | `SELECT` | `evaluationsId, executionsId, locationsId, projectsId` | +| `_list` | `EXEC` | `evaluationsId, executionsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/workstations/index.md b/docs/google-docs/providers/google/workstations/index.md index c2d53f85e8..94aee689d1 100644 --- a/docs/google-docs/providers/google/workstations/index.md +++ b/docs/google-docs/providers/google/workstations/index.md @@ -21,7 +21,7 @@ Allows Administrators To Create Managed Developer Environments In The Cloud.
total resources: 8
total selectable resources: 8
-total methods: 30
+total methods: 36
@@ -33,7 +33,7 @@ Allows Administrators To Create Managed Developer Environments In The Cloud. TypeService TitleCloud Workstations API DescriptionAllows Administrators To Create Managed Developer Environments In The Cloud. -Idworkstations:v23.08.00155 +Idworkstations:v23.08.00157 ## Resources diff --git a/docs/google-docs/providers/google/workstations/operations/index.md b/docs/google-docs/providers/google/workstations/operations/index.md index 057065eb78..9be93c4690 100644 --- a/docs/google-docs/providers/google/workstations/operations/index.md +++ b/docs/google-docs/providers/google/workstations/operations/index.md @@ -27,12 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `operations` | `array` | A list of operations that matches the specified filter in the request. | -| `nextPageToken` | `string` | The standard List next-page token. | +| `name` | `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}`. | +| `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `locationsId, operationsId, projectsId` | 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. | | `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `cancel` | `EXEC` | `locationsId, operationsId, projectsId` | 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`. | diff --git a/docs/google-docs/providers/google/workstations/workstation_clusters/index.md b/docs/google-docs/providers/google/workstations/workstation_clusters/index.md index b2021a4536..eab021c410 100644 --- a/docs/google-docs/providers/google/workstations/workstation_clusters/index.md +++ b/docs/google-docs/providers/google/workstations/workstation_clusters/index.md @@ -27,9 +27,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `workstationClusters` | `array` | The requested workstation clusters. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `unreachable` | `array` | Unreachable resources. | +| `name` | `string` | Full name of this resource. | +| `deleteTime` | `string` | Output only. Time when this resource was soft-deleted. | +| `displayName` | `string` | Human-readable name for this resource. | +| `updateTime` | `string` | Output only. Time when this resource was most recently updated. | +| `labels` | `object` | Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. | +| `network` | `string` | Immutable. Name of the Compute Engine network in which instances associated with this cluster will be created. | +| `uid` | `string` | Output only. A system-assigned unique identifier for this resource. | +| `controlPlaneIp` | `string` | Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address. | +| `annotations` | `object` | Client-specified annotations. | +| `etag` | `string` | 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. | +| `subnetwork` | `string` | Immutable. Name of the Compute Engine subnetwork in which instances associated with this cluster will be created. Must be part of the subnetwork specified for this cluster. | +| `createTime` | `string` | Output only. Time when this resource was created. | +| `degraded` | `boolean` | Output only. Whether this resource is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in the `conditions` field. | +| `conditions` | `array` | Output only. Status conditions describing the current resource state. | +| `reconciling` | `boolean` | Output only. Indicates whether this resource is currently being updated to match its intended state. | +| `privateClusterConfig` | `object` | Configuration options for private clusters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +50,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId` | Returns all workstation clusters in the specified location. | | `create` | `INSERT` | `locationsId, projectsId` | Creates a new workstation cluster. | | `delete` | `DELETE` | `locationsId, projectsId, workstationClustersId` | Deletes the specified workstation cluster. | +| `_list` | `EXEC` | `locationsId, projectsId` | Returns all workstation clusters in the specified location. | | `patch` | `EXEC` | `locationsId, projectsId, workstationClustersId` | Updates an existing workstation cluster. | 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 822ccd72bd..62036462e8 100644 --- a/docs/google-docs/providers/google/workstations/workstation_configs/index.md +++ b/docs/google-docs/providers/google/workstations/workstation_configs/index.md @@ -27,9 +27,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `workstationConfigs` | `array` | The requested configs. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `unreachable` | `array` | Unreachable resources. | +| `name` | `string` | Full name of this resource. | +| `createTime` | `string` | Output only. Time when this resource was created. | +| `runningTimeout` | `string` | Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The `idleTimeout` and `runningTimeout` parameters are independent of each other. Note that the `runningTimeout` parameter shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `54000s` (15 hours). Defaults to `43200s` (12 hours). A value of `0` indicates that workstations using this configuration should never time out. If `encryption_key` is set, it must be greater than `0` and less than `86400s` (24 hours). Warning: A value of `0s` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. | +| `idleTimeout` | `string` | 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). | +| `persistentDirectories` | `array` | Directories to persist across workstation sessions. | +| `enableAuditAgent` | `boolean` | Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). | +| `readinessChecks` | `array` | 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. | +| `etag` | `string` | 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. | +| `host` | `object` | Runtime host for a workstation. | +| `uid` | `string` | Output only. A system-assigned unique identifier for this resource. | +| `container` | `object` | A Docker container. | +| `degraded` | `boolean` | Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the `conditions` field. | +| `annotations` | `object` | Client-specified annotations. | +| `displayName` | `string` | Human-readable name for this resource. | +| `reconciling` | `boolean` | Output only. Indicates whether this resource is currently being updated to match its intended state. | +| `conditions` | `array` | Output only. Status conditions describing the current resource state. | +| `deleteTime` | `string` | Output only. Time when this resource was soft-deleted. | +| `encryptionKey` | `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). | +| `labels` | `object` | Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. | +| `updateTime` | `string` | Output only. Time when this resource was most recently updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,4 +54,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId, workstationClustersId` | Returns all workstation configurations in the specified cluster. | | `create` | `INSERT` | `locationsId, projectsId, workstationClustersId` | Creates a new workstation configuration. | | `delete` | `DELETE` | `locationsId, projectsId, workstationClustersId, workstationConfigsId` | Deletes the specified workstation configuration. | +| `_list` | `EXEC` | `locationsId, projectsId, workstationClustersId` | Returns all workstation configurations in the specified cluster. | | `patch` | `EXEC` | `locationsId, projectsId, workstationClustersId, workstationConfigsId` | Updates an existing workstation configuration. | 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 066fea090a..c81c4744d3 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 @@ -27,10 +27,28 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `unreachable` | `array` | Unreachable resources. | -| `workstationConfigs` | `array` | The requested configs. | +| `name` | `string` | Full name of this resource. | +| `degraded` | `boolean` | Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the `conditions` field. | +| `encryptionKey` | `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). | +| `reconciling` | `boolean` | Output only. Indicates whether this resource is currently being updated to match its intended state. | +| `deleteTime` | `string` | Output only. Time when this resource was soft-deleted. | +| `conditions` | `array` | Output only. Status conditions describing the current resource state. | +| `enableAuditAgent` | `boolean` | Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). | +| `idleTimeout` | `string` | 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). | +| `host` | `object` | Runtime host for a workstation. | +| `persistentDirectories` | `array` | Directories to persist across workstation sessions. | +| `etag` | `string` | 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. | +| `displayName` | `string` | Human-readable name for this resource. | +| `container` | `object` | A Docker container. | +| `readinessChecks` | `array` | 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. | +| `uid` | `string` | Output only. A system-assigned unique identifier for this resource. | +| `createTime` | `string` | Output only. Time when this resource was created. | +| `annotations` | `object` | Client-specified annotations. | +| `updateTime` | `string` | Output only. Time when this resource was most recently updated. | +| `labels` | `object` | Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. | +| `runningTimeout` | `string` | Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The `idleTimeout` and `runningTimeout` parameters are independent of each other. Note that the `runningTimeout` parameter shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `54000s` (15 hours). Defaults to `43200s` (12 hours). A value of `0` indicates that workstations using this configuration should never time out. If `encryption_key` is set, it must be greater than `0` and less than `86400s` (24 hours). Warning: A value of `0s` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list_usable` | `SELECT` | `locationsId, projectsId, workstationClustersId` | +| `_list_usable` | `EXEC` | `locationsId, projectsId, workstationClustersId` | diff --git a/docs/google-docs/providers/google/workstations/workstations/index.md b/docs/google-docs/providers/google/workstations/workstations/index.md index 1820597864..77d95fd795 100644 --- a/docs/google-docs/providers/google/workstations/workstations/index.md +++ b/docs/google-docs/providers/google/workstations/workstations/index.md @@ -27,9 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `unreachable` | `array` | Unreachable resources. | -| `workstations` | `array` | The requested workstations. | +| `name` | `string` | Full name of this resource. | +| `createTime` | `string` | Output only. Time when this resource was created. | +| `host` | `string` | Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format `{port}-{host}`. | +| `annotations` | `object` | Client-specified annotations. | +| `etag` | `string` | 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. | +| `displayName` | `string` | Human-readable name for this resource. | +| `env` | `object` | Environment variables passed to the workstation container's entrypoint. | +| `reconciling` | `boolean` | Output only. Indicates whether this resource is currently being updated to match its intended state. | +| `state` | `string` | Output only. Current state of the workstation. | +| `deleteTime` | `string` | Output only. Time when this resource was soft-deleted. | +| `uid` | `string` | Output only. A system-assigned unique identifier for this resource. | +| `updateTime` | `string` | Output only. Time when this resource was most recently updated. | +| `labels` | `object` | Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -37,6 +47,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `locationsId, projectsId, workstationClustersId, workstationConfigsId` | Returns all Workstations using the specified workstation configuration. | | `create` | `INSERT` | `locationsId, projectsId, workstationClustersId, workstationConfigsId` | Creates a new workstation. | | `delete` | `DELETE` | `locationsId, projectsId, workstationClustersId, workstationConfigsId, workstationsId` | Deletes the specified workstation. | +| `_list` | `EXEC` | `locationsId, projectsId, workstationClustersId, workstationConfigsId` | Returns all Workstations using the specified workstation configuration. | | `generate_access_token` | `EXEC` | `locationsId, projectsId, workstationClustersId, workstationConfigsId, workstationsId` | Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation. | | `patch` | `EXEC` | `locationsId, projectsId, workstationClustersId, workstationConfigsId, workstationsId` | Updates an existing workstation. | | `start` | `EXEC` | `locationsId, projectsId, workstationClustersId, workstationConfigsId, workstationsId` | Starts running a workstation so that users can connect to it. | diff --git a/docs/google-docs/providers/google/workstations/workstations_iam_policies/index.md b/docs/google-docs/providers/google/workstations/workstations_iam_policies/index.md index 3fd5a3d952..26df41e508 100644 --- a/docs/google-docs/providers/google/workstations/workstations_iam_policies/index.md +++ b/docs/google-docs/providers/google/workstations/workstations_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workstations/workstations_usable/index.md b/docs/google-docs/providers/google/workstations/workstations_usable/index.md index 37b121612d..5d1ad4b4e0 100644 --- a/docs/google-docs/providers/google/workstations/workstations_usable/index.md +++ b/docs/google-docs/providers/google/workstations/workstations_usable/index.md @@ -27,10 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `unreachable` | `array` | Unreachable resources. | -| `workstations` | `array` | The requested workstations. | -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | +| `name` | `string` | Full name of this resource. | +| `host` | `string` | Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format `{port}-{host}`. | +| `reconciling` | `boolean` | Output only. Indicates whether this resource is currently being updated to match its intended state. | +| `annotations` | `object` | Client-specified annotations. | +| `deleteTime` | `string` | Output only. Time when this resource was soft-deleted. | +| `env` | `object` | Environment variables passed to the workstation container's entrypoint. | +| `labels` | `object` | Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. | +| `uid` | `string` | Output only. A system-assigned unique identifier for this resource. | +| `createTime` | `string` | Output only. Time when this resource was created. | +| `displayName` | `string` | Human-readable name for this resource. | +| `state` | `string` | Output only. Current state of the workstation. | +| `etag` | `string` | 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. | +| `updateTime` | `string` | Output only. Time when this resource was most recently updated. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| | `list_usable` | `SELECT` | `locationsId, projectsId, workstationClustersId, workstationConfigsId` | +| `_list_usable` | `EXEC` | `locationsId, projectsId, workstationClustersId, workstationConfigsId` |