Autogenerated update (2020-08-07)

Delete:
- webfonts_v1

Update:
- appengine_v1
- appengine_v1alpha
- appengine_v1beta
- appsmarket_v2
- bigquerydatatransfer_v1
- bigqueryreservation_v1
- bigqueryreservation_v1beta1
- binaryauthorization_v1
- binaryauthorization_v1beta1
- chat_v1
- civicinfo_v2
- cloudbuild_v1
- cloudbuild_v1alpha1
- cloudbuild_v1alpha2
- cloudkms_v1
- cloudshell_v1
- cloudshell_v1alpha1
- cloudtrace_v1
- cloudtrace_v2
- cloudtrace_v2beta1
- datafusion_v1
- datafusion_v1beta1
- dataproc_v1beta2
- dfareporting_v3_4
- displayvideo_v1
- doubleclickbidmanager_v1
- doubleclickbidmanager_v1_1
- drive_v2
- drive_v3
- firestore_v1
- firestore_v1beta1
- genomics_v1
- genomics_v1alpha2
- genomics_v2alpha1
- monitoring_v1
- monitoring_v3
- osconfig_v1beta
- oslogin_v1
- people_v1
- recommendationengine_v1beta1
- runtimeconfig_v1beta1
- safebrowsing_v4
- serviceconsumermanagement_v1
- serviceconsumermanagement_v1beta1
- servicenetworking_v1
- servicenetworking_v1beta
- serviceusage_v1
- serviceusage_v1beta1
- sourcerepo_v1
- sql_v1beta4
- storage_v1
- testing_v1
- youtube_v3
This commit is contained in:
Google APIs 2020-08-07 00:38:13 +00:00
parent a76f4040f0
commit 929dd28e95
153 changed files with 9266 additions and 9113 deletions

View File

@ -11009,6 +11009,7 @@
"/appengine:v1/Resources": resources
"/appengine:v1/Resources/cpu": cpu
"/appengine:v1/Resources/diskGb": disk_gb
"/appengine:v1/Resources/kmsKeyReference": kms_key_reference
"/appengine:v1/Resources/memoryGb": memory_gb
"/appengine:v1/Resources/volumes": volumes
"/appengine:v1/Resources/volumes/volume": volume
@ -11771,6 +11772,7 @@
"/appengine:v1beta/Resources": resources
"/appengine:v1beta/Resources/cpu": cpu
"/appengine:v1beta/Resources/diskGb": disk_gb
"/appengine:v1beta/Resources/kmsKeyReference": kms_key_reference
"/appengine:v1beta/Resources/memoryGb": memory_gb
"/appengine:v1beta/Resources/volumes": volumes
"/appengine:v1beta/Resources/volumes/volume": volume
@ -58758,11 +58760,13 @@
"/datafusion:v1/Instance/networkConfig": network_config
"/datafusion:v1/Instance/options": options
"/datafusion:v1/Instance/options/option": option
"/datafusion:v1/Instance/p4ServiceAccount": p4_service_account
"/datafusion:v1/Instance/privateInstance": private_instance
"/datafusion:v1/Instance/serviceAccount": service_account
"/datafusion:v1/Instance/serviceEndpoint": service_endpoint
"/datafusion:v1/Instance/state": state
"/datafusion:v1/Instance/stateMessage": state_message
"/datafusion:v1/Instance/tenantProjectId": tenant_project_id
"/datafusion:v1/Instance/type": type
"/datafusion:v1/Instance/updateTime": update_time
"/datafusion:v1/Instance/version": version
@ -58836,6 +58840,8 @@
"/datafusion:v1/TestIamPermissionsResponse/permissions": permissions
"/datafusion:v1/TestIamPermissionsResponse/permissions/permission": permission
"/datafusion:v1/Version": version
"/datafusion:v1/Version/availableFeatures": available_features
"/datafusion:v1/Version/availableFeatures/available_feature": available_feature
"/datafusion:v1/Version/defaultVersion": default_version
"/datafusion:v1/Version/versionNumber": version_number
"/datafusion:v1/datafusion.projects.locations.get": get_project_location
@ -58949,11 +58955,13 @@
"/datafusion:v1beta1/Instance/networkConfig": network_config
"/datafusion:v1beta1/Instance/options": options
"/datafusion:v1beta1/Instance/options/option": option
"/datafusion:v1beta1/Instance/p4ServiceAccount": p4_service_account
"/datafusion:v1beta1/Instance/privateInstance": private_instance
"/datafusion:v1beta1/Instance/serviceAccount": service_account
"/datafusion:v1beta1/Instance/serviceEndpoint": service_endpoint
"/datafusion:v1beta1/Instance/state": state
"/datafusion:v1beta1/Instance/stateMessage": state_message
"/datafusion:v1beta1/Instance/tenantProjectId": tenant_project_id
"/datafusion:v1beta1/Instance/type": type
"/datafusion:v1beta1/Instance/updateTime": update_time
"/datafusion:v1beta1/Instance/version": version
@ -59048,6 +59056,8 @@
"/datafusion:v1beta1/TestIamPermissionsResponse/permissions/permission": permission
"/datafusion:v1beta1/UpgradeInstanceRequest": upgrade_instance_request
"/datafusion:v1beta1/Version": version
"/datafusion:v1beta1/Version/availableFeatures": available_features
"/datafusion:v1beta1/Version/availableFeatures/available_feature": available_feature
"/datafusion:v1beta1/Version/defaultVersion": default_version
"/datafusion:v1beta1/Version/versionNumber": version_number
"/datafusion:v1beta1/datafusion.projects.locations.get": get_project_location
@ -59793,6 +59803,7 @@
"/dataproc:v1beta2/ClusterConfig/initializationActions/initialization_action": initialization_action
"/dataproc:v1beta2/ClusterConfig/lifecycleConfig": lifecycle_config
"/dataproc:v1beta2/ClusterConfig/masterConfig": master_config
"/dataproc:v1beta2/ClusterConfig/metastoreConfig": metastore_config
"/dataproc:v1beta2/ClusterConfig/secondaryWorkerConfig": secondary_worker_config
"/dataproc:v1beta2/ClusterConfig/securityConfig": security_config
"/dataproc:v1beta2/ClusterConfig/softwareConfig": software_config
@ -60013,6 +60024,8 @@
"/dataproc:v1beta2/ManagedGroupConfig": managed_group_config
"/dataproc:v1beta2/ManagedGroupConfig/instanceGroupManagerName": instance_group_manager_name
"/dataproc:v1beta2/ManagedGroupConfig/instanceTemplateName": instance_template_name
"/dataproc:v1beta2/MetastoreConfig": metastore_config
"/dataproc:v1beta2/MetastoreConfig/dataprocMetastoreService": dataproc_metastore_service
"/dataproc:v1beta2/NamespacedGkeDeploymentTarget": namespaced_gke_deployment_target
"/dataproc:v1beta2/NamespacedGkeDeploymentTarget/clusterNamespace": cluster_namespace
"/dataproc:v1beta2/NamespacedGkeDeploymentTarget/targetGkeCluster": target_gke_cluster
@ -80662,6 +80675,9 @@
"/dfareporting:v3.4/dfareporting.reports.list/scope": scope
"/dfareporting:v3.4/dfareporting.reports.list/sortField": sort_field
"/dfareporting:v3.4/dfareporting.reports.list/sortOrder": sort_order
"/dfareporting:v3.4/dfareporting.reports.patch": patch_report
"/dfareporting:v3.4/dfareporting.reports.patch/profileId": profile_id
"/dfareporting:v3.4/dfareporting.reports.patch/reportId": report_id
"/dfareporting:v3.4/dfareporting.reports.run": run_report
"/dfareporting:v3.4/dfareporting.reports.run/profileId": profile_id
"/dfareporting:v3.4/dfareporting.reports.run/reportId": report_id
@ -91247,6 +91263,7 @@
"/drive:v2/Permission/teamDrivePermissionDetails/team_drive_permission_detail/teamDrivePermissionType": team_drive_permission_type
"/drive:v2/Permission/type": type
"/drive:v2/Permission/value": value
"/drive:v2/Permission/view": view
"/drive:v2/Permission/withLink": with_link
"/drive:v2/PermissionId": permission_id
"/drive:v2/PermissionId/id": id
@ -91378,6 +91395,7 @@
"/drive:v2/drive.changes.list/includeCorpusRemovals": include_corpus_removals
"/drive:v2/drive.changes.list/includeDeleted": include_deleted
"/drive:v2/drive.changes.list/includeItemsFromAllDrives": include_items_from_all_drives
"/drive:v2/drive.changes.list/includePermissionsForView": include_permissions_for_view
"/drive:v2/drive.changes.list/includeSubscribed": include_subscribed
"/drive:v2/drive.changes.list/includeTeamDriveItems": include_team_drive_items
"/drive:v2/drive.changes.list/maxResults": max_results
@ -91392,6 +91410,7 @@
"/drive:v2/drive.changes.watch/includeCorpusRemovals": include_corpus_removals
"/drive:v2/drive.changes.watch/includeDeleted": include_deleted
"/drive:v2/drive.changes.watch/includeItemsFromAllDrives": include_items_from_all_drives
"/drive:v2/drive.changes.watch/includePermissionsForView": include_permissions_for_view
"/drive:v2/drive.changes.watch/includeSubscribed": include_subscribed
"/drive:v2/drive.changes.watch/includeTeamDriveItems": include_team_drive_items
"/drive:v2/drive.changes.watch/maxResults": max_results
@ -91464,6 +91483,7 @@
"/drive:v2/drive.files.copy/convert": convert
"/drive:v2/drive.files.copy/enforceSingleParent": enforce_single_parent
"/drive:v2/drive.files.copy/fileId": file_id
"/drive:v2/drive.files.copy/includePermissionsForView": include_permissions_for_view
"/drive:v2/drive.files.copy/ocr": ocr
"/drive:v2/drive.files.copy/ocrLanguage": ocr_language
"/drive:v2/drive.files.copy/pinned": pinned
@ -91486,6 +91506,7 @@
"/drive:v2/drive.files.get": get_file
"/drive:v2/drive.files.get/acknowledgeAbuse": acknowledge_abuse
"/drive:v2/drive.files.get/fileId": file_id
"/drive:v2/drive.files.get/includePermissionsForView": include_permissions_for_view
"/drive:v2/drive.files.get/projection": projection
"/drive:v2/drive.files.get/revisionId": revision_id
"/drive:v2/drive.files.get/supportsAllDrives": supports_all_drives
@ -91494,6 +91515,7 @@
"/drive:v2/drive.files.insert": insert_file
"/drive:v2/drive.files.insert/convert": convert
"/drive:v2/drive.files.insert/enforceSingleParent": enforce_single_parent
"/drive:v2/drive.files.insert/includePermissionsForView": include_permissions_for_view
"/drive:v2/drive.files.insert/ocr": ocr
"/drive:v2/drive.files.insert/ocrLanguage": ocr_language
"/drive:v2/drive.files.insert/pinned": pinned
@ -91508,6 +91530,7 @@
"/drive:v2/drive.files.list/corpus": corpus
"/drive:v2/drive.files.list/driveId": drive_id
"/drive:v2/drive.files.list/includeItemsFromAllDrives": include_items_from_all_drives
"/drive:v2/drive.files.list/includePermissionsForView": include_permissions_for_view
"/drive:v2/drive.files.list/includeTeamDriveItems": include_team_drive_items
"/drive:v2/drive.files.list/maxResults": max_results
"/drive:v2/drive.files.list/orderBy": order_by
@ -91523,6 +91546,7 @@
"/drive:v2/drive.files.patch/convert": convert
"/drive:v2/drive.files.patch/enforceSingleParent": enforce_single_parent
"/drive:v2/drive.files.patch/fileId": file_id
"/drive:v2/drive.files.patch/includePermissionsForView": include_permissions_for_view
"/drive:v2/drive.files.patch/modifiedDateBehavior": modified_date_behavior
"/drive:v2/drive.files.patch/newRevision": new_revision
"/drive:v2/drive.files.patch/ocr": ocr
@ -91538,14 +91562,17 @@
"/drive:v2/drive.files.patch/useContentAsIndexableText": use_content_as_indexable_text
"/drive:v2/drive.files.touch": touch_file
"/drive:v2/drive.files.touch/fileId": file_id
"/drive:v2/drive.files.touch/includePermissionsForView": include_permissions_for_view
"/drive:v2/drive.files.touch/supportsAllDrives": supports_all_drives
"/drive:v2/drive.files.touch/supportsTeamDrives": supports_team_drives
"/drive:v2/drive.files.trash": trash_file
"/drive:v2/drive.files.trash/fileId": file_id
"/drive:v2/drive.files.trash/includePermissionsForView": include_permissions_for_view
"/drive:v2/drive.files.trash/supportsAllDrives": supports_all_drives
"/drive:v2/drive.files.trash/supportsTeamDrives": supports_team_drives
"/drive:v2/drive.files.untrash": untrash_file
"/drive:v2/drive.files.untrash/fileId": file_id
"/drive:v2/drive.files.untrash/includePermissionsForView": include_permissions_for_view
"/drive:v2/drive.files.untrash/supportsAllDrives": supports_all_drives
"/drive:v2/drive.files.untrash/supportsTeamDrives": supports_team_drives
"/drive:v2/drive.files.update": update_file
@ -91553,6 +91580,7 @@
"/drive:v2/drive.files.update/convert": convert
"/drive:v2/drive.files.update/enforceSingleParent": enforce_single_parent
"/drive:v2/drive.files.update/fileId": file_id
"/drive:v2/drive.files.update/includePermissionsForView": include_permissions_for_view
"/drive:v2/drive.files.update/modifiedDateBehavior": modified_date_behavior
"/drive:v2/drive.files.update/newRevision": new_revision
"/drive:v2/drive.files.update/ocr": ocr
@ -91569,6 +91597,7 @@
"/drive:v2/drive.files.watch": watch_file
"/drive:v2/drive.files.watch/acknowledgeAbuse": acknowledge_abuse
"/drive:v2/drive.files.watch/fileId": file_id
"/drive:v2/drive.files.watch/includePermissionsForView": include_permissions_for_view
"/drive:v2/drive.files.watch/projection": projection
"/drive:v2/drive.files.watch/revisionId": revision_id
"/drive:v2/drive.files.watch/supportsAllDrives": supports_all_drives
@ -91613,6 +91642,7 @@
"/drive:v2/drive.permissions.insert/useDomainAdminAccess": use_domain_admin_access
"/drive:v2/drive.permissions.list": list_permissions
"/drive:v2/drive.permissions.list/fileId": file_id
"/drive:v2/drive.permissions.list/includePermissionsForView": include_permissions_for_view
"/drive:v2/drive.permissions.list/maxResults": max_results
"/drive:v2/drive.permissions.list/pageToken": page_token
"/drive:v2/drive.permissions.list/supportsAllDrives": supports_all_drives
@ -92023,6 +92053,7 @@
"/drive:v3/Permission/teamDrivePermissionDetails/team_drive_permission_detail/role": role
"/drive:v3/Permission/teamDrivePermissionDetails/team_drive_permission_detail/teamDrivePermissionType": team_drive_permission_type
"/drive:v3/Permission/type": type
"/drive:v3/Permission/view": view
"/drive:v3/PermissionList": permission_list
"/drive:v3/PermissionList/kind": kind
"/drive:v3/PermissionList/nextPageToken": next_page_token
@ -92128,6 +92159,7 @@
"/drive:v3/drive.changes.list/driveId": drive_id
"/drive:v3/drive.changes.list/includeCorpusRemovals": include_corpus_removals
"/drive:v3/drive.changes.list/includeItemsFromAllDrives": include_items_from_all_drives
"/drive:v3/drive.changes.list/includePermissionsForView": include_permissions_for_view
"/drive:v3/drive.changes.list/includeRemoved": include_removed
"/drive:v3/drive.changes.list/includeTeamDriveItems": include_team_drive_items
"/drive:v3/drive.changes.list/pageSize": page_size
@ -92141,6 +92173,7 @@
"/drive:v3/drive.changes.watch/driveId": drive_id
"/drive:v3/drive.changes.watch/includeCorpusRemovals": include_corpus_removals
"/drive:v3/drive.changes.watch/includeItemsFromAllDrives": include_items_from_all_drives
"/drive:v3/drive.changes.watch/includePermissionsForView": include_permissions_for_view
"/drive:v3/drive.changes.watch/includeRemoved": include_removed
"/drive:v3/drive.changes.watch/includeTeamDriveItems": include_team_drive_items
"/drive:v3/drive.changes.watch/pageSize": page_size
@ -92192,6 +92225,7 @@
"/drive:v3/drive.files.copy/enforceSingleParent": enforce_single_parent
"/drive:v3/drive.files.copy/fileId": file_id
"/drive:v3/drive.files.copy/ignoreDefaultVisibility": ignore_default_visibility
"/drive:v3/drive.files.copy/includePermissionsForView": include_permissions_for_view
"/drive:v3/drive.files.copy/keepRevisionForever": keep_revision_forever
"/drive:v3/drive.files.copy/ocrLanguage": ocr_language
"/drive:v3/drive.files.copy/supportsAllDrives": supports_all_drives
@ -92199,6 +92233,7 @@
"/drive:v3/drive.files.create": create_file
"/drive:v3/drive.files.create/enforceSingleParent": enforce_single_parent
"/drive:v3/drive.files.create/ignoreDefaultVisibility": ignore_default_visibility
"/drive:v3/drive.files.create/includePermissionsForView": include_permissions_for_view
"/drive:v3/drive.files.create/keepRevisionForever": keep_revision_forever
"/drive:v3/drive.files.create/ocrLanguage": ocr_language
"/drive:v3/drive.files.create/supportsAllDrives": supports_all_drives
@ -92218,6 +92253,7 @@
"/drive:v3/drive.files.get": get_file
"/drive:v3/drive.files.get/acknowledgeAbuse": acknowledge_abuse
"/drive:v3/drive.files.get/fileId": file_id
"/drive:v3/drive.files.get/includePermissionsForView": include_permissions_for_view
"/drive:v3/drive.files.get/supportsAllDrives": supports_all_drives
"/drive:v3/drive.files.get/supportsTeamDrives": supports_team_drives
"/drive:v3/drive.files.list": list_files
@ -92225,6 +92261,7 @@
"/drive:v3/drive.files.list/corpus": corpus
"/drive:v3/drive.files.list/driveId": drive_id
"/drive:v3/drive.files.list/includeItemsFromAllDrives": include_items_from_all_drives
"/drive:v3/drive.files.list/includePermissionsForView": include_permissions_for_view
"/drive:v3/drive.files.list/includeTeamDriveItems": include_team_drive_items
"/drive:v3/drive.files.list/orderBy": order_by
"/drive:v3/drive.files.list/pageSize": page_size
@ -92238,6 +92275,7 @@
"/drive:v3/drive.files.update/addParents": add_parents
"/drive:v3/drive.files.update/enforceSingleParent": enforce_single_parent
"/drive:v3/drive.files.update/fileId": file_id
"/drive:v3/drive.files.update/includePermissionsForView": include_permissions_for_view
"/drive:v3/drive.files.update/keepRevisionForever": keep_revision_forever
"/drive:v3/drive.files.update/ocrLanguage": ocr_language
"/drive:v3/drive.files.update/removeParents": remove_parents
@ -92247,6 +92285,7 @@
"/drive:v3/drive.files.watch": watch_file
"/drive:v3/drive.files.watch/acknowledgeAbuse": acknowledge_abuse
"/drive:v3/drive.files.watch/fileId": file_id
"/drive:v3/drive.files.watch/includePermissionsForView": include_permissions_for_view
"/drive:v3/drive.files.watch/supportsAllDrives": supports_all_drives
"/drive:v3/drive.files.watch/supportsTeamDrives": supports_team_drives
"/drive:v3/drive.permissions.create": create_permission
@ -92273,6 +92312,7 @@
"/drive:v3/drive.permissions.get/useDomainAdminAccess": use_domain_admin_access
"/drive:v3/drive.permissions.list": list_permissions
"/drive:v3/drive.permissions.list/fileId": file_id
"/drive:v3/drive.permissions.list/includePermissionsForView": include_permissions_for_view
"/drive:v3/drive.permissions.list/pageSize": page_size
"/drive:v3/drive.permissions.list/pageToken": page_token
"/drive:v3/drive.permissions.list/supportsAllDrives": supports_all_drives
@ -98469,6 +98509,7 @@
"/genomics:v2alpha1/CheckInRequest/events": events
"/genomics:v2alpha1/CheckInRequest/events/event": event
"/genomics:v2alpha1/CheckInRequest/result": result
"/genomics:v2alpha1/CheckInRequest/sosReport": sos_report
"/genomics:v2alpha1/CheckInRequest/workerStatus": worker_status
"/genomics:v2alpha1/CheckInResponse": check_in_response
"/genomics:v2alpha1/CheckInResponse/deadline": deadline
@ -109949,6 +109990,17 @@
"/osconfig:v1beta/EffectiveGuestPolicySourcedSoftwareRecipe/softwareRecipe": software_recipe
"/osconfig:v1beta/EffectiveGuestPolicySourcedSoftwareRecipe/source": source
"/osconfig:v1beta/Empty": empty
"/osconfig:v1beta/ExecResource": exec_resource
"/osconfig:v1beta/ExecResource/enforce": enforce
"/osconfig:v1beta/ExecResource/validate": validate
"/osconfig:v1beta/ExecResourceExec": exec_resource_exec
"/osconfig:v1beta/ExecResourceExec/allowedSuccessCodes": allowed_success_codes
"/osconfig:v1beta/ExecResourceExec/allowedSuccessCodes/allowed_success_code": allowed_success_code
"/osconfig:v1beta/ExecResourceExec/args": args
"/osconfig:v1beta/ExecResourceExec/args/arg": arg
"/osconfig:v1beta/ExecResourceExec/file": file
"/osconfig:v1beta/ExecResourceExec/interpreter": interpreter
"/osconfig:v1beta/ExecResourceExec/script": script
"/osconfig:v1beta/ExecStep": exec_step
"/osconfig:v1beta/ExecStep/linuxExecStepConfig": linux_exec_step_config
"/osconfig:v1beta/ExecStep/windowsExecStepConfig": windows_exec_step_config
@ -109966,6 +110018,30 @@
"/osconfig:v1beta/ExecutePatchJobRequest/instanceFilter": instance_filter
"/osconfig:v1beta/ExecutePatchJobRequest/patchConfig": patch_config
"/osconfig:v1beta/ExecutePatchJobRequest/rollout": rollout
"/osconfig:v1beta/ExtractArchiveResource": extract_archive_resource
"/osconfig:v1beta/ExtractArchiveResource/creates": creates
"/osconfig:v1beta/ExtractArchiveResource/destination": destination
"/osconfig:v1beta/ExtractArchiveResource/overwrite": overwrite
"/osconfig:v1beta/ExtractArchiveResource/source": source
"/osconfig:v1beta/ExtractArchiveResource/type": type
"/osconfig:v1beta/File": file
"/osconfig:v1beta/File/allowInsecure": allow_insecure
"/osconfig:v1beta/File/gcs": gcs
"/osconfig:v1beta/File/localPath": local_path
"/osconfig:v1beta/File/remote": remote
"/osconfig:v1beta/FileGcs": file_gcs
"/osconfig:v1beta/FileGcs/bucket": bucket
"/osconfig:v1beta/FileGcs/generation": generation
"/osconfig:v1beta/FileGcs/object": object
"/osconfig:v1beta/FileRemote": file_remote
"/osconfig:v1beta/FileRemote/sha256Checksum": sha256_checksum
"/osconfig:v1beta/FileRemote/uri": uri
"/osconfig:v1beta/FileResource": file_resource
"/osconfig:v1beta/FileResource/content": content
"/osconfig:v1beta/FileResource/file": file
"/osconfig:v1beta/FileResource/path": path
"/osconfig:v1beta/FileResource/permissions": permissions
"/osconfig:v1beta/FileResource/state": state
"/osconfig:v1beta/FixedOrPercent": fixed_or_percent
"/osconfig:v1beta/FixedOrPercent/fixed": fixed
"/osconfig:v1beta/FixedOrPercent/percent": percent
@ -110024,6 +110100,35 @@
"/osconfig:v1beta/PackageRepository/goo": goo
"/osconfig:v1beta/PackageRepository/yum": yum
"/osconfig:v1beta/PackageRepository/zypper": zypper
"/osconfig:v1beta/PackageResource": package_resource
"/osconfig:v1beta/PackageResource/apt": apt
"/osconfig:v1beta/PackageResource/deb": deb
"/osconfig:v1beta/PackageResource/desiredState": desired_state
"/osconfig:v1beta/PackageResource/googet": googet
"/osconfig:v1beta/PackageResource/msi": msi
"/osconfig:v1beta/PackageResource/rpm": rpm
"/osconfig:v1beta/PackageResource/yum": yum
"/osconfig:v1beta/PackageResource/zypper": zypper
"/osconfig:v1beta/PackageResourceAPT": package_resource_apt
"/osconfig:v1beta/PackageResourceAPT/name": name
"/osconfig:v1beta/PackageResourceDeb": package_resource_deb
"/osconfig:v1beta/PackageResourceDeb/pullDeps": pull_deps
"/osconfig:v1beta/PackageResourceDeb/source": source
"/osconfig:v1beta/PackageResourceGooGet": package_resource_goo_get
"/osconfig:v1beta/PackageResourceGooGet/name": name
"/osconfig:v1beta/PackageResourceMSI": package_resource_msi
"/osconfig:v1beta/PackageResourceMSI/allowedSuccessCodes": allowed_success_codes
"/osconfig:v1beta/PackageResourceMSI/allowedSuccessCodes/allowed_success_code": allowed_success_code
"/osconfig:v1beta/PackageResourceMSI/flags": flags
"/osconfig:v1beta/PackageResourceMSI/flags/flag": flag
"/osconfig:v1beta/PackageResourceMSI/source": source
"/osconfig:v1beta/PackageResourceRPM": package_resource_rpm
"/osconfig:v1beta/PackageResourceRPM/pullDeps": pull_deps
"/osconfig:v1beta/PackageResourceRPM/source": source
"/osconfig:v1beta/PackageResourceYUM": package_resource_yum
"/osconfig:v1beta/PackageResourceYUM/name": name
"/osconfig:v1beta/PackageResourceZypper": package_resource_zypper
"/osconfig:v1beta/PackageResourceZypper/name": name
"/osconfig:v1beta/PatchConfig": patch_config
"/osconfig:v1beta/PatchConfig/apt": apt
"/osconfig:v1beta/PatchConfig/goo": goo
@ -110109,6 +110214,34 @@
"/osconfig:v1beta/RecurringSchedule/timeOfDay": time_of_day
"/osconfig:v1beta/RecurringSchedule/timeZone": time_zone
"/osconfig:v1beta/RecurringSchedule/weekly": weekly
"/osconfig:v1beta/RepositoryResource": repository_resource
"/osconfig:v1beta/RepositoryResource/apt": apt
"/osconfig:v1beta/RepositoryResource/goo": goo
"/osconfig:v1beta/RepositoryResource/yum": yum
"/osconfig:v1beta/RepositoryResource/zypper": zypper
"/osconfig:v1beta/RepositoryResourceAptRepository": repository_resource_apt_repository
"/osconfig:v1beta/RepositoryResourceAptRepository/archiveType": archive_type
"/osconfig:v1beta/RepositoryResourceAptRepository/components": components
"/osconfig:v1beta/RepositoryResourceAptRepository/components/component": component
"/osconfig:v1beta/RepositoryResourceAptRepository/distribution": distribution
"/osconfig:v1beta/RepositoryResourceAptRepository/gpgKey": gpg_key
"/osconfig:v1beta/RepositoryResourceAptRepository/uri": uri
"/osconfig:v1beta/RepositoryResourceGooRepository": repository_resource_goo_repository
"/osconfig:v1beta/RepositoryResourceGooRepository/name": name
"/osconfig:v1beta/RepositoryResourceGooRepository/url": url
"/osconfig:v1beta/RepositoryResourceYumRepository": repository_resource_yum_repository
"/osconfig:v1beta/RepositoryResourceYumRepository/baseUrl": base_url
"/osconfig:v1beta/RepositoryResourceYumRepository/displayName": display_name
"/osconfig:v1beta/RepositoryResourceYumRepository/gpgKeys": gpg_keys
"/osconfig:v1beta/RepositoryResourceYumRepository/gpgKeys/gpg_key": gpg_key
"/osconfig:v1beta/RepositoryResourceYumRepository/id": id
"/osconfig:v1beta/RepositoryResourceZypperRepository": repository_resource_zypper_repository
"/osconfig:v1beta/RepositoryResourceZypperRepository/baseUrl": base_url
"/osconfig:v1beta/RepositoryResourceZypperRepository/displayName": display_name
"/osconfig:v1beta/RepositoryResourceZypperRepository/gpgKeys": gpg_keys
"/osconfig:v1beta/RepositoryResourceZypperRepository/gpgKeys/gpg_key": gpg_key
"/osconfig:v1beta/RepositoryResourceZypperRepository/id": id
"/osconfig:v1beta/ServiceResource": service_resource
"/osconfig:v1beta/SoftwareRecipe": software_recipe
"/osconfig:v1beta/SoftwareRecipe/artifacts": artifacts
"/osconfig:v1beta/SoftwareRecipe/artifacts/artifact": artifact
@ -111407,6 +111540,10 @@
"/people:v1/CalendarUrl/metadata": metadata
"/people:v1/CalendarUrl/type": type
"/people:v1/CalendarUrl/url": url
"/people:v1/ClientData": client_data
"/people:v1/ClientData/key": key
"/people:v1/ClientData/metadata": metadata
"/people:v1/ClientData/value": value
"/people:v1/ContactGroup": contact_group
"/people:v1/ContactGroup/etag": etag
"/people:v1/ContactGroup/formattedName": formatted_name
@ -111586,6 +111723,8 @@
"/people:v1/Person/braggingRights/bragging_right": bragging_right
"/people:v1/Person/calendarUrls": calendar_urls
"/people:v1/Person/calendarUrls/calendar_url": calendar_url
"/people:v1/Person/clientData": client_data
"/people:v1/Person/clientData/client_datum": client_datum
"/people:v1/Person/coverPhotos": cover_photos
"/people:v1/Person/coverPhotos/cover_photo": cover_photo
"/people:v1/Person/emailAddresses": email_addresses
@ -114383,6 +114522,91 @@
"/pubsub:v1beta2/pubsub.projects.topics.testIamPermissions": test_topic_iam_permissions
"/pubsub:v1beta2/pubsub.projects.topics.testIamPermissions/resource": resource
"/pubsub:v1beta2/quotaUser": quota_user
"/pubsublite:v1/Capacity": capacity
"/pubsublite:v1/Capacity/publishMibPerSec": publish_mib_per_sec
"/pubsublite:v1/Capacity/subscribeMibPerSec": subscribe_mib_per_sec
"/pubsublite:v1/Cursor": cursor
"/pubsublite:v1/Cursor/offset": offset
"/pubsublite:v1/DeliveryConfig": delivery_config
"/pubsublite:v1/DeliveryConfig/deliveryRequirement": delivery_requirement
"/pubsublite:v1/Empty": empty
"/pubsublite:v1/ListPartitionCursorsResponse": list_partition_cursors_response
"/pubsublite:v1/ListPartitionCursorsResponse/nextPageToken": next_page_token
"/pubsublite:v1/ListPartitionCursorsResponse/partitionCursors": partition_cursors
"/pubsublite:v1/ListPartitionCursorsResponse/partitionCursors/partition_cursor": partition_cursor
"/pubsublite:v1/ListSubscriptionsResponse": list_subscriptions_response
"/pubsublite:v1/ListSubscriptionsResponse/nextPageToken": next_page_token
"/pubsublite:v1/ListSubscriptionsResponse/subscriptions": subscriptions
"/pubsublite:v1/ListSubscriptionsResponse/subscriptions/subscription": subscription
"/pubsublite:v1/ListTopicSubscriptionsResponse": list_topic_subscriptions_response
"/pubsublite:v1/ListTopicSubscriptionsResponse/nextPageToken": next_page_token
"/pubsublite:v1/ListTopicSubscriptionsResponse/subscriptions": subscriptions
"/pubsublite:v1/ListTopicSubscriptionsResponse/subscriptions/subscription": subscription
"/pubsublite:v1/ListTopicsResponse": list_topics_response
"/pubsublite:v1/ListTopicsResponse/nextPageToken": next_page_token
"/pubsublite:v1/ListTopicsResponse/topics": topics
"/pubsublite:v1/ListTopicsResponse/topics/topic": topic
"/pubsublite:v1/PartitionConfig": partition_config
"/pubsublite:v1/PartitionConfig/capacity": capacity
"/pubsublite:v1/PartitionConfig/count": count
"/pubsublite:v1/PartitionConfig/scale": scale
"/pubsublite:v1/PartitionCursor": partition_cursor
"/pubsublite:v1/PartitionCursor/cursor": cursor
"/pubsublite:v1/PartitionCursor/partition": partition
"/pubsublite:v1/RetentionConfig": retention_config
"/pubsublite:v1/RetentionConfig/perPartitionBytes": per_partition_bytes
"/pubsublite:v1/RetentionConfig/period": period
"/pubsublite:v1/Subscription": subscription
"/pubsublite:v1/Subscription/deliveryConfig": delivery_config
"/pubsublite:v1/Subscription/name": name
"/pubsublite:v1/Subscription/topic": topic
"/pubsublite:v1/Topic": topic
"/pubsublite:v1/Topic/name": name
"/pubsublite:v1/Topic/partitionConfig": partition_config
"/pubsublite:v1/Topic/retentionConfig": retention_config
"/pubsublite:v1/TopicPartitions": topic_partitions
"/pubsublite:v1/TopicPartitions/partitionCount": partition_count
"/pubsublite:v1/fields": fields
"/pubsublite:v1/key": key
"/pubsublite:v1/pubsublite.admin.projects.locations.subscriptions.create": create_admin_project_location_subscription
"/pubsublite:v1/pubsublite.admin.projects.locations.subscriptions.create/parent": parent
"/pubsublite:v1/pubsublite.admin.projects.locations.subscriptions.create/subscriptionId": subscription_id
"/pubsublite:v1/pubsublite.admin.projects.locations.subscriptions.delete": delete_admin_project_location_subscription
"/pubsublite:v1/pubsublite.admin.projects.locations.subscriptions.delete/name": name
"/pubsublite:v1/pubsublite.admin.projects.locations.subscriptions.get": get_admin_project_location_subscription
"/pubsublite:v1/pubsublite.admin.projects.locations.subscriptions.get/name": name
"/pubsublite:v1/pubsublite.admin.projects.locations.subscriptions.list": list_admin_project_location_subscriptions
"/pubsublite:v1/pubsublite.admin.projects.locations.subscriptions.list/pageSize": page_size
"/pubsublite:v1/pubsublite.admin.projects.locations.subscriptions.list/pageToken": page_token
"/pubsublite:v1/pubsublite.admin.projects.locations.subscriptions.list/parent": parent
"/pubsublite:v1/pubsublite.admin.projects.locations.subscriptions.patch": patch_admin_project_location_subscription
"/pubsublite:v1/pubsublite.admin.projects.locations.subscriptions.patch/name": name
"/pubsublite:v1/pubsublite.admin.projects.locations.subscriptions.patch/updateMask": update_mask
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.create": create_admin_project_location_topic
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.create/parent": parent
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.create/topicId": topic_id
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.delete": delete_admin_project_location_topic
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.delete/name": name
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.get": get_admin_project_location_topic
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.get/name": name
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.getPartitions": get_admin_project_location_topic_partitions
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.getPartitions/name": name
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.list": list_admin_project_location_topics
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.list/pageSize": page_size
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.list/pageToken": page_token
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.list/parent": parent
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.patch": patch_admin_project_location_topic
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.patch/name": name
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.patch/updateMask": update_mask
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.subscriptions.list": list_admin_project_location_topic_subscriptions
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.subscriptions.list/name": name
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.subscriptions.list/pageSize": page_size
"/pubsublite:v1/pubsublite.admin.projects.locations.topics.subscriptions.list/pageToken": page_token
"/pubsublite:v1/pubsublite.cursor.projects.locations.subscriptions.cursors.list": list_cursor_project_location_subscription_cursors
"/pubsublite:v1/pubsublite.cursor.projects.locations.subscriptions.cursors.list/pageSize": page_size
"/pubsublite:v1/pubsublite.cursor.projects.locations.subscriptions.cursors.list/pageToken": page_token
"/pubsublite:v1/pubsublite.cursor.projects.locations.subscriptions.cursors.list/parent": parent
"/pubsublite:v1/quotaUser": quota_user
"/qpxExpress:v1/AircraftData": aircraft_data
"/qpxExpress:v1/AircraftData/code": code
"/qpxExpress:v1/AircraftData/kind": kind

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/appengine/docs/admin-api/
module AppengineV1
VERSION = 'V1'
REVISION = '20200715'
REVISION = '20200802'
# View and manage your applications deployed on Google App Engine
AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin'

View File

@ -489,15 +489,15 @@ module Google
# Unencrypted PEM encoded RSA private key. This field is set once on certificate
# creation and then encrypted. The key size must be 2048 bits or fewer. Must
# include the header and footer. Example: <pre> -----BEGIN RSA PRIVATE KEY----- <
# unencrypted_key_value> -----END RSA PRIVATE KEY----- </pre> @InputOnly
# include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----
# END RSA PRIVATE KEY----- @InputOnly
# Corresponds to the JSON property `privateKey`
# @return [String]
attr_accessor :private_key
# PEM encoded x.509 public key certificate. This field is set once on
# certificate creation. Must include the header and footer. Example: <pre> -----
# BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- </pre>
# certificate creation. Must include the header and footer. Example: -----BEGIN
# CERTIFICATE----- -----END CERTIFICATE-----
# Corresponds to the JSON property `publicCertificate`
# @return [String]
attr_accessor :public_certificate
@ -658,11 +658,11 @@ module Google
class DebugInstanceRequest
include Google::Apis::Core::Hashable
# Public SSH key to add to the instance. Examples:
# [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]
# [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh `"userName":"[USERNAME]","expireOn":"
# [EXPIRE_TIME]"`For more information, see Adding and Removing SSH Keys (https://
# cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
# Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE]
# [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh `"userName":"[USERNAME]",
# "expireOn":"[EXPIRE_TIME]"`For more information, see Adding and Removing SSH
# Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys)
# .
# Corresponds to the JSON property `sshKey`
# @return [String]
attr_accessor :ssh_key
@ -800,11 +800,9 @@ module Google
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for Empty is empty JSON object ``.
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# Empty is empty JSON object ``.
class Empty
include Google::Apis::Core::Hashable
@ -969,7 +967,7 @@ module Google
attr_accessor :sha1_sum
# URL source to use to fetch this file. Must be a URL to a resource in Google
# Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
# Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
# Corresponds to the JSON property `sourceUrl`
# @return [String]
attr_accessor :source_url
@ -1013,7 +1011,7 @@ module Google
# IP address or range, defined using CIDR notation, of requests that this rule
# applies to. You can use the wildcard character "*" to match all IPs equivalent
# to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:
# db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be
# db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be
# silently performed on addresses which are not properly truncated. For example,
# 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6,
# 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
@ -1575,8 +1573,8 @@ module Google
# @return [String]
attr_accessor :display_name
# Cross-service attributes for the location. For example
# `"cloud.googleapis.com/region": "us-east1"`
# Cross-service attributes for the location. For example `"cloud.googleapis.com/
# region": "us-east1"`
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
@ -1721,18 +1719,16 @@ module Google
# Google Cloud Platform sub-network where the virtual machines are created.
# Specify the short name, not the resource path.If a subnetwork name is
# specified, a network name will also be required unless it is for the default
# network.
# If the network that the instance is being created in is a Legacy network, then
# the IP address is allocated from the IPv4Range.
# If the network that the instance is being created in is an auto Subnet Mode
# Network, then only network name should be specified (not the subnetwork_name)
# and the IP address is created from the IPCidrRange of the subnetwork that
# exists in that zone for that network.
# If the network that the instance is being created in is a custom Subnet Mode
# Network, then the subnetwork_name must be specified and the IP address is
# created from the IPCidrRange of the subnetwork.If specified, the subnetwork
# must exist in the same region as the App Engine flexible environment
# application.
# network. If the network that the instance is being created in is a Legacy
# network, then the IP address is allocated from the IPv4Range. If the network
# that the instance is being created in is an auto Subnet Mode Network, then
# only network name should be specified (not the subnetwork_name) and the IP
# address is created from the IPCidrRange of the subnetwork that exists in that
# zone for that network. If the network that the instance is being created in is
# a custom Subnet Mode Network, then the subnetwork_name must be specified and
# the IP address is created from the IPCidrRange of the subnetwork.If specified,
# the subnetwork must exist in the same region as the App Engine flexible
# environment application.
# Corresponds to the JSON property `subnetworkName`
# @return [String]
attr_accessor :subnetwork_name
@ -2191,6 +2187,12 @@ module Google
# @return [Float]
attr_accessor :disk_gb
# The name of the encryption key that is stored in Google Cloud KMS. Only should
# be used by Cloud Composer to encrypt the vm disk
# Corresponds to the JSON property `kmsKeyReference`
# @return [String]
attr_accessor :kms_key_reference
# Memory (GB) needed.
# Corresponds to the JSON property `memoryGb`
# @return [Float]
@ -2209,6 +2211,7 @@ module Google
def update!(**args)
@cpu = args[:cpu] if args.key?(:cpu)
@disk_gb = args[:disk_gb] if args.key?(:disk_gb)
@kms_key_reference = args[:kms_key_reference] if args.key?(:kms_key_reference)
@memory_gb = args[:memory_gb] if args.key?(:memory_gb)
@volumes = args[:volumes] if args.key?(:volumes)
end
@ -2722,9 +2725,9 @@ module Google
attr_accessor :inbound_services
# 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.
# 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.
# Corresponds to the JSON property `instanceClass`
# @return [String]
attr_accessor :instance_class
@ -2782,7 +2785,7 @@ module Google
# 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/<language>/config/appref
# standard//config/appref
# Corresponds to the JSON property `runtimeApiVersion`
# @return [String]
attr_accessor :runtime_api_version
@ -2944,7 +2947,7 @@ module Google
attr_accessor :files_count
# URL of the zip file to deploy from. Must be a URL to a resource in Google
# Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
# Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
# Corresponds to the JSON property `sourceUrl`
# @return [String]
attr_accessor :source_url

View File

@ -1004,6 +1004,7 @@ module Google
class Representation < Google::Apis::Core::JsonRepresentation
property :cpu, as: 'cpu'
property :disk_gb, as: 'diskGb'
property :kms_key_reference, as: 'kmsKeyReference'
property :memory_gb, as: 'memoryGb'
collection :volumes, as: 'volumes', class: Google::Apis::AppengineV1::Volume, decorator: Google::Apis::AppengineV1::Volume::Representation

View File

@ -48,12 +48,11 @@ module Google
end
# Creates an App Engine application for a Google Cloud Platform project.
# Required fields:
# id - The ID of the target Cloud Platform project.
# location - The region (https://cloud.google.com/appengine/docs/locations)
# where you want the App Engine application located.For more information about
# App Engine applications, see Managing Projects, Applications, and Billing (
# https://cloud.google.com/appengine/docs/standard/python/console/).
# Required fields: id - The ID of the target Cloud Platform project. location -
# The region (https://cloud.google.com/appengine/docs/locations) where you want
# the App Engine application located.For more information about App Engine
# applications, see Managing Projects, Applications, and Billing (https://cloud.
# google.com/appengine/docs/standard/python/console/).
# @param [Google::Apis::AppengineV1::Application] application_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -114,10 +113,9 @@ module Google
end
# Updates the specified Application resource. You can update the following
# fields:
# auth_domain - Google authentication domain for controlling user access to the
# application.
# default_cookie_expiration - Cookie expiration policy for the application.
# fields: auth_domain - Google authentication domain for controlling user access
# to the application. default_cookie_expiration - Cookie expiration policy for
# the application.
# @param [String] apps_id
# Part of `name`. Name of the Application resource to update. Example: apps/
# myapp.
@ -1296,50 +1294,43 @@ module Google
# 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:
# 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)
# 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)
# 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)
# 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)
# @param [String] apps_id
# Part of `name`. Name of the resource to update. Example: apps/myapp/services/
# default/versions/1.

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/appengine/docs/admin-api/
module AppengineV1alpha
VERSION = 'V1alpha'
REVISION = '20200329'
REVISION = '20200802'
# View and manage your applications deployed on Google App Engine
AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin'

View File

@ -141,15 +141,15 @@ module Google
# Unencrypted PEM encoded RSA private key. This field is set once on certificate
# creation and then encrypted. The key size must be 2048 bits or fewer. Must
# include the header and footer. Example: <pre> -----BEGIN RSA PRIVATE KEY----- <
# unencrypted_key_value> -----END RSA PRIVATE KEY----- </pre> @InputOnly
# include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----
# END RSA PRIVATE KEY----- @InputOnly
# Corresponds to the JSON property `privateKey`
# @return [String]
attr_accessor :private_key
# PEM encoded x.509 public key certificate. This field is set once on
# certificate creation. Must include the header and footer. Example: <pre> -----
# BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- </pre>
# certificate creation. Must include the header and footer. Example: -----BEGIN
# CERTIFICATE----- -----END CERTIFICATE-----
# Corresponds to the JSON property `publicCertificate`
# @return [String]
attr_accessor :public_certificate
@ -270,11 +270,9 @@ module Google
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for Empty is empty JSON object ``.
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# Empty is empty JSON object ``.
class Empty
include Google::Apis::Core::Hashable
@ -422,8 +420,8 @@ module Google
# @return [String]
attr_accessor :display_name
# Cross-service attributes for the location. For example
# `"cloud.googleapis.com/region": "us-east1"`
# Cross-service attributes for the location. For example `"cloud.googleapis.com/
# region": "us-east1"`
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/appengine/docs/admin-api/
module AppengineV1beta
VERSION = 'V1beta'
REVISION = '20200715'
REVISION = '20200802'
# View and manage your applications deployed on Google App Engine
AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin'

View File

@ -515,15 +515,15 @@ module Google
# Unencrypted PEM encoded RSA private key. This field is set once on certificate
# creation and then encrypted. The key size must be 2048 bits or fewer. Must
# include the header and footer. Example: <pre> -----BEGIN RSA PRIVATE KEY----- <
# unencrypted_key_value> -----END RSA PRIVATE KEY----- </pre> @InputOnly
# include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----
# END RSA PRIVATE KEY----- @InputOnly
# Corresponds to the JSON property `privateKey`
# @return [String]
attr_accessor :private_key
# PEM encoded x.509 public key certificate. This field is set once on
# certificate creation. Must include the header and footer. Example: <pre> -----
# BEGIN CERTIFICATE----- <certificate_value> -----END CERTIFICATE----- </pre>
# certificate creation. Must include the header and footer. Example: -----BEGIN
# CERTIFICATE----- -----END CERTIFICATE-----
# Corresponds to the JSON property `publicCertificate`
# @return [String]
attr_accessor :public_certificate
@ -731,11 +731,11 @@ module Google
class DebugInstanceRequest
include Google::Apis::Core::Hashable
# Public SSH key to add to the instance. Examples:
# [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]
# [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh `"userName":"[USERNAME]","expireOn":"
# [EXPIRE_TIME]"`For more information, see Adding and Removing SSH Keys (https://
# cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
# Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE]
# [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh `"userName":"[USERNAME]",
# "expireOn":"[EXPIRE_TIME]"`For more information, see Adding and Removing SSH
# Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys)
# .
# Corresponds to the JSON property `sshKey`
# @return [String]
attr_accessor :ssh_key
@ -879,11 +879,9 @@ module Google
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for Empty is empty JSON object ``.
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# Empty is empty JSON object ``.
class Empty
include Google::Apis::Core::Hashable
@ -1048,7 +1046,7 @@ module Google
attr_accessor :sha1_sum
# URL source to use to fetch this file. Must be a URL to a resource in Google
# Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
# Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
# Corresponds to the JSON property `sourceUrl`
# @return [String]
attr_accessor :source_url
@ -1092,7 +1090,7 @@ module Google
# IP address or range, defined using CIDR notation, of requests that this rule
# applies to. You can use the wildcard character "*" to match all IPs equivalent
# to "0/0" and "::/0" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:
# db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.<p>Truncation will be
# db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be
# silently performed on addresses which are not properly truncated. For example,
# 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6,
# 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.
@ -1654,8 +1652,8 @@ module Google
# @return [String]
attr_accessor :display_name
# Cross-service attributes for the location. For example
# `"cloud.googleapis.com/region": "us-east1"`
# Cross-service attributes for the location. For example `"cloud.googleapis.com/
# region": "us-east1"`
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
@ -1800,18 +1798,16 @@ module Google
# Google Cloud Platform sub-network where the virtual machines are created.
# Specify the short name, not the resource path.If a subnetwork name is
# specified, a network name will also be required unless it is for the default
# network.
# If the network that the instance is being created in is a Legacy network, then
# the IP address is allocated from the IPv4Range.
# If the network that the instance is being created in is an auto Subnet Mode
# Network, then only network name should be specified (not the subnetwork_name)
# and the IP address is created from the IPCidrRange of the subnetwork that
# exists in that zone for that network.
# If the network that the instance is being created in is a custom Subnet Mode
# Network, then the subnetwork_name must be specified and the IP address is
# created from the IPCidrRange of the subnetwork.If specified, the subnetwork
# must exist in the same region as the App Engine flexible environment
# application.
# network. If the network that the instance is being created in is a Legacy
# network, then the IP address is allocated from the IPv4Range. If the network
# that the instance is being created in is an auto Subnet Mode Network, then
# only network name should be specified (not the subnetwork_name) and the IP
# address is created from the IPCidrRange of the subnetwork that exists in that
# zone for that network. If the network that the instance is being created in is
# a custom Subnet Mode Network, then the subnetwork_name must be specified and
# the IP address is created from the IPCidrRange of the subnetwork.If specified,
# the subnetwork must exist in the same region as the App Engine flexible
# environment application.
# Corresponds to the JSON property `subnetworkName`
# @return [String]
attr_accessor :subnetwork_name
@ -2270,6 +2266,12 @@ module Google
# @return [Float]
attr_accessor :disk_gb
# The name of the encryption key that is stored in Google Cloud KMS. Only should
# be used by Cloud Composer to encrypt the vm disk
# Corresponds to the JSON property `kmsKeyReference`
# @return [String]
attr_accessor :kms_key_reference
# Memory (GB) needed.
# Corresponds to the JSON property `memoryGb`
# @return [Float]
@ -2288,6 +2290,7 @@ module Google
def update!(**args)
@cpu = args[:cpu] if args.key?(:cpu)
@disk_gb = args[:disk_gb] if args.key?(:disk_gb)
@kms_key_reference = args[:kms_key_reference] if args.key?(:kms_key_reference)
@memory_gb = args[:memory_gb] if args.key?(:memory_gb)
@volumes = args[:volumes] if args.key?(:volumes)
end
@ -2801,9 +2804,9 @@ module Google
attr_accessor :inbound_services
# 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.
# 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.
# Corresponds to the JSON property `instanceClass`
# @return [String]
attr_accessor :instance_class
@ -2861,7 +2864,7 @@ module Google
# 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/<language>/config/appref
# standard//config/appref
# Corresponds to the JSON property `runtimeApiVersion`
# @return [String]
attr_accessor :runtime_api_version
@ -3023,7 +3026,7 @@ module Google
attr_accessor :files_count
# URL of the zip file to deploy from. Must be a URL to a resource in Google
# Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
# Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
# Corresponds to the JSON property `sourceUrl`
# @return [String]
attr_accessor :source_url

View File

@ -1038,6 +1038,7 @@ module Google
class Representation < Google::Apis::Core::JsonRepresentation
property :cpu, as: 'cpu'
property :disk_gb, as: 'diskGb'
property :kms_key_reference, as: 'kmsKeyReference'
property :memory_gb, as: 'memoryGb'
collection :volumes, as: 'volumes', class: Google::Apis::AppengineV1beta::Volume, decorator: Google::Apis::AppengineV1beta::Volume::Representation

View File

@ -48,12 +48,11 @@ module Google
end
# Creates an App Engine application for a Google Cloud Platform project.
# Required fields:
# id - The ID of the target Cloud Platform project.
# location - The region (https://cloud.google.com/appengine/docs/locations)
# where you want the App Engine application located.For more information about
# App Engine applications, see Managing Projects, Applications, and Billing (
# https://cloud.google.com/appengine/docs/standard/python/console/).
# Required fields: id - The ID of the target Cloud Platform project. location -
# The region (https://cloud.google.com/appengine/docs/locations) where you want
# the App Engine application located.For more information about App Engine
# applications, see Managing Projects, Applications, and Billing (https://cloud.
# google.com/appengine/docs/standard/python/console/).
# @param [Google::Apis::AppengineV1beta::Application] application_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -114,10 +113,9 @@ module Google
end
# Updates the specified Application resource. You can update the following
# fields:
# auth_domain - Google authentication domain for controlling user access to the
# application.
# default_cookie_expiration - Cookie expiration policy for the application.
# fields: auth_domain - Google authentication domain for controlling user access
# to the application. default_cookie_expiration - Cookie expiration policy for
# the application.
# @param [String] apps_id
# Part of `name`. Name of the Application resource to update. Example: apps/
# myapp.
@ -1296,51 +1294,43 @@ module Google
# 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/v1beta/apps.services.versions#Version.FIELDS.instance_class)automatic
# scaling in the standard environment:
# resource uses:Standard environment instance_class (https://cloud.google.com/
# appengine/docs/admin-api/reference/rest/v1beta/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/v1beta/apps.services.versions#Version.FIELDS.
# automatic_scaling)
# automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/
# admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.
# automatic_scaling)
# automaticScaling.standard_scheduler_settings.max_instances (https://cloud.
# google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.
# versions#StandardSchedulerSettings)
# automaticScaling.standard_scheduler_settings.min_instances (https://cloud.
# google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.
# versions#StandardSchedulerSettings)
# automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://
# cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.
# versions#StandardSchedulerSettings)
# automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.
# com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#
# Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.
# max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/
# rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.
# standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/
# docs/admin-api/reference/rest/v1beta/apps.services.versions#
# StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.
# target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/
# reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)
# automaticScaling.standard_scheduler_settings.target_throughput_utilization (
# https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/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/v1beta/apps.services.versions#Version.FIELDS.serving_status)
# manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/
# reference/rest/v1beta/apps.services.versions#manualscaling)Flexible
# environment
# serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/
# rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)automatic
# scaling in the flexible environment:
# the standard environment: serving_status (https://cloud.google.com/appengine/
# docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.
# serving_status) manual_scaling.instances (https://cloud.google.com/appengine/
# docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)
# Flexible environment serving_status (https://cloud.google.com/appengine/docs/
# admin-api/reference/rest/v1beta/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/v1beta/apps.services.versions#Version.FIELDS.
# automatic_scaling)
# automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/
# automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.
# com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#
# Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (
# https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.
# services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.
# cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/
# admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.
# automatic_scaling)
# automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/
# docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.
# automatic_scaling)
# automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/
# appengine/docs/admin-api/reference/rest/v1beta/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/v1beta/apps.services.versions#manualscaling)
# automatic_scaling)manual scaling in the flexible environment: manual_scaling.
# instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/
# v1beta/apps.services.versions#manualscaling)
# @param [String] apps_id
# Part of `name`. Name of the resource to update. Example: apps/myapp/services/
# default/versions/1.

View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/apps-marketplace
module AppsmarketV2
VERSION = 'V2'
REVISION = '20200727'
REVISION = '20200803'
# View your installed application's licensing information
AUTH_APPSMARKETPLACE_LICENSE = 'https://www.googleapis.com/auth/appsmarketplace.license'

View File

@ -51,7 +51,9 @@ module Google
# @return [String]
attr_accessor :kind
# The customer's license status.
# The customer's license status. One of: - `ACTIVE`: The customer has a valid
# license. - `UNLICENSED`: There is no license: either this customer has never
# installed your application, or else has deleted it.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
@ -196,8 +198,7 @@ module Google
# @return [Array<Google::Apis::AppsmarketV2::Reassignments>]
attr_accessor :reassignments
# The time the event occurred, measuring in milliseconds since the UNIX
# epoch.
# The time the event occurred, measuring in milliseconds since the UNIX epoch.
# Corresponds to the JSON property `timestamp`
# @return [Fixnum]
attr_accessor :timestamp
@ -235,12 +236,11 @@ module Google
# @return [String]
attr_accessor :next_page_token
# The list of notifications. One or more of:
# - provisions -- A new license of the application has been provisioned.
# - expiries -- A license of the application has expired.
# - deletions -- An application has been deleted from a domain.
# - reassignments -- An administrator has assigned or revoked a seat license
# for the application on the provided domain.
# The list of notifications. One or more of: - `provisions`: A new license of
# the application has been provisioned. - `expiries`: A license of the
# application has expired. - `deletions`: An application has been deleted from a
# domain. - `reassignments`: An administrator has assigned or revoked a seat
# license for the application on the provided domain.
# Corresponds to the JSON property `notifications`
# @return [Array<Google::Apis::AppsmarketV2::LicenseNotification>]
attr_accessor :notifications
@ -360,13 +360,11 @@ module Google
# @return [String]
attr_accessor :kind
# The user's licensing status. One of:
# - ACTIVE -- The user has a valid license and should be permitted to use the
# application.
# - UNLICENSED -- The administrator of this user's domain never assigned a
# seat for the application to this user.
# - EXPIRED -- The administrator assigned a seat to this user, but the
# license is expired.
# The user's licensing status. One of: - `ACTIVE`: The user has a valid license
# and should be permitted to use the application. - `UNLICENSED`: The
# administrator of this user's domain never assigned a seat for the application
# to this user. - `EXPIRED`: The administrator assigned a seat to this user, but
# the license is expired.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/bigquery/
module BigquerydatatransferV1
VERSION = 'V1'
REVISION = '20200616'
REVISION = '20200801'
# View and manage your data in Google BigQuery
AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery'

View File

@ -22,12 +22,11 @@ module Google
module Apis
module BigquerydatatransferV1
# A request to determine whether the user has valid credentials. This method
# is used to limit the number of OAuth popups in the user interface. The
# user id is inferred from the API call context.
# If the data source has the Google+ authorization type, this method
# returns false, as it cannot be determined whether the credentials are
# already valid merely based on the user id.
# A request to determine whether the user has valid credentials. This method is
# used to limit the number of OAuth popups in the user interface. The user id is
# inferred from the API call context. If the data source has the Google+
# authorization type, this method returns false, as it cannot be determined
# whether the credentials are already valid merely based on the user id.
class CheckValidCredsRequest
include Google::Apis::Core::Hashable
@ -60,8 +59,8 @@ module Google
end
end
# Represents data source metadata. Metadata is sufficient to
# render UI and request proper OAuth tokens.
# Represents data source metadata. Metadata is sufficient to render UI and
# request proper OAuth tokens.
class DataSource
include Google::Apis::Core::Hashable
@ -75,10 +74,9 @@ module Google
# @return [String]
attr_accessor :client_id
# 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.
# 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.
# Corresponds to the JSON property `dataRefreshType`
# @return [String]
attr_accessor :data_refresh_type
@ -88,17 +86,15 @@ module Google
# @return [String]
attr_accessor :data_source_id
# Default data refresh window on days.
# Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
# Default data refresh window on days. Only meaningful when `data_refresh_type` =
# `SLIDING_WINDOW`.
# Corresponds to the JSON property `defaultDataRefreshWindowDays`
# @return [Fixnum]
attr_accessor :default_data_refresh_window_days
# 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`.
# 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`.
# Corresponds to the JSON property `defaultSchedule`
# @return [String]
attr_accessor :default_schedule
@ -118,8 +114,7 @@ module Google
# @return [String]
attr_accessor :help_url
# Disables backfilling and manual run scheduling
# for the data source.
# Disables backfilling and manual run scheduling for the data source.
# Corresponds to the JSON property `manualRunsDisabled`
# @return [Boolean]
attr_accessor :manual_runs_disabled
@ -140,16 +135,16 @@ module Google
# @return [Array<Google::Apis::BigquerydatatransferV1::DataSourceParameter>]
attr_accessor :parameters
# 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
# 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
# Corresponds to the JSON property `scopes`
# @return [Array<String>]
attr_accessor :scopes
# 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.
# operates on the default schedule. When set to `true`, user can override
# default schedule.
# Corresponds to the JSON property `supportsCustomSchedule`
# @return [Boolean]
attr_accessor :supports_custom_schedule
@ -166,8 +161,8 @@ module Google
# @return [String]
attr_accessor :transfer_type
# The number of seconds to wait for an update from the data source
# before the Data Transfer Service marks the transfer as FAILED.
# The number of seconds to wait for an update from the data source before the
# Data Transfer Service marks the transfer as FAILED.
# Corresponds to the JSON property `updateDeadlineSeconds`
# @return [Fixnum]
attr_accessor :update_deadline_seconds
@ -199,12 +194,11 @@ module Google
end
end
# Represents a data source parameter with validation rules, so that
# parameters can be rendered in the UI. These parameters are given to us by
# supported data sources, and include all needed information for rendering
# and validation.
# Thus, whoever uses this api can decide to generate either generic ui,
# or custom data source specific forms.
# Represents a data source parameter with validation rules, so that parameters
# can be rendered in the UI. These parameters are given to us by supported data
# sources, and include all needed information for rendering and validation. Thus,
# whoever uses this api can decide to generate either generic ui, or custom
# data source specific forms.
class DataSourceParameter
include Google::Apis::Core::Hashable
@ -213,8 +207,8 @@ module Google
# @return [Array<String>]
attr_accessor :allowed_values
# If true, it should not be used in new transfers, and it should not be
# visible to users.
# If true, it should not be used in new transfers, and it should not be visible
# to users.
# Corresponds to the JSON property `deprecated`
# @return [Boolean]
attr_accessor :deprecated
@ -320,8 +314,7 @@ module Google
end
end
# Represents preferences for sending email notifications for transfer run
# events.
# Represents preferences for sending email notifications for transfer run events.
class EmailPreferences
include Google::Apis::Core::Hashable
@ -341,13 +334,11 @@ module Google
end
end
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
@ -369,10 +360,9 @@ module Google
# @return [Array<Google::Apis::BigquerydatatransferV1::DataSource>]
attr_accessor :data_sources
# Output only. The next-pagination token. For multiple-page list results,
# this token can be used as the
# `ListDataSourcesRequest.page_token`
# to request the next page of list results.
# Output only. The next-pagination token. For multiple-page list results, this
# token can be used as the `ListDataSourcesRequest.page_token` to request the
# next page of list results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -417,10 +407,9 @@ module Google
class ListTransferConfigsResponse
include Google::Apis::Core::Hashable
# 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.
# 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.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -445,10 +434,9 @@ module Google
class ListTransferLogsResponse
include Google::Apis::Core::Hashable
# 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.
# 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.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -473,10 +461,9 @@ module Google
class ListTransferRunsResponse
include Google::Apis::Core::Hashable
# 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.
# 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.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -501,14 +488,14 @@ module Google
class Location
include Google::Apis::Core::Hashable
# The friendly name for this location, typically a nearby city name.
# For example, "Tokyo".
# The friendly name for this location, typically a nearby city name. For example,
# "Tokyo".
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Cross-service attributes for the location. For example
# `"cloud.googleapis.com/region": "us-east1"`
# Cross-service attributes for the location. For example `"cloud.googleapis.com/
# region": "us-east1"`
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
@ -524,8 +511,8 @@ module Google
# @return [Hash<String,Object>]
attr_accessor :metadata
# Resource name for the location, which may vary between implementations.
# For example: `"projects/example-project/locations/us-east1"`
# Resource name for the location, which may vary between implementations. For
# example: `"projects/example-project/locations/us-east1"`
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -558,18 +545,17 @@ module Google
alias_method :disable_auto_scheduling?, :disable_auto_scheduling
# Defines time to stop scheduling transfer runs. A transfer run cannot be
# scheduled at or after the end time. The end time can be changed at any
# moment. The time when a data transfer can be trigerred manually is not
# limited by this option.
# scheduled at or after the end time. The end time can be changed at any moment.
# The time when a data transfer can be trigerred manually is not limited by this
# option.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# Specifies time to start scheduling transfer runs. The first run will be
# scheduled at or after the start time according to a recurrence pattern
# defined in the schedule string. The start time can be changed at any
# moment. The time when a data transfer can be trigerred manually is not
# limited by this option.
# scheduled at or after the start time according to a recurrence pattern defined
# in the schedule string. The start time can be changed at any moment. The time
# when a data transfer can be trigerred manually is not limited by this option.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
@ -590,14 +576,14 @@ module Google
class ScheduleTransferRunsRequest
include Google::Apis::Core::Hashable
# Required. End time of the range of transfer runs. For example,
# `"2017-05-30T00:00:00+00:00"`.
# Required. End time of the range of transfer runs. For example, `"2017-05-30T00:
# 00:00+00:00"`.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# Required. Start time of the range of transfer runs. For example,
# `"2017-05-25T00:00:00+00:00"`.
# Required. Start time of the range of transfer runs. For example, `"2017-05-
# 25T00:00:00+00:00"`.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
@ -636,8 +622,8 @@ module Google
class StartManualTransferRunsRequest
include Google::Apis::Core::Hashable
# Specific run_time for a transfer run to be started. The
# requested_run_time must not be in the future.
# Specific run_time for a transfer run to be started. The requested_run_time
# must not be in the future.
# Corresponds to the JSON property `requestedRunTime`
# @return [String]
attr_accessor :requested_run_time
@ -678,12 +664,12 @@ module Google
end
end
# 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).
# 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).
class Status
include Google::Apis::Core::Hashable
@ -692,15 +678,15 @@ module Google
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# A developer-facing error message, which should be in English. Any user-facing
# error message should be localized and sent in the google.rpc.Status.details
# field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
@ -722,18 +708,18 @@ module Google
class TimeRange
include Google::Apis::Core::Hashable
# End time of the range of transfer runs. For example,
# `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future.
# Creates transfer runs where run_time is in the range between start_time
# (inclusive) and end_time (exclusive).
# End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:
# 00"`. The end_time must not be in the future. Creates transfer runs where
# run_time is in the range between start_time (inclusive) and end_time (
# exclusive).
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# Start time of the range of transfer runs. For example,
# `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than
# the end_time. Creates transfer runs where run_time is in the range
# between start_time (inclusive) and end_time (exclusive).
# Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+
# 00:00"`. The start_time must be strictly less than the end_time. Creates
# transfer runs where run_time is in the range between start_time (inclusive)
# and end_time (exclusive).
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
@ -749,21 +735,20 @@ module Google
end
end
# Represents a data transfer configuration. A transfer configuration
# contains all metadata needed to perform a data transfer. For example,
# `destination_dataset_id` specifies where data should be stored.
# When a new transfer configuration is created, the specified
# `destination_dataset_id` is created when needed and shared with the
# appropriate data source service account.
# Represents a data transfer configuration. A transfer configuration contains
# all metadata needed to perform a data transfer. For example, `
# destination_dataset_id` specifies where data should be stored. When a new
# transfer configuration is created, the specified `destination_dataset_id` is
# created when needed and shared with the appropriate data source service
# account.
class TransferConfig
include Google::Apis::Core::Hashable
# 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.
# 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.
# Corresponds to the JSON property `dataRefreshWindowDays`
# @return [Fixnum]
attr_accessor :data_refresh_window_days
@ -783,8 +768,8 @@ module Google
# @return [String]
attr_accessor :destination_dataset_id
# Is this config disabled. When set to true, no runs are scheduled
# for a given transfer.
# Is this config disabled. When set to true, no runs are scheduled for a given
# transfer.
# Corresponds to the JSON property `disabled`
# @return [Boolean]
attr_accessor :disabled
@ -795,19 +780,17 @@ module Google
# @return [String]
attr_accessor :display_name
# Represents preferences for sending email notifications for transfer run
# events.
# Represents preferences for sending email notifications for transfer run events.
# Corresponds to the JSON property `emailPreferences`
# @return [Google::Apis::BigquerydatatransferV1::EmailPreferences]
attr_accessor :email_preferences
# The resource name of the transfer config.
# Transfer config names have the form of
# `projects/`project_id`/locations/`region`/transferConfigs/`config_id``.
# The name is automatically generated based on the config_id specified in
# CreateTransferConfigRequest along with project_id and region. If config_id
# is not provided, usually a uuid, even though it is not guaranteed or
# required, will be generated for config_id.
# The resource name of the transfer config. Transfer config names have the form
# of `projects/`project_id`/locations/`region`/transferConfigs/`config_id``. The
# name is automatically generated based on the config_id specified in
# CreateTransferConfigRequest along with project_id and region. If config_id is
# not provided, usually a uuid, even though it is not guaranteed or required,
# will be generated for config_id.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -817,8 +800,8 @@ module Google
# @return [String]
attr_accessor :next_run_time
# Pub/Sub topic where notifications will be sent after transfer runs
# associated with this transfer config finish.
# Pub/Sub topic where notifications will be sent after transfer runs associated
# with this transfer config finish.
# Corresponds to the JSON property `notificationPubsubTopic`
# @return [String]
attr_accessor :notification_pubsub_topic
@ -828,19 +811,14 @@ module Google
# @return [Hash<String,Object>]
attr_accessor :params
# 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 granularity should be at least 8 hours, or less frequent.
# 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 granularity should be at least 8 hours, or less
# frequent.
# Corresponds to the JSON property `schedule`
# @return [String]
attr_accessor :schedule
@ -935,33 +913,30 @@ module Google
# @return [String]
attr_accessor :destination_dataset_id
# Represents preferences for sending email notifications for transfer run
# events.
# Represents preferences for sending email notifications for transfer run events.
# Corresponds to the JSON property `emailPreferences`
# @return [Google::Apis::BigquerydatatransferV1::EmailPreferences]
attr_accessor :email_preferences
# Output only. Time when transfer run ended.
# Parameter ignored by server for input requests.
# Output only. Time when transfer run ended. Parameter ignored by server for
# input requests.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# 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).
# 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).
# Corresponds to the JSON property `errorStatus`
# @return [Google::Apis::BigquerydatatransferV1::Status]
attr_accessor :error_status
# 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.
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -983,11 +958,10 @@ module Google
# @return [String]
attr_accessor :run_time
# 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.
# 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.
# Corresponds to the JSON property `schedule`
# @return [String]
attr_accessor :schedule
@ -997,8 +971,8 @@ module Google
# @return [String]
attr_accessor :schedule_time
# Output only. Time when transfer run was started.
# Parameter ignored by server for input requests.
# Output only. Time when transfer run was started. Parameter ignored by server
# for input requests.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time

View File

@ -49,15 +49,14 @@ module Google
end
# Returns true if valid credentials exist for the given data source and
# requesting user.
# Some data sources doesn't support service account, so we need to talk to
# them on behalf of the end user. This API just checks whether we have OAuth
# token for the particular user, which is a pre-requisite before user can
# create a transfer config.
# requesting user. Some data sources doesn't support service account, so we need
# to talk to them on behalf of the end user. This API just checks whether we
# have OAuth token for the particular user, which is a pre-requisite before user
# can create a transfer config.
# @param [String] name
# Required. The data source in the form:
# `projects/`project_id`/dataSources/`data_source_id`` or
# `projects/`project_id`/locations/`location_id`/dataSources/`data_source_id``.
# Required. The data source in the form: `projects/`project_id`/dataSources/`
# data_source_id`` or `projects/`project_id`/locations/`location_id`/dataSources/
# `data_source_id``.
# @param [Google::Apis::BigquerydatatransferV1::CheckValidCredsRequest] check_valid_creds_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -88,12 +87,12 @@ module Google
execute_or_queue_command(command, &block)
end
# Retrieves a supported data source and returns its settings,
# which can be used for UI rendering.
# Retrieves a supported data source and returns its settings, which can be used
# for UI rendering.
# @param [String] name
# Required. The field will contain name of the resource requested, for example:
# `projects/`project_id`/dataSources/`data_source_id`` or
# `projects/`project_id`/locations/`location_id`/dataSources/`data_source_id``
# Required. The field will contain name of the resource requested, for example: `
# projects/`project_id`/dataSources/`data_source_id`` or `projects/`project_id`/
# locations/`location_id`/dataSources/`data_source_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -121,19 +120,18 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists supported data sources and returns their settings,
# which can be used for UI rendering.
# Lists supported data sources and returns their settings, which can be used for
# UI rendering.
# @param [String] parent
# Required. The BigQuery project id for which data sources should be returned.
# Must be in the form: `projects/`project_id`` or
# `projects/`project_id`/locations/`location_id`
# Must be in the form: `projects/`project_id`` or `projects/`project_id`/
# locations/`location_id`
# @param [Fixnum] page_size
# Page size. The default page size is the maximum value of 1000 results.
# @param [String] page_token
# Pagination token, which can be used to request a specific page
# of `ListDataSourcesRequest` list results. For multiple-page
# results, `ListDataSourcesResponse` outputs
# a `next_page` token, which can be used as the
# Pagination token, which can be used to request a specific page of `
# ListDataSourcesRequest` list results. For multiple-page results, `
# ListDataSourcesResponse` outputs a `next_page` token, which can be used as the
# `page_token` value to request the next page of list results.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -234,15 +232,14 @@ module Google
end
# Returns true if valid credentials exist for the given data source and
# requesting user.
# Some data sources doesn't support service account, so we need to talk to
# them on behalf of the end user. This API just checks whether we have OAuth
# token for the particular user, which is a pre-requisite before user can
# create a transfer config.
# requesting user. Some data sources doesn't support service account, so we need
# to talk to them on behalf of the end user. This API just checks whether we
# have OAuth token for the particular user, which is a pre-requisite before user
# can create a transfer config.
# @param [String] name
# Required. The data source in the form:
# `projects/`project_id`/dataSources/`data_source_id`` or
# `projects/`project_id`/locations/`location_id`/dataSources/`data_source_id``.
# Required. The data source in the form: `projects/`project_id`/dataSources/`
# data_source_id`` or `projects/`project_id`/locations/`location_id`/dataSources/
# `data_source_id``.
# @param [Google::Apis::BigquerydatatransferV1::CheckValidCredsRequest] check_valid_creds_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -273,12 +270,12 @@ module Google
execute_or_queue_command(command, &block)
end
# Retrieves a supported data source and returns its settings,
# which can be used for UI rendering.
# Retrieves a supported data source and returns its settings, which can be used
# for UI rendering.
# @param [String] name
# Required. The field will contain name of the resource requested, for example:
# `projects/`project_id`/dataSources/`data_source_id`` or
# `projects/`project_id`/locations/`location_id`/dataSources/`data_source_id``
# Required. The field will contain name of the resource requested, for example: `
# projects/`project_id`/dataSources/`data_source_id`` or `projects/`project_id`/
# locations/`location_id`/dataSources/`data_source_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -306,19 +303,18 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists supported data sources and returns their settings,
# which can be used for UI rendering.
# Lists supported data sources and returns their settings, which can be used for
# UI rendering.
# @param [String] parent
# Required. The BigQuery project id for which data sources should be returned.
# Must be in the form: `projects/`project_id`` or
# `projects/`project_id`/locations/`location_id`
# Must be in the form: `projects/`project_id`` or `projects/`project_id`/
# locations/`location_id`
# @param [Fixnum] page_size
# Page size. The default page size is the maximum value of 1000 results.
# @param [String] page_token
# Pagination token, which can be used to request a specific page
# of `ListDataSourcesRequest` list results. For multiple-page
# results, `ListDataSourcesResponse` outputs
# a `next_page` token, which can be used as the
# Pagination token, which can be used to request a specific page of `
# ListDataSourcesRequest` list results. For multiple-page results, `
# ListDataSourcesResponse` outputs a `next_page` token, which can be used as the
# `page_token` value to request the next page of list results.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -352,40 +348,33 @@ module Google
# Creates a new data transfer configuration.
# @param [String] parent
# Required. The BigQuery project id where the transfer configuration should be
# created.
# Must be in the format projects/`project_id`/locations/`location_id` or
# projects/`project_id`. If specified location and location of the
# created. Must be in the format projects/`project_id`/locations/`location_id`
# or projects/`project_id`. If specified location and location of the
# destination bigquery dataset do not match - the request will fail.
# @param [Google::Apis::BigquerydatatransferV1::TransferConfig] transfer_config_object
# @param [String] authorization_code
# Optional OAuth2 authorization code to use with this transfer configuration.
# This is required if new credentials are needed, as indicated by
# `CheckValidCreds`.
# In order to obtain authorization_code, please make a
# request to
# https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<
# datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
# * client_id should be OAuth client_id of BigQuery DTS API for the given
# data source returned by ListDataSources method.
# * data_source_scopes are the scopes returned by ListDataSources method.
# * redirect_uri is an optional parameter. If not specified, then
# authorization code is posted to the opener of authorization flow window.
# Otherwise it will be sent to the redirect uri. A special value of
# urn:ietf:wg:oauth:2.0:oob means that authorization code should be
# returned in the title bar of the browser, with the page text prompting
# the user to copy the code and paste it in the application.
# This is required if new credentials are needed, as indicated by `
# CheckValidCreds`. In order to obtain authorization_code, please make a request
# to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&
# redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for
# the given data source returned by ListDataSources method. * data_source_scopes
# are the scopes returned by ListDataSources method. * redirect_uri is an
# optional parameter. If not specified, then authorization code is posted to the
# opener of authorization flow window. Otherwise it will be sent to the redirect
# uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization
# code should be returned in the title bar of the browser, with the page text
# prompting the user to copy the code and paste it in the application.
# @param [String] service_account_name
# Optional service account name. If this field is set, transfer config will
# be created with this service account credentials. It requires that
# requesting user calling this API has permissions to act as this service
# account.
# Optional service account name. If this field is set, transfer config will be
# created with this service account credentials. It requires that requesting
# user calling this API has permissions to act as this service account.
# @param [String] version_info
# Optional version info. If users want to find a very recent access token,
# that is, immediately after approving access, users have to set the
# version_info claim in the token request. To obtain the version_info, users
# must use the "none+gsession" response type. which be return a
# version_info back in the authorization response which be be put in a JWT
# claim in the token request.
# Optional version info. If users want to find a very recent access token, that
# is, immediately after approving access, users have to set the version_info
# claim in the token request. To obtain the version_info, users must use the "
# none+gsession" response type. which be return a version_info back in the
# authorization response which be be put in a JWT claim in the token request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -418,12 +407,12 @@ module Google
execute_or_queue_command(command, &block)
end
# Deletes a data transfer configuration,
# including any associated transfer runs and logs.
# Deletes a data transfer configuration, including any associated transfer runs
# and logs.
# @param [String] name
# Required. The field will contain name of the resource requested, for example:
# `projects/`project_id`/transferConfigs/`config_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id``
# Required. The field will contain name of the resource requested, for example: `
# projects/`project_id`/transferConfigs/`config_id`` or `projects/`project_id`/
# locations/`location_id`/transferConfigs/`config_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -453,9 +442,9 @@ module Google
# Returns information about a data transfer config.
# @param [String] name
# Required. The field will contain name of the resource requested, for example:
# `projects/`project_id`/transferConfigs/`config_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id``
# Required. The field will contain name of the resource requested, for example: `
# projects/`project_id`/transferConfigs/`config_id`` or `projects/`project_id`/
# locations/`location_id`/transferConfigs/`config_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -485,19 +474,17 @@ module Google
# Returns information about all data transfers in the project.
# @param [String] parent
# Required. The BigQuery project id for which data sources
# should be returned: `projects/`project_id`` or
# `projects/`project_id`/locations/`location_id``
# Required. The BigQuery project id for which data sources should be returned: `
# projects/`project_id`` or `projects/`project_id`/locations/`location_id``
# @param [Array<String>, String] data_source_ids
# When specified, only configurations of requested data sources are returned.
# @param [Fixnum] page_size
# Page size. The default page size is the maximum value of 1000 results.
# @param [String] page_token
# Pagination token, which can be used to request a specific page
# of `ListTransfersRequest` list results. For multiple-page
# results, `ListTransfersResponse` outputs
# a `next_page` token, which can be used as the
# `page_token` value to request the next page of list results.
# Pagination token, which can be used to request a specific page of `
# ListTransfersRequest` list results. For multiple-page results, `
# ListTransfersResponse` outputs a `next_page` token, which can be used as the `
# page_token` value to request the next page of list results.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -528,49 +515,42 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates a data transfer configuration.
# All fields must be set, even if they are not updated.
# Updates a data transfer configuration. All fields must be set, even if they
# are not updated.
# @param [String] name
# The resource name of the transfer config.
# Transfer config names have the form of
# `projects/`project_id`/locations/`region`/transferConfigs/`config_id``.
# The name is automatically generated based on the config_id specified in
# CreateTransferConfigRequest along with project_id and region. If config_id
# is not provided, usually a uuid, even though it is not guaranteed or
# required, will be generated for config_id.
# The resource name of the transfer config. Transfer config names have the form
# of `projects/`project_id`/locations/`region`/transferConfigs/`config_id``. The
# name is automatically generated based on the config_id specified in
# CreateTransferConfigRequest along with project_id and region. If config_id is
# not provided, usually a uuid, even though it is not guaranteed or required,
# will be generated for config_id.
# @param [Google::Apis::BigquerydatatransferV1::TransferConfig] transfer_config_object
# @param [String] authorization_code
# Optional OAuth2 authorization code to use with this transfer configuration.
# If it is provided, the transfer configuration will be associated with the
# authorizing user.
# In order to obtain authorization_code, please make a
# request to
# https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<
# datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
# * client_id should be OAuth client_id of BigQuery DTS API for the given
# data source returned by ListDataSources method.
# * data_source_scopes are the scopes returned by ListDataSources method.
# * redirect_uri is an optional parameter. If not specified, then
# authorization code is posted to the opener of authorization flow window.
# Otherwise it will be sent to the redirect uri. A special value of
# urn:ietf:wg:oauth:2.0:oob means that authorization code should be
# returned in the title bar of the browser, with the page text prompting
# the user to copy the code and paste it in the application.
# Optional OAuth2 authorization code to use with this transfer configuration. If
# it is provided, the transfer configuration will be associated with the
# authorizing user. In order to obtain authorization_code, please make a request
# to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&
# redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for
# the given data source returned by ListDataSources method. * data_source_scopes
# are the scopes returned by ListDataSources method. * redirect_uri is an
# optional parameter. If not specified, then authorization code is posted to the
# opener of authorization flow window. Otherwise it will be sent to the redirect
# uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization
# code should be returned in the title bar of the browser, with the page text
# prompting the user to copy the code and paste it in the application.
# @param [String] service_account_name
# Optional service account name. If this field is set and
# "service_account_name" is set in update_mask, transfer config will be
# updated to use this service account credentials. It requires that
# requesting user calling this API has permissions to act as this service
# account.
# Optional service account name. If this field is set and "service_account_name"
# is set in update_mask, transfer config will be updated to use this service
# account credentials. It requires that requesting user calling this API has
# permissions to act as this service account.
# @param [String] update_mask
# Required. Required list of fields to be updated in this request.
# @param [String] version_info
# Optional version info. If users want to find a very recent access token,
# that is, immediately after approving access, users have to set the
# version_info claim in the token request. To obtain the version_info, users
# must use the "none+gsession" response type. which be return a
# version_info back in the authorization response which be be put in a JWT
# claim in the token request.
# Optional version info. If users want to find a very recent access token, that
# is, immediately after approving access, users have to set the version_info
# claim in the token request. To obtain the version_info, users must use the "
# none+gsession" response type. which be return a version_info back in the
# authorization response which be be put in a JWT claim in the token request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -604,15 +584,14 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] parent
# Required. Transfer configuration name in the form:
# `projects/`project_id`/transferConfigs/`config_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id``.
# Required. Transfer configuration name in the form: `projects/`project_id`/
# transferConfigs/`config_id`` or `projects/`project_id`/locations/`location_id`/
# transferConfigs/`config_id``.
# @param [Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsRequest] schedule_transfer_runs_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -645,12 +624,12 @@ module Google
# Start manual transfer runs to be executed now with schedule_time equal to
# current time. The transfer runs can be created for a time range where the
# run_time is between start_time (inclusive) and end_time (exclusive), or for
# a specific run_time.
# run_time is between start_time (inclusive) and end_time (exclusive), or for a
# specific run_time.
# @param [String] parent
# Transfer configuration name in the form:
# `projects/`project_id`/transferConfigs/`config_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id``.
# Transfer configuration name in the form: `projects/`project_id`/
# transferConfigs/`config_id`` or `projects/`project_id`/locations/`location_id`/
# transferConfigs/`config_id``.
# @param [Google::Apis::BigquerydatatransferV1::StartManualTransferRunsRequest] start_manual_transfer_runs_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -683,10 +662,9 @@ module Google
# Deletes the specified transfer run.
# @param [String] name
# Required. The field will contain name of the resource requested, for example:
# `projects/`project_id`/transferConfigs/`config_id`/runs/`run_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id`/
# runs/`run_id``
# Required. The field will contain name of the resource requested, for example: `
# projects/`project_id`/transferConfigs/`config_id`/runs/`run_id`` or `projects/`
# project_id`/locations/`location_id`/transferConfigs/`config_id`/runs/`run_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -716,10 +694,9 @@ module Google
# Returns information about the particular transfer run.
# @param [String] name
# Required. The field will contain name of the resource requested, for example:
# `projects/`project_id`/transferConfigs/`config_id`/runs/`run_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id`/
# runs/`run_id``
# Required. The field will contain name of the resource requested, for example: `
# projects/`project_id`/transferConfigs/`config_id`/runs/`run_id`` or `projects/`
# project_id`/locations/`location_id`/transferConfigs/`config_id`/runs/`run_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -750,18 +727,16 @@ module Google
# Returns information about running and completed jobs.
# @param [String] parent
# Required. Name of transfer configuration for which transfer runs should be
# retrieved.
# Format of transfer configuration resource name is:
# `projects/`project_id`/transferConfigs/`config_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id``.
# retrieved. Format of transfer configuration resource name is: `projects/`
# project_id`/transferConfigs/`config_id`` or `projects/`project_id`/locations/`
# location_id`/transferConfigs/`config_id``.
# @param [Fixnum] page_size
# Page size. The default page size is the maximum value of 1000 results.
# @param [String] page_token
# Pagination token, which can be used to request a specific page
# of `ListTransferRunsRequest` list results. For multiple-page
# results, `ListTransferRunsResponse` outputs
# a `next_page` token, which can be used as the
# `page_token` value to request the next page of list results.
# Pagination token, which can be used to request a specific page of `
# ListTransferRunsRequest` list results. For multiple-page results, `
# ListTransferRunsResponse` outputs a `next_page` token, which can be used as
# the `page_token` value to request the next page of list results.
# @param [String] run_attempt
# Indicates how run attempts are to be pulled.
# @param [Array<String>, String] states
@ -799,21 +774,19 @@ module Google
# Returns user facing log messages for the data transfer run.
# @param [String] parent
# Required. Transfer run name in the form:
# `projects/`project_id`/transferConfigs/`config_id`/runs/`run_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id`/
# runs/`run_id``
# Required. Transfer run name in the form: `projects/`project_id`/
# transferConfigs/`config_id`/runs/`run_id`` or `projects/`project_id`/locations/
# `location_id`/transferConfigs/`config_id`/runs/`run_id``
# @param [Array<String>, String] message_types
# Message types to return. If not populated - INFO, WARNING and ERROR
# messages are returned.
# Message types to return. If not populated - INFO, WARNING and ERROR messages
# are returned.
# @param [Fixnum] page_size
# Page size. The default page size is the maximum value of 1000 results.
# @param [String] page_token
# Pagination token, which can be used to request a specific page
# of `ListTransferLogsRequest` list results. For multiple-page
# results, `ListTransferLogsResponse` outputs
# a `next_page` token, which can be used as the
# `page_token` value to request the next page of list results.
# Pagination token, which can be used to request a specific page of `
# ListTransferLogsRequest` list results. For multiple-page results, `
# ListTransferLogsResponse` outputs a `next_page` token, which can be used as
# the `page_token` value to request the next page of list results.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -847,40 +820,33 @@ module Google
# Creates a new data transfer configuration.
# @param [String] parent
# Required. The BigQuery project id where the transfer configuration should be
# created.
# Must be in the format projects/`project_id`/locations/`location_id` or
# projects/`project_id`. If specified location and location of the
# created. Must be in the format projects/`project_id`/locations/`location_id`
# or projects/`project_id`. If specified location and location of the
# destination bigquery dataset do not match - the request will fail.
# @param [Google::Apis::BigquerydatatransferV1::TransferConfig] transfer_config_object
# @param [String] authorization_code
# Optional OAuth2 authorization code to use with this transfer configuration.
# This is required if new credentials are needed, as indicated by
# `CheckValidCreds`.
# In order to obtain authorization_code, please make a
# request to
# https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<
# datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
# * client_id should be OAuth client_id of BigQuery DTS API for the given
# data source returned by ListDataSources method.
# * data_source_scopes are the scopes returned by ListDataSources method.
# * redirect_uri is an optional parameter. If not specified, then
# authorization code is posted to the opener of authorization flow window.
# Otherwise it will be sent to the redirect uri. A special value of
# urn:ietf:wg:oauth:2.0:oob means that authorization code should be
# returned in the title bar of the browser, with the page text prompting
# the user to copy the code and paste it in the application.
# This is required if new credentials are needed, as indicated by `
# CheckValidCreds`. In order to obtain authorization_code, please make a request
# to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&
# redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for
# the given data source returned by ListDataSources method. * data_source_scopes
# are the scopes returned by ListDataSources method. * redirect_uri is an
# optional parameter. If not specified, then authorization code is posted to the
# opener of authorization flow window. Otherwise it will be sent to the redirect
# uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization
# code should be returned in the title bar of the browser, with the page text
# prompting the user to copy the code and paste it in the application.
# @param [String] service_account_name
# Optional service account name. If this field is set, transfer config will
# be created with this service account credentials. It requires that
# requesting user calling this API has permissions to act as this service
# account.
# Optional service account name. If this field is set, transfer config will be
# created with this service account credentials. It requires that requesting
# user calling this API has permissions to act as this service account.
# @param [String] version_info
# Optional version info. If users want to find a very recent access token,
# that is, immediately after approving access, users have to set the
# version_info claim in the token request. To obtain the version_info, users
# must use the "none+gsession" response type. which be return a
# version_info back in the authorization response which be be put in a JWT
# claim in the token request.
# Optional version info. If users want to find a very recent access token, that
# is, immediately after approving access, users have to set the version_info
# claim in the token request. To obtain the version_info, users must use the "
# none+gsession" response type. which be return a version_info back in the
# authorization response which be be put in a JWT claim in the token request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -913,12 +879,12 @@ module Google
execute_or_queue_command(command, &block)
end
# Deletes a data transfer configuration,
# including any associated transfer runs and logs.
# Deletes a data transfer configuration, including any associated transfer runs
# and logs.
# @param [String] name
# Required. The field will contain name of the resource requested, for example:
# `projects/`project_id`/transferConfigs/`config_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id``
# Required. The field will contain name of the resource requested, for example: `
# projects/`project_id`/transferConfigs/`config_id`` or `projects/`project_id`/
# locations/`location_id`/transferConfigs/`config_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -948,9 +914,9 @@ module Google
# Returns information about a data transfer config.
# @param [String] name
# Required. The field will contain name of the resource requested, for example:
# `projects/`project_id`/transferConfigs/`config_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id``
# Required. The field will contain name of the resource requested, for example: `
# projects/`project_id`/transferConfigs/`config_id`` or `projects/`project_id`/
# locations/`location_id`/transferConfigs/`config_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -980,19 +946,17 @@ module Google
# Returns information about all data transfers in the project.
# @param [String] parent
# Required. The BigQuery project id for which data sources
# should be returned: `projects/`project_id`` or
# `projects/`project_id`/locations/`location_id``
# Required. The BigQuery project id for which data sources should be returned: `
# projects/`project_id`` or `projects/`project_id`/locations/`location_id``
# @param [Array<String>, String] data_source_ids
# When specified, only configurations of requested data sources are returned.
# @param [Fixnum] page_size
# Page size. The default page size is the maximum value of 1000 results.
# @param [String] page_token
# Pagination token, which can be used to request a specific page
# of `ListTransfersRequest` list results. For multiple-page
# results, `ListTransfersResponse` outputs
# a `next_page` token, which can be used as the
# `page_token` value to request the next page of list results.
# Pagination token, which can be used to request a specific page of `
# ListTransfersRequest` list results. For multiple-page results, `
# ListTransfersResponse` outputs a `next_page` token, which can be used as the `
# page_token` value to request the next page of list results.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -1023,49 +987,42 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates a data transfer configuration.
# All fields must be set, even if they are not updated.
# Updates a data transfer configuration. All fields must be set, even if they
# are not updated.
# @param [String] name
# The resource name of the transfer config.
# Transfer config names have the form of
# `projects/`project_id`/locations/`region`/transferConfigs/`config_id``.
# The name is automatically generated based on the config_id specified in
# CreateTransferConfigRequest along with project_id and region. If config_id
# is not provided, usually a uuid, even though it is not guaranteed or
# required, will be generated for config_id.
# The resource name of the transfer config. Transfer config names have the form
# of `projects/`project_id`/locations/`region`/transferConfigs/`config_id``. The
# name is automatically generated based on the config_id specified in
# CreateTransferConfigRequest along with project_id and region. If config_id is
# not provided, usually a uuid, even though it is not guaranteed or required,
# will be generated for config_id.
# @param [Google::Apis::BigquerydatatransferV1::TransferConfig] transfer_config_object
# @param [String] authorization_code
# Optional OAuth2 authorization code to use with this transfer configuration.
# If it is provided, the transfer configuration will be associated with the
# authorizing user.
# In order to obtain authorization_code, please make a
# request to
# https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<
# datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>
# * client_id should be OAuth client_id of BigQuery DTS API for the given
# data source returned by ListDataSources method.
# * data_source_scopes are the scopes returned by ListDataSources method.
# * redirect_uri is an optional parameter. If not specified, then
# authorization code is posted to the opener of authorization flow window.
# Otherwise it will be sent to the redirect uri. A special value of
# urn:ietf:wg:oauth:2.0:oob means that authorization code should be
# returned in the title bar of the browser, with the page text prompting
# the user to copy the code and paste it in the application.
# Optional OAuth2 authorization code to use with this transfer configuration. If
# it is provided, the transfer configuration will be associated with the
# authorizing user. In order to obtain authorization_code, please make a request
# to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&
# redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for
# the given data source returned by ListDataSources method. * data_source_scopes
# are the scopes returned by ListDataSources method. * redirect_uri is an
# optional parameter. If not specified, then authorization code is posted to the
# opener of authorization flow window. Otherwise it will be sent to the redirect
# uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization
# code should be returned in the title bar of the browser, with the page text
# prompting the user to copy the code and paste it in the application.
# @param [String] service_account_name
# Optional service account name. If this field is set and
# "service_account_name" is set in update_mask, transfer config will be
# updated to use this service account credentials. It requires that
# requesting user calling this API has permissions to act as this service
# account.
# Optional service account name. If this field is set and "service_account_name"
# is set in update_mask, transfer config will be updated to use this service
# account credentials. It requires that requesting user calling this API has
# permissions to act as this service account.
# @param [String] update_mask
# Required. Required list of fields to be updated in this request.
# @param [String] version_info
# Optional version info. If users want to find a very recent access token,
# that is, immediately after approving access, users have to set the
# version_info claim in the token request. To obtain the version_info, users
# must use the "none+gsession" response type. which be return a
# version_info back in the authorization response which be be put in a JWT
# claim in the token request.
# Optional version info. If users want to find a very recent access token, that
# is, immediately after approving access, users have to set the version_info
# claim in the token request. To obtain the version_info, users must use the "
# none+gsession" response type. which be return a version_info back in the
# authorization response which be be put in a JWT claim in the token request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -1099,15 +1056,14 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] parent
# Required. Transfer configuration name in the form:
# `projects/`project_id`/transferConfigs/`config_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id``.
# Required. Transfer configuration name in the form: `projects/`project_id`/
# transferConfigs/`config_id`` or `projects/`project_id`/locations/`location_id`/
# transferConfigs/`config_id``.
# @param [Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsRequest] schedule_transfer_runs_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -1140,12 +1096,12 @@ module Google
# Start manual transfer runs to be executed now with schedule_time equal to
# current time. The transfer runs can be created for a time range where the
# run_time is between start_time (inclusive) and end_time (exclusive), or for
# a specific run_time.
# run_time is between start_time (inclusive) and end_time (exclusive), or for a
# specific run_time.
# @param [String] parent
# Transfer configuration name in the form:
# `projects/`project_id`/transferConfigs/`config_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id``.
# Transfer configuration name in the form: `projects/`project_id`/
# transferConfigs/`config_id`` or `projects/`project_id`/locations/`location_id`/
# transferConfigs/`config_id``.
# @param [Google::Apis::BigquerydatatransferV1::StartManualTransferRunsRequest] start_manual_transfer_runs_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -1178,10 +1134,9 @@ module Google
# Deletes the specified transfer run.
# @param [String] name
# Required. The field will contain name of the resource requested, for example:
# `projects/`project_id`/transferConfigs/`config_id`/runs/`run_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id`/
# runs/`run_id``
# Required. The field will contain name of the resource requested, for example: `
# projects/`project_id`/transferConfigs/`config_id`/runs/`run_id`` or `projects/`
# project_id`/locations/`location_id`/transferConfigs/`config_id`/runs/`run_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -1211,10 +1166,9 @@ module Google
# Returns information about the particular transfer run.
# @param [String] name
# Required. The field will contain name of the resource requested, for example:
# `projects/`project_id`/transferConfigs/`config_id`/runs/`run_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id`/
# runs/`run_id``
# Required. The field will contain name of the resource requested, for example: `
# projects/`project_id`/transferConfigs/`config_id`/runs/`run_id`` or `projects/`
# project_id`/locations/`location_id`/transferConfigs/`config_id`/runs/`run_id``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -1245,18 +1199,16 @@ module Google
# Returns information about running and completed jobs.
# @param [String] parent
# Required. Name of transfer configuration for which transfer runs should be
# retrieved.
# Format of transfer configuration resource name is:
# `projects/`project_id`/transferConfigs/`config_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id``.
# retrieved. Format of transfer configuration resource name is: `projects/`
# project_id`/transferConfigs/`config_id`` or `projects/`project_id`/locations/`
# location_id`/transferConfigs/`config_id``.
# @param [Fixnum] page_size
# Page size. The default page size is the maximum value of 1000 results.
# @param [String] page_token
# Pagination token, which can be used to request a specific page
# of `ListTransferRunsRequest` list results. For multiple-page
# results, `ListTransferRunsResponse` outputs
# a `next_page` token, which can be used as the
# `page_token` value to request the next page of list results.
# Pagination token, which can be used to request a specific page of `
# ListTransferRunsRequest` list results. For multiple-page results, `
# ListTransferRunsResponse` outputs a `next_page` token, which can be used as
# the `page_token` value to request the next page of list results.
# @param [String] run_attempt
# Indicates how run attempts are to be pulled.
# @param [Array<String>, String] states
@ -1294,21 +1246,19 @@ module Google
# Returns user facing log messages for the data transfer run.
# @param [String] parent
# Required. Transfer run name in the form:
# `projects/`project_id`/transferConfigs/`config_id`/runs/`run_id`` or
# `projects/`project_id`/locations/`location_id`/transferConfigs/`config_id`/
# runs/`run_id``
# Required. Transfer run name in the form: `projects/`project_id`/
# transferConfigs/`config_id`/runs/`run_id`` or `projects/`project_id`/locations/
# `location_id`/transferConfigs/`config_id`/runs/`run_id``
# @param [Array<String>, String] message_types
# Message types to return. If not populated - INFO, WARNING and ERROR
# messages are returned.
# Message types to return. If not populated - INFO, WARNING and ERROR messages
# are returned.
# @param [Fixnum] page_size
# Page size. The default page size is the maximum value of 1000 results.
# @param [String] page_token
# Pagination token, which can be used to request a specific page
# of `ListTransferLogsRequest` list results. For multiple-page
# results, `ListTransferLogsResponse` outputs
# a `next_page` token, which can be used as the
# `page_token` value to request the next page of list results.
# Pagination token, which can be used to request a specific page of `
# ListTransferLogsRequest` list results. For multiple-page results, `
# ListTransferLogsResponse` outputs a `next_page` token, which can be used as
# the `page_token` value to request the next page of list results.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/bigquery/
module BigqueryreservationV1
VERSION = 'V1'
REVISION = '20200702'
REVISION = '20200801'
# View and manage your data in Google BigQuery
AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery'

View File

@ -22,13 +22,13 @@ module Google
module Apis
module BigqueryreservationV1
# A Assignment allows a project to submit jobs
# of a certain type using slots from the specified reservation.
# A Assignment allows a project to submit jobs of a certain type using slots
# from the specified reservation.
class Assignment
include Google::Apis::Core::Hashable
# The resource which will use the reservation. E.g.
# `projects/myproject`, `folders/123`, or `organizations/456`.
# The resource which will use the reservation. E.g. `projects/myproject`, `
# folders/123`, or `organizations/456`.
# Corresponds to the JSON property `assignee`
# @return [String]
attr_accessor :assignee
@ -38,8 +38,8 @@ module Google
# @return [String]
attr_accessor :job_type
# Output only. Name of the resource. E.g.:
# `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
# Output only. Name of the resource. E.g.: `projects/myproject/locations/US/
# reservations/team1-prod/assignments/123`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -66,9 +66,8 @@ module Google
class BiReservation
include Google::Apis::Core::Hashable
# The resource name of the singleton BI reservation.
# Reservation names have the form
# `projects/`project_id`/locations/`location_id`/bireservation`.
# The resource name of the singleton BI reservation. Reservation names have the
# form `projects/`project_id`/locations/`location_id`/bireservation`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -95,43 +94,39 @@ module Google
end
end
# Capacity commitment is a way to purchase compute capacity for BigQuery jobs
# (in the form of slots) with some committed period of usage. Annual
# commitments renew by default. Commitments can be removed after their
# commitment end time passes.
# In order to remove annual commitment, its plan needs to be changed
# to monthly or flex first.
# A capacity commitment resource exists as a child resource of the admin
# project.
# Capacity commitment is a way to purchase compute capacity for BigQuery jobs (
# in the form of slots) with some committed period of usage. Annual commitments
# renew by default. Commitments can be removed after their commitment end time
# passes. In order to remove annual commitment, its plan needs to be changed to
# monthly or flex first. A capacity commitment resource exists as a child
# resource of the admin project.
class CapacityCommitment
include Google::Apis::Core::Hashable
# Output only. The end of the current commitment period. It is applicable only
# for ACTIVE
# capacity commitments.
# for ACTIVE capacity commitments.
# Corresponds to the JSON property `commitmentEndTime`
# @return [String]
attr_accessor :commitment_end_time
# Output only. The start of the current commitment period. It is applicable only
# for
# ACTIVE capacity commitments.
# for ACTIVE capacity commitments.
# Corresponds to the JSON property `commitmentStartTime`
# @return [String]
attr_accessor :commitment_start_time
# 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).
# 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).
# Corresponds to the JSON property `failureStatus`
# @return [Google::Apis::BigqueryreservationV1::Status]
attr_accessor :failure_status
# Output only. The resource name of the capacity commitment, e.g.,
# `projects/myproject/locations/US/capacityCommitments/123`
# Output only. The resource name of the capacity commitment, e.g., `projects/
# myproject/locations/US/capacityCommitments/123`
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -175,13 +170,12 @@ module Google
end
end
# The metadata for operation returned from
# ReservationService.CreateSlotPool.
# The metadata for operation returned from ReservationService.CreateSlotPool.
class CreateSlotPoolMetadata
include Google::Apis::Core::Hashable
# Resource name of the slot pool that is being created. E.g.,
# projects/myproject/locations/us-central1/reservations/foo/slotPools/123
# Resource name of the slot pool that is being created. E.g., projects/myproject/
# locations/us-central1/reservations/foo/slotPools/123
# Corresponds to the JSON property `slotPool`
# @return [String]
attr_accessor :slot_pool
@ -196,13 +190,11 @@ module Google
end
end
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
@ -224,8 +216,8 @@ module Google
# @return [Array<Google::Apis::BigqueryreservationV1::Assignment>]
attr_accessor :assignments
# Token to retrieve the next page of results, or empty if there are no
# more results in the list.
# Token to retrieve the next page of results, or empty if there are no more
# results in the list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -250,8 +242,8 @@ module Google
# @return [Array<Google::Apis::BigqueryreservationV1::CapacityCommitment>]
attr_accessor :capacity_commitments
# Token to retrieve the next page of results, or empty if there are no
# more results in the list.
# Token to retrieve the next page of results, or empty if there are no more
# results in the list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -296,8 +288,8 @@ module Google
class ListReservationsResponse
include Google::Apis::Core::Hashable
# Token to retrieve the next page of results, or empty if there are no
# more results in the list.
# Token to retrieve the next page of results, or empty if there are no more
# results in the list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -322,11 +314,10 @@ module Google
class MergeCapacityCommitmentsRequest
include Google::Apis::Core::Hashable
# Ids of capacity commitments to merge.
# These capacity commitments must exist under admin project and location
# specified in the parent.
# ID is the last portion of capacity commitment name e.g., 'abc' for
# projects/myproject/locations/US/capacityCommitments/abc
# Ids of capacity commitments to merge. These capacity commitments must exist
# under admin project and location specified in the parent. ID is the last
# portion of capacity commitment name e.g., 'abc' for projects/myproject/
# locations/US/capacityCommitments/abc
# Corresponds to the JSON property `capacityCommitmentIds`
# @return [Array<String>]
attr_accessor :capacity_commitment_ids
@ -341,18 +332,15 @@ module Google
end
end
# The request for
# ReservationService.MoveAssignment.
# **Note**: "bigquery.reservationAssignments.create" permission is required on
# the destination_id.
# **Note**: "bigquery.reservationAssignments.create" and
# "bigquery.reservationAssignments.delete" permission are required on the
# related assignee.
# The request for ReservationService.MoveAssignment. **Note**: "bigquery.
# reservationAssignments.create" permission is required on the destination_id. **
# Note**: "bigquery.reservationAssignments.create" and "bigquery.
# reservationAssignments.delete" permission are required on the related assignee.
class MoveAssignmentRequest
include Google::Apis::Core::Hashable
# The new reservation ID, e.g.:
# `projects/myotherproject/locations/US/reservations/team2-prod`
# The new reservation ID, e.g.: `projects/myotherproject/locations/US/
# reservations/team2-prod`
# Corresponds to the JSON property `destinationId`
# @return [String]
attr_accessor :destination_id
@ -372,47 +360,45 @@ module Google
class Operation
include Google::Apis::Core::Hashable
# 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.
# 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.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# 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).
# 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).
# Corresponds to the JSON property `error`
# @return [Google::Apis::BigqueryreservationV1::Status]
attr_accessor :error
# 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.
# 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.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
# 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``.
# originally returns it. If you use the default HTTP mapping, the `name` should
# be a resource name ending with `operations/`unique_id``.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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`.
# 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`.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
@ -443,20 +429,19 @@ module Google
attr_accessor :ignore_idle_slots
alias_method :ignore_idle_slots?, :ignore_idle_slots
# The resource name of the reservation, e.g.,
# `projects/*/locations/*/reservations/team1-prod`.
# The resource name of the reservation, e.g., `projects/*/locations/*/
# reservations/team1-prod`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Minimum 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.
# If the new reservation's slot capacity exceed the parent's slot capacity or
# if total slot capacity of the new reservation and its siblings exceeds the
# parent's slot capacity, the request will fail with
# `google.rpc.Code.RESOURCE_EXHAUSTED`.
# Minimum 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. If the new reservation's slot capacity exceed the parent's slot
# capacity or if total slot capacity of the new reservation and its siblings
# exceeds the parent's slot capacity, the request will fail with `google.rpc.
# Code.RESOURCE_EXHAUSTED`.
# Corresponds to the JSON property `slotCapacity`
# @return [Fixnum]
attr_accessor :slot_capacity
@ -482,8 +467,8 @@ module Google
# @return [Array<Google::Apis::BigqueryreservationV1::Assignment>]
attr_accessor :assignments
# Token to retrieve the next page of results, or empty if there are no
# more results in the list.
# Token to retrieve the next page of results, or empty if there are no more
# results in the list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -508,8 +493,8 @@ module Google
# @return [Array<Google::Apis::BigqueryreservationV1::Assignment>]
attr_accessor :assignments
# Token to retrieve the next page of results, or empty if there are no
# more results in the list.
# Token to retrieve the next page of results, or empty if there are no more
# results in the list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -548,26 +533,22 @@ module Google
class SplitCapacityCommitmentResponse
include Google::Apis::Core::Hashable
# Capacity commitment is a way to purchase compute capacity for BigQuery jobs
# (in the form of slots) with some committed period of usage. Annual
# commitments renew by default. Commitments can be removed after their
# commitment end time passes.
# In order to remove annual commitment, its plan needs to be changed
# to monthly or flex first.
# A capacity commitment resource exists as a child resource of the admin
# project.
# Capacity commitment is a way to purchase compute capacity for BigQuery jobs (
# in the form of slots) with some committed period of usage. Annual commitments
# renew by default. Commitments can be removed after their commitment end time
# passes. In order to remove annual commitment, its plan needs to be changed to
# monthly or flex first. A capacity commitment resource exists as a child
# resource of the admin project.
# Corresponds to the JSON property `first`
# @return [Google::Apis::BigqueryreservationV1::CapacityCommitment]
attr_accessor :first
# Capacity commitment is a way to purchase compute capacity for BigQuery jobs
# (in the form of slots) with some committed period of usage. Annual
# commitments renew by default. Commitments can be removed after their
# commitment end time passes.
# In order to remove annual commitment, its plan needs to be changed
# to monthly or flex first.
# A capacity commitment resource exists as a child resource of the admin
# project.
# Capacity commitment is a way to purchase compute capacity for BigQuery jobs (
# in the form of slots) with some committed period of usage. Annual commitments
# renew by default. Commitments can be removed after their commitment end time
# passes. In order to remove annual commitment, its plan needs to be changed to
# monthly or flex first. A capacity commitment resource exists as a child
# resource of the admin project.
# Corresponds to the JSON property `second`
# @return [Google::Apis::BigqueryreservationV1::CapacityCommitment]
attr_accessor :second
@ -583,12 +564,12 @@ module Google
end
end
# 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).
# 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).
class Status
include Google::Apis::Core::Hashable
@ -597,15 +578,15 @@ module Google
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# A developer-facing error message, which should be in English. Any user-facing
# error message should be localized and sent in the google.rpc.Status.details
# field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message

View File

@ -47,10 +47,10 @@ module Google
@batch_path = 'batch'
end
# 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`.
# 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`.
# @param [String] name
# The name of the operation resource to be deleted.
# @param [String] fields
@ -80,15 +80,14 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] name
# The name of the operation's parent resource.
# @param [String] filter
@ -129,8 +128,8 @@ module Google
# Retrieves a BI reservation.
# @param [String] name
# Required. Name of the requested reservation, for example:
# `projects/`project_id`/locations/`location_id`/bireservation`
# Required. Name of the requested reservation, for example: `projects/`
# project_id`/locations/`location_id`/bireservation`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -158,36 +157,27 @@ module Google
execute_or_queue_command(command, &block)
end
# Looks up assignments for a specified resource for a particular region.
# If the request is about a project:
# 1. Assignments created on the project will be returned if they exist.
# 2. Otherwise assignments created on the closest ancestor will be
# returned.
# 3. Assignments for different JobTypes will all be returned.
# The same logic applies if the request is about a folder.
# If the request is about an organization, then assignments created on the
# organization will be returned (organization doesn't have ancestors).
# Comparing to ListAssignments, there are some behavior
# differences:
# 1. permission on the assignee will be verified in this API.
# 2. Hierarchy lookup (project->folder->organization) happens in this API.
# 3. Parent here is `projects/*/locations/*`, instead of
# `projects/*/locations/*reservations/*`.
# Looks up assignments for a specified resource for a particular region. If the
# request is about a project: 1. Assignments created on the project will be
# returned if they exist. 2. Otherwise assignments created on the closest
# ancestor will be returned. 3. Assignments for different JobTypes will all be
# returned. The same logic applies if the request is about a folder. If the
# request is about an organization, then assignments created on the organization
# will be returned (organization doesn't have ancestors). Comparing to
# ListAssignments, there are some behavior differences: 1. permission on the
# assignee will be verified in this API. 2. Hierarchy lookup (project->folder->
# organization) happens in this API. 3. Parent here is `projects/*/locations/*`,
# instead of `projects/*/locations/*reservations/*`.
# @param [String] parent
# Required. The resource name with location (project name could be the wildcard '
# -'),
# e.g.:
# `projects/-/locations/US`.
# -'), e.g.: `projects/-/locations/US`.
# @param [Fixnum] page_size
# The maximum number of items to return per page.
# @param [String] page_token
# The next_page_token value returned from a previous List request, if any.
# @param [String] query
# Please specify resource name as assignee in the query.
# Examples:
# * `assignee=projects/myproject`
# * `assignee=folders/123`
# * `assignee=organizations/456`
# Please specify resource name as assignee in the query. Examples: * `assignee=
# projects/myproject` * `assignee=folders/123` * `assignee=organizations/456`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -218,38 +208,28 @@ module Google
execute_or_queue_command(command, &block)
end
# Looks up assignments for a specified resource for a particular region.
# If the request is about a project:
# 1. Assignments created on the project will be returned if they exist.
# 2. Otherwise assignments created on the closest ancestor will be
# returned.
# 3. Assignments for different JobTypes will all be returned.
# The same logic applies if the request is about a folder.
# If the request is about an organization, then assignments created on the
# organization will be returned (organization doesn't have ancestors).
# Comparing to ListAssignments, there are some behavior
# differences:
# 1. permission on the assignee will be verified in this API.
# 2. Hierarchy lookup (project->folder->organization) happens in this API.
# 3. Parent here is `projects/*/locations/*`, instead of
# `projects/*/locations/*reservations/*`.
# **Note** "-" cannot be used for projects
# nor locations.
# Looks up assignments for a specified resource for a particular region. If the
# request is about a project: 1. Assignments created on the project will be
# returned if they exist. 2. Otherwise assignments created on the closest
# ancestor will be returned. 3. Assignments for different JobTypes will all be
# returned. The same logic applies if the request is about a folder. If the
# request is about an organization, then assignments created on the organization
# will be returned (organization doesn't have ancestors). Comparing to
# ListAssignments, there are some behavior differences: 1. permission on the
# assignee will be verified in this API. 2. Hierarchy lookup (project->folder->
# organization) happens in this API. 3. Parent here is `projects/*/locations/*`,
# instead of `projects/*/locations/*reservations/*`. **Note** "-" cannot be used
# for projects nor locations.
# @param [String] parent
# Required. The resource name of the admin project(containing project and
# location),
# e.g.:
# `projects/myproject/locations/US`.
# location), e.g.: `projects/myproject/locations/US`.
# @param [Fixnum] page_size
# The maximum number of items to return per page.
# @param [String] page_token
# The next_page_token value returned from a previous List request, if any.
# @param [String] query
# Please specify resource name as assignee in the query.
# Examples:
# * `assignee=projects/myproject`
# * `assignee=folders/123`
# * `assignee=organizations/456`
# Please specify resource name as assignee in the query. Examples: * `assignee=
# projects/myproject` * `assignee=folders/123` * `assignee=organizations/456`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -280,16 +260,13 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates a BI reservation.
# Only fields specified in the `field_mask` are updated.
# A singleton BI reservation always exists with default size 0.
# In order to reserve BI capacity it needs to be updated to an amount
# greater than 0. In order to release BI capacity reservation size
# must be set to 0.
# Updates a BI reservation. Only fields specified in the `field_mask` are
# updated. A singleton BI reservation always exists with default size 0. In
# order to reserve BI capacity it needs to be updated to an amount greater than
# 0. In order to release BI capacity reservation size must be set to 0.
# @param [String] name
# The resource name of the singleton BI reservation.
# Reservation names have the form
# `projects/`project_id`/locations/`location_id`/bireservation`.
# The resource name of the singleton BI reservation. Reservation names have the
# form `projects/`project_id`/locations/`location_id`/bireservation`.
# @param [Google::Apis::BigqueryreservationV1::BiReservation] bi_reservation_object
# @param [String] update_mask
# A list of fields to be updated in this request.
@ -325,8 +302,8 @@ module Google
# Creates a new capacity commitment resource.
# @param [String] parent
# Required. Resource name of the parent reservation. E.g.,
# `projects/myproject/locations/US`
# Required. Resource name of the parent reservation. E.g., `projects/myproject/
# locations/US`
# @param [Google::Apis::BigqueryreservationV1::CapacityCommitment] capacity_commitment_object
# @param [Boolean] enforce_single_admin_project_per_org
# If true, fail the request if another project in the organization has a
@ -361,12 +338,12 @@ module Google
execute_or_queue_command(command, &block)
end
# 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`.
# 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`.
# @param [String] name
# Required. Resource name of the capacity commitment to delete. E.g.,
# `projects/myproject/locations/US/capacityCommitments/123`
# Required. Resource name of the capacity commitment to delete. E.g., `projects/
# myproject/locations/US/capacityCommitments/123`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -396,8 +373,8 @@ module Google
# Returns information about the capacity commitment.
# @param [String] name
# Required. Resource name of the capacity commitment to retrieve. E.g.,
# `projects/myproject/locations/US/capacityCommitments/123`
# Required. Resource name of the capacity commitment to retrieve. E.g., `
# projects/myproject/locations/US/capacityCommitments/123`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -427,8 +404,8 @@ module Google
# Lists all the capacity commitments for the admin project.
# @param [String] parent
# Required. Resource name of the parent reservation. E.g.,
# `projects/myproject/locations/US`
# Required. Resource name of the parent reservation. E.g., `projects/myproject/
# locations/US`
# @param [Fixnum] page_size
# The maximum number of items to return.
# @param [String] page_token
@ -462,14 +439,14 @@ module Google
execute_or_queue_command(command, &block)
end
# 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`.
# 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`.
# @param [String] parent
# Parent resource that identifies admin project and location e.g.,
# `projects/myproject/locations/us`
# Parent resource that identifies admin project and location e.g., `projects/
# myproject/locations/us`
# @param [Google::Apis::BigqueryreservationV1::MergeCapacityCommitmentsRequest] merge_capacity_commitments_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -500,14 +477,13 @@ module Google
execute_or_queue_command(command, &block)
end
# 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`.
# 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`.
# @param [String] name
# Output only. The resource name of the capacity commitment, e.g.,
# `projects/myproject/locations/US/capacityCommitments/123`
# Output only. The resource name of the capacity commitment, e.g., `projects/
# myproject/locations/US/capacityCommitments/123`
# @param [Google::Apis::BigqueryreservationV1::CapacityCommitment] capacity_commitment_object
# @param [String] update_mask
# Standard field mask for the set of fields to be updated.
@ -541,15 +517,14 @@ module Google
execute_or_queue_command(command, &block)
end
# 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 would change the plan of the first one to `FLEX` and then delete it.
# 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 would
# change the plan of the first one to `FLEX` and then delete it.
# @param [String] name
# Required. The resource name e.g.,:
# `projects/myproject/locations/US/capacityCommitments/123`
# Required. The resource name e.g.,: `projects/myproject/locations/US/
# capacityCommitments/123`
# @param [Google::Apis::BigqueryreservationV1::SplitCapacityCommitmentRequest] split_capacity_commitment_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -582,8 +557,7 @@ module Google
# Creates a new reservation resource.
# @param [String] parent
# Required. Project, location. E.g.,
# `projects/myproject/locations/US`
# Required. Project, location. E.g., `projects/myproject/locations/US`
# @param [Google::Apis::BigqueryreservationV1::Reservation] reservation_object
# @param [String] reservation_id
# The reservation ID. This field must only contain lower case alphanumeric
@ -618,12 +592,11 @@ module Google
execute_or_queue_command(command, &block)
end
# Deletes a reservation.
# Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has
# assignments.
# Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` when
# reservation has assignments.
# @param [String] name
# Required. Resource name of the reservation to retrieve. E.g.,
# `projects/myproject/locations/US/reservations/team1-prod`
# Required. Resource name of the reservation to retrieve. E.g., `projects/
# myproject/locations/US/reservations/team1-prod`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -653,8 +626,8 @@ module Google
# Returns information about the reservation.
# @param [String] name
# Required. Resource name of the reservation to retrieve. E.g.,
# `projects/myproject/locations/US/reservations/team1-prod`
# Required. Resource name of the reservation to retrieve. E.g., `projects/
# myproject/locations/US/reservations/team1-prod`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -684,8 +657,8 @@ module Google
# Lists all the reservations for the project in the specified location.
# @param [String] parent
# Required. The parent resource name containing project and location, e.g.:
# `projects/myproject/locations/US`
# Required. The parent resource name containing project and location, e.g.: `
# projects/myproject/locations/US`
# @param [Fixnum] page_size
# The maximum number of items to return per page.
# @param [String] page_token
@ -721,8 +694,8 @@ module Google
# Updates an existing reservation resource.
# @param [String] name
# The resource name of the reservation, e.g.,
# `projects/*/locations/*/reservations/team1-prod`.
# The resource name of the reservation, e.g., `projects/*/locations/*/
# reservations/team1-prod`.
# @param [Google::Apis::BigqueryreservationV1::Reservation] reservation_object
# @param [String] update_mask
# Standard field mask for the set of fields to be updated.
@ -756,32 +729,26 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# 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. 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.
# @param [String] parent
# Required. The parent resource name of the assignment
# E.g. `projects/myproject/locations/US/reservations/team1-prod`
# Required. The parent resource name of the assignment E.g. `projects/myproject/
# locations/US/reservations/team1-prod`
# @param [Google::Apis::BigqueryreservationV1::Assignment] assignment_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -812,21 +779,17 @@ module Google
execute_or_queue_command(command, &block)
end
# 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: `<organizationA, res1>`
# and `<project1, res1>`
# In this example, deletion of the `<organizationA, res1>` assignment won't
# affect the other assignment `<project1, res1>`. After said deletion,
# queries from `project1` will still use `res1` while queries from
# `project2` will switch to use on-demand mode.
# 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.
# @param [String] name
# Required. Name of the resource, e.g.
# `projects/myproject/locations/US/reservations/team1-prod/assignments/123`
# Required. Name of the resource, e.g. `projects/myproject/locations/US/
# reservations/team1-prod/assignments/123`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -854,26 +817,19 @@ module Google
execute_or_queue_command(command, &block)
end
# 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: `<organizationA, res1>`
# and `<project1, res1>`
# 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.
# 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.
# @param [String] parent
# Required. The parent resource name e.g.:
# `projects/myproject/locations/US/reservations/team1-prod`
# Or:
# `projects/myproject/locations/US/reservations/-`
# Required. The parent resource name e.g.: `projects/myproject/locations/US/
# reservations/team1-prod` Or: `projects/myproject/locations/US/reservations/-`
# @param [Fixnum] page_size
# The maximum number of items to return per page.
# @param [String] page_token
@ -907,14 +863,12 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] name
# Required. The resource name of the assignment,
# e.g.
# `projects/myproject/locations/US/reservations/team1-prod/assignments/123`
# Required. The resource name of the assignment, e.g. `projects/myproject/
# locations/US/reservations/team1-prod/assignments/123`
# @param [Google::Apis::BigqueryreservationV1::MoveAssignmentRequest] move_assignment_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/bigquery/
module BigqueryreservationV1beta1
VERSION = 'V1beta1'
REVISION = '20200702'
REVISION = '20200801'
# View and manage your data in Google BigQuery
AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery'

View File

@ -22,13 +22,13 @@ module Google
module Apis
module BigqueryreservationV1beta1
# A Assignment allows a project to submit jobs
# of a certain type using slots from the specified reservation.
# A Assignment allows a project to submit jobs of a certain type using slots
# from the specified reservation.
class Assignment
include Google::Apis::Core::Hashable
# The resource which will use the reservation. E.g.
# `projects/myproject`, `folders/123`, or `organizations/456`.
# The resource which will use the reservation. E.g. `projects/myproject`, `
# folders/123`, or `organizations/456`.
# Corresponds to the JSON property `assignee`
# @return [String]
attr_accessor :assignee
@ -38,8 +38,8 @@ module Google
# @return [String]
attr_accessor :job_type
# Output only. Name of the resource. E.g.:
# `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
# Output only. Name of the resource. E.g.: `projects/myproject/locations/US/
# reservations/team1-prod/assignments/123`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -66,9 +66,8 @@ module Google
class BiReservation
include Google::Apis::Core::Hashable
# The resource name of the singleton BI reservation.
# Reservation names have the form
# `projects/`project_id`/locations/`location_id`/bireservation`.
# The resource name of the singleton BI reservation. Reservation names have the
# form `projects/`project_id`/locations/`location_id`/bireservation`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -95,43 +94,39 @@ module Google
end
end
# Capacity commitment is a way to purchase compute capacity for BigQuery jobs
# (in the form of slots) with some committed period of usage. Annual
# commitments renew by default. Commitments can be removed after their
# commitment end time passes.
# In order to remove annual commitment, its plan needs to be changed
# to monthly or flex first.
# A capacity commitment resource exists as a child resource of the admin
# project.
# Capacity commitment is a way to purchase compute capacity for BigQuery jobs (
# in the form of slots) with some committed period of usage. Annual commitments
# renew by default. Commitments can be removed after their commitment end time
# passes. In order to remove annual commitment, its plan needs to be changed to
# monthly or flex first. A capacity commitment resource exists as a child
# resource of the admin project.
class CapacityCommitment
include Google::Apis::Core::Hashable
# Output only. The end of the current commitment period. It is applicable only
# for ACTIVE
# capacity commitments.
# for ACTIVE capacity commitments.
# Corresponds to the JSON property `commitmentEndTime`
# @return [String]
attr_accessor :commitment_end_time
# Output only. The start of the current commitment period. It is applicable only
# for
# ACTIVE capacity commitments.
# for ACTIVE capacity commitments.
# Corresponds to the JSON property `commitmentStartTime`
# @return [String]
attr_accessor :commitment_start_time
# 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).
# 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).
# Corresponds to the JSON property `failureStatus`
# @return [Google::Apis::BigqueryreservationV1beta1::Status]
attr_accessor :failure_status
# Output only. The resource name of the capacity commitment, e.g.,
# `projects/myproject/locations/US/capacityCommitments/123`
# Output only. The resource name of the capacity commitment, e.g., `projects/
# myproject/locations/US/capacityCommitments/123`
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -175,13 +170,12 @@ module Google
end
end
# The metadata for operation returned from
# ReservationService.CreateSlotPool.
# The metadata for operation returned from ReservationService.CreateSlotPool.
class CreateSlotPoolMetadata
include Google::Apis::Core::Hashable
# Resource name of the slot pool that is being created. E.g.,
# projects/myproject/locations/us-central1/reservations/foo/slotPools/123
# Resource name of the slot pool that is being created. E.g., projects/myproject/
# locations/us-central1/reservations/foo/slotPools/123
# Corresponds to the JSON property `slotPool`
# @return [String]
attr_accessor :slot_pool
@ -196,13 +190,11 @@ module Google
end
end
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
@ -224,8 +216,8 @@ module Google
# @return [Array<Google::Apis::BigqueryreservationV1beta1::Assignment>]
attr_accessor :assignments
# Token to retrieve the next page of results, or empty if there are no
# more results in the list.
# Token to retrieve the next page of results, or empty if there are no more
# results in the list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -250,8 +242,8 @@ module Google
# @return [Array<Google::Apis::BigqueryreservationV1beta1::CapacityCommitment>]
attr_accessor :capacity_commitments
# Token to retrieve the next page of results, or empty if there are no
# more results in the list.
# Token to retrieve the next page of results, or empty if there are no more
# results in the list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -271,8 +263,8 @@ module Google
class ListReservationsResponse
include Google::Apis::Core::Hashable
# Token to retrieve the next page of results, or empty if there are no
# more results in the list.
# Token to retrieve the next page of results, or empty if there are no more
# results in the list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -297,11 +289,10 @@ module Google
class MergeCapacityCommitmentsRequest
include Google::Apis::Core::Hashable
# Ids of capacity commitments to merge.
# These capacity commitments must exist under admin project and location
# specified in the parent.
# ID is the last portion of capacity commitment name e.g., 'abc' for
# projects/myproject/locations/US/capacityCommitments/abc
# Ids of capacity commitments to merge. These capacity commitments must exist
# under admin project and location specified in the parent. ID is the last
# portion of capacity commitment name e.g., 'abc' for projects/myproject/
# locations/US/capacityCommitments/abc
# Corresponds to the JSON property `capacityCommitmentIds`
# @return [Array<String>]
attr_accessor :capacity_commitment_ids
@ -316,18 +307,15 @@ module Google
end
end
# The request for
# ReservationService.MoveAssignment.
# **Note**: "bigquery.reservationAssignments.create" permission is required on
# the destination_id.
# **Note**: "bigquery.reservationAssignments.create" and
# "bigquery.reservationAssignments.delete" permission are required on the
# related assignee.
# The request for ReservationService.MoveAssignment. **Note**: "bigquery.
# reservationAssignments.create" permission is required on the destination_id. **
# Note**: "bigquery.reservationAssignments.create" and "bigquery.
# reservationAssignments.delete" permission are required on the related assignee.
class MoveAssignmentRequest
include Google::Apis::Core::Hashable
# The new reservation ID, e.g.:
# `projects/myotherproject/locations/US/reservations/team2-prod`
# The new reservation ID, e.g.: `projects/myotherproject/locations/US/
# reservations/team2-prod`
# Corresponds to the JSON property `destinationId`
# @return [String]
attr_accessor :destination_id
@ -354,20 +342,19 @@ module Google
attr_accessor :ignore_idle_slots
alias_method :ignore_idle_slots?, :ignore_idle_slots
# The resource name of the reservation, e.g.,
# `projects/*/locations/*/reservations/team1-prod`.
# The resource name of the reservation, e.g., `projects/*/locations/*/
# reservations/team1-prod`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Minimum 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.
# If the new reservation's slot capacity exceed the parent's slot capacity or
# if total slot capacity of the new reservation and its siblings exceeds the
# parent's slot capacity, the request will fail with
# `google.rpc.Code.RESOURCE_EXHAUSTED`.
# Minimum 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. If the new reservation's slot capacity exceed the parent's slot
# capacity or if total slot capacity of the new reservation and its siblings
# exceeds the parent's slot capacity, the request will fail with `google.rpc.
# Code.RESOURCE_EXHAUSTED`.
# Corresponds to the JSON property `slotCapacity`
# @return [Fixnum]
attr_accessor :slot_capacity
@ -393,8 +380,8 @@ module Google
# @return [Array<Google::Apis::BigqueryreservationV1beta1::Assignment>]
attr_accessor :assignments
# Token to retrieve the next page of results, or empty if there are no
# more results in the list.
# Token to retrieve the next page of results, or empty if there are no more
# results in the list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -433,26 +420,22 @@ module Google
class SplitCapacityCommitmentResponse
include Google::Apis::Core::Hashable
# Capacity commitment is a way to purchase compute capacity for BigQuery jobs
# (in the form of slots) with some committed period of usage. Annual
# commitments renew by default. Commitments can be removed after their
# commitment end time passes.
# In order to remove annual commitment, its plan needs to be changed
# to monthly or flex first.
# A capacity commitment resource exists as a child resource of the admin
# project.
# Capacity commitment is a way to purchase compute capacity for BigQuery jobs (
# in the form of slots) with some committed period of usage. Annual commitments
# renew by default. Commitments can be removed after their commitment end time
# passes. In order to remove annual commitment, its plan needs to be changed to
# monthly or flex first. A capacity commitment resource exists as a child
# resource of the admin project.
# Corresponds to the JSON property `first`
# @return [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment]
attr_accessor :first
# Capacity commitment is a way to purchase compute capacity for BigQuery jobs
# (in the form of slots) with some committed period of usage. Annual
# commitments renew by default. Commitments can be removed after their
# commitment end time passes.
# In order to remove annual commitment, its plan needs to be changed
# to monthly or flex first.
# A capacity commitment resource exists as a child resource of the admin
# project.
# Capacity commitment is a way to purchase compute capacity for BigQuery jobs (
# in the form of slots) with some committed period of usage. Annual commitments
# renew by default. Commitments can be removed after their commitment end time
# passes. In order to remove annual commitment, its plan needs to be changed to
# monthly or flex first. A capacity commitment resource exists as a child
# resource of the admin project.
# Corresponds to the JSON property `second`
# @return [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment]
attr_accessor :second
@ -468,12 +451,12 @@ module Google
end
end
# 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).
# 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).
class Status
include Google::Apis::Core::Hashable
@ -482,15 +465,15 @@ module Google
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# A developer-facing error message, which should be in English. Any user-facing
# error message should be localized and sent in the google.rpc.Status.details
# field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message

View File

@ -49,8 +49,8 @@ module Google
# Retrieves a BI reservation.
# @param [String] name
# Required. Name of the requested reservation, for example:
# `projects/`project_id`/locations/`location_id`/bireservation`
# Required. Name of the requested reservation, for example: `projects/`
# project_id`/locations/`location_id`/bireservation`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -78,38 +78,28 @@ module Google
execute_or_queue_command(command, &block)
end
# Looks up assignments for a specified resource for a particular region.
# If the request is about a project:
# 1. Assignments created on the project will be returned if they exist.
# 2. Otherwise assignments created on the closest ancestor will be
# returned.
# 3. Assignments for different JobTypes will all be returned.
# The same logic applies if the request is about a folder.
# If the request is about an organization, then assignments created on the
# organization will be returned (organization doesn't have ancestors).
# Comparing to ListAssignments, there are some behavior
# differences:
# 1. permission on the assignee will be verified in this API.
# 2. Hierarchy lookup (project->folder->organization) happens in this API.
# 3. Parent here is `projects/*/locations/*`, instead of
# `projects/*/locations/*reservations/*`.
# **Note** "-" cannot be used for projects
# nor locations.
# Looks up assignments for a specified resource for a particular region. If the
# request is about a project: 1. Assignments created on the project will be
# returned if they exist. 2. Otherwise assignments created on the closest
# ancestor will be returned. 3. Assignments for different JobTypes will all be
# returned. The same logic applies if the request is about a folder. If the
# request is about an organization, then assignments created on the organization
# will be returned (organization doesn't have ancestors). Comparing to
# ListAssignments, there are some behavior differences: 1. permission on the
# assignee will be verified in this API. 2. Hierarchy lookup (project->folder->
# organization) happens in this API. 3. Parent here is `projects/*/locations/*`,
# instead of `projects/*/locations/*reservations/*`. **Note** "-" cannot be used
# for projects nor locations.
# @param [String] parent
# Required. The resource name of the admin project(containing project and
# location),
# e.g.:
# `projects/myproject/locations/US`.
# location), e.g.: `projects/myproject/locations/US`.
# @param [Fixnum] page_size
# The maximum number of items to return.
# @param [String] page_token
# The next_page_token value returned from a previous List request, if any.
# @param [String] query
# Please specify resource name as assignee in the query.
# Examples:
# * `assignee=projects/myproject`
# * `assignee=folders/123`
# * `assignee=organizations/456`
# Please specify resource name as assignee in the query. Examples: * `assignee=
# projects/myproject` * `assignee=folders/123` * `assignee=organizations/456`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -140,16 +130,13 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates a BI reservation.
# Only fields specified in the `field_mask` are updated.
# A singleton BI reservation always exists with default size 0.
# In order to reserve BI capacity it needs to be updated to an amount
# greater than 0. In order to release BI capacity reservation size
# must be set to 0.
# Updates a BI reservation. Only fields specified in the `field_mask` are
# updated. A singleton BI reservation always exists with default size 0. In
# order to reserve BI capacity it needs to be updated to an amount greater than
# 0. In order to release BI capacity reservation size must be set to 0.
# @param [String] name
# The resource name of the singleton BI reservation.
# Reservation names have the form
# `projects/`project_id`/locations/`location_id`/bireservation`.
# The resource name of the singleton BI reservation. Reservation names have the
# form `projects/`project_id`/locations/`location_id`/bireservation`.
# @param [Google::Apis::BigqueryreservationV1beta1::BiReservation] bi_reservation_object
# @param [String] update_mask
# A list of fields to be updated in this request.
@ -185,8 +172,8 @@ module Google
# Creates a new capacity commitment resource.
# @param [String] parent
# Required. Resource name of the parent reservation. E.g.,
# `projects/myproject/locations/US`
# Required. Resource name of the parent reservation. E.g., `projects/myproject/
# locations/US`
# @param [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] capacity_commitment_object
# @param [Boolean] enforce_single_admin_project_per_org
# If true, fail the request if another project in the organization has a
@ -221,12 +208,12 @@ module Google
execute_or_queue_command(command, &block)
end
# 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`.
# 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`.
# @param [String] name
# Required. Resource name of the capacity commitment to delete. E.g.,
# `projects/myproject/locations/US/capacityCommitments/123`
# Required. Resource name of the capacity commitment to delete. E.g., `projects/
# myproject/locations/US/capacityCommitments/123`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -256,8 +243,8 @@ module Google
# Returns information about the capacity commitment.
# @param [String] name
# Required. Resource name of the capacity commitment to retrieve. E.g.,
# `projects/myproject/locations/US/capacityCommitments/123`
# Required. Resource name of the capacity commitment to retrieve. E.g., `
# projects/myproject/locations/US/capacityCommitments/123`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -287,8 +274,8 @@ module Google
# Lists all the capacity commitments for the admin project.
# @param [String] parent
# Required. Resource name of the parent reservation. E.g.,
# `projects/myproject/locations/US`
# Required. Resource name of the parent reservation. E.g., `projects/myproject/
# locations/US`
# @param [Fixnum] page_size
# The maximum number of items to return.
# @param [String] page_token
@ -322,14 +309,14 @@ module Google
execute_or_queue_command(command, &block)
end
# 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`.
# 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`.
# @param [String] parent
# Parent resource that identifies admin project and location e.g.,
# `projects/myproject/locations/us`
# Parent resource that identifies admin project and location e.g., `projects/
# myproject/locations/us`
# @param [Google::Apis::BigqueryreservationV1beta1::MergeCapacityCommitmentsRequest] merge_capacity_commitments_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -360,14 +347,13 @@ module Google
execute_or_queue_command(command, &block)
end
# 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`.
# 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`.
# @param [String] name
# Output only. The resource name of the capacity commitment, e.g.,
# `projects/myproject/locations/US/capacityCommitments/123`
# Output only. The resource name of the capacity commitment, e.g., `projects/
# myproject/locations/US/capacityCommitments/123`
# @param [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] capacity_commitment_object
# @param [String] update_mask
# Standard field mask for the set of fields to be updated.
@ -401,15 +387,14 @@ module Google
execute_or_queue_command(command, &block)
end
# 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 would change the plan of the first one to `FLEX` and then delete it.
# 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 would
# change the plan of the first one to `FLEX` and then delete it.
# @param [String] name
# Required. The resource name e.g.,:
# `projects/myproject/locations/US/capacityCommitments/123`
# Required. The resource name e.g.,: `projects/myproject/locations/US/
# capacityCommitments/123`
# @param [Google::Apis::BigqueryreservationV1beta1::SplitCapacityCommitmentRequest] split_capacity_commitment_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -442,8 +427,7 @@ module Google
# Creates a new reservation resource.
# @param [String] parent
# Required. Project, location. E.g.,
# `projects/myproject/locations/US`
# Required. Project, location. E.g., `projects/myproject/locations/US`
# @param [Google::Apis::BigqueryreservationV1beta1::Reservation] reservation_object
# @param [String] reservation_id
# The reservation ID. This field must only contain lower case alphanumeric
@ -478,12 +462,11 @@ module Google
execute_or_queue_command(command, &block)
end
# Deletes a reservation.
# Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has
# assignments.
# Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` when
# reservation has assignments.
# @param [String] name
# Required. Resource name of the reservation to retrieve. E.g.,
# `projects/myproject/locations/US/reservations/team1-prod`
# Required. Resource name of the reservation to retrieve. E.g., `projects/
# myproject/locations/US/reservations/team1-prod`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -513,8 +496,8 @@ module Google
# Returns information about the reservation.
# @param [String] name
# Required. Resource name of the reservation to retrieve. E.g.,
# `projects/myproject/locations/US/reservations/team1-prod`
# Required. Resource name of the reservation to retrieve. E.g., `projects/
# myproject/locations/US/reservations/team1-prod`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -544,14 +527,13 @@ module Google
# Lists all the reservations for the project in the specified location.
# @param [String] parent
# Required. The parent resource name containing project and location, e.g.:
# `projects/myproject/locations/US`
# Required. The parent resource name containing project and location, e.g.: `
# projects/myproject/locations/US`
# @param [String] filter
# Can be used to filter out reservations based on names, capacity, etc, e.g.:
# filter="reservation.slot_capacity > 200"
# filter="reservation.name = \"*dev/*\""
# Advanced filtering syntax can be
# [here](https://cloud.google.com/logging/docs/view/advanced-filters).
# filter="reservation.slot_capacity > 200" filter="reservation.name = \"*dev/*\""
# Advanced filtering syntax can be [here](https://cloud.google.com/logging/docs/
# view/advanced-filters).
# @param [Fixnum] page_size
# The maximum number of items to return.
# @param [String] page_token
@ -588,8 +570,8 @@ module Google
# Updates an existing reservation resource.
# @param [String] name
# The resource name of the reservation, e.g.,
# `projects/*/locations/*/reservations/team1-prod`.
# The resource name of the reservation, e.g., `projects/*/locations/*/
# reservations/team1-prod`.
# @param [Google::Apis::BigqueryreservationV1beta1::Reservation] reservation_object
# @param [String] update_mask
# Standard field mask for the set of fields to be updated.
@ -623,32 +605,26 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# 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. 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.
# @param [String] parent
# Required. The parent resource name of the assignment
# E.g. `projects/myproject/locations/US/reservations/team1-prod`
# Required. The parent resource name of the assignment E.g. `projects/myproject/
# locations/US/reservations/team1-prod`
# @param [Google::Apis::BigqueryreservationV1beta1::Assignment] assignment_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -679,21 +655,17 @@ module Google
execute_or_queue_command(command, &block)
end
# 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: `<organizationA, res1>`
# and `<project1, res1>`
# In this example, deletion of the `<organizationA, res1>` assignment won't
# affect the other assignment `<project1, res1>`. After said deletion,
# queries from `project1` will still use `res1` while queries from
# `project2` will switch to use on-demand mode.
# 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.
# @param [String] name
# Required. Name of the resource, e.g.
# `projects/myproject/locations/US/reservations/team1-prod/assignments/123`
# Required. Name of the resource, e.g. `projects/myproject/locations/US/
# reservations/team1-prod/assignments/123`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -721,26 +693,19 @@ module Google
execute_or_queue_command(command, &block)
end
# 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: `<organizationA, res1>`
# and `<project1, res1>`
# 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.
# 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.
# @param [String] parent
# Required. The parent resource name e.g.:
# `projects/myproject/locations/US/reservations/team1-prod`
# Or:
# `projects/myproject/locations/US/reservations/-`
# Required. The parent resource name e.g.: `projects/myproject/locations/US/
# reservations/team1-prod` Or: `projects/myproject/locations/US/reservations/-`
# @param [Fixnum] page_size
# The maximum number of items to return.
# @param [String] page_token
@ -774,14 +739,12 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] name
# Required. The resource name of the assignment,
# e.g.
# `projects/myproject/locations/US/reservations/team1-prod/assignments/123`
# Required. The resource name of the assignment, e.g. `projects/myproject/
# locations/US/reservations/team1-prod/assignments/123`
# @param [Google::Apis::BigqueryreservationV1beta1::MoveAssignmentRequest] move_assignment_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/binary-authorization/
module BinaryauthorizationV1
VERSION = 'V1'
REVISION = '20200605'
REVISION = '20200731'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/binary-authorization/
module BinaryauthorizationV1beta1
VERSION = 'V1beta1'
REVISION = '20200501'
REVISION = '20200731'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/hangouts/chat
module ChatV1
VERSION = 'V1'
REVISION = '20200722'
REVISION = '20200801'
end
end
end

View File

@ -22,10 +22,10 @@ module Google
module Apis
module ChatV1
# List of string parameters to supply when the action method is invoked.
# For example, consider three snooze buttons: snooze now, snooze 1 day,
# snooze next week. You might use action method = snooze(), passing the
# snooze type and snooze time in the list of string parameters.
# List of string parameters to supply when the action method is invoked. For
# example, consider three snooze buttons: snooze now, snooze 1 day, snooze next
# week. You might use action method = snooze(), passing the snooze type and
# snooze time in the list of string parameters.
class ActionParameter
include Google::Apis::Core::Hashable
@ -75,28 +75,12 @@ module Google
end
end
# Annotations associated with the plain-text body of the message.
# Example plain-text message body:
# ```
# Hello @FooBot how are you!"
# ```
# The corresponding annotations metadata:
# ```
# "annotations":[`
# "type":"USER_MENTION",
# "startIndex":6,
# "length":7,
# "userMention": `
# "user": `
# "name":"users/107946847022116401880",
# "displayName":"FooBot",
# "avatarUrl":"https://goo.gl/aeDtrS",
# "type":"BOT"
# `,
# "type":"MENTION"
# `
# `]
# ```
# Annotations associated with the plain-text body of the message. Example plain-
# text message body: ``` Hello @FooBot how are you!" ``` The corresponding
# annotations metadata: ``` "annotations":[` "type":"USER_MENTION", "startIndex":
# 6, "length":7, "userMention": ` "user": ` "name":"users/107946847022116401880",
# "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" `, "
# type":"MENTION" ` `] ```
class Annotation
include Google::Apis::Core::Hashable
@ -155,8 +139,8 @@ module Google
attr_accessor :content_type
# Output only. The download URL which should be used to allow a human user to
# download the attachment. Bots should not use this URL to download
# attachment content.
# download the attachment. Bots should not use this URL to download attachment
# content.
# Corresponds to the JSON property `downloadUri`
# @return [String]
attr_accessor :download_uri
@ -166,8 +150,8 @@ module Google
# @return [Google::Apis::ChatV1::DriveDataRef]
attr_accessor :drive_data_ref
# Resource name of the attachment, in the form
# "spaces/*/messages/*/attachments/*".
# Resource name of the attachment, in the form "spaces/*/messages/*/attachments/*
# ".
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -177,9 +161,8 @@ module Google
# @return [String]
attr_accessor :source
# Output only. The thumbnail URL which should be used to preview the
# attachment to a human user. Bots should not use this URL to download
# attachment content.
# Output only. The thumbnail URL which should be used to preview the attachment
# to a human user. Bots should not use this URL to download attachment content.
# Corresponds to the JSON property `thumbnailUri`
# @return [String]
attr_accessor :thumbnail_uri
@ -205,8 +188,8 @@ module Google
class AttachmentDataRef
include Google::Apis::Core::Hashable
# The resource name of the attachment data. This is used with the media API
# to download the attachment data.
# The resource name of the attachment data. This is used with the media API to
# download the attachment data.
# Corresponds to the JSON property `resourceName`
# @return [String]
attr_accessor :resource_name
@ -283,10 +266,9 @@ module Google
end
end
# A card action is
# the action associated with the card. For an invoice card, a
# typical action would be: delete invoice, email invoice or open the
# invoice in browser.
# A card action is the action associated with the card. For an invoice card, a
# typical action would be: delete invoice, email invoice or open the invoice in
# browser.
class CardAction
include Google::Apis::Core::Hashable
@ -330,9 +312,9 @@ module Google
# @return [String]
attr_accessor :subtitle
# The title must be specified. The header has a fixed height: if both a
# title and subtitle is specified, each will take up 1 line. If only the
# title is specified, it will take up both lines.
# The title must be specified. The header has a fixed height: if both a title
# and subtitle is specified, each will take up 1 line. If only the title is
# specified, it will take up both lines.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
@ -354,16 +336,16 @@ module Google
class DeprecatedEvent
include Google::Apis::Core::Hashable
# A form action describes the behavior when the form is submitted.
# For example, an Apps Script can be invoked to handle the form.
# A form action describes the behavior when the form is submitted. For example,
# an Apps Script can be invoked to handle the form.
# Corresponds to the JSON property `action`
# @return [Google::Apis::ChatV1::FormAction]
attr_accessor :action
# The URL the bot should redirect the user to after they have completed an
# authorization or configuration flow outside of Hangouts Chat. See the
# [Authorizing access to 3p services guide](/hangouts/chat/how-tos/auth-3p)
# for more information.
# authorization or configuration flow outside of Hangouts Chat. See the [
# Authorizing access to 3p services guide](/hangouts/chat/how-tos/auth-3p) for
# more information.
# Corresponds to the JSON property `configCompleteRedirectUrl`
# @return [String]
attr_accessor :config_complete_redirect_url
@ -383,17 +365,16 @@ module Google
# @return [Google::Apis::ChatV1::Space]
attr_accessor :space
# The bot-defined key for the thread related to the event. See the
# thread_key field of the
# `spaces.message.create` request for more information.
# The bot-defined key for the thread related to the event. See the thread_key
# field of the `spaces.message.create` request for more information.
# Corresponds to the JSON property `threadKey`
# @return [String]
attr_accessor :thread_key
# A secret value that bots can use to verify if a request is from Google. The
# token is randomly generated by Google, remains static, and can be obtained
# from the Hangouts Chat API configuration page in the Cloud Console.
# Developers can revoke/regenerate it if needed from the same page.
# from the Hangouts Chat API configuration page in the Cloud Console. Developers
# can revoke/regenerate it if needed from the same page.
# Corresponds to the JSON property `token`
# @return [String]
attr_accessor :token
@ -445,13 +426,11 @@ module Google
end
end
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
@ -464,15 +443,15 @@ module Google
end
end
# A form action describes the behavior when the form is submitted.
# For example, an Apps Script can be invoked to handle the form.
# A form action describes the behavior when the form is submitted. For example,
# an Apps Script can be invoked to handle the form.
class FormAction
include Google::Apis::Core::Hashable
# The method name is used to identify which part of the form triggered the
# form submission. This information is echoed back to the bot as part of
# the card click event. The same method name can be used for several
# elements that trigger a common behavior if desired.
# The method name is used to identify which part of the form triggered the form
# submission. This information is echoed back to the bot as part of the card
# click event. The same method name can be used for several elements that
# trigger a common behavior if desired.
# Corresponds to the JSON property `actionMethodName`
# @return [String]
attr_accessor :action_method_name
@ -497,10 +476,10 @@ module Google
class Image
include Google::Apis::Core::Hashable
# The aspect ratio of this image (width/height). This field allows clients
# to reserve the right height for the image while waiting for it to load.
# It's not meant to override the native aspect ratio of the image.
# If unset, the server fills it by prefetching the image.
# The aspect ratio of this image (width/height). This field allows clients to
# reserve the right height for the image while waiting for it to load. It's not
# meant to override the native aspect ratio of the image. If unset, the server
# fills it by prefetching the image.
# Corresponds to the JSON property `aspectRatio`
# @return [Float]
attr_accessor :aspect_ratio
@ -531,8 +510,7 @@ module Google
class ImageButton
include Google::Apis::Core::Hashable
# The icon specified by an enum that indices to an icon provided by Chat
# API.
# The icon specified by an enum that indices to an icon provided by Chat API.
# Corresponds to the JSON property `icon`
# @return [String]
attr_accessor :icon
@ -542,8 +520,8 @@ module Google
# @return [String]
attr_accessor :icon_url
# The name of this image_button which will be used for accessibility.
# Default value will be provided if developers don't specify.
# The name of this image_button which will be used for accessibility. Default
# value will be provided if developers don't specify.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -566,8 +544,8 @@ module Google
end
end
# A UI element contains a key (label) and a value (content). And this
# element may also contain some actions such as onclick button.
# A UI element contains a key (label) and a value (content). And this element
# may also contain some actions such as onclick button.
class KeyValue
include Google::Apis::Core::Hashable
@ -592,8 +570,8 @@ module Google
attr_accessor :content_multiline
alias_method :content_multiline?, :content_multiline
# An enum value that will be replaced by the Chat API with the
# corresponding icon image.
# An enum value that will be replaced by the Chat API with the corresponding
# icon image.
# Corresponds to the JSON property `icon`
# @return [String]
attr_accessor :icon
@ -639,8 +617,8 @@ module Google
# @return [Array<Google::Apis::ChatV1::Membership>]
attr_accessor :memberships
# Continuation token to retrieve the next page of results. It will be empty
# for the last page of results.
# Continuation token to retrieve the next page of results. It will be empty for
# the last page of results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -660,9 +638,9 @@ module Google
class ListSpacesResponse
include Google::Apis::Core::Hashable
# Continuation token to retrieve the next page of results. It will be empty
# for the last page of results. Tokens expire in an hour. An error is thrown
# if an expired token is passed.
# Continuation token to retrieve the next page of results. It will be empty for
# the last page of results. Tokens expire in an hour. An error is thrown if an
# expired token is passed.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -706,8 +684,8 @@ module Google
class Membership
include Google::Apis::Core::Hashable
# The creation time of the membership a.k.a the time at which the member
# joined the space, if applicable.
# The creation time of the membership a.k.a the time at which the member joined
# the space, if applicable.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
@ -717,8 +695,8 @@ module Google
# @return [Google::Apis::ChatV1::User]
attr_accessor :member
# Resource name of the membership, in the form "spaces/*/members/*".
# Example: spaces/AAAAMpdlehY/members/105115627578887013105
# Resource name of the membership, in the form "spaces/*/members/*". Example:
# spaces/AAAAMpdlehY/members/105115627578887013105
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -765,15 +743,14 @@ module Google
# @return [Array<Google::Apis::ChatV1::Attachment>]
attr_accessor :attachment
# Rich, formatted and interactive cards that can be used to display UI
# elements such as: formatted texts, buttons, clickable images. Cards are
# normally displayed below the plain-text body of the message.
# Rich, formatted and interactive cards that can be used to display UI elements
# such as: formatted texts, buttons, clickable images. Cards are normally
# displayed below the plain-text body of the message.
# Corresponds to the JSON property `cards`
# @return [Array<Google::Apis::ChatV1::Card>]
attr_accessor :cards
# Output only. The time at which the message was created in Hangouts Chat
# server.
# Output only. The time at which the message was created in Hangouts Chat server.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
@ -784,15 +761,15 @@ module Google
# @return [String]
attr_accessor :fallback_text
# Resource name, in the form "spaces/*/messages/*".
# Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
# Resource name, in the form "spaces/*/messages/*". Example: spaces/AAAAMpdlehY/
# messages/UMxbHmzDlr4.UMxbHmzDlr4
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Text for generating preview chips. This text will not be displayed to the
# user, but any links to images, web pages, videos, etc. included here will
# generate preview chips.
# Text for generating preview chips. This text will not be displayed to the user,
# but any links to images, web pages, videos, etc. included here will generate
# preview chips.
# Corresponds to the JSON property `previewText`
# @return [String]
attr_accessor :preview_text
@ -843,8 +820,8 @@ module Google
class OnClick
include Google::Apis::Core::Hashable
# A form action describes the behavior when the form is submitted.
# For example, an Apps Script can be invoked to handle the form.
# A form action describes the behavior when the form is submitted. For example,
# an Apps Script can be invoked to handle the form.
# Corresponds to the JSON property `action`
# @return [Google::Apis::ChatV1::FormAction]
attr_accessor :action
@ -884,10 +861,9 @@ module Google
end
end
# A section contains a collection of widgets that are rendered
# (vertically) in the order that they are specified. Across all platforms,
# cards have a narrow fixed width, so
# there is currently no need for layout properties (e.g. float).
# A section contains a collection of widgets that are rendered (vertically) in
# the order that they are specified. Across all platforms, cards have a narrow
# fixed width, so there is currently no need for layout properties (e.g. float).
class Section
include Google::Apis::Core::Hashable
@ -916,15 +892,14 @@ module Google
class Space
include Google::Apis::Core::Hashable
# Output only. The display name (only if the space is a room).
# Please note that this field might not be populated in direct messages
# between humans.
# Output only. The display name (only if the space is a room). Please note that
# this field might not be populated in direct messages between humans.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Resource name of the space, in the form "spaces/*".
# Example: spaces/AAAAMpdlehYs
# Resource name of the space, in the form "spaces/*". Example: spaces/
# AAAAMpdlehYs
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -941,8 +916,8 @@ module Google
attr_accessor :threaded
alias_method :threaded?, :threaded
# Output only. The type of a space.
# This is deprecated. Use `single_user_bot_dm` instead.
# Output only. The type of a space. This is deprecated. Use `single_user_bot_dm`
# instead.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
@ -1009,8 +984,8 @@ module Google
class Thread
include Google::Apis::Core::Hashable
# Resource name, in the form "spaces/*/threads/*".
# Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4
# Resource name, in the form "spaces/*/threads/*". Example: spaces/AAAAMpdlehY/
# threads/UMxbHmzDlr4
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -1091,8 +1066,8 @@ module Google
class WidgetMarkup
include Google::Apis::Core::Hashable
# A list of buttons. Buttons is also oneof data and only one of these
# fields should be set.
# A list of buttons. Buttons is also oneof data and only one of these fields
# should be set.
# Corresponds to the JSON property `buttons`
# @return [Array<Google::Apis::ChatV1::Button>]
attr_accessor :buttons
@ -1102,8 +1077,8 @@ module Google
# @return [Google::Apis::ChatV1::Image]
attr_accessor :image
# A UI element contains a key (label) and a value (content). And this
# element may also contain some actions such as onclick button.
# A UI element contains a key (label) and a value (content). And this element
# may also contain some actions such as onclick button.
# Corresponds to the JSON property `keyValue`
# @return [Google::Apis::ChatV1::KeyValue]
attr_accessor :key_value

View File

@ -47,11 +47,10 @@ module Google
@batch_path = 'batch'
end
# Downloads media. Download is supported
# on the URI `/v1/media/`+name`?alt=media`.
# Downloads media. Download is supported on the URI `/v1/media/`+name`?alt=media`
# .
# @param [String] resource_name
# Name of the media that is being downloaded. See
# ReadRequest.resource_name.
# Name of the media that is being downloaded. See ReadRequest.resource_name.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -88,8 +87,8 @@ module Google
# Returns a space.
# @param [String] name
# Required. Resource name of the space, in the form "spaces/*".
# Example: spaces/AAAAMpdlehY
# Required. Resource name of the space, in the form "spaces/*". Example: spaces/
# AAAAMpdlehY
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -119,9 +118,8 @@ module Google
# Lists spaces the caller is a member of.
# @param [Fixnum] page_size
# Requested page size. The value is capped at 1000.
# Server may return fewer results than requested.
# If unspecified, server will default to 100.
# Requested page size. The value is capped at 1000. Server may return fewer
# results than requested. If unspecified, server will default to 100.
# @param [String] page_token
# A token identifying a page of results the server should return.
# @param [String] fields
@ -154,9 +152,8 @@ module Google
# Returns a membership.
# @param [String] name
# Required. Resource name of the membership to be retrieved, in the form
# "spaces/*/members/*".
# Example: spaces/AAAAMpdlehY/members/105115627578887013105
# Required. Resource name of the membership to be retrieved, in the form "spaces/
# */members/*". Example: spaces/AAAAMpdlehY/members/105115627578887013105
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -187,12 +184,10 @@ module Google
# Lists human memberships in a space.
# @param [String] parent
# Required. The resource name of the space for which membership list is to be
# fetched, in the form "spaces/*".
# Example: spaces/AAAAMpdlehY
# fetched, in the form "spaces/*". Example: spaces/AAAAMpdlehY
# @param [Fixnum] page_size
# Requested page size. The value is capped at 1000.
# Server may return fewer results than requested.
# If unspecified, server will default to 100.
# Requested page size. The value is capped at 1000. Server may return fewer
# results than requested. If unspecified, server will default to 100.
# @param [String] page_token
# A token identifying a page of results the server should return.
# @param [String] fields
@ -226,18 +221,16 @@ module Google
# Creates a message.
# @param [String] parent
# Required. Space resource name, in the form "spaces/*".
# Example: spaces/AAAAMpdlehY
# Required. Space resource name, in the form "spaces/*". Example: spaces/
# AAAAMpdlehY
# @param [Google::Apis::ChatV1::Message] message_object
# @param [String] thread_key
# Opaque thread identifier string that can be specified to group messages
# into a single thread. If this is the first message with a given thread
# identifier, a new thread is created. Subsequent messages with the same
# thread identifier will be posted into the same thread. This relieves bots
# and webhooks from having to store the Hangouts Chat thread ID of a thread (
# created earlier by them) to post
# further updates to it.
# Has no effect if thread field,
# Opaque thread identifier string that can be specified to group messages into a
# single thread. If this is the first message with a given thread identifier, a
# new thread is created. Subsequent messages with the same thread identifier
# will be posted into the same thread. This relieves bots and webhooks from
# having to store the Hangouts Chat thread ID of a thread (created earlier by
# them) to post further updates to it. Has no effect if thread field,
# corresponding to an existing thread, is set in message.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -271,9 +264,8 @@ module Google
# Deletes a message.
# @param [String] name
# Required. Resource name of the message to be deleted, in the form
# "spaces/*/messages/*"
# Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
# Required. Resource name of the message to be deleted, in the form "spaces/*/
# messages/*" Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -303,9 +295,8 @@ module Google
# Returns a message.
# @param [String] name
# Required. Resource name of the message to be retrieved, in the form
# "spaces/*/messages/*".
# Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
# Required. Resource name of the message to be retrieved, in the form "spaces/*/
# messages/*". Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -335,15 +326,12 @@ module Google
# Updates a message.
# @param [String] name
# Resource name, in the form "spaces/*/messages/*".
# Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
# Resource name, in the form "spaces/*/messages/*". Example: spaces/AAAAMpdlehY/
# messages/UMxbHmzDlr4.UMxbHmzDlr4
# @param [Google::Apis::ChatV1::Message] message_object
# @param [String] update_mask
# Required. The field paths to be updated, comma separated if there are
# multiple.
# Currently supported field paths:
# * text
# * cards
# Required. The field paths to be updated, comma separated if there are multiple.
# Currently supported field paths: * text * cards
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -377,8 +365,8 @@ module Google
# Gets the metadata of a message attachment. The attachment data is fetched
# using the media API.
# @param [String] name
# Resource name of the attachment, in the form
# "spaces/*/messages/*/attachments/*".
# Resource name of the attachment, in the form "spaces/*/messages/*/attachments/*
# ".
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user

View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/civic-information/
module CivicinfoV2
VERSION = 'V2'
REVISION = '20200706'
REVISION = '20200804'
end
end
end

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/cloud-build/docs/
module CloudbuildV1
VERSION = 'V1'
REVISION = '20200720'
REVISION = '20200801'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

File diff suppressed because it is too large Load Diff

View File

@ -47,15 +47,13 @@ module Google
@batch_path = 'batch'
end
# 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,
# 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`.
# @param [String] name
# The name of the operation resource to be cancelled.
@ -89,9 +87,8 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] name
# The name of the operation resource.
# @param [String] fields
@ -157,10 +154,9 @@ module Google
execute_or_queue_command(command, &block)
end
# 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`).
# 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`).
# @param [String] project_id
# Required. ID of the project.
# @param [Google::Apis::CloudbuildV1::Build] build_object
@ -193,9 +189,9 @@ module Google
execute_or_queue_command(command, &block)
end
# Returns information about a previously requested build.
# The `Build` that is returned includes its status (such as `SUCCESS`,
# `FAILURE`, or `WORKING`), and timing information.
# Returns information about a previously requested build. The `Build` that is
# returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and
# timing information.
# @param [String] project_id
# Required. ID of the project.
# @param [String] id
@ -228,9 +224,8 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists previously requested builds.
# Previously requested builds may still be in-progress, or may have finished
# successfully or unsuccessfully.
# Lists previously requested builds. Previously requested builds may still be in-
# progress, or may have finished successfully or unsuccessfully.
# @param [String] project_id
# Required. ID of the project.
# @param [String] filter
@ -269,26 +264,22 @@ module Google
execute_or_queue_command(command, &block)
end
# Creates a new build based on the specified build.
# This method creates a new build using the original build request, which may
# or may not result in an identical build.
# For triggered builds:
# * Triggered builds resolve to a precise revision; therefore a retry of a
# triggered build will result in a build that uses the same revision.
# For non-triggered builds that specify `RepoSource`:
# * If the original build built from the tip of a branch, the retried build
# will build from the tip of that branch, which may not be the same revision
# as the original build.
# * If the original build specified a commit sha or revision ID, the retried
# build will use the identical source.
# For builds that specify `StorageSource`:
# * If the original build pulled source from Google Cloud Storage without
# specifying the generation of the object, the new build will use the current
# object, which may be different from the original build source.
# Creates a new build based on the specified build. This method creates a new
# build using the original build request, which may or may not result in an
# identical build. For triggered builds: * Triggered builds resolve to a precise
# revision; therefore a retry of a triggered build will result in a build that
# uses the same revision. For non-triggered builds that specify `RepoSource`: *
# If the original build built from the tip of a branch, the retried build will
# build from the tip of that branch, which may not be the same revision as the
# original build. * If the original build specified a commit sha or revision ID,
# the retried build will use the identical source. For builds that specify `
# StorageSource`: * If the original build pulled source from Google Cloud
# Storage without specifying the generation of the object, the new build will
# use the current object, which may be different from the original build source.
# * If the original build pulled source from Cloud Storage and specified the
# generation of the object, the new build will attempt to use the same
# object, which may or may not be available depending on the bucket's
# lifecycle management settings.
# generation of the object, the new build will attempt to use the same object,
# which may or may not be available depending on the bucket's lifecycle
# management settings.
# @param [String] project_id
# Required. ID of the project.
# @param [String] id
@ -324,15 +315,13 @@ module Google
execute_or_queue_command(command, &block)
end
# 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,
# 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`.
# @param [String] name
# The name of the operation resource to be cancelled.
@ -366,9 +355,8 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] name
# The name of the operation resource.
# @param [String] fields
@ -398,8 +386,7 @@ module Google
execute_or_queue_command(command, &block)
end
# Creates a new `BuildTrigger`.
# This API is experimental.
# Creates a new `BuildTrigger`. This API is experimental.
# @param [String] project_id
# Required. ID of the project for which to configure automatic builds.
# @param [Google::Apis::CloudbuildV1::BuildTrigger] build_trigger_object
@ -432,8 +419,8 @@ module Google
execute_or_queue_command(command, &block)
end
# Deletes a `BuildTrigger` by its project ID and trigger ID.
# This API is experimental.
# Deletes a `BuildTrigger` by its project ID and trigger ID. This API is
# experimental.
# @param [String] project_id
# Required. ID of the project that owns the trigger.
# @param [String] trigger_id
@ -466,8 +453,7 @@ module Google
execute_or_queue_command(command, &block)
end
# Returns information about a `BuildTrigger`.
# This API is experimental.
# Returns information about a `BuildTrigger`. This API is experimental.
# @param [String] project_id
# Required. ID of the project that owns the trigger.
# @param [String] trigger_id
@ -500,8 +486,7 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists existing `BuildTrigger`s.
# This API is experimental.
# Lists existing `BuildTrigger`s. This API is experimental.
# @param [String] project_id
# Required. ID of the project for which to list BuildTriggers.
# @param [Fixnum] page_size
@ -537,8 +522,8 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates a `BuildTrigger` by its project ID and trigger ID.
# This API is experimental.
# Updates a `BuildTrigger` by its project ID and trigger ID. This API is
# experimental.
# @param [String] project_id
# Required. ID of the project that owns the trigger.
# @param [String] trigger_id

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/cloud-build/docs/
module CloudbuildV1alpha1
VERSION = 'V1alpha1'
REVISION = '20200720'
REVISION = '20200801'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

File diff suppressed because it is too large Load Diff

View File

@ -47,15 +47,13 @@ module Google
@batch_path = 'batch'
end
# 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,
# 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`.
# @param [String] name
# The name of the operation resource to be cancelled.
@ -89,9 +87,8 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] name
# The name of the operation resource.
# @param [String] fields
@ -156,8 +153,8 @@ module Google
# Deletes a `WorkerPool` by its project ID and WorkerPool name.
# @param [String] name
# The field will contain name of the resource requested, for example:
# "projects/project-1/workerPools/workerpool-name"
# The field will contain name of the resource requested, for example: "projects/
# project-1/workerPools/workerpool-name"
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -187,8 +184,8 @@ module Google
# Returns information about a `WorkerPool`.
# @param [String] name
# The field will contain name of the resource requested, for example:
# "projects/project-1/workerPools/workerpool-name"
# The field will contain name of the resource requested, for example: "projects/
# project-1/workerPools/workerpool-name"
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -248,8 +245,8 @@ module Google
# Update a `WorkerPool`.
# @param [String] name
# The field will contain name of the resource requested, for example:
# "projects/project-1/workerPools/workerpool-name"
# The field will contain name of the resource requested, for example: "projects/
# project-1/workerPools/workerpool-name"
# @param [Google::Apis::CloudbuildV1alpha1::WorkerPool] worker_pool_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/cloud-build/docs/
module CloudbuildV1alpha2
VERSION = 'V1alpha2'
REVISION = '20200720'
REVISION = '20200801'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -22,17 +22,15 @@ module Google
module Apis
module CloudbuildV1alpha2
# Files in the workspace to upload to Cloud Storage upon successful
# completion of all build steps.
# Files in the workspace to upload to Cloud Storage upon successful completion
# of all build steps.
class ArtifactObjects
include Google::Apis::Core::Hashable
# Cloud Storage bucket and optional object path, in the form
# "gs://bucket/path/to/somewhere/". (see [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)
# ).
# Files in the workspace matching any path pattern will be uploaded to
# Cloud Storage with this location as a prefix.
# Cloud Storage bucket and optional object path, in the form "gs://bucket/path/
# to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/
# storage/docs/bucket-naming#requirements)). Files in the workspace matching any
# path pattern will be uploaded to Cloud Storage with this location as a prefix.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
@ -59,8 +57,8 @@ module Google
end
end
# An artifact that was uploaded during a build. This
# is a single record in the artifact manifest JSON file.
# An artifact that was uploaded during a build. This is a single record in the
# artifact manifest JSON file.
class ArtifactResult
include Google::Apis::Core::Hashable
@ -69,9 +67,8 @@ module Google
# @return [Array<Google::Apis::CloudbuildV1alpha2::FileHashes>]
attr_accessor :file_hash
# The path of an artifact in a Google Cloud Storage bucket, with the
# generation number. For example,
# `gs://mybucket/path/to/output.jar#generation`.
# The path of an artifact in a Google Cloud Storage bucket, with the generation
# number. For example, `gs://mybucket/path/to/output.jar#generation`.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
@ -87,23 +84,22 @@ module Google
end
end
# Artifacts produced by a build that should be uploaded upon
# successful completion of all build steps.
# Artifacts produced by a build that should be uploaded upon successful
# completion of all build steps.
class Artifacts
include Google::Apis::Core::Hashable
# A list of images to be pushed upon the successful completion of all build
# steps.
# The images will be pushed using the builder service account's credentials.
# The digests of the pushed images will be stored in the Build resource's
# results field.
# If any of the images fail to be pushed, the build is marked FAILURE.
# steps. The images will be pushed using the builder service account's
# credentials. The digests of the pushed images will be stored in the Build
# resource's results field. If any of the images fail to be pushed, the build is
# marked FAILURE.
# Corresponds to the JSON property `images`
# @return [Array<String>]
attr_accessor :images
# Files in the workspace to upload to Cloud Storage upon successful
# completion of all build steps.
# Files in the workspace to upload to Cloud Storage upon successful completion
# of all build steps.
# Corresponds to the JSON property `objects`
# @return [Google::Apis::CloudbuildV1alpha2::ArtifactObjects]
attr_accessor :objects
@ -119,31 +115,27 @@ module Google
end
end
# 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.
# - $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.
# 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. - $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.
class Build
include Google::Apis::Core::Hashable
# Artifacts produced by a build that should be uploaded upon
# successful completion of all build steps.
# Artifacts produced by a build that should be uploaded upon successful
# completion of all build steps.
# Corresponds to the JSON property `artifacts`
# @return [Google::Apis::CloudbuildV1alpha2::Artifacts]
attr_accessor :artifacts
# Output only. The ID of the `BuildTrigger` that triggered this build, if it
# was triggered automatically.
# Output only. The ID of the `BuildTrigger` that triggered this build, if it was
# triggered automatically.
# Corresponds to the JSON property `buildTriggerId`
# @return [String]
attr_accessor :build_trigger_id
@ -153,9 +145,8 @@ module Google
# @return [String]
attr_accessor :create_time
# 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.
# 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.
# Corresponds to the JSON property `finishTime`
# @return [String]
attr_accessor :finish_time
@ -166,12 +157,10 @@ module Google
attr_accessor :id
# 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.
# 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`.
# results field. If any of the images fail to be pushed, the build status is
# marked `FAILURE`.
# Corresponds to the JSON property `images`
# @return [Array<String>]
attr_accessor :images
@ -181,11 +170,9 @@ module Google
# @return [String]
attr_accessor :log_url
# Google Cloud Storage bucket where logs should be written (see
# [Bucket Name
# Google 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`.
# ). Logs file names will be of the format `$`logs_bucket`/log-$`build_id`.txt`.
# Corresponds to the JSON property `logsBucket`
# @return [String]
attr_accessor :logs_bucket
@ -200,10 +187,9 @@ module Google
# @return [String]
attr_accessor :project_id
# 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.
# 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.
# Corresponds to the JSON property `queueTtl`
# @return [String]
attr_accessor :queue_ttl
@ -259,22 +245,18 @@ module Google
# @return [Array<String>]
attr_accessor :tags
# 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 ten minutes.
# 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 ten minutes.
# Corresponds to the JSON property `timeout`
# @return [String]
attr_accessor :timeout
# 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 specified images.
# * FETCHSOURCE: time to fetch source.
# If the build does not specify source or images,
# these keys will not be included.
# 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 specified
# images. * FETCHSOURCE: time to fetch source. If the build does not specify
# source or images, these keys will not be included.
# Corresponds to the JSON property `timing`
# @return [Hash<String,Google::Apis::CloudbuildV1alpha2::TimeSpan>]
attr_accessor :timing
@ -315,20 +297,16 @@ module Google
class BuildOperationMetadata
include Google::Apis::Core::Hashable
# 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.
# - $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.
# 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. - $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.
# Corresponds to the JSON property `build`
# @return [Google::Apis::CloudbuildV1alpha2::Build]
attr_accessor :build
@ -347,19 +325,18 @@ module Google
class BuildOptions
include Google::Apis::Core::Hashable
# Requested disk size for the VM that runs the build. Note that this is *NOT*
# "disk free"; some of the space will be used by the operating system and
# build utilities. Also note that this is the minimum disk size that will be
# allocated for the build -- the build may run with a larger disk than
# requested. At present, the maximum disk size is 1000GB; builds that request
# more than the maximum are rejected with an error.
# Requested disk size for the VM that runs the build. Note that this is *NOT* "
# disk free"; some of the space will be used by the operating system and build
# utilities. Also note that this is the minimum disk size that will be allocated
# for the build -- the build may run with a larger disk than requested. At
# present, the maximum disk size is 1000GB; builds that request more than the
# maximum are rejected with an error.
# Corresponds to the JSON property `diskSizeGb`
# @return [Fixnum]
attr_accessor :disk_size_gb
# Option to specify whether or not to apply bash style string
# operations to the substitutions.
# NOTE: this is always enabled for triggered builds and cannot be
# Option to specify whether or not to apply bash style string operations to the
# substitutions. NOTE: this is always enabled for triggered builds and cannot be
# overridden in the build configuration file.
# Corresponds to the JSON property `dynamicSubstitutions`
# @return [Boolean]
@ -367,22 +344,21 @@ module Google
alias_method :dynamic_substitutions?, :dynamic_substitutions
# A list of global environment variable definitions that will exist for all
# build steps in this build. If a variable is defined in both globally and in
# a build step, the variable will use the build step value.
# The elements are of the form "KEY=VALUE" for the environment variable "KEY"
# being given the value "VALUE".
# build steps in this build. If a variable is defined in both globally and in a
# build step, the variable will use the build step value. The elements are of
# the form "KEY=VALUE" for the environment variable "KEY" being given the value "
# VALUE".
# Corresponds to the JSON property `env`
# @return [Array<String>]
attr_accessor :env
# Option to define build log streaming behavior to Google Cloud
# Storage.
# Option to define build log streaming behavior to Google Cloud Storage.
# Corresponds to the JSON property `logStreamingOption`
# @return [String]
attr_accessor :log_streaming_option
# Option to specify the logging mode, which determines if and where build
# logs are stored.
# Option to specify the logging mode, which determines if and where build logs
# are stored.
# Corresponds to the JSON property `logging`
# @return [String]
attr_accessor :logging
@ -397,10 +373,9 @@ module Google
# @return [String]
attr_accessor :requested_verify_option
# A list of global environment variables, which are encrypted using a Cloud
# Key Management Service crypto key. These values must be specified in the
# build's `Secret`. These variables will be available to all build steps
# in this build.
# A list of global environment variables, which are encrypted using a Cloud Key
# Management Service crypto key. These values must be specified in the build's `
# Secret`. These variables will be available to all build steps in this build.
# Corresponds to the JSON property `secretEnv`
# @return [Array<String>]
attr_accessor :secret_env
@ -410,28 +385,25 @@ module Google
# @return [Array<String>]
attr_accessor :source_provenance_hash
# Option to specify behavior when there is an error in the substitution
# checks.
# NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot
# be overridden in the build configuration file.
# Option to specify behavior when there is an error in the substitution checks.
# NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be
# overridden in the build configuration file.
# Corresponds to the JSON property `substitutionOption`
# @return [String]
attr_accessor :substitution_option
# Global list of volumes to mount for ALL build steps
# Each volume is created as an empty volume prior to starting the build
# process. Upon completion of the build, volumes and their contents are
# discarded. Global volume names and paths cannot conflict with the volumes
# defined a build step.
# Using a global volume in a build with only one step is not valid as
# it is indicative of a build request with an incorrect configuration.
# Global list of volumes to mount for ALL build steps Each volume is created as
# an empty volume prior to starting the build process. Upon completion of the
# build, volumes and their contents are discarded. Global volume names and paths
# cannot conflict with the volumes defined a build step. Using a global volume
# in a build with only one step is not valid as it is indicative of a build
# request with an incorrect configuration.
# Corresponds to the JSON property `volumes`
# @return [Array<Google::Apis::CloudbuildV1alpha2::Volume>]
attr_accessor :volumes
# Option to specify a `WorkerPool` for the build.
# Format: projects/`project`/workerPools/`workerPool`
# This field is experimental.
# Option to specify a `WorkerPool` for the build. Format: projects/`project`/
# locations/`location`/workerPools/`workerPool` This field is experimental.
# Corresponds to the JSON property `workerPool`
# @return [String]
attr_accessor :worker_pool
@ -461,61 +433,56 @@ module Google
class BuildStep
include Google::Apis::Core::Hashable
# A list of arguments that will be presented to the step when it is started.
# If the image used to run the step's container has an entrypoint, the `args`
# are used as arguments to that entrypoint. If the image does not define
# an entrypoint, the first element in args is used as the entrypoint,
# and the remainder will be used as arguments.
# A list of arguments that will be presented to the step when it is started. If
# the image used to run the step's container has an entrypoint, the `args` are
# used as arguments to that entrypoint. If the image does not define an
# entrypoint, the first element in args is used as the entrypoint, and the
# remainder will be used as arguments.
# Corresponds to the JSON property `args`
# @return [Array<String>]
attr_accessor :args
# Working directory to use when running this step's container.
# If this value is a relative path, it is relative to the build's working
# directory. If this value is absolute, it may be outside the build's working
# directory, in which case the contents of the path may not be persisted
# across build step executions, unless a `volume` for that path is specified.
# If the build specifies a `RepoSource` with `dir` and a step with a `dir`,
# which specifies an absolute path, the `RepoSource` `dir` is ignored for
# the step's execution.
# Working directory to use when running this step's container. If this value is
# a relative path, it is relative to the build's working directory. If this
# value is absolute, it may be outside the build's working directory, in which
# case the contents of the path may not be persisted across build step
# executions, unless a `volume` for that path is specified. If the build
# specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies
# an absolute path, the `RepoSource` `dir` is ignored for the step's execution.
# Corresponds to the JSON property `dir`
# @return [String]
attr_accessor :dir
# Entrypoint to be used instead of the build step image's default entrypoint.
# If unset, the image's default entrypoint is used.
# Entrypoint to be used instead of the build step image's default entrypoint. If
# unset, the image's default entrypoint is used.
# Corresponds to the JSON property `entrypoint`
# @return [String]
attr_accessor :entrypoint
# A list of environment variable definitions to be used when running a step.
# The elements are of the form "KEY=VALUE" for the environment variable "KEY"
# being given the value "VALUE".
# A list of environment variable definitions to be used when running a step. The
# elements are of the form "KEY=VALUE" for the environment variable "KEY" being
# given the value "VALUE".
# Corresponds to the JSON property `env`
# @return [Array<String>]
attr_accessor :env
# Unique identifier for this build step, used in `wait_for` to
# reference this build step as a dependency.
# Unique identifier for this build step, used in `wait_for` to reference this
# build step as a dependency.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Required. The name of the container image that will run this particular
# build step.
# If the image is available in the host's Docker daemon's cache, it
# will be run directly. If not, the host will attempt to pull the image
# first, using the builder service account's credentials if necessary.
# The Docker daemon's cache will already have the latest versions of all of
# the officially supported build steps
# ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/
# GoogleCloudPlatform/cloud-builders)).
# The Docker daemon will also have cached many of the layers for some popular
# images, like "ubuntu", "debian", but they will be refreshed at the time you
# attempt to use them.
# If you built an image in a previous build step, it will be stored in the
# host's Docker daemon's cache and is available to use as the name for a
# later build step.
# Required. The name of the container image that will run this particular build
# step. If the image is available in the host's Docker daemon's cache, it will
# be run directly. If not, the host will attempt to pull the image first, using
# the builder service account's credentials if necessary. The Docker daemon's
# cache will already have the latest versions of all of the officially supported
# build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://
# github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also
# have cached many of the layers for some popular images, like "ubuntu", "debian"
# , but they will be refreshed at the time you attempt to use them. If you built
# an image in a previous build step, it will be stored in the host's Docker
# daemon's cache and is available to use as the name for a later build step.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -526,22 +493,22 @@ module Google
attr_accessor :pull_timing
# A list of environment variables which are encrypted using a Cloud Key
# Management Service crypto key. These values must be specified in the
# build's `Secret`.
# Management Service crypto key. These values must be specified in the build's `
# Secret`.
# Corresponds to the JSON property `secretEnv`
# @return [Array<String>]
attr_accessor :secret_env
# Output only. Status of the build step. At this time, build step status is
# only updated on build completion; step status is not updated in real-time
# as the build progresses.
# Output only. Status of the build step. At this time, build step status is only
# updated on build completion; step status is not updated in real-time as the
# build progresses.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# Time limit for executing this build step. If not defined, the step has no
# time limit and will be allowed to continue to run until either it completes
# or the build itself times out.
# Time limit for executing this build step. If not defined, the step has no time
# limit and will be allowed to continue to run until either it completes or the
# build itself times out.
# Corresponds to the JSON property `timeout`
# @return [String]
attr_accessor :timeout
@ -551,21 +518,19 @@ module Google
# @return [Google::Apis::CloudbuildV1alpha2::TimeSpan]
attr_accessor :timing
# List of volumes to mount into the build step.
# Each volume is created as an empty volume prior to execution of the
# build step. Upon completion of the build, volumes and their contents are
# discarded.
# Using a named volume in only one step is not valid as it is indicative
# of a build request with an incorrect configuration.
# List of volumes to mount into the build step. Each volume is created as an
# empty volume prior to execution of the build step. Upon completion of the
# build, volumes and their contents are discarded. Using a named volume in only
# one step is not valid as it is indicative of a build request with an incorrect
# configuration.
# Corresponds to the JSON property `volumes`
# @return [Array<Google::Apis::CloudbuildV1alpha2::Volume>]
attr_accessor :volumes
# The ID(s) of the step(s) that this build step depends on.
# This build step will not start until all the build steps in `wait_for`
# have completed successfully. If `wait_for` is empty, this build step will
# start when all previous build steps in the `Build.Steps` list have
# completed successfully.
# The ID(s) of the step(s) that this build step depends on. This build step will
# not start until all the build steps in `wait_for` have completed successfully.
# If `wait_for` is empty, this build step will start when all previous build
# steps in the `Build.Steps` list have completed successfully.
# Corresponds to the JSON property `waitFor`
# @return [Array<String>]
attr_accessor :wait_for
@ -637,13 +602,11 @@ module Google
end
end
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
@ -744,12 +707,11 @@ module Google
class NetworkConfig
include Google::Apis::Core::Hashable
# Required. Immutable. The network definition that the workers are peered to.
# If this section is left empty, the workers will be peered to
# WorkerPool.project_id on the default network. Must be in the format
# `projects/`project`/global/networks/`network``, where `project`
# is a project number, such as `12345`, and `network` is the name of a
# VPC network in the project.
# Required. Immutable. The network definition that the workers are peered to. If
# this section is left empty, the workers will be peered to WorkerPool.
# project_id on the default network. Must be in the format `projects/`project`/
# global/networks/`network``, where `project` is a project number, such as `
# 12345`, and `network` is the name of a VPC network in the project.
# Corresponds to the JSON property `peeredNetwork`
# @return [String]
attr_accessor :peered_network
@ -769,9 +731,9 @@ module Google
class Notification
include Google::Apis::Core::Hashable
# The filter string to use for notification filtering.
# Currently, this is assumed to be a CEL program.
# See https://opensource.google/projects/cel for more.
# The filter string to use for notification filtering. Currently, this is
# assumed to be a CEL program. See https://opensource.google/projects/cel for
# more.
# Corresponds to the JSON property `filter`
# @return [String]
attr_accessor :filter
@ -782,8 +744,8 @@ module Google
attr_accessor :http_delivery
# SlackDelivery is the delivery configuration for delivering Slack messages via
# webhooks. See Slack webhook documentation at:
# https://api.slack.com/messaging/webhooks.
# webhooks. See Slack webhook documentation at: https://api.slack.com/messaging/
# webhooks.
# Corresponds to the JSON property `slackDelivery`
# @return [Google::Apis::CloudbuildV1alpha2::SlackDelivery]
attr_accessor :slack_delivery
@ -855,15 +817,15 @@ module Google
class NotifierMetadata
include Google::Apis::Core::Hashable
# The human-readable and user-given name for the notifier.
# For example: "repo-merge-email-notifier".
# The human-readable and user-given name for the notifier. For example: "repo-
# merge-email-notifier".
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The string representing the name and version of notifier to deploy.
# Expected to be of the form of "<registry-path>/<name>:<version>".
# For example: "gcr.io/my-project/notifiers/smtp:1.2.34".
# The string representing the name and version of notifier to deploy. Expected
# to be of the form of "/:". For example: "gcr.io/my-project/notifiers/smtp:1.2.
# 34".
# Corresponds to the JSON property `notifier`
# @return [String]
attr_accessor :notifier
@ -884,16 +846,16 @@ module Google
class NotifierSecret
include Google::Apis::Core::Hashable
# Name is the local name of the secret, such as the verbatim string
# "my-smtp-password".
# Name is the local name of the secret, such as the verbatim string "my-smtp-
# password".
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Value is interpreted to be a resource path for fetching the actual
# (versioned) secret data for this secret. For example, this would be a
# Google Cloud Secret Manager secret version resource path like:
# "projects/my-project/secrets/my-secret/versions/latest".
# Value is interpreted to be a resource path for fetching the actual (versioned)
# secret data for this secret. For example, this would be a Google Cloud Secret
# Manager secret version resource path like: "projects/my-project/secrets/my-
# secret/versions/latest".
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
@ -914,8 +876,8 @@ module Google
class NotifierSecretRef
include Google::Apis::Core::Hashable
# The value of `secret_ref` should be a `name` that is registered in a
# `Secret` in the `secrets` list of the `Spec`.
# The value of `secret_ref` should be a `name` that is registered in a `Secret`
# in the `secrets` list of the `Spec`.
# Corresponds to the JSON property `secretRef`
# @return [String]
attr_accessor :secret_ref
@ -961,47 +923,45 @@ module Google
class Operation
include Google::Apis::Core::Hashable
# 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.
# 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.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# 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).
# 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).
# Corresponds to the JSON property `error`
# @return [Google::Apis::CloudbuildV1alpha2::Status]
attr_accessor :error
# 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.
# 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.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
# 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``.
# originally returns it. If you use the default HTTP mapping, the `name` should
# be a resource name ending with `operations/`unique_id``.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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`.
# 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`.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
@ -1024,9 +984,9 @@ module Google
class RepoSource
include Google::Apis::Core::Hashable
# Regex matching branches to build.
# The syntax of the regular expressions accepted is the syntax accepted by
# RE2 and described at https://github.com/google/re2/wiki/Syntax
# Regex matching branches to build. The syntax of the regular expressions
# accepted is the syntax accepted by RE2 and described at https://github.com/
# google/re2/wiki/Syntax
# Corresponds to the JSON property `branchName`
# @return [String]
attr_accessor :branch_name
@ -1036,15 +996,14 @@ module Google
# @return [String]
attr_accessor :commit_sha
# Directory, relative to the source root, in which to run the build.
# This must be a relative path. If a step's `dir` is specified and is an
# absolute path, this value is ignored for that step's execution.
# Directory, relative to the source root, in which to run the build. This must
# be a relative path. If a step's `dir` is specified and is an absolute path,
# this value is ignored for that step's execution.
# Corresponds to the JSON property `dir`
# @return [String]
attr_accessor :dir
# Only trigger a build if the revision regex does NOT match the revision
# regex.
# Only trigger a build if the revision regex does NOT match the revision regex.
# Corresponds to the JSON property `invertRegex`
# @return [Boolean]
attr_accessor :invert_regex
@ -1061,15 +1020,15 @@ module Google
# @return [String]
attr_accessor :repo_name
# Substitutions to use in a triggered build.
# Should only be used with RunBuildTrigger
# Substitutions to use in a triggered build. Should only be used with
# RunBuildTrigger
# Corresponds to the JSON property `substitutions`
# @return [Hash<String,String>]
attr_accessor :substitutions
# Regex matching tags to build.
# The syntax of the regular expressions accepted is the syntax accepted by
# RE2 and described at https://github.com/google/re2/wiki/Syntax
# Regex matching tags to build. The syntax of the regular expressions accepted
# is the syntax accepted by RE2 and described at https://github.com/google/re2/
# wiki/Syntax
# Corresponds to the JSON property `tagName`
# @return [String]
attr_accessor :tag_name
@ -1105,17 +1064,15 @@ module Google
# @return [Google::Apis::CloudbuildV1alpha2::TimeSpan]
attr_accessor :artifact_timing
# List of build step digests, in the order corresponding to build step
# indices.
# List of build step digests, in the order corresponding to build step indices.
# Corresponds to the JSON property `buildStepImages`
# @return [Array<String>]
attr_accessor :build_step_images
# List of build step outputs, produced by builder images, in the order
# corresponding to build step indices.
# [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders)
# can produce this output by writing to `$BUILDER_OUTPUT/output`.
# Only the first 4KB of data is stored.
# corresponding to build step indices. [Cloud Builders](https://cloud.google.com/
# cloud-build/docs/cloud-builders) can produce this output by writing to `$
# BUILDER_OUTPUT/output`. Only the first 4KB of data is stored.
# Corresponds to the JSON property `buildStepOutputs`
# @return [Array<String>]
attr_accessor :build_step_outputs
@ -1149,8 +1106,8 @@ module Google
class SmtpDelivery
include Google::Apis::Core::Hashable
# This is the SMTP account/email that appears in the `From:` of the email.
# If empty, it is assumed to be sender.
# This is the SMTP account/email that appears in the `From:` of the email. If
# empty, it is assumed to be sender.
# Corresponds to the JSON property `fromAddress`
# @return [String]
attr_accessor :from_address
@ -1166,8 +1123,8 @@ module Google
# @return [String]
attr_accessor :port
# This is the list of addresses to which we send the email (i.e. in the `To:`
# of the email).
# This is the list of addresses to which we send the email (i.e. in the `To:` of
# the email).
# Corresponds to the JSON property `recipientAddresses`
# @return [Array<String>]
attr_accessor :recipient_addresses
@ -1197,8 +1154,8 @@ module Google
end
end
# Pairs a set of secret environment variables containing encrypted
# values with the Cloud KMS key to use to decrypt the value.
# Pairs a set of secret environment variables containing encrypted values with
# the Cloud KMS key to use to decrypt the value.
class Secret
include Google::Apis::Core::Hashable
@ -1207,11 +1164,10 @@ module Google
# @return [String]
attr_accessor :kms_key_name
# Map of environment variable name to its encrypted value.
# Secret environment variables must be unique across all of a build's
# secrets, and must be used by at least one build step. Values can be at most
# 64 KB in size. There can be at most 100 secret values across all of a
# build's secrets.
# Map of environment variable name to its encrypted value. Secret environment
# variables must be unique across all of a build's secrets, and must be used by
# at least one build step. Values can be at most 64 KB in size. There can be at
# most 100 secret values across all of a build's secrets.
# Corresponds to the JSON property `secretEnv`
# @return [Hash<String,String>]
attr_accessor :secret_env
@ -1228,8 +1184,8 @@ module Google
end
# SlackDelivery is the delivery configuration for delivering Slack messages via
# webhooks. See Slack webhook documentation at:
# https://api.slack.com/messaging/webhooks.
# webhooks. See Slack webhook documentation at: https://api.slack.com/messaging/
# webhooks.
class SlackDelivery
include Google::Apis::Core::Hashable
@ -1280,13 +1236,12 @@ module Google
include Google::Apis::Core::Hashable
# Output only. Hash(es) of the build source, which can be used to verify that
# the original source integrity was maintained in the build. Note that
# `FileHashes` will only be populated if `BuildOptions` has requested a
# `SourceProvenanceHash`.
# The keys to this map are file paths used as build source and the values
# contain the hash values for those files.
# If the build source came in a single package such as a gzipped tarfile
# (`.tar.gz`), the `FileHash` will be for the single path to that file.
# the original source integrity was maintained in the build. Note that `
# FileHashes` will only be populated if `BuildOptions` has requested a `
# SourceProvenanceHash`. The keys to this map are file paths used as build
# source and the values contain the hash values for those files. If the build
# source came in a single package such as a gzipped tarfile (`.tar.gz`), the `
# FileHash` will be for the single path to that file.
# Corresponds to the JSON property `fileHashes`
# @return [Hash<String,Google::Apis::CloudbuildV1alpha2::FileHashes>]
attr_accessor :file_hashes
@ -1313,12 +1268,12 @@ module Google
end
end
# 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).
# 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).
class Status
include Google::Apis::Core::Hashable
@ -1327,15 +1282,15 @@ module Google
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# A developer-facing error message, which should be in English. Any user-facing
# error message should be localized and sent in the google.rpc.Status.details
# field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
@ -1356,23 +1311,21 @@ module Google
class StorageSource
include Google::Apis::Core::Hashable
# Google Cloud Storage bucket containing the source (see
# [Bucket Name
# Google Cloud Storage bucket containing the source (see [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)
# ).
# Corresponds to the JSON property `bucket`
# @return [String]
attr_accessor :bucket
# Google Cloud Storage generation for the object. If the generation is
# omitted, the latest generation will be used.
# Google Cloud Storage generation for the object. If the generation is omitted,
# the latest generation will be used.
# Corresponds to the JSON property `generation`
# @return [Fixnum]
attr_accessor :generation
# Google Cloud Storage object containing the source.
# This object must be a gzipped archive file (`.tar.gz`) containing source to
# build.
# Google Cloud Storage object containing the source. This object must be a
# gzipped archive file (`.tar.gz`) containing source to build.
# Corresponds to the JSON property `object`
# @return [String]
attr_accessor :object
@ -1419,16 +1372,16 @@ module Google
class Volume
include Google::Apis::Core::Hashable
# Name of the volume to mount.
# Volume names must be unique per build step and must be valid names for
# Docker volumes. Each named volume must be used by at least two build steps.
# Name of the volume to mount. Volume names must be unique per build step and
# must be valid names for Docker volumes. Each named volume must be used by at
# least two build steps.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Path at which to mount the volume.
# Paths must be absolute and cannot conflict with other volume paths on the
# same build step or with certain reserved volume paths.
# Path at which to mount the volume. Paths must be absolute and cannot conflict
# with other volume paths on the same build step or with certain reserved volume
# paths.
# Corresponds to the JSON property `path`
# @return [String]
attr_accessor :path
@ -1449,17 +1402,16 @@ module Google
class WorkerConfig
include Google::Apis::Core::Hashable
# Size of the disk attached to the worker, in GB.
# See https://cloud.google.com/compute/docs/disks/
# If `0` is specified, Cloud Build will use a standard disk size.
# Size of the disk attached to the worker, in GB. See https://cloud.google.com/
# compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk
# size.
# Corresponds to the JSON property `diskSizeGb`
# @return [Fixnum]
attr_accessor :disk_size_gb
# Machine Type of the worker, such as n1-standard-1.
# See https://cloud.google.com/compute/docs/machine-types.
# If left blank, Cloud Build will use a standard unspecified machine to
# create the worker pool.
# Machine Type of the worker, such as n1-standard-1. See https://cloud.google.
# com/compute/docs/machine-types. If left blank, Cloud Build will use a standard
# unspecified machine to create the worker pool.
# Corresponds to the JSON property `machineType`
# @return [String]
attr_accessor :machine_type
@ -1475,31 +1427,28 @@ module Google
end
end
# Configuration for a WorkerPool to run the builds.
# Workers are machines that Cloud Build uses to run your builds. By default,
# all workers run in a project owned by Cloud Build. To have full control over
# the workers that execute your builds -- such as enabling them to access
# private resources on your private network -- you can request Cloud Build to
# run the workers in your own project by creating a custom workers pool.
# Configuration for a WorkerPool to run the builds. Workers are machines that
# Cloud Build uses to run your builds. By default, all workers run in a project
# owned by Cloud Build. To have full control over the workers that execute your
# builds -- such as enabling them to access private resources on your private
# network -- you can request Cloud Build to run the workers in your own project
# by creating a custom workers pool.
class WorkerPool
include Google::Apis::Core::Hashable
# Output only. Time at which the request to create the `WorkerPool` was
# received.
# Output only. Time at which the request to create the `WorkerPool` was received.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Output only. Time at which the request to delete the `WorkerPool` was
# received.
# Output only. Time at which the request to delete the `WorkerPool` was received.
# Corresponds to the JSON property `deleteTime`
# @return [String]
attr_accessor :delete_time
# Output only. The resource name of the `WorkerPool`.
# Format of the name is `projects/`project_id`/workerPools/`worker_pool_id``,
# where the value of `worker_pool_id` is provided in the CreateWorkerPool
# request.
# Output only. The resource name of the `WorkerPool`. Format of the name is `
# projects/`project_id`/workerPools/`worker_pool_id``, where the value of `
# worker_pool_id` is provided in the CreateWorkerPool request.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -1510,9 +1459,8 @@ module Google
attr_accessor :network_config
# Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1"
# is currently
# supported.
# Note that `region` cannot be changed once the `WorkerPool` is created.
# is currently supported. Note that `region` cannot be changed once the `
# WorkerPool` is created.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
@ -1522,8 +1470,7 @@ module Google
# @return [String]
attr_accessor :state
# Output only. Time at which the request to update the `WorkerPool` was
# received.
# Output only. Time at which the request to update the `WorkerPool` was received.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time

View File

@ -47,15 +47,13 @@ module Google
@batch_path = 'batch'
end
# 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,
# 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`.
# @param [String] name
# The name of the operation resource to be cancelled.
@ -89,9 +87,8 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] name
# The name of the operation resource.
# @param [String] fields
@ -123,15 +120,13 @@ module Google
# Creates a `WorkerPool` to run the builds, and returns the new worker pool.
# @param [String] parent
# Required. The parent resource where this book will be created.
# Format: projects/`project`
# Required. The parent resource where this book will be created. Format:
# projects/`project`
# @param [Google::Apis::CloudbuildV1alpha2::WorkerPool] worker_pool_object
# @param [String] worker_pool_id
# Required. Immutable. The ID to use for the `WorkerPool`, which will become the
# final component
# of the resource name.
# This value should be 1-63 characters, and valid characters
# are /a-z-/.
# final component of the resource name. This value should be 1-63 characters,
# and valid characters are /a-z-/.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -164,8 +159,8 @@ module Google
# Deletes a `WorkerPool`.
# @param [String] name
# Required. The name of the `WorkerPool` to delete.
# Format: projects/`project`/workerPools/`workerPool`
# Required. The name of the `WorkerPool` to delete. Format: projects/`project`/
# workerPools/`workerPool`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -195,8 +190,8 @@ module Google
# Returns details of a `WorkerPool`.
# @param [String] name
# Required. The name of the `WorkerPool` to retrieve.
# Format: projects/`project`/workerPools/`workerPool`
# Required. The name of the `WorkerPool` to retrieve. Format: projects/`project`/
# workerPools/`workerPool`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -226,8 +221,8 @@ module Google
# Lists `WorkerPool`s by project.
# @param [String] parent
# Required. The parent, which owns this collection of `WorkerPools`.
# Format: projects/`project`
# Required. The parent, which owns this collection of `WorkerPools`. Format:
# projects/`project`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -257,10 +252,9 @@ module Google
# Updates a `WorkerPool`.
# @param [String] name
# Output only. The resource name of the `WorkerPool`.
# Format of the name is `projects/`project_id`/workerPools/`worker_pool_id``,
# where the value of `worker_pool_id` is provided in the CreateWorkerPool
# request.
# Output only. The resource name of the `WorkerPool`. Format of the name is `
# projects/`project_id`/workerPools/`worker_pool_id``, where the value of `
# worker_pool_id` is provided in the CreateWorkerPool request.
# @param [Google::Apis::CloudbuildV1alpha2::WorkerPool] worker_pool_object
# @param [String] update_mask
# A mask specifying which fields in `WorkerPool` should be updated.

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/kms/
module CloudkmsV1
VERSION = 'V1'
REVISION = '20200609'
REVISION = '20200803'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

File diff suppressed because it is too large Load Diff

View File

@ -119,12 +119,12 @@ module Google
# Create a new KeyRing in a given Project and Location.
# @param [String] parent
# Required. The resource name of the location associated with the
# KeyRings, in the format `projects/*/locations/*`.
# Required. The resource name of the location associated with the KeyRings, in
# the format `projects/*/locations/*`.
# @param [Google::Apis::CloudkmsV1::KeyRing] key_ring_object
# @param [String] key_ring_id
# Required. It must be unique within a location and match the regular
# expression `[a-zA-Z0-9_-]`1,63``
# Required. It must be unique within a location and match the regular expression
# `[a-zA-Z0-9_-]`1,63``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -185,22 +185,19 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets the access control policy for a resource.
# Returns an empty policy if the resource exists and does not have a policy
# set.
# Gets the access control policy for a resource. Returns an empty policy if the
# resource exists and does not have a policy set.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested.
# See the operation documentation for the appropriate value for this field.
# REQUIRED: The resource for which the policy is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Fixnum] options_requested_policy_version
# Optional. The policy format version to be returned.
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.
# Requests for policies with any conditional bindings must specify version 3.
# Policies without any conditional bindings may specify any valid value 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).
# Optional. The policy format version to be returned. Valid values are 0, 1, and
# 3. Requests specifying an invalid value will be rejected. Requests for
# policies with any conditional bindings must specify version 3. Policies
# without any conditional bindings may specify any valid value 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).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -231,26 +228,25 @@ module Google
# Lists KeyRings.
# @param [String] parent
# Required. The resource name of the location associated with the
# KeyRings, in the format `projects/*/locations/*`.
# Required. The resource name of the location associated with the KeyRings, in
# the format `projects/*/locations/*`.
# @param [String] filter
# Optional. Only include resources that match the filter in the response. For
# more information, see
# [Sorting and filtering list
# results](https://cloud.google.com/kms/docs/sorting-and-filtering).
# more information, see [Sorting and filtering list results](https://cloud.
# google.com/kms/docs/sorting-and-filtering).
# @param [String] order_by
# Optional. Specify how the results should be sorted. If not specified, the
# results will be sorted in the default order. For more information, see
# [Sorting and filtering list
# results](https://cloud.google.com/kms/docs/sorting-and-filtering).
# results will be sorted in the default order. For more information, see [
# Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-
# and-filtering).
# @param [Fixnum] page_size
# Optional. Optional limit on the number of KeyRings to include in the
# response. Further KeyRings can subsequently be obtained by
# including the ListKeyRingsResponse.next_page_token in a subsequent
# request. If unspecified, the server will pick an appropriate default.
# Optional. Optional limit on the number of KeyRings to include in the response.
# Further KeyRings can subsequently be obtained by including the
# ListKeyRingsResponse.next_page_token in a subsequent request. If unspecified,
# the server will pick an appropriate default.
# @param [String] page_token
# Optional. Optional pagination token, returned earlier via
# ListKeyRingsResponse.next_page_token.
# Optional. Optional pagination token, returned earlier via ListKeyRingsResponse.
# next_page_token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -283,11 +279,11 @@ module Google
end
# Sets the access control policy on the specified resource. Replaces any
# existing policy.
# Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
# PERMISSION_DENIED` errors.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified.
# See the operation documentation for the appropriate value for this field.
# REQUIRED: The resource for which the policy is being specified. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::CloudkmsV1::SetIamPolicyRequest] set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -318,15 +314,14 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# See the operation documentation for the appropriate value for this field.
# REQUIRED: The resource for which the policy detail is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::CloudkmsV1::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -357,23 +352,18 @@ module Google
execute_or_queue_command(command, &block)
end
# Create a new CryptoKey within a KeyRing.
# CryptoKey.purpose and
# CryptoKey.version_template.algorithm
# are required.
# Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.
# version_template.algorithm are required.
# @param [String] parent
# Required. The name of the KeyRing associated with the
# CryptoKeys.
# Required. The name of the KeyRing associated with the CryptoKeys.
# @param [Google::Apis::CloudkmsV1::CryptoKey] crypto_key_object
# @param [String] crypto_key_id
# Required. It must be unique within a KeyRing and match the regular
# expression `[a-zA-Z0-9_-]`1,63``
# Required. It must be unique within a KeyRing and match the regular expression `
# [a-zA-Z0-9_-]`1,63``
# @param [Boolean] skip_initial_version_creation
# If set to true, the request will create a CryptoKey without any
# CryptoKeyVersions. You must manually call
# CreateCryptoKeyVersion or
# ImportCryptoKeyVersion
# before you can use this CryptoKey.
# CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or
# ImportCryptoKeyVersion before you can use this CryptoKey.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -405,11 +395,11 @@ module Google
execute_or_queue_command(command, &block)
end
# Decrypts data that was protected by Encrypt. The CryptoKey.purpose
# must be ENCRYPT_DECRYPT.
# Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be
# ENCRYPT_DECRYPT.
# @param [String] name
# Required. The resource name of the CryptoKey to use for decryption.
# The server will choose the appropriate version.
# Required. The resource name of the CryptoKey to use for decryption. The server
# will choose the appropriate version.
# @param [Google::Apis::CloudkmsV1::DecryptRequest] decrypt_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -440,14 +430,12 @@ module Google
execute_or_queue_command(command, &block)
end
# Encrypts data, so that it can only be recovered by a call to Decrypt.
# The CryptoKey.purpose must be
# ENCRYPT_DECRYPT.
# Encrypts data, so that it can only be recovered by a call to Decrypt. The
# CryptoKey.purpose must be ENCRYPT_DECRYPT.
# @param [String] name
# Required. The resource name of the CryptoKey or CryptoKeyVersion
# to use for encryption.
# If a CryptoKey is specified, the server will use its
# primary version.
# Required. The resource name of the CryptoKey or CryptoKeyVersion to use for
# encryption. If a CryptoKey is specified, the server will use its primary
# version.
# @param [Google::Apis::CloudkmsV1::EncryptRequest] encrypt_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -478,8 +466,8 @@ module Google
execute_or_queue_command(command, &block)
end
# Returns metadata for a given CryptoKey, as well as its
# primary CryptoKeyVersion.
# Returns metadata for a given CryptoKey, as well as its primary
# CryptoKeyVersion.
# @param [String] name
# Required. The name of the CryptoKey to get.
# @param [String] fields
@ -509,22 +497,19 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets the access control policy for a resource.
# Returns an empty policy if the resource exists and does not have a policy
# set.
# Gets the access control policy for a resource. Returns an empty policy if the
# resource exists and does not have a policy set.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested.
# See the operation documentation for the appropriate value for this field.
# REQUIRED: The resource for which the policy is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Fixnum] options_requested_policy_version
# Optional. The policy format version to be returned.
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.
# Requests for policies with any conditional bindings must specify version 3.
# Policies without any conditional bindings may specify any valid value 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).
# Optional. The policy format version to be returned. Valid values are 0, 1, and
# 3. Requests specifying an invalid value will be rejected. Requests for
# policies with any conditional bindings must specify version 3. Policies
# without any conditional bindings may specify any valid value 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).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -555,23 +540,22 @@ module Google
# Lists CryptoKeys.
# @param [String] parent
# Required. The resource name of the KeyRing to list, in the format
# `projects/*/locations/*/keyRings/*`.
# Required. The resource name of the KeyRing to list, in the format `projects/*/
# locations/*/keyRings/*`.
# @param [String] filter
# Optional. Only include resources that match the filter in the response. For
# more information, see
# [Sorting and filtering list
# results](https://cloud.google.com/kms/docs/sorting-and-filtering).
# more information, see [Sorting and filtering list results](https://cloud.
# google.com/kms/docs/sorting-and-filtering).
# @param [String] order_by
# Optional. Specify how the results should be sorted. If not specified, the
# results will be sorted in the default order. For more information, see
# [Sorting and filtering list
# results](https://cloud.google.com/kms/docs/sorting-and-filtering).
# results will be sorted in the default order. For more information, see [
# Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-
# and-filtering).
# @param [Fixnum] page_size
# Optional. Optional limit on the number of CryptoKeys to include in the
# response. Further CryptoKeys can subsequently be obtained by
# including the ListCryptoKeysResponse.next_page_token in a subsequent
# request. If unspecified, the server will pick an appropriate default.
# response. Further CryptoKeys can subsequently be obtained by including the
# ListCryptoKeysResponse.next_page_token in a subsequent request. If unspecified,
# the server will pick an appropriate default.
# @param [String] page_token
# Optional. Optional pagination token, returned earlier via
# ListCryptoKeysResponse.next_page_token.
@ -611,8 +595,8 @@ module Google
# Update a CryptoKey.
# @param [String] name
# Output only. The resource name for this CryptoKey in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
# Output only. The resource name for this CryptoKey in the format `projects/*/
# locations/*/keyRings/*/cryptoKeys/*`.
# @param [Google::Apis::CloudkmsV1::CryptoKey] crypto_key_object
# @param [String] update_mask
# Required. List of fields to be updated in this request.
@ -647,11 +631,11 @@ module Google
end
# Sets the access control policy on the specified resource. Replaces any
# existing policy.
# Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
# PERMISSION_DENIED` errors.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified.
# See the operation documentation for the appropriate value for this field.
# REQUIRED: The resource for which the policy is being specified. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::CloudkmsV1::SetIamPolicyRequest] set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -682,15 +666,14 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# See the operation documentation for the appropriate value for this field.
# REQUIRED: The resource for which the policy detail is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::CloudkmsV1::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -721,8 +704,8 @@ module Google
execute_or_queue_command(command, &block)
end
# Update the version of a CryptoKey that will be used in Encrypt.
# Returns an error if called on an asymmetric key.
# Update the version of a CryptoKey that will be used in Encrypt. Returns an
# error if called on an asymmetric key.
# @param [String] name
# Required. The resource name of the CryptoKey to update.
# @param [Google::Apis::CloudkmsV1::UpdateCryptoKeyPrimaryVersionRequest] update_crypto_key_primary_version_request_object
@ -755,12 +738,10 @@ module Google
execute_or_queue_command(command, &block)
end
# Decrypts data that was encrypted with a public key retrieved from
# GetPublicKey corresponding to a CryptoKeyVersion with
# CryptoKey.purpose ASYMMETRIC_DECRYPT.
# Decrypts data that was encrypted with a public key retrieved from GetPublicKey
# corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.
# @param [String] name
# Required. The resource name of the CryptoKeyVersion to use for
# decryption.
# Required. The resource name of the CryptoKeyVersion to use for decryption.
# @param [Google::Apis::CloudkmsV1::AsymmetricDecryptRequest] asymmetric_decrypt_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -791,9 +772,9 @@ module Google
execute_or_queue_command(command, &block)
end
# Signs data using a CryptoKeyVersion with CryptoKey.purpose
# ASYMMETRIC_SIGN, producing a signature that can be verified with the public
# key retrieved from GetPublicKey.
# Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN,
# producing a signature that can be verified with the public key retrieved from
# GetPublicKey.
# @param [String] name
# Required. The resource name of the CryptoKeyVersion to use for signing.
# @param [Google::Apis::CloudkmsV1::AsymmetricSignRequest] asymmetric_sign_request_object
@ -826,13 +807,10 @@ module Google
execute_or_queue_command(command, &block)
end
# Create a new CryptoKeyVersion in a CryptoKey.
# The server will assign the next sequential id. If unset,
# state will be set to
# ENABLED.
# Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next
# sequential id. If unset, state will be set to ENABLED.
# @param [String] parent
# Required. The name of the CryptoKey associated with
# the CryptoKeyVersions.
# Required. The name of the CryptoKey associated with the CryptoKeyVersions.
# @param [Google::Apis::CloudkmsV1::CryptoKeyVersion] crypto_key_version_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -863,16 +841,12 @@ module Google
execute_or_queue_command(command, &block)
end
# Schedule a CryptoKeyVersion for destruction.
# Upon calling this method, CryptoKeyVersion.state will be set to
# DESTROY_SCHEDULED
# and destroy_time will be set to a time 24
# hours in the future, at which point the state
# will be changed to
# DESTROYED, and the key
# material will be irrevocably destroyed.
# Before the destroy_time is reached,
# RestoreCryptoKeyVersion may be called to reverse the process.
# Schedule a CryptoKeyVersion for destruction. Upon calling this method,
# CryptoKeyVersion.state will be set to DESTROY_SCHEDULED and destroy_time will
# be set to a time 24 hours in the future, at which point the state will be
# changed to DESTROYED, and the key material will be irrevocably destroyed.
# Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to
# reverse the process.
# @param [String] name
# Required. The resource name of the CryptoKeyVersion to destroy.
# @param [Google::Apis::CloudkmsV1::DestroyCryptoKeyVersionRequest] destroy_crypto_key_version_request_object
@ -935,13 +909,10 @@ module Google
execute_or_queue_command(command, &block)
end
# Returns the public key for the given CryptoKeyVersion. The
# CryptoKey.purpose must be
# ASYMMETRIC_SIGN or
# ASYMMETRIC_DECRYPT.
# Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose
# must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.
# @param [String] name
# Required. The name of the CryptoKeyVersion public key to
# get.
# Required. The name of the CryptoKeyVersion public key to get.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -969,13 +940,11 @@ module Google
execute_or_queue_command(command, &block)
end
# Imports a new CryptoKeyVersion into an existing CryptoKey using the
# wrapped key material provided in the request.
# The version ID will be assigned the next sequential id within the
# CryptoKey.
# Imports a new CryptoKeyVersion into an existing CryptoKey using the wrapped
# key material provided in the request. The version ID will be assigned the next
# sequential id within the CryptoKey.
# @param [String] parent
# Required. The name of the CryptoKey to
# be imported into.
# Required. The name of the CryptoKey to be imported into.
# @param [Google::Apis::CloudkmsV1::ImportCryptoKeyVersionRequest] import_crypto_key_version_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -1008,24 +977,22 @@ module Google
# Lists CryptoKeyVersions.
# @param [String] parent
# Required. The resource name of the CryptoKey to list, in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
# Required. The resource name of the CryptoKey to list, in the format `projects/*
# /locations/*/keyRings/*/cryptoKeys/*`.
# @param [String] filter
# Optional. Only include resources that match the filter in the response. For
# more information, see
# [Sorting and filtering list
# results](https://cloud.google.com/kms/docs/sorting-and-filtering).
# more information, see [Sorting and filtering list results](https://cloud.
# google.com/kms/docs/sorting-and-filtering).
# @param [String] order_by
# Optional. Specify how the results should be sorted. If not specified, the
# results will be sorted in the default order. For more information, see
# [Sorting and filtering list
# results](https://cloud.google.com/kms/docs/sorting-and-filtering).
# results will be sorted in the default order. For more information, see [
# Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-
# and-filtering).
# @param [Fixnum] page_size
# Optional. Optional limit on the number of CryptoKeyVersions to
# include in the response. Further CryptoKeyVersions can
# subsequently be obtained by including the
# ListCryptoKeyVersionsResponse.next_page_token in a subsequent request.
# If unspecified, the server will pick an appropriate default.
# Optional. Optional limit on the number of CryptoKeyVersions to include in the
# response. Further CryptoKeyVersions can subsequently be obtained by including
# the ListCryptoKeyVersionsResponse.next_page_token in a subsequent request. If
# unspecified, the server will pick an appropriate default.
# @param [String] page_token
# Optional. Optional pagination token, returned earlier via
# ListCryptoKeyVersionsResponse.next_page_token.
@ -1063,15 +1030,12 @@ module Google
execute_or_queue_command(command, &block)
end
# Update a CryptoKeyVersion's metadata.
# state may be changed between
# ENABLED and
# DISABLED using this
# method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to
# move between other states.
# Update a CryptoKeyVersion's metadata. state may be changed between ENABLED and
# DISABLED using this method. See DestroyCryptoKeyVersion and
# RestoreCryptoKeyVersion to move between other states.
# @param [String] name
# Output only. The resource name for this CryptoKeyVersion in the format
# `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
# Output only. The resource name for this CryptoKeyVersion in the format `
# projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
# @param [Google::Apis::CloudkmsV1::CryptoKeyVersion] crypto_key_version_object
# @param [String] update_mask
# Required. List of fields to be updated in this request.
@ -1105,12 +1069,9 @@ module Google
execute_or_queue_command(command, &block)
end
# Restore a CryptoKeyVersion in the
# DESTROY_SCHEDULED
# state.
# Upon restoration of the CryptoKeyVersion, state
# will be set to DISABLED,
# and destroy_time will be cleared.
# Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of
# the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be
# cleared.
# @param [String] name
# Required. The resource name of the CryptoKeyVersion to restore.
# @param [Google::Apis::CloudkmsV1::RestoreCryptoKeyVersionRequest] restore_crypto_key_version_request_object
@ -1143,15 +1104,13 @@ module Google
execute_or_queue_command(command, &block)
end
# Create a new ImportJob within a KeyRing.
# ImportJob.import_method is required.
# Create a new ImportJob within a KeyRing. ImportJob.import_method is required.
# @param [String] parent
# Required. The name of the KeyRing associated with the
# ImportJobs.
# Required. The name of the KeyRing associated with the ImportJobs.
# @param [Google::Apis::CloudkmsV1::ImportJob] import_job_object
# @param [String] import_job_id
# Required. It must be unique within a KeyRing and match the regular
# expression `[a-zA-Z0-9_-]`1,63``
# Required. It must be unique within a KeyRing and match the regular expression `
# [a-zA-Z0-9_-]`1,63``
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -1212,22 +1171,19 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets the access control policy for a resource.
# Returns an empty policy if the resource exists and does not have a policy
# set.
# Gets the access control policy for a resource. Returns an empty policy if the
# resource exists and does not have a policy set.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested.
# See the operation documentation for the appropriate value for this field.
# REQUIRED: The resource for which the policy is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Fixnum] options_requested_policy_version
# Optional. The policy format version to be returned.
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.
# Requests for policies with any conditional bindings must specify version 3.
# Policies without any conditional bindings may specify any valid value 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).
# Optional. The policy format version to be returned. Valid values are 0, 1, and
# 3. Requests specifying an invalid value will be rejected. Requests for
# policies with any conditional bindings must specify version 3. Policies
# without any conditional bindings may specify any valid value 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).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -1258,23 +1214,22 @@ module Google
# Lists ImportJobs.
# @param [String] parent
# Required. The resource name of the KeyRing to list, in the format
# `projects/*/locations/*/keyRings/*`.
# Required. The resource name of the KeyRing to list, in the format `projects/*/
# locations/*/keyRings/*`.
# @param [String] filter
# Optional. Only include resources that match the filter in the response. For
# more information, see
# [Sorting and filtering list
# results](https://cloud.google.com/kms/docs/sorting-and-filtering).
# more information, see [Sorting and filtering list results](https://cloud.
# google.com/kms/docs/sorting-and-filtering).
# @param [String] order_by
# Optional. Specify how the results should be sorted. If not specified, the
# results will be sorted in the default order. For more information, see
# [Sorting and filtering list
# results](https://cloud.google.com/kms/docs/sorting-and-filtering).
# results will be sorted in the default order. For more information, see [
# Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-
# and-filtering).
# @param [Fixnum] page_size
# Optional. Optional limit on the number of ImportJobs to include in the
# response. Further ImportJobs can subsequently be obtained by
# including the ListImportJobsResponse.next_page_token in a subsequent
# request. If unspecified, the server will pick an appropriate default.
# response. Further ImportJobs can subsequently be obtained by including the
# ListImportJobsResponse.next_page_token in a subsequent request. If unspecified,
# the server will pick an appropriate default.
# @param [String] page_token
# Optional. Optional pagination token, returned earlier via
# ListImportJobsResponse.next_page_token.
@ -1310,11 +1265,11 @@ module Google
end
# Sets the access control policy on the specified resource. Replaces any
# existing policy.
# Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
# PERMISSION_DENIED` errors.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified.
# See the operation documentation for the appropriate value for this field.
# REQUIRED: The resource for which the policy is being specified. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::CloudkmsV1::SetIamPolicyRequest] set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -1345,15 +1300,14 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# See the operation documentation for the appropriate value for this field.
# REQUIRED: The resource for which the policy detail is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::CloudkmsV1::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/shell/docs/
module CloudshellV1
VERSION = 'V1'
REVISION = '20200721'
REVISION = '20200803'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -35,13 +35,11 @@ module Google
end
end
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
@ -54,112 +52,6 @@ module Google
end
end
# A Cloud Shell environment, which is defined as the combination of a Docker
# image specifying what is installed on the environment and a home directory
# containing the user's data that will remain across sessions. Each user has a
# single environment with the ID "default".
class Environment
include Google::Apis::Core::Hashable
# Required. Full path to the Docker image used to run this environment, e.g.
# "gcr.io/dev-con/cloud-devshell:latest".
# Corresponds to the JSON property `dockerImage`
# @return [String]
attr_accessor :docker_image
# Output only. The environment's identifier, unique among the user's
# environments.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Output only. 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`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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 CreatePublicKey and DeletePublicKey
# methods.
# Corresponds to the JSON property `publicKeys`
# @return [Array<Google::Apis::CloudshellV1::PublicKey>]
attr_accessor :public_keys
# Indicates the size of the backing VM running the environment. If set to
# something other than DEFAULT, it will be reverted to the default VM size
# after vm_size_expire_time.
# Corresponds to the JSON property `size`
# @return [String]
attr_accessor :size
# Output only. Host to which clients can connect to initiate SSH sessions
# with the environment.
# Corresponds to the JSON property `sshHost`
# @return [String]
attr_accessor :ssh_host
# Output only. Port to which clients can connect to initiate SSH sessions
# with the environment.
# Corresponds to the JSON property `sshPort`
# @return [Fixnum]
attr_accessor :ssh_port
# Output only. Username that clients should use when initiating SSH sessions
# with the environment.
# Corresponds to the JSON property `sshUsername`
# @return [String]
attr_accessor :ssh_username
# Output only. Current execution state of this environment.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# Output only. The time when the Environment will expire back to the default
# VM size.
# Corresponds to the JSON property `vmSizeExpireTime`
# @return [String]
attr_accessor :vm_size_expire_time
# Output only. Host to which clients can connect to initiate HTTPS or WSS
# connections with the environment.
# Corresponds to the JSON property `webHost`
# @return [String]
attr_accessor :web_host
# Output only. Ports to which clients can connect to initiate HTTPS or WSS
# connections with the environment.
# Corresponds to the JSON property `webPorts`
# @return [Array<Fixnum>]
attr_accessor :web_ports
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@docker_image = args[:docker_image] if args.key?(:docker_image)
@id = args[:id] if args.key?(:id)
@name = args[:name] if args.key?(:name)
@public_keys = args[:public_keys] if args.key?(:public_keys)
@size = args[:size] if args.key?(:size)
@ssh_host = args[:ssh_host] if args.key?(:ssh_host)
@ssh_port = args[:ssh_port] if args.key?(:ssh_port)
@ssh_username = args[:ssh_username] if args.key?(:ssh_username)
@state = args[:state] if args.key?(:state)
@vm_size_expire_time = args[:vm_size_expire_time] if args.key?(:vm_size_expire_time)
@web_host = args[:web_host] if args.key?(:web_host)
@web_ports = args[:web_ports] if args.key?(:web_ports)
end
end
# The response message for Operations.ListOperations.
class ListOperationsResponse
include Google::Apis::Core::Hashable
@ -190,47 +82,45 @@ module Google
class Operation
include Google::Apis::Core::Hashable
# 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.
# 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.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# 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).
# 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).
# Corresponds to the JSON property `error`
# @return [Google::Apis::CloudshellV1::Status]
attr_accessor :error
# 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.
# 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.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
# 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``.
# originally returns it. If you use the default HTTP mapping, the `name` should
# be a resource name ending with `operations/`unique_id``.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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`.
# 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`.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
@ -249,93 +139,12 @@ module Google
end
end
# A public SSH key, corresponding to a private SSH key held by the client.
class PublicKey
include Google::Apis::Core::Hashable
# Required. Format of this key's content.
# Corresponds to the JSON property `format`
# @return [String]
attr_accessor :format
# Required. Content of this key.
# Corresponds to the JSON property `key`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :key
# Output only. Full name of this resource, in the format
# `users/`owner_email`/environments/`environment_id`/publicKeys/`key_id``.
# ``owner_email`` is the email address of the user to whom the key belongs.
# ``environment_id`` is the identifier of the environment to which the key
# grants access. ``key_id`` is the unique identifier of the key. For example,
# `users/someone@example.com/environments/default/publicKeys/myKey`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@format = args[:format] if args.key?(:format)
@key = args[:key] if args.key?(:key)
@name = args[:name] if args.key?(:name)
end
end
# Message included in the metadata field of operations returned from
# StartEnvironment.
class StartEnvironmentMetadata
include Google::Apis::Core::Hashable
# Current state of the environment being started.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@state = args[:state] if args.key?(:state)
end
end
# Message included in the response field of operations returned from
# StartEnvironment
# once the operation is complete.
class StartEnvironmentResponse
include Google::Apis::Core::Hashable
# A Cloud Shell environment, which is defined as the combination of a Docker
# image specifying what is installed on the environment and a home directory
# containing the user's data that will remain across sessions. Each user has a
# single environment with the ID "default".
# Corresponds to the JSON property `environment`
# @return [Google::Apis::CloudshellV1::Environment]
attr_accessor :environment
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@environment = args[:environment] if args.key?(:environment)
end
end
# 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).
# 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).
class Status
include Google::Apis::Core::Hashable
@ -344,15 +153,15 @@ module Google
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# A developer-facing error message, which should be in English. Any user-facing
# error message should be localized and sent in the google.rpc.Status.details
# field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message

View File

@ -34,12 +34,6 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class Environment
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListOperationsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -52,24 +46,6 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class PublicKey
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class StartEnvironmentMetadata
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class StartEnvironmentResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Status
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -88,25 +64,6 @@ module Google
end
end
class Environment
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :docker_image, as: 'dockerImage'
property :id, as: 'id'
property :name, as: 'name'
collection :public_keys, as: 'publicKeys', class: Google::Apis::CloudshellV1::PublicKey, decorator: Google::Apis::CloudshellV1::PublicKey::Representation
property :size, as: 'size'
property :ssh_host, as: 'sshHost'
property :ssh_port, as: 'sshPort'
property :ssh_username, as: 'sshUsername'
property :state, as: 'state'
property :vm_size_expire_time, as: 'vmSizeExpireTime'
property :web_host, as: 'webHost'
collection :web_ports, as: 'webPorts'
end
end
class ListOperationsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -128,30 +85,6 @@ module Google
end
end
class PublicKey
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :format, as: 'format'
property :key, :base64 => true, as: 'key'
property :name, as: 'name'
end
end
class StartEnvironmentMetadata
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :state, as: 'state'
end
end
class StartEnvironmentResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :environment, as: 'environment', class: Google::Apis::CloudshellV1::Environment, decorator: Google::Apis::CloudshellV1::Environment::Representation
end
end
class Status
# @private
class Representation < Google::Apis::Core::JsonRepresentation

View File

@ -48,15 +48,13 @@ module Google
@batch_path = 'batch'
end
# 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,
# 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`.
# @param [String] name
# The name of the operation resource to be cancelled.
@ -90,10 +88,10 @@ module Google
execute_or_queue_command(command, &block)
end
# 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`.
# 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`.
# @param [String] name
# The name of the operation resource to be deleted.
# @param [String] fields
@ -123,9 +121,8 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] name
# The name of the operation resource.
# @param [String] fields
@ -155,15 +152,14 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] name
# The name of the operation's parent resource.
# @param [String] filter

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/shell/docs/
module CloudshellV1alpha1
VERSION = 'V1alpha1'
REVISION = '20200721'
REVISION = '20200803'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -22,8 +22,7 @@ module Google
module Apis
module CloudshellV1alpha1
# Request message for
# AuthorizeEnvironment.
# Request message for AuthorizeEnvironment.
class AuthorizeEnvironmentRequest
include Google::Apis::Core::Hashable
@ -55,8 +54,7 @@ module Google
end
end
# Request message for
# CreatePublicKey.
# Request message for CreatePublicKey.
class CreatePublicKeyRequest
include Google::Apis::Core::Hashable
@ -75,13 +73,11 @@ module Google
end
end
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
@ -101,8 +97,8 @@ module Google
class Environment
include Google::Apis::Core::Hashable
# Required. Full path to the Docker image used to run this environment, e.g.
# "gcr.io/dev-con/cloud-devshell:latest".
# Required. Full path to the Docker image used to run this environment, e.g. "
# gcr.io/dev-con/cloud-devshell:latest".
# Corresponds to the JSON property `dockerImage`
# @return [String]
attr_accessor :docker_image
@ -113,39 +109,38 @@ module Google
# @return [String]
attr_accessor :id
# Output only. 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`.
# Output only. 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`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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 CreatePublicKey and DeletePublicKey
# methods.
# 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 CreatePublicKey and DeletePublicKey methods.
# Corresponds to the JSON property `publicKeys`
# @return [Array<Google::Apis::CloudshellV1alpha1::PublicKey>]
attr_accessor :public_keys
# Indicates the size of the backing VM running the environment. If set to
# something other than DEFAULT, it will be reverted to the default VM size
# after vm_size_expire_time.
# Indicates the size of the backing VM running the environment. If set to
# something other than DEFAULT, it will be reverted to the default VM size after
# vm_size_expire_time.
# Corresponds to the JSON property `size`
# @return [String]
attr_accessor :size
# Output only. Host to which clients can connect to initiate SSH sessions
# with the environment.
# Output only. Host to which clients can connect to initiate SSH sessions with
# the environment.
# Corresponds to the JSON property `sshHost`
# @return [String]
attr_accessor :ssh_host
# Output only. Port to which clients can connect to initiate SSH sessions
# with the environment.
# Output only. Port to which clients can connect to initiate SSH sessions with
# the environment.
# Corresponds to the JSON property `sshPort`
# @return [Fixnum]
attr_accessor :ssh_port
@ -161,8 +156,8 @@ module Google
# @return [String]
attr_accessor :state
# Output only. The time when the Environment will expire back to the default
# VM size.
# Output only. The time when the Environment will expire back to the default VM
# size.
# Corresponds to the JSON property `vmSizeExpireTime`
# @return [String]
attr_accessor :vm_size_expire_time
@ -205,47 +200,45 @@ module Google
class Operation
include Google::Apis::Core::Hashable
# 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.
# 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.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# 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).
# 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).
# Corresponds to the JSON property `error`
# @return [Google::Apis::CloudshellV1alpha1::Status]
attr_accessor :error
# 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.
# 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.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
# 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``.
# originally returns it. If you use the default HTTP mapping, the `name` should
# be a resource name ending with `operations/`unique_id``.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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`.
# 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`.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
@ -279,12 +272,12 @@ module Google
# @return [String]
attr_accessor :key
# Output only. Full name of this resource, in the format
# `users/`owner_email`/environments/`environment_id`/publicKeys/`key_id``.
# ``owner_email`` is the email address of the user to whom the key belongs.
# ``environment_id`` is the identifier of the environment to which the key
# grants access. ``key_id`` is the unique identifier of the key. For example,
# `users/someone@example.com/environments/default/publicKeys/myKey`.
# Output only. Full name of this resource, in the format `users/`owner_email`/
# environments/`environment_id`/publicKeys/`key_id``. ``owner_email`` is the
# email address of the user to whom the key belongs. ``environment_id`` is the
# identifier of the environment to which the key grants access. ``key_id`` is
# the unique identifier of the key. For example, `users/someone@example.com/
# environments/default/publicKeys/myKey`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -321,15 +314,14 @@ module Google
end
end
# Request message for
# StartEnvironment.
# Request message for StartEnvironment.
class StartEnvironmentRequest
include Google::Apis::Core::Hashable
# The initial access token passed to the environment. If this is present and
# valid, the environment will be pre-authenticated with gcloud so that the
# user can run gcloud commands in Cloud Shell without having to log in. This
# code can be updated later by calling AuthorizeEnvironment.
# valid, the environment will be pre-authenticated with gcloud so that the user
# can run gcloud commands in Cloud Shell without having to log in. This code can
# be updated later by calling AuthorizeEnvironment.
# Corresponds to the JSON property `accessToken`
# @return [String]
attr_accessor :access_token
@ -351,8 +343,7 @@ module Google
end
# Message included in the response field of operations returned from
# StartEnvironment
# once the operation is complete.
# StartEnvironment once the operation is complete.
class StartEnvironmentResponse
include Google::Apis::Core::Hashable
@ -374,12 +365,12 @@ module Google
end
end
# 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).
# 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).
class Status
include Google::Apis::Core::Hashable
@ -388,15 +379,15 @@ module Google
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# A developer-facing error message, which should be in English. Any user-facing
# error message should be localized and sent in the google.rpc.Status.details
# field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message

View File

@ -49,13 +49,11 @@ module Google
end
# Sends OAuth credentials to a running environment on behalf of a user. When
# this completes, the environment will be authorized to run various Google
# Cloud command line tools without requiring the user to manually
# authenticate.
# this completes, the environment will be authorized to run various Google Cloud
# command line tools without requiring the user to manually authenticate.
# @param [String] name
# Name of the resource that should receive the credentials, for example
# `users/me/environments/default` or
# `users/someone@example.com/environments/default`.
# Name of the resource that should receive the credentials, for example `users/
# me/environments/default` or `users/someone@example.com/environments/default`.
# @param [Google::Apis::CloudshellV1alpha1::AuthorizeEnvironmentRequest] authorize_environment_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -88,8 +86,8 @@ module Google
# Gets an environment. Returns NOT_FOUND if the environment does not exist.
# @param [String] name
# Name of the requested resource, for example `users/me/environments/default`
# or `users/someone@example.com/environments/default`.
# Name of the requested resource, for example `users/me/environments/default` or
# `users/someone@example.com/environments/default`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -119,9 +117,8 @@ module Google
# Updates an existing environment.
# @param [String] name
# Name of the resource to be updated, for example
# `users/me/environments/default` or
# `users/someone@example.com/environments/default`.
# Name of the resource to be updated, for example `users/me/environments/default`
# or `users/someone@example.com/environments/default`.
# @param [Google::Apis::CloudshellV1alpha1::Environment] environment_object
# @param [String] update_mask
# Mask specifying which fields in the environment should be updated.
@ -156,15 +153,14 @@ module Google
end
# Starts an existing environment, allowing clients to connect to it. The
# returned operation will contain an instance of StartEnvironmentMetadata in
# its metadata field. Users can wait for the environment to start by polling
# this operation via GetOperation. Once the environment has finished starting
# and is ready to accept connections, the operation will contain a
# returned operation will contain an instance of StartEnvironmentMetadata in its
# metadata field. Users can wait for the environment to start by polling this
# operation via GetOperation. Once the environment has finished starting and is
# ready to accept connections, the operation will contain a
# StartEnvironmentResponse in its response field.
# @param [String] name
# Name of the resource that should be started, for example
# `users/me/environments/default` or
# `users/someone@example.com/environments/default`.
# Name of the resource that should be started, for example `users/me/
# environments/default` or `users/someone@example.com/environments/default`.
# @param [Google::Apis::CloudshellV1alpha1::StartEnvironmentRequest] start_environment_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -197,8 +193,8 @@ module Google
# Adds a public SSH key to an environment, allowing clients with the
# corresponding private key to connect to that environment via SSH. If a key
# with the same format and content already exists, this will return the
# existing key.
# with the same format and content already exists, this will return the existing
# key.
# @param [String] parent
# Parent resource name, e.g. `users/me/environments/default`.
# @param [Google::Apis::CloudshellV1alpha1::CreatePublicKeyRequest] create_public_key_request_object
@ -231,11 +227,11 @@ module Google
execute_or_queue_command(command, &block)
end
# Removes a public SSH key from an environment. Clients will no longer be
# able to connect to the environment using the corresponding private key.
# Removes a public SSH key from an environment. Clients will no longer be able
# to connect to the environment using the corresponding private key.
# @param [String] name
# Name of the resource to be deleted, e.g.
# `users/me/environments/default/publicKeys/my-key`.
# Name of the resource to be deleted, e.g. `users/me/environments/default/
# publicKeys/my-key`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user

View File

@ -29,7 +29,7 @@ module Google
# @see https://cloud.google.com/trace
module CloudtraceV1
VERSION = 'V1'
REVISION = '20200713'
REVISION = '20200805'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -22,13 +22,11 @@ module Google
module Apis
module CloudtraceV1
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
@ -45,9 +43,9 @@ module Google
class ListTracesResponse
include Google::Apis::Core::Hashable
# If defined, indicates that there are more traces that match the request
# and that this value should be passed to the next request to continue
# retrieving additional traces.
# If defined, indicates that there are more traces that match the request and
# that this value should be passed to the next request to continue retrieving
# additional traces.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -68,9 +66,9 @@ module Google
end
end
# A trace describes how long it takes for an application to perform an
# operation. It consists of a set of spans, each of which represent a single
# timed event within the operation.
# A trace describes how long it takes for an application to perform an operation.
# It consists of a set of spans, each of which represent a single timed event
# within the operation.
class Trace
include Google::Apis::Core::Hashable
@ -84,9 +82,9 @@ module Google
# @return [Array<Google::Apis::CloudtraceV1::TraceSpan>]
attr_accessor :spans
# Globally unique identifier for the trace. This identifier is a 128-bit
# numeric value formatted as a 32-byte hex string. For example,
# `382d4f4c6b7bb2f4a972559d9085001d`. The numeric value should not be zero.
# Globally unique identifier for the trace. This identifier is a 128-bit numeric
# value formatted as a 32-byte hex string. For example, `
# 382d4f4c6b7bb2f4a972559d9085001d`. The numeric value should not be zero.
# Corresponds to the JSON property `traceId`
# @return [String]
attr_accessor :trace_id
@ -103,11 +101,11 @@ module Google
end
end
# A span represents a single timed event within a trace. Spans can be nested
# and form a trace tree. Often, a trace contains a root span that describes the
# end-to-end latency of an operation and, optionally, one or more subspans for
# its suboperations. Spans do not need to be contiguous. There may be gaps
# between spans in a trace.
# A span represents a single timed event within a trace. Spans can be nested and
# form a trace tree. Often, a trace contains a root span that describes the end-
# to-end latency of an operation and, optionally, one or more subspans for its
# suboperations. Spans do not need to be contiguous. There may be gaps between
# spans in a trace.
class TraceSpan
include Google::Apis::Core::Hashable
@ -117,53 +115,33 @@ module Google
attr_accessor :end_time
# Distinguishes between spans generated in a particular context. For example,
# two spans with the same name may be distinguished using `RPC_CLIENT`
# and `RPC_SERVER` to identify queueing latency associated with the span.
# two spans with the same name may be distinguished using `RPC_CLIENT` and `
# RPC_SERVER` to identify queueing latency associated with the span.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Collection of labels associated with the span. Label keys must be less than
# 128 bytes. Label values must be less than 16 kilobytes (10MB for
# `/stacktrace` values).
# Some predefined label keys exist, or you may create your own. When creating
# your own, we recommend the following formats:
# * `/category/product/key` for agents of well-known products (e.g.
# `/db/mongodb/read_size`).
# * `short_host/path/key` for domain-specific keys (e.g.
# `foo.com/myproduct/bar`)
# Predefined labels include:
# * `/agent`
# * `/component`
# * `/error/message`
# * `/error/name`
# * `/http/client_city`
# * `/http/client_country`
# * `/http/client_protocol`
# * `/http/client_region`
# * `/http/host`
# * `/http/method`
# * `/http/path`
# * `/http/redirected_url`
# * `/http/request/size`
# * `/http/response/size`
# * `/http/route`
# * `/http/status_code`
# * `/http/url`
# * `/http/user_agent`
# * `/pid`
# * `/stacktrace`
# * `/tid`
# 128 bytes. Label values must be less than 16 kilobytes (10MB for `/stacktrace`
# values). Some predefined label keys exist, or you may create your own. When
# creating your own, we recommend the following formats: * `/category/product/
# key` for agents of well-known products (e.g. `/db/mongodb/read_size`). * `
# short_host/path/key` for domain-specific keys (e.g. `foo.com/myproduct/bar`)
# Predefined labels include: * `/agent` * `/component` * `/error/message` * `/
# error/name` * `/http/client_city` * `/http/client_country` * `/http/
# client_protocol` * `/http/client_region` * `/http/host` * `/http/method` * `/
# http/path` * `/http/redirected_url` * `/http/request/size` * `/http/response/
# size` * `/http/route` * `/http/status_code` * `/http/url` * `/http/user_agent`
# * `/pid` * `/stacktrace` * `/tid`
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# Name of the span. Must be less than 128 bytes. The span name is sanitized
# and displayed in the Trace tool in the Google Cloud Platform Console.
# The name may be a method name or some other per-call site name.
# For the same executable and the same call point, a best practice is
# to use a consistent name, which makes it easier to correlate
# cross-trace spans.
# Name of the span. Must be less than 128 bytes. The span name is sanitized and
# displayed in the Trace tool in the Google Cloud Platform Console. The name may
# be a method name or some other per-call site name. For the same executable and
# the same call point, a best practice is to use a consistent name, which makes
# it easier to correlate cross-trace spans.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -173,8 +151,8 @@ module Google
# @return [Fixnum]
attr_accessor :parent_span_id
# Identifier for the span. Must be a 64-bit integer other than 0 and
# unique within a trace. For example, `2205310701640571284`.
# Identifier for the span. Must be a 64-bit integer other than 0 and unique
# within a trace. For example, `2205310701640571284`.
# Corresponds to the JSON property `spanId`
# @return [Fixnum]
attr_accessor :span_id

View File

@ -51,11 +51,11 @@ module Google
@batch_path = 'batch'
end
# Sends new traces to Cloud Trace or updates existing traces. If the ID
# of a trace that you send matches that of an existing trace, any fields
# in the existing trace and its spans are overwritten by the provided values,
# and any new fields provided are merged with the existing trace data. If the
# ID does not match, a new trace is created.
# Sends new traces to Cloud Trace or updates existing traces. If the ID of a
# trace that you send matches that of an existing trace, any fields in the
# existing trace and its spans are overwritten by the provided values, and any
# new fields provided are merged with the existing trace data. If the ID does
# not match, a new trace is created.
# @param [String] project_id
# Required. ID of the Cloud project where the trace data is stored.
# @param [Google::Apis::CloudtraceV1::Traces] traces_object
@ -125,61 +125,47 @@ module Google
# @param [String] project_id
# Required. ID of the Cloud project where the trace data is stored.
# @param [String] end_time
# End of the time interval (inclusive) during which the trace data was
# collected from the application.
# End of the time interval (inclusive) during which the trace data was collected
# from the application.
# @param [String] filter
# Optional. A filter against labels for the request.
# By default, searches use prefix matching. To specify exact match, prepend
# a plus symbol (`+`) to the search term.
# Multiple terms are ANDed. Syntax:
# * `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root
# span starts with `NAME_PREFIX`.
# * `+root:NAME` or `+NAME`: Return traces where any root span's name is
# exactly `NAME`.
# * `span:NAME_PREFIX`: Return traces where any span starts with
# `NAME_PREFIX`.
# * `+span:NAME`: Return traces where any span's name is exactly
# `NAME`.
# * `latency:DURATION`: Return traces whose overall latency is
# greater or equal to than `DURATION`. Accepted units are nanoseconds
# (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For
# example, `latency:24ms` returns traces whose overall latency
# is greater than or equal to 24 milliseconds.
# * `label:LABEL_KEY`: Return all traces containing the specified
# label key (exact match, case-sensitive) regardless of the key:value
# pair's value (including empty values).
# * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified
# label key (exact match, case-sensitive) whose value starts with
# `VALUE_PREFIX`. Both a key and a value must be specified.
# * `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair
# exactly matching the specified text. Both a key and a value must be
# specified.
# * `method:VALUE`: Equivalent to `/http/method:VALUE`.
# * `url:VALUE`: Equivalent to `/http/url:VALUE`.
# Optional. A filter against labels for the request. By default, searches use
# prefix matching. To specify exact match, prepend a plus symbol (`+`) to the
# search term. Multiple terms are ANDed. Syntax: * `root:NAME_PREFIX` or `
# NAME_PREFIX`: Return traces where any root span starts with `NAME_PREFIX`. * `+
# root:NAME` or `+NAME`: Return traces where any root span's name is exactly `
# NAME`. * `span:NAME_PREFIX`: Return traces where any span starts with `
# NAME_PREFIX`. * `+span:NAME`: Return traces where any span's name is exactly `
# NAME`. * `latency:DURATION`: Return traces whose overall latency is greater or
# equal to than `DURATION`. Accepted units are nanoseconds (`ns`), milliseconds (
# `ms`), and seconds (`s`). Default is `ms`. For example, `latency:24ms` returns
# traces whose overall latency is greater than or equal to 24 milliseconds. * `
# label:LABEL_KEY`: Return all traces containing the specified label key (exact
# match, case-sensitive) regardless of the key:value pair's value (including
# empty values). * `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the
# specified label key (exact match, case-sensitive) whose value starts with `
# VALUE_PREFIX`. Both a key and a value must be specified. * `+LABEL_KEY:VALUE`:
# Return all traces containing a key:value pair exactly matching the specified
# text. Both a key and a value must be specified. * `method:VALUE`: Equivalent
# to `/http/method:VALUE`. * `url:VALUE`: Equivalent to `/http/url:VALUE`.
# @param [String] order_by
# Optional. Field used to sort the returned traces.
# Can be one of the following:
# * `trace_id`
# * `name` (`name` field of root span in the trace)
# * `duration` (difference between `end_time` and `start_time` fields of
# the root span)
# * `start` (`start_time` field of the root span)
# Descending order can be specified by appending `desc` to the sort field
# (for example, `name desc`).
# Only one sort field is permitted.
# Optional. Field used to sort the returned traces. Can be one of the following:
# * `trace_id` * `name` (`name` field of root span in the trace) * `duration` (
# difference between `end_time` and `start_time` fields of the root span) * `
# start` (`start_time` field of the root span) Descending order can be specified
# by appending `desc` to the sort field (for example, `name desc`). Only one
# sort field is permitted.
# @param [Fixnum] page_size
# Optional. Maximum number of traces to return. If not specified or <= 0, the
# implementation selects a reasonable value. The implementation may
# return fewer traces than the requested page size.
# implementation selects a reasonable value. The implementation may return fewer
# traces than the requested page size.
# @param [String] page_token
# Token identifying the page of results to return. If provided, use the
# value of the `next_page_token` field from a previous request.
# Token identifying the page of results to return. If provided, use the value of
# the `next_page_token` field from a previous request.
# @param [String] start_time
# Start of the time interval (inclusive) during which the trace data was
# collected from the application.
# @param [String] view
# Optional. Type of data returned for traces in the list. Default is
# `MINIMAL`.
# Optional. Type of data returned for traces in the list. Default is `MINIMAL`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user

View File

@ -29,7 +29,7 @@ module Google
# @see https://cloud.google.com/trace
module CloudtraceV2
VERSION = 'V2'
REVISION = '20200713'
REVISION = '20200805'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -83,19 +83,18 @@ module Google
class Attributes
include Google::Apis::Core::Hashable
# The set of attributes. Each attribute's key can be up to 128 bytes
# long. The value can be a string up to 256 bytes, a signed 64-bit integer,
# or the Boolean values `true` and `false`. For example:
# "/instance_id": ` "string_value": ` "value": "my-instance" ` `
# "/http/request_bytes": ` "int_value": 300 `
# "abc.com/myattribute": ` "bool_value": false `
# The set of attributes. Each attribute's key can be up to 128 bytes long. The
# value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean
# values `true` and `false`. For example: "/instance_id": ` "string_value": ` "
# value": "my-instance" ` ` "/http/request_bytes": ` "int_value": 300 ` "abc.com/
# myattribute": ` "bool_value": false `
# Corresponds to the JSON property `attributeMap`
# @return [Hash<String,Google::Apis::CloudtraceV2::AttributeValue>]
attr_accessor :attribute_map
# The number of attributes that were discarded. Attributes can be discarded
# because their keys are too long or because there are too many attributes.
# If this value is 0 then all attributes are valid.
# because their keys are too long or because there are too many attributes. If
# this value is 0 then all attributes are valid.
# Corresponds to the JSON property `droppedAttributesCount`
# @return [Fixnum]
attr_accessor :dropped_attributes_count
@ -115,8 +114,8 @@ module Google
class BatchWriteSpansRequest
include Google::Apis::Core::Hashable
# Required. A list of new spans. The span names must not match existing
# spans, or the results are undefined.
# Required. A list of new spans. The span names must not match existing spans,
# or the results are undefined.
# Corresponds to the JSON property `spans`
# @return [Array<Google::Apis::CloudtraceV2::Span>]
attr_accessor :spans
@ -131,13 +130,11 @@ module Google
end
end
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
@ -151,9 +148,9 @@ module Google
end
# A pointer from the current span to another span in the same trace or in a
# different trace. For example, this can be used in batching operations,
# where a single batch handler processes multiple requests from different
# traces or when the handler receives a request from a different project.
# different trace. For example, this can be used in batching operations, where a
# single batch handler processes multiple requests from different traces or when
# the handler receives a request from a different project.
class Link
include Google::Apis::Core::Hashable
@ -190,13 +187,13 @@ module Google
end
end
# A collection of links, which are references from this span to a span
# in the same or different trace.
# A collection of links, which are references from this span to a span in the
# same or different trace.
class Links
include Google::Apis::Core::Hashable
# The number of dropped links after the maximum size was enforced. If
# this value is 0, then no links were dropped.
# The number of dropped links after the maximum size was enforced. If this value
# is 0, then no links were dropped.
# Corresponds to the JSON property `droppedLinksCount`
# @return [Fixnum]
attr_accessor :dropped_links_count
@ -221,21 +218,19 @@ module Google
class MessageEvent
include Google::Apis::Core::Hashable
# The number of compressed bytes sent or received. If missing assumed to
# be the same size as uncompressed.
# The number of compressed bytes sent or received. If missing assumed to be the
# same size as uncompressed.
# Corresponds to the JSON property `compressedSizeBytes`
# @return [Fixnum]
attr_accessor :compressed_size_bytes
# An identifier for the MessageEvent's message that can be used to match
# SENT and RECEIVED MessageEvents. It is recommended to be unique within
# a Span.
# An identifier for the MessageEvent's message that can be used to match SENT
# and RECEIVED MessageEvents. It is recommended to be unique within a Span.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# Type of MessageEvent. Indicates whether the message was sent or
# received.
# Type of MessageEvent. Indicates whether the message was sent or received.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
@ -283,12 +278,11 @@ module Google
end
end
# A span represents a single operation within a trace. Spans can be
# nested to form a trace tree. Often, a trace contains a root span
# that describes the end-to-end latency, and one or more subspans for
# its sub-operations. A trace can also contain multiple root spans,
# or none at all. Spans do not need to be contiguous&mdash;there may be
# gaps or overlaps between spans in a trace.
# A span represents a single operation within a trace. Spans can be nested to
# form a trace tree. Often, a trace contains a root span that describes the end-
# to-end latency, and one or more subspans for its sub-operations. A trace can
# also contain multiple root spans, or none at all. Spans do not need to be
# contiguous—there may be gaps or overlaps between spans in a trace.
class Span
include Google::Apis::Core::Hashable
@ -297,8 +291,8 @@ module Google
# @return [Google::Apis::CloudtraceV2::Attributes]
attr_accessor :attributes
# Optional. The number of child spans that were generated while this span
# was active. If set, allows implementation to detect missing child spans.
# Optional. The number of child spans that were generated while this span was
# active. If set, allows implementation to detect missing child spans.
# Corresponds to the JSON property `childSpanCount`
# @return [Fixnum]
attr_accessor :child_span_count
@ -309,39 +303,36 @@ module Google
attr_accessor :display_name
# Required. The end time of the span. On the client side, this is the time kept
# by
# the local machine where the span execution ends. On the server side, this
# by the local machine where the span execution ends. On the server side, this
# is the time when the server application handler stops running.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# A collection of links, which are references from this span to a span
# in the same or different trace.
# A collection of links, which are references from this span to a span in the
# same or different trace.
# Corresponds to the JSON property `links`
# @return [Google::Apis::CloudtraceV2::Links]
attr_accessor :links
# Required. The resource name of the span in the following format:
# projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique
# identifier for a trace within a project;
# it is a 32-character hexadecimal encoding of a 16-byte array.
# [SPAN_ID] is a unique identifier for a span within a trace; it
# is a 16-character hexadecimal encoding of an 8-byte array. It should not
# be zero.
# Required. The resource name of the span in the following format: projects/[
# PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace
# within a project; it is a 32-character hexadecimal encoding of a 16-byte array.
# [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-
# character hexadecimal encoding of an 8-byte array. It should not be zero.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The [SPAN_ID] of this span's parent span. If this is a root span,
# then this field must be empty.
# The [SPAN_ID] of this span's parent span. If this is a root span, then this
# field must be empty.
# Corresponds to the JSON property `parentSpanId`
# @return [String]
attr_accessor :parent_span_id
# Optional. Set this parameter to indicate whether this span is in
# the same process as its parent. If you do not set this parameter,
# Trace is unable to take advantage of this helpful information.
# Optional. Set this parameter to indicate whether this span is in the same
# process as its parent. If you do not set this parameter, Trace is unable to
# take advantage of this helpful information.
# Corresponds to the JSON property `sameProcessAsParentSpan`
# @return [Boolean]
attr_accessor :same_process_as_parent_span
@ -353,9 +344,8 @@ module Google
attr_accessor :span_id
# Optional. Distinguishes between spans generated in a particular context. For
# example,
# two spans with the same name may be distinguished using `CLIENT` (caller)
# and `SERVER` (callee) to identify an RPC call.
# example, two spans with the same name may be distinguished using `CLIENT` (
# caller) and `SERVER` (callee) to identify an RPC call.
# Corresponds to the JSON property `spanKind`
# @return [String]
attr_accessor :span_kind
@ -366,26 +356,25 @@ module Google
attr_accessor :stack_trace
# Required. The start time of the span. On the client side, this is the time
# kept by
# the local machine where the span execution starts. On the server side, this
# is the time when the server's application handler starts running.
# kept by the local machine where the span execution starts. On the server side,
# this is the time when the server's application handler starts running.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
# 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).
# 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).
# Corresponds to the JSON property `status`
# @return [Google::Apis::CloudtraceV2::Status]
attr_accessor :status
# A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation
# on the span, consisting of either user-supplied key:value pairs, or
# details of a message sent/received between Spans.
# A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation on
# the span, consisting of either user-supplied key:value pairs, or details of a
# message sent/received between Spans.
# Corresponds to the JSON property `timeEvents`
# @return [Google::Apis::CloudtraceV2::TimeEvents]
attr_accessor :time_events
@ -417,8 +406,8 @@ module Google
class StackFrame
include Google::Apis::Core::Hashable
# The column number where the function call appears, if available.
# This is important in JavaScript because of its anonymous functions.
# The column number where the function call appears, if available. This is
# important in JavaScript because of its anonymous functions.
# Corresponds to the JSON property `columnNumber`
# @return [Fixnum]
attr_accessor :column_number
@ -473,9 +462,8 @@ module Google
class StackFrames
include Google::Apis::Core::Hashable
# The number of stack frames that were dropped because there
# were too many stack frames.
# If this value is 0, then no stack frames were dropped.
# The number of stack frames that were dropped because there were too many stack
# frames. If this value is 0, then no stack frames were dropped.
# Corresponds to the JSON property `droppedFramesCount`
# @return [Fixnum]
attr_accessor :dropped_frames_count
@ -505,13 +493,11 @@ module Google
# @return [Google::Apis::CloudtraceV2::StackFrames]
attr_accessor :stack_frames
# The hash ID is used to conserve network bandwidth for duplicate
# stack traces within a single trace.
# Often multiple spans will have identical stack traces.
# The first occurrence of a stack trace should contain both the
# `stackFrame` content and a value in `stackTraceHashId`.
# Subsequent spans within the same request can refer
# to that stack trace by only setting `stackTraceHashId`.
# The hash ID is used to conserve network bandwidth for duplicate stack traces
# within a single trace. Often multiple spans will have identical stack traces.
# The first occurrence of a stack trace should contain both the `stackFrame`
# content and a value in `stackTraceHashId`. Subsequent spans within the same
# request can refer to that stack trace by only setting `stackTraceHashId`.
# Corresponds to the JSON property `stackTraceHashId`
# @return [Fixnum]
attr_accessor :stack_trace_hash_id
@ -527,12 +513,12 @@ module Google
end
end
# 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).
# 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).
class Status
include Google::Apis::Core::Hashable
@ -541,15 +527,15 @@ module Google
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# A developer-facing error message, which should be in English. Any user-facing
# error message should be localized and sent in the google.rpc.Status.details
# field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
@ -597,20 +583,20 @@ module Google
end
end
# A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation
# on the span, consisting of either user-supplied key:value pairs, or
# details of a message sent/received between Spans.
# A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation on
# the span, consisting of either user-supplied key:value pairs, or details of a
# message sent/received between Spans.
class TimeEvents
include Google::Apis::Core::Hashable
# The number of dropped annotations in all the included time events.
# If the value is 0, then no annotations were dropped.
# The number of dropped annotations in all the included time events. If the
# value is 0, then no annotations were dropped.
# Corresponds to the JSON property `droppedAnnotationsCount`
# @return [Fixnum]
attr_accessor :dropped_annotations_count
# The number of dropped message events in all the included time events.
# If the value is 0, then no message events were dropped.
# The number of dropped message events in all the included time events. If the
# value is 0, then no message events were dropped.
# Corresponds to the JSON property `droppedMessageEventsCount`
# @return [Fixnum]
attr_accessor :dropped_message_events_count
@ -636,18 +622,17 @@ module Google
class TruncatableString
include Google::Apis::Core::Hashable
# The number of bytes removed from the original string. If this
# value is 0, then the string was not shortened.
# The number of bytes removed from the original string. If this value is 0, then
# the string was not shortened.
# Corresponds to the JSON property `truncatedByteCount`
# @return [Fixnum]
attr_accessor :truncated_byte_count
# The shortened string. For example, if the original string is 500
# bytes long and the limit of the string is 128 bytes, then
# `value` contains the first 128 bytes of the 500-byte string.
# Truncation always happens on a UTF8 character boundary. If there
# are multi-byte characters in the string, then the length of the
# shortened string might be less than the size limit.
# The shortened string. For example, if the original string is 500 bytes long
# and the limit of the string is 128 bytes, then `value` contains the first 128
# bytes of the 500-byte string. Truncation always happens on a UTF8 character
# boundary. If there are multi-byte characters in the string, then the length of
# the shortened string might be less than the size limit.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value

View File

@ -51,11 +51,10 @@ module Google
@batch_path = 'batch'
end
# Sends new spans to new or existing traces. You cannot update
# existing spans.
# Sends new spans to new or existing traces. You cannot update existing spans.
# @param [String] name
# Required. The name of the project where the spans belong. The format is
# `projects/[PROJECT_ID]`.
# Required. The name of the project where the spans belong. The format is `
# projects/[PROJECT_ID]`.
# @param [Google::Apis::CloudtraceV2::BatchWriteSpansRequest] batch_write_spans_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -88,13 +87,11 @@ module Google
# Creates a new span.
# @param [String] name
# Required. The resource name of the span in the following format:
# projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique
# identifier for a trace within a project;
# it is a 32-character hexadecimal encoding of a 16-byte array.
# [SPAN_ID] is a unique identifier for a span within a trace; it
# is a 16-character hexadecimal encoding of an 8-byte array. It should not
# be zero.
# Required. The resource name of the span in the following format: projects/[
# PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace
# within a project; it is a 32-character hexadecimal encoding of a 16-byte array.
# [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-
# character hexadecimal encoding of an 8-byte array. It should not be zero.
# @param [Google::Apis::CloudtraceV2::Span] span_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.

View File

@ -29,7 +29,7 @@ module Google
# @see https://cloud.google.com/trace
module CloudtraceV2beta1
VERSION = 'V2beta1'
REVISION = '20200330'
REVISION = '20200805'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -22,13 +22,11 @@ module Google
module Apis
module CloudtraceV2beta1
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
@ -45,8 +43,8 @@ module Google
class ListTraceSinksResponse
include Google::Apis::Core::Hashable
# 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
# 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`.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
@ -72,9 +70,8 @@ module Google
class OutputConfig
include Google::Apis::Core::Hashable
# The destination for writing trace data. Currently only BigQuery is
# supported. E.g.:
# "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
# The destination for writing trace data. Currently only BigQuery is supported.
# E.g.: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
# Corresponds to the JSON property `destination`
# @return [String]
attr_accessor :destination
@ -89,20 +86,16 @@ module Google
end
end
# Describes a sink used to export traces to a BigQuery dataset. The sink must
# be created within a project.
# Describes a sink used to export traces to a BigQuery dataset. The sink must be
# created within a project.
class TraceSink
include Google::Apis::Core::Hashable
# Required. The canonical sink resource name, unique within the project. Must be
# of the
# form:
# project/[PROJECT_NUMBER]/traceSinks/[SINK_ID].
# E.g.:
# `"projects/12345/traceSinks/my-project-trace-sink"`.
# Sink identifiers are limited to 256 characters and can include only the
# following characters: upper and lower-case alphanumeric characters,
# underscores, hyphens, and periods.
# of the form: project/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/
# 12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256
# characters and can include only the following characters: upper and lower-case
# alphanumeric characters, underscores, hyphens, and periods.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -112,17 +105,14 @@ module Google
# @return [Google::Apis::CloudtraceV2beta1::OutputConfig]
attr_accessor :output_config
# Output only. A service account name for exporting the data. This field is
# set by sinks.create and sinks.update. The service account will need to be
# granted write access to the destination specified in the output
# configuration, see [Granting access for a
# resource](/iam/docs/granting-roles-to-service-accounts#
# granting_access_to_a_service_account_for_a_resource).
# To create tables and write data this account will need the dataEditor role.
# Read more about roles in the [BigQuery
# documentation](https://cloud.google.com/bigquery/docs/access-control).
# E.g.:
# "service-00000001@00000002.iam.gserviceaccount.com"
# Output only. A service account name for exporting the data. This field is set
# by sinks.create and sinks.update. The service account will need to be granted
# write access to the destination specified in the output configuration, see [
# Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#
# granting_access_to_a_service_account_for_a_resource). To create tables and
# write data this account will need the dataEditor role. Read more about roles
# in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-
# control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com"
# Corresponds to the JSON property `writerIdentity`
# @return [String]
attr_accessor :writer_identity

View File

@ -51,15 +51,14 @@ module Google
@batch_path = 'batch'
end
# Creates a sink that exports trace spans to a destination. The
# export of newly-ingested traces begins immediately, unless the sink's
# `writer_identity` is not permitted to write to the destination. A sink can
# export traces only from the resource owning the sink (the 'parent').
# Creates a sink that exports trace spans to a destination. The export of newly-
# ingested traces begins immediately, unless the sink's `writer_identity` is not
# permitted to write to the destination. A sink can export traces only from the
# resource owning the sink (the 'parent').
# @param [String] parent
# Required. The resource in which to create the sink (currently only project
# sinks are supported):
# "projects/[PROJECT_ID]"
# Examples: `"projects/my-trace-project"`, `"projects/123456789"`.
# sinks are supported): "projects/[PROJECT_ID]" Examples: `"projects/my-trace-
# project"`, `"projects/123456789"`.
# @param [Google::Apis::CloudtraceV2beta1::TraceSink] trace_sink_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -92,10 +91,9 @@ module Google
# Deletes a sink.
# @param [String] name
# Required. The full resource name of the sink to delete, including the
# parent resource and the sink identifier:
# "projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]"
# Example: `"projects/12345/traceSinks/my-sink-id"`.
# Required. The full resource name of the sink to delete, including the parent
# resource and the sink identifier: "projects/[PROJECT_NUMBER]/traceSinks/[
# SINK_ID]" Example: `"projects/12345/traceSinks/my-sink-id"`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -125,9 +123,8 @@ module Google
# Get a trace sink by name under the parent resource (GCP project).
# @param [String] name
# Required. The resource name of the sink:
# "projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]"
# Example: `"projects/12345/traceSinks/my-sink-id"`.
# Required. The resource name of the sink: "projects/[PROJECT_NUMBER]/traceSinks/
# [SINK_ID]" Example: `"projects/12345/traceSinks/my-sink-id"`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -158,17 +155,16 @@ module Google
# List all sinks for the parent resource (GCP project).
# @param [String] parent
# Required. The parent resource whose sinks are to be listed (currently only
# project parent resources are supported):
# "projects/[PROJECT_ID]"
# project parent resources are supported): "projects/[PROJECT_ID]"
# @param [Fixnum] page_size
# Optional. The maximum number of results to return from this request.
# Non-positive values are ignored. The presence of `nextPageToken` in the
# response indicates that more results might be available.
# Optional. The maximum number of results to return from this request. Non-
# positive values are ignored. The presence of `nextPageToken` in the response
# indicates that more results might be available.
# @param [String] page_token
# Optional. If present, then retrieve the next batch of results from the
# preceding call to this method. `pageToken` must be the value of
# `nextPageToken` from the previous response. The values of other method
# parameters should be identical to those in the previous call.
# preceding call to this method. `pageToken` must be the value of `nextPageToken`
# from the previous response. The values of other method parameters should be
# identical to those in the previous call.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -198,24 +194,21 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates a sink. This method updates fields in the existing sink according
# to the provided update mask. The sink's name cannot be changed nor any
# output-only fields (e.g. the writer_identity).
# Updates a sink. This method updates fields in the existing sink according to
# the provided update mask. The sink's name cannot be changed nor any output-
# only fields (e.g. the writer_identity).
# @param [String] name
# Required. The full resource name of the sink to update, including the
# parent resource and the sink identifier:
# "projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]"
# Example: `"projects/12345/traceSinks/my-sink-id"`.
# Required. The full resource name of the sink to update, including the parent
# resource and the sink identifier: "projects/[PROJECT_NUMBER]/traceSinks/[
# SINK_ID]" Example: `"projects/12345/traceSinks/my-sink-id"`.
# @param [Google::Apis::CloudtraceV2beta1::TraceSink] trace_sink_object
# @param [String] update_mask
# Required. Field mask that specifies the fields in `trace_sink` that are to
# be updated. A sink field is overwritten if, and only if, it is
# in the update mask. `name` and `writer_identity` fields cannot be updated.
# An empty updateMask is considered an error.
# For a detailed `FieldMask` definition, see
# https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
# fieldmask
# Example: `updateMask=output_config`.
# Required. Field mask that specifies the fields in `trace_sink` that are to be
# updated. A sink field is overwritten if, and only if, it is in the update mask.
# `name` and `writer_identity` fields cannot be updated. An empty updateMask is
# considered an error. For a detailed `FieldMask` definition, see https://
# developers.google.com/protocol-buffers/docs/reference/google.protobuf#
# fieldmask Example: `updateMask=output_config`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user

View File

@ -21,20 +21,17 @@ module Google
# Cloud Data Fusion API
#
# Cloud 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,
# 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.
#
# @see https://cloud.google.com/data-fusion/docs
module DatafusionV1
VERSION = 'V1'
REVISION = '20200609'
REVISION = '20200803'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -41,53 +41,21 @@ module Google
end
end
# Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
# Example Policy with multiple AuditConfigs:
# `
# "audit_configs": [
# `
# "service": "allServices",
# "audit_log_configs": [
# `
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# `,
# `
# "log_type": "DATA_WRITE"
# `,
# `
# "log_type": "ADMIN_READ"
# `
# ]
# `,
# `
# "service": "sampleservice.googleapis.com",
# "audit_log_configs": [
# `
# "log_type": "DATA_READ"
# `,
# `
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:aliya@example.com"
# ]
# `
# ]
# `
# ]
# `
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts jose@example.com from DATA_READ logging, and
# aliya@example.com from DATA_WRITE logging.
# Specifies the audit configuration for a service. The configuration determines
# which permission types are logged, and what identities, if any, are exempted
# from logging. An AuditConfig must have one or more AuditLogConfigs. If there
# are AuditConfigs for both `allServices` and a specific service, the union of
# the two AuditConfigs is used for that service: the log_types specified in each
# AuditConfig are enabled, and the exempted_members in each AuditLogConfig are
# exempted. Example Policy with multiple AuditConfigs: ` "audit_configs": [ ` "
# service": "allServices", "audit_log_configs": [ ` "log_type": "DATA_READ", "
# exempted_members": [ "user:jose@example.com" ] `, ` "log_type": "DATA_WRITE" `,
# ` "log_type": "ADMIN_READ" ` ] `, ` "service": "sampleservice.googleapis.com",
# "audit_log_configs": [ ` "log_type": "DATA_READ" `, ` "log_type": "DATA_WRITE"
# , "exempted_members": [ "user:aliya@example.com" ] ` ] ` ] ` For sampleservice,
# this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also
# exempts jose@example.com from DATA_READ logging, and aliya@example.com from
# DATA_WRITE logging.
class AuditConfig
include Google::Apis::Core::Hashable
@ -96,9 +64,9 @@ module Google
# @return [Array<Google::Apis::DatafusionV1::AuditLogConfig>]
attr_accessor :audit_log_configs
# Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
# Specifies a service that will be enabled for audit logging. For example, `
# storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special
# value that covers all services.
# Corresponds to the JSON property `service`
# @return [String]
attr_accessor :service
@ -114,28 +82,15 @@ module Google
end
end
# Provides the configuration for logging a type of permissions.
# Example:
# `
# "audit_log_configs": [
# `
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# `,
# `
# "log_type": "DATA_WRITE"
# `
# ]
# `
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
# Provides the configuration for logging a type of permissions. Example: ` "
# audit_log_configs": [ ` "log_type": "DATA_READ", "exempted_members": [ "user:
# jose@example.com" ] `, ` "log_type": "DATA_WRITE" ` ] ` This enables '
# DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from
# DATA_READ logging.
class AuditLogConfig
include Google::Apis::Core::Hashable
# Specifies the identities that do not cause logging for this type of
# permission.
# Specifies the identities that do not cause logging for this type of permission.
# Follows the same format of Binding.members.
# Corresponds to the JSON property `exemptedMembers`
# @return [Array<String>]
@ -161,69 +116,57 @@ module Google
class Binding
include Google::Apis::Core::Hashable
# Represents a textual expression in the Common Expression Language (CEL)
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
# Example (Comparison):
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() < 100"
# Example (Equality):
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
# Example (Logic):
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' && document.type != 'internal'"
# Example (Data Manipulation):
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
# Represents a textual expression in the Common Expression Language (CEL) syntax.
# CEL is a C-like expression language. The syntax and semantics of CEL are
# documented at https://github.com/google/cel-spec. Example (Comparison): title:
# "Summary size limit" description: "Determines if a summary is less than 100
# chars" expression: "document.summary.size() < 100" Example (Equality): title: "
# Requestor is owner" description: "Determines if requestor is the document
# owner" expression: "document.owner == request.auth.claims.email" Example (
# Logic): title: "Public documents" description: "Determine whether the document
# should be publicly visible" expression: "document.type != 'private' &&
# document.type != 'internal'" Example (Data Manipulation): title: "Notification
# string" description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)" The
# exact variables and functions that may be referenced within an expression are
# determined by the service that evaluates it. See the service documentation for
# additional information.
# Corresponds to the JSON property `condition`
# @return [Google::Apis::DatafusionV1::Expr]
attr_accessor :condition
# Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
# * `user:`emailid``: An email address that represents a specific Google
# account. For example, `alice@example.com` .
# * `serviceAccount:`emailid``: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
# * `group:`emailid``: An email address that represents a Google group.
# For example, `admins@example.com`.
# * `deleted:user:`emailid`?uid=`uniqueid``: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?uid=123456789012345678901`. If the user is
# recovered, this value reverts to `user:`emailid`` and the recovered user
# retains the role in the binding.
# * `deleted:serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example,
# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to
# `serviceAccount:`emailid`` and the undeleted service account retains the
# role in the binding.
# * `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique
# identifier) representing a Google group that has been recently
# deleted. For example, `admins@example.com?uid=123456789012345678901`. If
# the group is recovered, this value reverts to `group:`emailid`` and the
# recovered group retains the role in the binding.
# * `domain:`domain``: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
# Specifies the identities requesting access for a Cloud Platform resource. `
# members` can have the following values: * `allUsers`: A special identifier
# that represents anyone who is on the internet; with or without a Google
# account. * `allAuthenticatedUsers`: A special identifier that represents
# anyone who is authenticated with a Google account or a service account. * `
# user:`emailid``: An email address that represents a specific Google account.
# For example, `alice@example.com` . * `serviceAccount:`emailid``: An email
# address that represents a service account. For example, `my-other-app@appspot.
# gserviceaccount.com`. * `group:`emailid``: An email address that represents a
# Google group. For example, `admins@example.com`. * `deleted:user:`emailid`?uid=
# `uniqueid``: An email address (plus unique identifier) representing a user
# that has been recently deleted. For example, `alice@example.com?uid=
# 123456789012345678901`. If the user is recovered, this value reverts to `user:`
# emailid`` and the recovered user retains the role in the binding. * `deleted:
# serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus unique
# identifier) representing a service account that has been recently deleted. For
# example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to `serviceAccount:`
# emailid`` and the undeleted service account retains the role in the binding. *
# `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique
# identifier) representing a Google group that has been recently deleted. For
# example, `admins@example.com?uid=123456789012345678901`. If the group is
# recovered, this value reverts to `group:`emailid`` and the recovered group
# retains the role in the binding. * `domain:`domain``: The G Suite domain (
# primary) that represents all the users of that domain. For example, `google.
# com` or `example.com`.
# Corresponds to the JSON property `members`
# @return [Array<String>]
attr_accessor :members
# Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
# Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`
# , or `roles/owner`.
# Corresponds to the JSON property `role`
# @return [String]
attr_accessor :role
@ -253,13 +196,11 @@ module Google
end
end
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
@ -272,52 +213,43 @@ module Google
end
end
# Represents a textual expression in the Common Expression Language (CEL)
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
# Example (Comparison):
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() < 100"
# Example (Equality):
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
# Example (Logic):
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' && document.type != 'internal'"
# Example (Data Manipulation):
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
# Represents a textual expression in the Common Expression Language (CEL) syntax.
# CEL is a C-like expression language. The syntax and semantics of CEL are
# documented at https://github.com/google/cel-spec. Example (Comparison): title:
# "Summary size limit" description: "Determines if a summary is less than 100
# chars" expression: "document.summary.size() < 100" Example (Equality): title: "
# Requestor is owner" description: "Determines if requestor is the document
# owner" expression: "document.owner == request.auth.claims.email" Example (
# Logic): title: "Public documents" description: "Determine whether the document
# should be publicly visible" expression: "document.type != 'private' &&
# document.type != 'internal'" Example (Data Manipulation): title: "Notification
# string" description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)" The
# exact variables and functions that may be referenced within an expression are
# determined by the service that evaluates it. See the service documentation for
# additional information.
class Expr
include Google::Apis::Core::Hashable
# Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
# Optional. Description of the expression. This is a longer text which describes
# the expression, e.g. when hovered over it in a UI.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Textual representation of an expression in Common Expression Language
# syntax.
# Textual representation of an expression in Common Expression Language syntax.
# Corresponds to the JSON property `expression`
# @return [String]
attr_accessor :expression
# Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
# Optional. String indicating the location of the expression for error reporting,
# e.g. a file name and a position in the file.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
# Optional. Title for the expression, i.e. a short string describing its purpose.
# This can be used e.g. in UIs which allow to enter the expression.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
@ -336,7 +268,6 @@ module Google
end
# Represents a Data Fusion instance.
# Next available ID: 23
class Instance
include Google::Apis::Core::Hashable
@ -390,44 +321,49 @@ module Google
attr_accessor :gcs_bucket
# The resource labels for instance to use to annotate any related underlying
# resources such as GCE VMs. The character '=' is not allowed to be used
# within the labels.
# resources such as GCE VMs. The character '=' is not allowed to be used within
# the labels.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# Output only. The name of this instance is in the form of
# projects/`project`/locations/`location`/instances/`instance`.
# Output only. The name of this instance is in the form of projects/`project`/
# locations/`location`/instances/`instance`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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.
# 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.
# Corresponds to the JSON property `networkConfig`
# @return [Google::Apis::DatafusionV1::NetworkConfig]
attr_accessor :network_config
# Map of additional options used to configure the behavior of
# Data Fusion instance.
# Map of additional options used to configure the behavior of Data Fusion
# instance.
# Corresponds to the JSON property `options`
# @return [Hash<String,String>]
attr_accessor :options
# 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.
# Output only. P4 service account for the customer project.
# Corresponds to the JSON property `p4ServiceAccount`
# @return [String]
attr_accessor :p4_service_account
# 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.
# Corresponds to the JSON property `privateInstance`
# @return [Boolean]
attr_accessor :private_instance
alias_method :private_instance?, :private_instance
# Output only. Service account which will be used to access resources in
# the customer project."
# Output only. Deprecated. Use tenant_project_id instead to extract the tenant
# project ID.
# Corresponds to the JSON property `serviceAccount`
# @return [String]
attr_accessor :service_account
@ -448,6 +384,11 @@ module Google
# @return [String]
attr_accessor :state_message
# Output only. The name of the tenant project.
# Corresponds to the JSON property `tenantProjectId`
# @return [String]
attr_accessor :tenant_project_id
# Required. Instance type.
# Corresponds to the JSON property `type`
# @return [String]
@ -488,11 +429,13 @@ module Google
@name = args[:name] if args.key?(:name)
@network_config = args[:network_config] if args.key?(:network_config)
@options = args[:options] if args.key?(:options)
@p4_service_account = args[:p4_service_account] if args.key?(:p4_service_account)
@private_instance = args[:private_instance] if args.key?(:private_instance)
@service_account = args[:service_account] if args.key?(:service_account)
@service_endpoint = args[:service_endpoint] if args.key?(:service_endpoint)
@state = args[:state] if args.key?(:state)
@state_message = args[:state_message] if args.key?(:state_message)
@tenant_project_id = args[:tenant_project_id] if args.key?(:tenant_project_id)
@type = args[:type] if args.key?(:type)
@update_time = args[:update_time] if args.key?(:update_time)
@version = args[:version] if args.key?(:version)
@ -612,14 +555,14 @@ module Google
class Location
include Google::Apis::Core::Hashable
# The friendly name for this location, typically a nearby city name.
# For example, "Tokyo".
# The friendly name for this location, typically a nearby city name. For example,
# "Tokyo".
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Cross-service attributes for the location. For example
# `"cloud.googleapis.com/region": "us-east1"`
# Cross-service attributes for the location. For example `"cloud.googleapis.com/
# region": "us-east1"`
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
@ -635,8 +578,8 @@ module Google
# @return [Hash<String,Object>]
attr_accessor :metadata
# Resource name for the location, which may vary between implementations.
# For example: `"projects/example-project/locations/us-east1"`
# Resource name for the location, which may vary between implementations. For
# example: `"projects/example-project/locations/us-east1"`
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -655,26 +598,26 @@ module Google
end
end
# 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.
# 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.
class NetworkConfig
include Google::Apis::Core::Hashable
# The IP range in CIDR notation to use for the managed Data Fusion instance
# nodes. This range must not overlap with any other ranges used in the
# customer network.
# nodes. This range must not overlap with any other ranges used in the customer
# network.
# Corresponds to the JSON property `ipAllocation`
# @return [String]
attr_accessor :ip_allocation
# Name of the network in the customer project with which the Tenant Project
# will be peered for executing pipelines. In case of shared VPC where the
# network resides in another host project the network should specified in
# the form of projects/`host-project-id`/global/networks/`network`
# Name of the network in the customer project with which the Tenant Project will
# be peered for executing pipelines. In case of shared VPC where the network
# resides in another host project the network should specified in the form of
# projects/`host-project-id`/global/networks/`network`
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
@ -695,47 +638,45 @@ module Google
class Operation
include Google::Apis::Core::Hashable
# 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.
# 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.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# 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).
# 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).
# Corresponds to the JSON property `error`
# @return [Google::Apis::DatafusionV1::Status]
attr_accessor :error
# 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.
# 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.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
# 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``.
# originally returns it. If you use the default HTTP mapping, the `name` should
# be a resource name ending with `operations/`unique_id``.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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`.
# 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`.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
@ -773,10 +714,9 @@ module Google
# @return [String]
attr_accessor :end_time
# 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`.
# 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`.
# Corresponds to the JSON property `requestedCancellation`
# @return [Boolean]
attr_accessor :requested_cancellation
@ -814,66 +754,32 @@ module Google
end
# 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` to a single `role`. Members 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/).
# controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
# A `binding` binds one or more `members` to a single `role`. Members 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/).
class Policy
include Google::Apis::Core::Hashable
@ -882,48 +788,44 @@ module Google
# @return [Array<Google::Apis::DatafusionV1::AuditConfig>]
attr_accessor :audit_configs
# Associates a list of `members` to 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 member.
# Associates a list of `members` to 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 member.
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::DatafusionV1::Binding>]
attr_accessor :bindings
# `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.
# `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.
# Corresponds to the JSON property `etag`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :etag
# 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).
# 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).
# Corresponds to the JSON property `version`
# @return [Fixnum]
attr_accessor :version
@ -959,74 +861,39 @@ module Google
include Google::Apis::Core::Hashable
# 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` to a single `role`. Members 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/).
# controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
# A `binding` binds one or more `members` to a single `role`. Members 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/).
# Corresponds to the JSON property `policy`
# @return [Google::Apis::DatafusionV1::Policy]
attr_accessor :policy
# OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
# the fields in the mask will be modified. If no mask is provided, the
# following default mask is used:
# `paths: "bindings, etag"`
# the fields in the mask will be modified. If no mask is provided, the following
# default mask is used: `paths: "bindings, etag"`
# Corresponds to the JSON property `updateMask`
# @return [String]
attr_accessor :update_mask
@ -1042,12 +909,12 @@ module Google
end
end
# 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).
# 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).
class Status
include Google::Apis::Core::Hashable
@ -1056,15 +923,15 @@ module Google
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# A developer-facing error message, which should be in English. Any user-facing
# error message should be localized and sent in the google.rpc.Status.details
# field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
@ -1085,10 +952,9 @@ module Google
class TestIamPermissionsRequest
include Google::Apis::Core::Hashable
# The set of permissions to check for the `resource`. Permissions with
# wildcards (such as '*' or 'storage.*') are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
# The set of permissions to check for the `resource`. Permissions with wildcards
# (such as '*' or 'storage.*') are not allowed. For more information see [IAM
# Overview](https://cloud.google.com/iam/docs/overview#permissions).
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
@ -1107,8 +973,7 @@ module Google
class TestIamPermissionsResponse
include Google::Apis::Core::Hashable
# A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
# A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
@ -1128,6 +993,11 @@ module Google
class Version
include Google::Apis::Core::Hashable
# Represents a list of available feature names for a given version.
# Corresponds to the JSON property `availableFeatures`
# @return [Array<String>]
attr_accessor :available_features
# Whether this is currently the default version for Cloud Data Fusion
# Corresponds to the JSON property `defaultVersion`
# @return [Boolean]
@ -1145,6 +1015,7 @@ module Google
# Update properties of this object
def update!(**args)
@available_features = args[:available_features] if args.key?(:available_features)
@default_version = args[:default_version] if args.key?(:default_version)
@version_number = args[:version_number] if args.key?(:version_number)
end

View File

@ -235,11 +235,13 @@ module Google
property :network_config, as: 'networkConfig', class: Google::Apis::DatafusionV1::NetworkConfig, decorator: Google::Apis::DatafusionV1::NetworkConfig::Representation
hash :options, as: 'options'
property :p4_service_account, as: 'p4ServiceAccount'
property :private_instance, as: 'privateInstance'
property :service_account, as: 'serviceAccount'
property :service_endpoint, as: 'serviceEndpoint'
property :state, as: 'state'
property :state_message, as: 'stateMessage'
property :tenant_project_id, as: 'tenantProjectId'
property :type, as: 'type'
property :update_time, as: 'updateTime'
property :version, as: 'version'
@ -381,6 +383,7 @@ module Google
class Version
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :available_features, as: 'availableFeatures'
property :default_version, as: 'defaultVersion'
property :version_number, as: 'versionNumber'
end

View File

@ -23,13 +23,10 @@ module Google
# Cloud Data Fusion API
#
# Cloud 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,
# 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.
#
@ -92,8 +89,7 @@ module Google
# @param [String] filter
# The standard list filter.
# @param [Boolean] include_unrevealed_locations
# If true, the returned list will include locations which are not yet
# revealed.
# If true, the returned list will include locations which are not yet revealed.
# @param [Fixnum] page_size
# The standard list page size.
# @param [String] page_token
@ -131,8 +127,8 @@ module Google
# Creates a new Data Fusion instance in the specified project and location.
# @param [String] parent
# The instance's project and location in the format
# projects/`project`/locations/`location`.
# The instance's project and location in the format projects/`project`/locations/
# `location`.
# @param [Google::Apis::DatafusionV1::Instance] instance_object
# @param [String] instance_id
# The name of the instance to create.
@ -168,8 +164,8 @@ module Google
# Deletes a single Date Fusion instance.
# @param [String] name
# The instance resource name in the format
# projects/`project`/locations/`location`/instances/`instance`
# The instance resource name in the format projects/`project`/locations/`
# location`/instances/`instance`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -199,8 +195,8 @@ module Google
# Gets details of a single Data Fusion instance.
# @param [String] name
# The instance resource name in the format
# projects/`project`/locations/`location`/instances/`instance`.
# The instance resource name in the format projects/`project`/locations/`
# location`/instances/`instance`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -228,22 +224,19 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets the access control policy for a resource.
# Returns an empty policy if the resource exists and does not have a policy
# set.
# Gets the access control policy for a resource. Returns an empty policy if the
# resource exists and does not have a policy set.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested.
# See the operation documentation for the appropriate value for this field.
# REQUIRED: The resource for which the policy is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Fixnum] options_requested_policy_version
# Optional. The policy format version to be returned.
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.
# Requests for policies with any conditional bindings must specify version 3.
# Policies without any conditional bindings may specify any valid value 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).
# Optional. The policy format version to be returned. Valid values are 0, 1, and
# 3. Requests specifying an invalid value will be rejected. Requests for
# policies with any conditional bindings must specify version 3. Policies
# without any conditional bindings may specify any valid value 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).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -274,19 +267,19 @@ module Google
# Lists Data Fusion instances in the specified project and location.
# @param [String] parent
# The project and location for which to retrieve instance information
# in the format projects/`project`/locations/`location`. If the location is
# specified as '-' (wildcard), then all regions available to the project
# are queried, and the results are aggregated.
# The project and location for which to retrieve instance information in the
# format projects/`project`/locations/`location`. If the location is specified
# as '-' (wildcard), then all regions available to the project are queried, and
# the results are aggregated.
# @param [String] filter
# List filter.
# @param [String] order_by
# Sort results. Supported values are "name", "name desc", or "" (unsorted).
# Sort results. Supported values are "name", "name desc", or "" (unsorted).
# @param [Fixnum] page_size
# The maximum number of items to return.
# @param [String] page_token
# The next_page_token value to use if there are additional
# results to retrieve for this list request.
# The next_page_token value to use if there are additional results to retrieve
# for this list request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -320,15 +313,14 @@ module Google
# Updates a single Data Fusion instance.
# @param [String] name
# Output only. The name of this instance is in the form of
# projects/`project`/locations/`location`/instances/`instance`.
# Output only. The name of this instance is in the form of projects/`project`/
# locations/`location`/instances/`instance`.
# @param [Google::Apis::DatafusionV1::Instance] instance_object
# @param [String] update_mask
# Field mask is used to specify the fields that the update will overwrite
# in an instance resource. The fields specified in the update_mask are
# relative to the resource, not the full request.
# A field will be overwritten if it is in the mask.
# If the user does not provide a mask, all the supported fields (labels,
# Field mask is used to specify the fields that the update will overwrite in an
# instance resource. The fields specified in the update_mask are relative to the
# resource, not the full request. A field will be overwritten if it is in the
# mask. If the user does not provide a mask, all the supported fields (labels,
# options, and version currently) will be overwritten.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -360,8 +352,8 @@ module Google
execute_or_queue_command(command, &block)
end
# Restart a single Data Fusion instance.
# At the end of an operation instance is fully restarted.
# Restart a single Data Fusion instance. At the end of an operation instance is
# fully restarted.
# @param [String] name
# Name of the Data Fusion instance which need to be restarted in the form of
# projects/`project`/locations/`location`/instances/`instance`
@ -396,11 +388,11 @@ module Google
end
# Sets the access control policy on the specified resource. Replaces any
# existing policy.
# Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
# PERMISSION_DENIED` errors.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified.
# See the operation documentation for the appropriate value for this field.
# REQUIRED: The resource for which the policy is being specified. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DatafusionV1::SetIamPolicyRequest] set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -431,15 +423,14 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# See the operation documentation for the appropriate value for this field.
# REQUIRED: The resource for which the policy detail is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DatafusionV1::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -470,15 +461,13 @@ module Google
execute_or_queue_command(command, &block)
end
# 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,
# 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`.
# @param [String] name
# The name of the operation resource to be cancelled.
@ -512,10 +501,10 @@ module Google
execute_or_queue_command(command, &block)
end
# 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`.
# 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`.
# @param [String] name
# The name of the operation resource to be deleted.
# @param [String] fields
@ -545,9 +534,8 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] name
# The name of the operation resource.
# @param [String] fields
@ -577,15 +565,14 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] name
# The name of the operation's parent resource.
# @param [String] filter
@ -624,20 +611,20 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists possible versions for Data Fusion instances in the specified project
# and location.
# Lists possible versions for Data Fusion instances in the specified project and
# location.
# @param [String] parent
# Required. The project and location for which to retrieve instance information
# in the format projects/`project`/locations/`location`.
# @param [Boolean] latest_patch_only
# Whether or not to return the latest patch of every available minor version.
# If true, only the latest patch will be returned. Ex. if allowed versions is
# [6.1.1, 6.1.2, 6.2.0] then response will be [6.1.2, 6.2.0]
# Whether or not to return the latest patch of every available minor version. If
# true, only the latest patch will be returned. Ex. if allowed versions is [6.1.
# 1, 6.1.2, 6.2.0] then response will be [6.1.2, 6.2.0]
# @param [Fixnum] page_size
# The maximum number of items to return.
# @param [String] page_token
# The next_page_token value to use if there are additional
# results to retrieve for this list request.
# The next_page_token value to use if there are additional results to retrieve
# for this list request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user

View File

@ -21,20 +21,17 @@ module Google
# Cloud Data Fusion API
#
# Cloud 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,
# 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.
#
# @see https://cloud.google.com/data-fusion/docs
module DatafusionV1beta1
VERSION = 'V1beta1'
REVISION = '20200609'
REVISION = '20200803'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -41,53 +41,21 @@ module Google
end
end
# Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
# Example Policy with multiple AuditConfigs:
# `
# "audit_configs": [
# `
# "service": "allServices",
# "audit_log_configs": [
# `
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# `,
# `
# "log_type": "DATA_WRITE"
# `,
# `
# "log_type": "ADMIN_READ"
# `
# ]
# `,
# `
# "service": "sampleservice.googleapis.com",
# "audit_log_configs": [
# `
# "log_type": "DATA_READ"
# `,
# `
# "log_type": "DATA_WRITE",
# "exempted_members": [
# "user:aliya@example.com"
# ]
# `
# ]
# `
# ]
# `
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts jose@example.com from DATA_READ logging, and
# aliya@example.com from DATA_WRITE logging.
# Specifies the audit configuration for a service. The configuration determines
# which permission types are logged, and what identities, if any, are exempted
# from logging. An AuditConfig must have one or more AuditLogConfigs. If there
# are AuditConfigs for both `allServices` and a specific service, the union of
# the two AuditConfigs is used for that service: the log_types specified in each
# AuditConfig are enabled, and the exempted_members in each AuditLogConfig are
# exempted. Example Policy with multiple AuditConfigs: ` "audit_configs": [ ` "
# service": "allServices", "audit_log_configs": [ ` "log_type": "DATA_READ", "
# exempted_members": [ "user:jose@example.com" ] `, ` "log_type": "DATA_WRITE" `,
# ` "log_type": "ADMIN_READ" ` ] `, ` "service": "sampleservice.googleapis.com",
# "audit_log_configs": [ ` "log_type": "DATA_READ" `, ` "log_type": "DATA_WRITE"
# , "exempted_members": [ "user:aliya@example.com" ] ` ] ` ] ` For sampleservice,
# this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also
# exempts jose@example.com from DATA_READ logging, and aliya@example.com from
# DATA_WRITE logging.
class AuditConfig
include Google::Apis::Core::Hashable
@ -96,9 +64,9 @@ module Google
# @return [Array<Google::Apis::DatafusionV1beta1::AuditLogConfig>]
attr_accessor :audit_log_configs
# Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
# Specifies a service that will be enabled for audit logging. For example, `
# storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special
# value that covers all services.
# Corresponds to the JSON property `service`
# @return [String]
attr_accessor :service
@ -114,28 +82,15 @@ module Google
end
end
# Provides the configuration for logging a type of permissions.
# Example:
# `
# "audit_log_configs": [
# `
# "log_type": "DATA_READ",
# "exempted_members": [
# "user:jose@example.com"
# ]
# `,
# `
# "log_type": "DATA_WRITE"
# `
# ]
# `
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
# Provides the configuration for logging a type of permissions. Example: ` "
# audit_log_configs": [ ` "log_type": "DATA_READ", "exempted_members": [ "user:
# jose@example.com" ] `, ` "log_type": "DATA_WRITE" ` ] ` This enables '
# DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from
# DATA_READ logging.
class AuditLogConfig
include Google::Apis::Core::Hashable
# Specifies the identities that do not cause logging for this type of
# permission.
# Specifies the identities that do not cause logging for this type of permission.
# Follows the same format of Binding.members.
# Corresponds to the JSON property `exemptedMembers`
# @return [Array<String>]
@ -161,69 +116,57 @@ module Google
class Binding
include Google::Apis::Core::Hashable
# Represents a textual expression in the Common Expression Language (CEL)
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
# Example (Comparison):
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() < 100"
# Example (Equality):
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
# Example (Logic):
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' && document.type != 'internal'"
# Example (Data Manipulation):
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
# Represents a textual expression in the Common Expression Language (CEL) syntax.
# CEL is a C-like expression language. The syntax and semantics of CEL are
# documented at https://github.com/google/cel-spec. Example (Comparison): title:
# "Summary size limit" description: "Determines if a summary is less than 100
# chars" expression: "document.summary.size() < 100" Example (Equality): title: "
# Requestor is owner" description: "Determines if requestor is the document
# owner" expression: "document.owner == request.auth.claims.email" Example (
# Logic): title: "Public documents" description: "Determine whether the document
# should be publicly visible" expression: "document.type != 'private' &&
# document.type != 'internal'" Example (Data Manipulation): title: "Notification
# string" description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)" The
# exact variables and functions that may be referenced within an expression are
# determined by the service that evaluates it. See the service documentation for
# additional information.
# Corresponds to the JSON property `condition`
# @return [Google::Apis::DatafusionV1beta1::Expr]
attr_accessor :condition
# Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
# * `user:`emailid``: An email address that represents a specific Google
# account. For example, `alice@example.com` .
# * `serviceAccount:`emailid``: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
# * `group:`emailid``: An email address that represents a Google group.
# For example, `admins@example.com`.
# * `deleted:user:`emailid`?uid=`uniqueid``: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?uid=123456789012345678901`. If the user is
# recovered, this value reverts to `user:`emailid`` and the recovered user
# retains the role in the binding.
# * `deleted:serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example,
# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to
# `serviceAccount:`emailid`` and the undeleted service account retains the
# role in the binding.
# * `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique
# identifier) representing a Google group that has been recently
# deleted. For example, `admins@example.com?uid=123456789012345678901`. If
# the group is recovered, this value reverts to `group:`emailid`` and the
# recovered group retains the role in the binding.
# * `domain:`domain``: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
# Specifies the identities requesting access for a Cloud Platform resource. `
# members` can have the following values: * `allUsers`: A special identifier
# that represents anyone who is on the internet; with or without a Google
# account. * `allAuthenticatedUsers`: A special identifier that represents
# anyone who is authenticated with a Google account or a service account. * `
# user:`emailid``: An email address that represents a specific Google account.
# For example, `alice@example.com` . * `serviceAccount:`emailid``: An email
# address that represents a service account. For example, `my-other-app@appspot.
# gserviceaccount.com`. * `group:`emailid``: An email address that represents a
# Google group. For example, `admins@example.com`. * `deleted:user:`emailid`?uid=
# `uniqueid``: An email address (plus unique identifier) representing a user
# that has been recently deleted. For example, `alice@example.com?uid=
# 123456789012345678901`. If the user is recovered, this value reverts to `user:`
# emailid`` and the recovered user retains the role in the binding. * `deleted:
# serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus unique
# identifier) representing a service account that has been recently deleted. For
# example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to `serviceAccount:`
# emailid`` and the undeleted service account retains the role in the binding. *
# `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique
# identifier) representing a Google group that has been recently deleted. For
# example, `admins@example.com?uid=123456789012345678901`. If the group is
# recovered, this value reverts to `group:`emailid`` and the recovered group
# retains the role in the binding. * `domain:`domain``: The G Suite domain (
# primary) that represents all the users of that domain. For example, `google.
# com` or `example.com`.
# Corresponds to the JSON property `members`
# @return [Array<String>]
attr_accessor :members
# Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
# Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`
# , or `roles/owner`.
# Corresponds to the JSON property `role`
# @return [String]
attr_accessor :role
@ -253,13 +196,11 @@ module Google
end
end
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
@ -272,52 +213,43 @@ module Google
end
end
# Represents a textual expression in the Common Expression Language (CEL)
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
# Example (Comparison):
# title: "Summary size limit"
# description: "Determines if a summary is less than 100 chars"
# expression: "document.summary.size() < 100"
# Example (Equality):
# title: "Requestor is owner"
# description: "Determines if requestor is the document owner"
# expression: "document.owner == request.auth.claims.email"
# Example (Logic):
# title: "Public documents"
# description: "Determine whether the document should be publicly visible"
# expression: "document.type != 'private' && document.type != 'internal'"
# Example (Data Manipulation):
# title: "Notification string"
# description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)"
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
# Represents a textual expression in the Common Expression Language (CEL) syntax.
# CEL is a C-like expression language. The syntax and semantics of CEL are
# documented at https://github.com/google/cel-spec. Example (Comparison): title:
# "Summary size limit" description: "Determines if a summary is less than 100
# chars" expression: "document.summary.size() < 100" Example (Equality): title: "
# Requestor is owner" description: "Determines if requestor is the document
# owner" expression: "document.owner == request.auth.claims.email" Example (
# Logic): title: "Public documents" description: "Determine whether the document
# should be publicly visible" expression: "document.type != 'private' &&
# document.type != 'internal'" Example (Data Manipulation): title: "Notification
# string" description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)" The
# exact variables and functions that may be referenced within an expression are
# determined by the service that evaluates it. See the service documentation for
# additional information.
class Expr
include Google::Apis::Core::Hashable
# Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
# Optional. Description of the expression. This is a longer text which describes
# the expression, e.g. when hovered over it in a UI.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Textual representation of an expression in Common Expression Language
# syntax.
# Textual representation of an expression in Common Expression Language syntax.
# Corresponds to the JSON property `expression`
# @return [String]
attr_accessor :expression
# Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
# Optional. String indicating the location of the expression for error reporting,
# e.g. a file name and a position in the file.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
# Optional. Title for the expression, i.e. a short string describing its purpose.
# This can be used e.g. in UIs which allow to enter the expression.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
@ -336,7 +268,6 @@ module Google
end
# Represents a Data Fusion instance.
# Next available ID: 23
class Instance
include Google::Apis::Core::Hashable
@ -390,44 +321,49 @@ module Google
attr_accessor :gcs_bucket
# 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.
# resources such as Compute Engine VMs. The character '=' is not allowed to be
# used within the labels.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# Output only. The name of this instance is in the form of
# projects/`project`/locations/`location`/instances/`instance`.
# Output only. The name of this instance is in the form of projects/`project`/
# locations/`location`/instances/`instance`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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.
# 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.
# Corresponds to the JSON property `networkConfig`
# @return [Google::Apis::DatafusionV1beta1::NetworkConfig]
attr_accessor :network_config
# Map of additional options used to configure the behavior of
# Data Fusion instance.
# Map of additional options used to configure the behavior of Data Fusion
# instance.
# Corresponds to the JSON property `options`
# @return [Hash<String,String>]
attr_accessor :options
# 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.
# Output only. P4 service account for the customer project.
# Corresponds to the JSON property `p4ServiceAccount`
# @return [String]
attr_accessor :p4_service_account
# 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.
# Corresponds to the JSON property `privateInstance`
# @return [Boolean]
attr_accessor :private_instance
alias_method :private_instance?, :private_instance
# Output only. Service account which will be used to access resources in
# the customer project."
# Output only. Deprecated. Use tenant_project_id instead to extract the tenant
# project ID.
# Corresponds to the JSON property `serviceAccount`
# @return [String]
attr_accessor :service_account
@ -448,6 +384,11 @@ module Google
# @return [String]
attr_accessor :state_message
# Output only. The name of the tenant project.
# Corresponds to the JSON property `tenantProjectId`
# @return [String]
attr_accessor :tenant_project_id
# Required. Instance type.
# Corresponds to the JSON property `type`
# @return [String]
@ -487,11 +428,13 @@ module Google
@name = args[:name] if args.key?(:name)
@network_config = args[:network_config] if args.key?(:network_config)
@options = args[:options] if args.key?(:options)
@p4_service_account = args[:p4_service_account] if args.key?(:p4_service_account)
@private_instance = args[:private_instance] if args.key?(:private_instance)
@service_account = args[:service_account] if args.key?(:service_account)
@service_endpoint = args[:service_endpoint] if args.key?(:service_endpoint)
@state = args[:state] if args.key?(:state)
@state_message = args[:state_message] if args.key?(:state_message)
@tenant_project_id = args[:tenant_project_id] if args.key?(:tenant_project_id)
@type = args[:type] if args.key?(:type)
@update_time = args[:update_time] if args.key?(:update_time)
@version = args[:version] if args.key?(:version)
@ -611,14 +554,14 @@ module Google
class Location
include Google::Apis::Core::Hashable
# The friendly name for this location, typically a nearby city name.
# For example, "Tokyo".
# The friendly name for this location, typically a nearby city name. For example,
# "Tokyo".
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Cross-service attributes for the location. For example
# `"cloud.googleapis.com/region": "us-east1"`
# Cross-service attributes for the location. For example `"cloud.googleapis.com/
# region": "us-east1"`
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
@ -634,8 +577,8 @@ module Google
# @return [Hash<String,Object>]
attr_accessor :metadata
# Resource name for the location, which may vary between implementations.
# For example: `"projects/example-project/locations/us-east1"`
# Resource name for the location, which may vary between implementations. For
# example: `"projects/example-project/locations/us-east1"`
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -654,12 +597,12 @@ module Google
end
end
# 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.
# 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.
class NetworkConfig
include Google::Apis::Core::Hashable
@ -670,10 +613,10 @@ module Google
# @return [String]
attr_accessor :ip_allocation
# Name of the network in the customer project with which the Tenant Project
# will be peered for executing pipelines. In case of shared VPC where the
# network resides in another host project the network should specified in
# the form of projects/`host-project-id`/global/networks/`network`
# Name of the network in the customer project with which the Tenant Project will
# be peered for executing pipelines. In case of shared VPC where the network
# resides in another host project the network should specified in the form of
# projects/`host-project-id`/global/networks/`network`
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
@ -694,47 +637,45 @@ module Google
class Operation
include Google::Apis::Core::Hashable
# 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.
# 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.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# 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).
# 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).
# Corresponds to the JSON property `error`
# @return [Google::Apis::DatafusionV1beta1::Status]
attr_accessor :error
# 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.
# 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.
# Corresponds to the JSON property `metadata`
# @return [Hash<String,Object>]
attr_accessor :metadata
# 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``.
# originally returns it. If you use the default HTTP mapping, the `name` should
# be a resource name ending with `operations/`unique_id``.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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`.
# 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`.
# Corresponds to the JSON property `response`
# @return [Hash<String,Object>]
attr_accessor :response
@ -772,10 +713,9 @@ module Google
# @return [String]
attr_accessor :end_time
# 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`.
# 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`.
# Corresponds to the JSON property `requestedCancellation`
# @return [Boolean]
attr_accessor :requested_cancellation
@ -813,66 +753,32 @@ module Google
end
# 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` to a single `role`. Members 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/).
# controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
# A `binding` binds one or more `members` to a single `role`. Members 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/).
class Policy
include Google::Apis::Core::Hashable
@ -881,48 +787,44 @@ module Google
# @return [Array<Google::Apis::DatafusionV1beta1::AuditConfig>]
attr_accessor :audit_configs
# Associates a list of `members` to 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 member.
# Associates a list of `members` to 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 member.
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::DatafusionV1beta1::Binding>]
attr_accessor :bindings
# `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.
# `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.
# Corresponds to the JSON property `etag`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :etag
# 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).
# 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).
# Corresponds to the JSON property `version`
# @return [Fixnum]
attr_accessor :version
@ -958,74 +860,39 @@ module Google
include Google::Apis::Core::Hashable
# 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` to a single `role`. Members 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/).
# controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
# A `binding` binds one or more `members` to a single `role`. Members 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/).
# Corresponds to the JSON property `policy`
# @return [Google::Apis::DatafusionV1beta1::Policy]
attr_accessor :policy
# OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
# the fields in the mask will be modified. If no mask is provided, the
# following default mask is used:
# `paths: "bindings, etag"`
# the fields in the mask will be modified. If no mask is provided, the following
# default mask is used: `paths: "bindings, etag"`
# Corresponds to the JSON property `updateMask`
# @return [String]
attr_accessor :update_mask
@ -1041,12 +908,12 @@ module Google
end
end
# 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).
# 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).
class Status
include Google::Apis::Core::Hashable
@ -1055,15 +922,15 @@ module Google
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# A developer-facing error message, which should be in English. Any user-facing
# error message should be localized and sent in the google.rpc.Status.details
# field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
@ -1084,10 +951,9 @@ module Google
class TestIamPermissionsRequest
include Google::Apis::Core::Hashable
# The set of permissions to check for the `resource`. Permissions with
# wildcards (such as '*' or 'storage.*') are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
# The set of permissions to check for the `resource`. Permissions with wildcards
# (such as '*' or 'storage.*') are not allowed. For more information see [IAM
# Overview](https://cloud.google.com/iam/docs/overview#permissions).
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
@ -1106,8 +972,7 @@ module Google
class TestIamPermissionsResponse
include Google::Apis::Core::Hashable
# A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
# A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
@ -1122,8 +987,8 @@ module Google
end
end
# Request message for upgrading a Data Fusion instance.
# To change the instance properties, instance update should be used.
# Request message for upgrading a Data Fusion instance. To change the instance
# properties, instance update should be used.
class UpgradeInstanceRequest
include Google::Apis::Core::Hashable
@ -1140,6 +1005,11 @@ module Google
class Version
include Google::Apis::Core::Hashable
# Represents a list of available feature names for a given version.
# Corresponds to the JSON property `availableFeatures`
# @return [Array<String>]
attr_accessor :available_features
# Whether this is currently the default version for Cloud Data Fusion
# Corresponds to the JSON property `defaultVersion`
# @return [Boolean]
@ -1157,6 +1027,7 @@ module Google
# Update properties of this object
def update!(**args)
@available_features = args[:available_features] if args.key?(:available_features)
@default_version = args[:default_version] if args.key?(:default_version)
@version_number = args[:version_number] if args.key?(:version_number)
end

View File

@ -241,11 +241,13 @@ module Google
property :network_config, as: 'networkConfig', class: Google::Apis::DatafusionV1beta1::NetworkConfig, decorator: Google::Apis::DatafusionV1beta1::NetworkConfig::Representation
hash :options, as: 'options'
property :p4_service_account, as: 'p4ServiceAccount'
property :private_instance, as: 'privateInstance'
property :service_account, as: 'serviceAccount'
property :service_endpoint, as: 'serviceEndpoint'
property :state, as: 'state'
property :state_message, as: 'stateMessage'
property :tenant_project_id, as: 'tenantProjectId'
property :type, as: 'type'
property :update_time, as: 'updateTime'
property :version, as: 'version'
@ -393,6 +395,7 @@ module Google
class Version
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :available_features, as: 'availableFeatures'
property :default_version, as: 'defaultVersion'
property :version_number, as: 'versionNumber'
end

View File

@ -23,13 +23,10 @@ module Google
# Cloud Data Fusion API
#
# Cloud 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,
# 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.
#
@ -92,8 +89,7 @@ module Google
# @param [String] filter
# The standard list filter.
# @param [Boolean] include_unrevealed_locations
# If true, the returned list will include locations which are not yet
# revealed.
# If true, the returned list will include locations which are not yet revealed.
# @param [Fixnum] page_size
# The standard list page size.
# @param [String] page_token
@ -131,8 +127,8 @@ module Google
# Creates a new Data Fusion instance in the specified project and location.
# @param [String] parent
# The instance's project and location in the format
# projects/`project`/locations/`location`.
# The instance's project and location in the format projects/`project`/locations/
# `location`.
# @param [Google::Apis::DatafusionV1beta1::Instance] instance_object
# @param [String] instance_id
# The name of the instance to create.
@ -168,8 +164,8 @@ module Google
# Deletes a single Date Fusion instance.
# @param [String] name
# The instance resource name in the format
# projects/`project`/locations/`location`/instances/`instance`
# The instance resource name in the format projects/`project`/locations/`
# location`/instances/`instance`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -199,8 +195,8 @@ module Google
# Gets details of a single Data Fusion instance.
# @param [String] name
# The instance resource name in the format
# projects/`project`/locations/`location`/instances/`instance`.
# The instance resource name in the format projects/`project`/locations/`
# location`/instances/`instance`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -228,22 +224,19 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets the access control policy for a resource.
# Returns an empty policy if the resource exists and does not have a policy
# set.
# Gets the access control policy for a resource. Returns an empty policy if the
# resource exists and does not have a policy set.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested.
# See the operation documentation for the appropriate value for this field.
# REQUIRED: The resource for which the policy is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Fixnum] options_requested_policy_version
# Optional. The policy format version to be returned.
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.
# Requests for policies with any conditional bindings must specify version 3.
# Policies without any conditional bindings may specify any valid value 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).
# Optional. The policy format version to be returned. Valid values are 0, 1, and
# 3. Requests specifying an invalid value will be rejected. Requests for
# policies with any conditional bindings must specify version 3. Policies
# without any conditional bindings may specify any valid value 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).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -274,19 +267,19 @@ module Google
# Lists Data Fusion instances in the specified project and location.
# @param [String] parent
# The project and location for which to retrieve instance information
# in the format projects/`project`/locations/`location`. If the location is
# specified as '-' (wildcard), then all regions available to the project
# are queried, and the results are aggregated.
# The project and location for which to retrieve instance information in the
# format projects/`project`/locations/`location`. If the location is specified
# as '-' (wildcard), then all regions available to the project are queried, and
# the results are aggregated.
# @param [String] filter
# List filter.
# @param [String] order_by
# Sort results. Supported values are "name", "name desc", or "" (unsorted).
# Sort results. Supported values are "name", "name desc", or "" (unsorted).
# @param [Fixnum] page_size
# The maximum number of items to return.
# @param [String] page_token
# The next_page_token value to use if there are additional
# results to retrieve for this list request.
# The next_page_token value to use if there are additional results to retrieve
# for this list request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -320,16 +313,15 @@ module Google
# Updates a single Data Fusion instance.
# @param [String] name
# Output only. The name of this instance is in the form of
# projects/`project`/locations/`location`/instances/`instance`.
# Output only. The name of this instance is in the form of projects/`project`/
# locations/`location`/instances/`instance`.
# @param [Google::Apis::DatafusionV1beta1::Instance] instance_object
# @param [String] update_mask
# Field mask is used to specify the fields that the update will overwrite
# in an instance resource. The fields specified in the update_mask are
# relative to the resource, not the full request.
# A field will be overwritten if it is in the mask.
# If the user does not provide a mask, all the supported fields (labels and
# options currently) will be overwritten.
# Field mask is used to specify the fields that the update will overwrite in an
# instance resource. The fields specified in the update_mask are relative to the
# resource, not the full request. A field will be overwritten if it is in the
# mask. If the user does not provide a mask, all the supported fields (labels
# and options currently) will be overwritten.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -360,8 +352,8 @@ module Google
execute_or_queue_command(command, &block)
end
# Restart a single Data Fusion instance.
# At the end of an operation instance is fully restarted.
# Restart a single Data Fusion instance. At the end of an operation instance is
# fully restarted.
# @param [String] name
# Name of the Data Fusion instance which need to be restarted in the form of
# projects/`project`/locations/`location`/instances/`instance`
@ -396,11 +388,11 @@ module Google
end
# Sets the access control policy on the specified resource. Replaces any
# existing policy.
# Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
# PERMISSION_DENIED` errors.
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified.
# See the operation documentation for the appropriate value for this field.
# REQUIRED: The resource for which the policy is being specified. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DatafusionV1beta1::SetIamPolicyRequest] set_iam_policy_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -431,15 +423,14 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# See the operation documentation for the appropriate value for this field.
# REQUIRED: The resource for which the policy detail is being requested. See the
# operation documentation for the appropriate value for this field.
# @param [Google::Apis::DatafusionV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -470,13 +461,12 @@ module Google
execute_or_queue_command(command, &block)
end
# Upgrade a single Data Fusion instance.
# At the end of an operation instance is fully upgraded.
# Upgrade a single Data Fusion instance. At the end of an operation instance is
# fully upgraded.
# @param [String] name
# Name of the Data Fusion instance which need to be upgraded in the form of
# projects/`project`/locations/`location`/instances/`instance`
# Instance will be upgraded with the latest stable version of the Data
# Fusion.
# projects/`project`/locations/`location`/instances/`instance` Instance will be
# upgraded with the latest stable version of the Data Fusion.
# @param [Google::Apis::DatafusionV1beta1::UpgradeInstanceRequest] upgrade_instance_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -507,15 +497,13 @@ module Google
execute_or_queue_command(command, &block)
end
# 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,
# 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`.
# @param [String] name
# The name of the operation resource to be cancelled.
@ -549,10 +537,10 @@ module Google
execute_or_queue_command(command, &block)
end
# 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`.
# 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`.
# @param [String] name
# The name of the operation resource to be deleted.
# @param [String] fields
@ -582,9 +570,8 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] name
# The name of the operation resource.
# @param [String] fields
@ -614,15 +601,14 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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.
# @param [String] name
# The name of the operation's parent resource.
# @param [String] filter
@ -661,20 +647,20 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists possible versions for Data Fusion instances in the specified project
# and location.
# Lists possible versions for Data Fusion instances in the specified project and
# location.
# @param [String] parent
# Required. The project and location for which to retrieve instance information
# in the format projects/`project`/locations/`location`.
# @param [Boolean] latest_patch_only
# Whether or not to return the latest patch of every available minor version.
# If true, only the latest patch will be returned. Ex. if allowed versions is
# [6.1.1, 6.1.2, 6.2.0] then response will be [6.1.2, 6.2.0]
# Whether or not to return the latest patch of every available minor version. If
# true, only the latest patch will be returned. Ex. if allowed versions is [6.1.
# 1, 6.1.2, 6.2.0] then response will be [6.1.2, 6.2.0]
# @param [Fixnum] page_size
# The maximum number of items to return.
# @param [String] page_token
# The next_page_token value to use if there are additional
# results to retrieve for this list request.
# The next_page_token value to use if there are additional results to retrieve
# for this list request.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/dataproc/
module DataprocV1beta2
VERSION = 'V1beta2'
REVISION = '20200725'
REVISION = '20200731'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -442,6 +442,11 @@ module Google
# @return [Google::Apis::DataprocV1beta2::InstanceGroupConfig]
attr_accessor :master_config
# Specifies the metastore configuration.
# Corresponds to the JSON property `metastoreConfig`
# @return [Google::Apis::DataprocV1beta2::MetastoreConfig]
attr_accessor :metastore_config
# The config settings for Compute Engine resources in an instance group, such as
# a master or worker group.
# Corresponds to the JSON property `secondaryWorkerConfig`
@ -490,6 +495,7 @@ module Google
@initialization_actions = args[:initialization_actions] if args.key?(:initialization_actions)
@lifecycle_config = args[:lifecycle_config] if args.key?(:lifecycle_config)
@master_config = args[:master_config] if args.key?(:master_config)
@metastore_config = args[:metastore_config] if args.key?(:metastore_config)
@secondary_worker_config = args[:secondary_worker_config] if args.key?(:secondary_worker_config)
@security_config = args[:security_config] if args.key?(:security_config)
@software_config = args[:software_config] if args.key?(:software_config)
@ -2111,6 +2117,25 @@ module Google
end
end
# Specifies the metastore configuration.
class MetastoreConfig
include Google::Apis::Core::Hashable
# Optional. Relative resource name of an existing Dataproc Metastore service.
# Corresponds to the JSON property `dataprocMetastoreService`
# @return [String]
attr_accessor :dataproc_metastore_service
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@dataproc_metastore_service = args[:dataproc_metastore_service] if args.key?(:dataproc_metastore_service)
end
end
# A full, namespace-isolated deployment target for an existing GKE cluster.
class NamespacedGkeDeploymentTarget
include Google::Apis::Core::Hashable

View File

@ -304,6 +304,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class MetastoreConfig
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class NamespacedGkeDeploymentTarget
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -599,6 +605,8 @@ module Google
property :master_config, as: 'masterConfig', class: Google::Apis::DataprocV1beta2::InstanceGroupConfig, decorator: Google::Apis::DataprocV1beta2::InstanceGroupConfig::Representation
property :metastore_config, as: 'metastoreConfig', class: Google::Apis::DataprocV1beta2::MetastoreConfig, decorator: Google::Apis::DataprocV1beta2::MetastoreConfig::Representation
property :secondary_worker_config, as: 'secondaryWorkerConfig', class: Google::Apis::DataprocV1beta2::InstanceGroupConfig, decorator: Google::Apis::DataprocV1beta2::InstanceGroupConfig::Representation
property :security_config, as: 'securityConfig', class: Google::Apis::DataprocV1beta2::SecurityConfig, decorator: Google::Apis::DataprocV1beta2::SecurityConfig::Representation
@ -1015,6 +1023,13 @@ module Google
end
end
class MetastoreConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :dataproc_metastore_service, as: 'dataprocMetastoreService'
end
end
class NamespacedGkeDeploymentTarget
# @private
class Representation < Google::Apis::Core::JsonRepresentation

View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/doubleclick-advertisers/
module DfareportingV3_4
VERSION = 'V3_4'
REVISION = '20200722'
REVISION = '20200730'
# Manage DoubleClick Digital Marketing conversions
AUTH_DDMCONVERSIONS = 'https://www.googleapis.com/auth/ddmconversions'

View File

@ -7086,6 +7086,45 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates a report. This method supports patch semantics.
# @param [Fixnum] profile_id
# The DFA user profile ID.
# @param [Fixnum] report_id
# The ID of the report.
# @param [Google::Apis::DfareportingV3_4::Report] report_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DfareportingV3_4::Report] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DfareportingV3_4::Report]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:patch, 'userprofiles/{profileId}/reports/{reportId}', options)
command.request_representation = Google::Apis::DfareportingV3_4::Report::Representation
command.request_object = report_object
command.response_representation = Google::Apis::DfareportingV3_4::Report::Representation
command.response_class = Google::Apis::DfareportingV3_4::Report
command.params['profileId'] = profile_id unless profile_id.nil?
command.params['reportId'] = report_id unless report_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Runs a report.
# @param [Fixnum] profile_id
# The DFA profile ID.

View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/display-video/
module DisplayvideoV1
VERSION = 'V1'
REVISION = '20200728'
REVISION = '20200804'
# Create, see, edit, and permanently delete your Display & Video 360 entities and reports
AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video'

View File

@ -20,12 +20,13 @@ module Google
module Apis
# DoubleClick Bid Manager API
#
# API for viewing and managing your reports in DoubleClick Bid Manager.
# DoubleClick Bid Manager API allows users to manage and create campaigns and
# reports.
#
# @see https://developers.google.com/bid-manager/
module DoubleclickbidmanagerV1
VERSION = 'V1'
REVISION = '20200723'
REVISION = '20200731'
# View and manage your reports in DoubleClick Bid Manager
AUTH_DOUBLECLICKBIDMANAGER = 'https://www.googleapis.com/auth/doubleclickbidmanager'

View File

@ -26,8 +26,8 @@ module Google
class DownloadLineItemsRequest
include Google::Apis::Core::Hashable
# File specification (column names, types, order) in which the line items will
# be returned. Default to EWF.
# File specification (column names, types, order) in which the line items
# will be returned. Default to <code>EWF</code>.
# Corresponds to the JSON property `fileSpec`
# @return [String]
attr_accessor :file_spec
@ -43,7 +43,8 @@ module Google
# @return [String]
attr_accessor :filter_type
# Format in which the line items will be returned. Default to CSV.
# Format in which the line items will be returned. Default to
# <code>CSV</code>.
# Corresponds to the JSON property `format`
# @return [String]
attr_accessor :format
@ -65,8 +66,10 @@ module Google
class DownloadLineItemsResponse
include Google::Apis::Core::Hashable
# Retrieved line items in CSV format. For more information about file formats,
# see Entity Write File Format.
# Retrieved line items in CSV format. For more information about file
# formats, see <a
# href="https://developers.google.com/bid-manager/guides/entity-write/format">
# Entity Write File Format</a>.
# Corresponds to the JSON property `lineItems`
# @return [String]
attr_accessor :line_items
@ -86,21 +89,18 @@ module Google
class DownloadRequest
include Google::Apis::Core::Hashable
# File types that will be returned. If INVENTORY_SOURCE is requested, no other
# file types may be requested.
# Acceptable values are:
# - "AD"
# - "AD_GROUP"
# - "CAMPAIGN"
# - "INSERTION_ORDER"
# - "INVENTORY_SOURCE"
# - "LINE_ITEM"
# File types that will be returned. If INVENTORY_SOURCE is requested, no
# other file types may be requested. <br><br>Acceptable values are: <ul>
# <li>"<code>AD</code>"</li> <li>"<code>AD_GROUP</code>"</li>
# <li>"<code>CAMPAIGN</code>"</li> <li>"<code>INSERTION_ORDER</code>"</li>
# <li>"<code>INVENTORY_SOURCE</code>"</li> <li>"<code>LINE_ITEM</code>"</li>
# </ul>
# Corresponds to the JSON property `fileTypes`
# @return [Array<String>]
attr_accessor :file_types
# The IDs of the specified filter type. This is used to filter entities to fetch.
# At least one ID must be specified.
# The IDs of the specified filter type. This is used to filter entities to
# fetch. At least one ID must be specified.
# Corresponds to the JSON property `filterIds`
# @return [Array<Fixnum>]
attr_accessor :filter_ids
@ -112,7 +112,7 @@ module Google
attr_accessor :filter_type
# SDF Version (column names, types, order) in which the entities will be
# returned. Default to 5.
# returned. Default to <code>5</code>.
# Corresponds to the JSON property `version`
# @return [String]
attr_accessor :version
@ -208,8 +208,8 @@ module Google
class ListQueriesResponse
include Google::Apis::Core::Hashable
# Identifies what kind of resource this is. Value: the fixed string "
# doubleclickbidmanager#listQueriesResponse".
# Identifies what kind of resource this is. Value: the fixed string
# <code>"doubleclickbidmanager#listQueriesResponse"</code>.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
@ -234,8 +234,8 @@ module Google
class ListReportsResponse
include Google::Apis::Core::Hashable
# Identifies what kind of resource this is. Value: the fixed string "
# doubleclickbidmanager#listReportsResponse".
# Identifies what kind of resource this is. Value: the fixed string
# <code>"doubleclickbidmanager#listReportsResponse"</code>.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
@ -304,8 +304,8 @@ module Google
class Query
include Google::Apis::Core::Hashable
# Identifies what kind of resource this is. Value: the fixed string "
# doubleclickbidmanager#query".
# Identifies what kind of resource this is. Value: the fixed string
# <code>"doubleclickbidmanager#query"</code>.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
@ -326,15 +326,17 @@ module Google
attr_accessor :query_id
# The ending time for the data that is shown in the report. Note,
# reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and
# ignored otherwise.
# <code>reportDataEndTimeMs</code> is required if
# <code>metadata.dataRange</code> is <code>CUSTOM_DATES</code> and ignored
# otherwise.
# Corresponds to the JSON property `reportDataEndTimeMs`
# @return [Fixnum]
attr_accessor :report_data_end_time_ms
# The starting time for the data that is shown in the report. Note,
# reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and
# ignored otherwise.
# <code>reportDataStartTimeMs</code> is required if
# <code>metadata.dataRange</code> is <code>CUSTOM_DATES</code> and ignored
# otherwise.
# Corresponds to the JSON property `reportDataStartTimeMs`
# @return [Fixnum]
attr_accessor :report_data_start_time_ms
@ -344,7 +346,8 @@ module Google
# @return [Google::Apis::DoubleclickbidmanagerV1::QuerySchedule]
attr_accessor :schedule
# Canonical timezone code for report data time. Defaults to America/New_York.
# Canonical timezone code for report data time. Defaults to
# <code>America/New_York</code>.
# Corresponds to the JSON property `timezoneCode`
# @return [String]
attr_accessor :timezone_code
@ -396,11 +399,12 @@ module Google
# @return [Fixnum]
attr_accessor :latest_report_run_time_ms
# Locale of the generated reports. Valid values are cs CZECH de GERMAN en
# ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR
# BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-
# TW TAIWAN_CHINESE
# An locale string not in the list above will generate reports in English.
# Locale of the generated reports. Valid values are cs CZECH de
# GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja
# JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru
# RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW
# TAIWAN_CHINESE <br><br> An locale string not in the list above will
# generate reports in English.
# Corresponds to the JSON property `locale`
# @return [String]
attr_accessor :locale
@ -416,14 +420,15 @@ module Google
attr_accessor :running
alias_method :running?, :running
# Whether to send an email notification when a report is ready. Default to false.
# Whether to send an email notification when a report is ready. Default to
# false.
# Corresponds to the JSON property `sendNotification`
# @return [Boolean]
attr_accessor :send_notification
alias_method :send_notification?, :send_notification
# List of email addresses which are sent email notifications when the report is
# finished. Separate from sendNotification.
# List of email addresses which are sent email notifications when the report
# is finished. Separate from <code>sendNotification</code>.
# Corresponds to the JSON property `shareEmailAddress`
# @return [Array<String>]
attr_accessor :share_email_address
@ -473,8 +478,8 @@ module Google
# @return [Fixnum]
attr_accessor :next_run_minute_of_day
# Canonical timezone code for report generation time. Defaults to America/
# New_York.
# Canonical timezone code for report generation time. Defaults to
# <code>America/New_York</code>.
# Corresponds to the JSON property `nextRunTimezoneCode`
# @return [String]
attr_accessor :next_run_timezone_code
@ -571,7 +576,8 @@ module Google
class ReportMetadata
include Google::Apis::Core::Hashable
# The path to the location in Google Cloud Storage where the report is stored.
# The path to the location in Google Cloud Storage where the report is
# stored.
# Corresponds to the JSON property `googleCloudStoragePath`
# @return [String]
attr_accessor :google_cloud_storage_path
@ -702,20 +708,21 @@ module Google
attr_accessor :data_range
# The ending time for the data that is shown in the report. Note,
# reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored
# otherwise.
# <code>reportDataEndTimeMs</code> is required if <code>dataRange</code> is
# <code>CUSTOM_DATES</code> and ignored otherwise.
# Corresponds to the JSON property `reportDataEndTimeMs`
# @return [Fixnum]
attr_accessor :report_data_end_time_ms
# The starting time for the data that is shown in the report. Note,
# reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored
# otherwise.
# <code>reportDataStartTimeMs</code> is required if <code>dataRange</code> is
# <code>CUSTOM_DATES</code> and ignored otherwise.
# Corresponds to the JSON property `reportDataStartTimeMs`
# @return [Fixnum]
attr_accessor :report_data_start_time_ms
# Canonical timezone code for report data time. Defaults to America/New_York.
# Canonical timezone code for report data time. Defaults to
# <code>America/New_York</code>.
# Corresponds to the JSON property `timezoneCode`
# @return [String]
attr_accessor :timezone_code
@ -737,19 +744,21 @@ module Google
class UploadLineItemsRequest
include Google::Apis::Core::Hashable
# Set to true to get upload status without actually persisting the line items.
# Set to <code>true</code> to get upload status without actually persisting
# the line items.
# Corresponds to the JSON property `dryRun`
# @return [Boolean]
attr_accessor :dry_run
alias_method :dry_run?, :dry_run
# Format the line items are in. Default to CSV.
# Format the line items are in. Default to <code>CSV</code>.
# Corresponds to the JSON property `format`
# @return [String]
attr_accessor :format
# Line items in CSV to upload. Refer to Entity Write File Format for more
# information on file format.
# Line items in CSV to upload. Refer to <a
# href="https://developers.google.com/bid-manager/guides/entity-write/format">
# Entity Write File Format</a> for more information on file format.
# Corresponds to the JSON property `lineItems`
# @return [String]
attr_accessor :line_items

View File

@ -22,7 +22,8 @@ module Google
module DoubleclickbidmanagerV1
# DoubleClick Bid Manager API
#
# API for viewing and managing your reports in DoubleClick Bid Manager.
# DoubleClick Bid Manager API allows users to manage and create campaigns and
# reports.
#
# @example
# require 'google/apis/doubleclickbidmanager_v1'
@ -38,17 +39,13 @@ module Google
attr_accessor :key
# @return [String]
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
# @return [String]
# Deprecated. Please use quotaUser instead.
attr_accessor :user_ip
def initialize
super('https://www.googleapis.com/', 'doubleclickbidmanager/v1/')
@batch_path = 'batch/doubleclickbidmanager/v1'
super('https://www.googleapis.com/', '')
@batch_path = 'batch/doubleclickbidmanager'
end
# Retrieves line items in CSV format. YouTube & partners line items are not
@ -57,10 +54,8 @@ module Google
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -73,15 +68,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def download_line_items(download_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'lineitems/downloadlineitems', options)
def download_line_items(download_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'doubleclickbidmanager/v1/lineitems/downloadlineitems', options)
command.request_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsRequest::Representation
command.request_object = download_line_items_request_object
command.response_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsResponse::Representation
command.response_class = Google::Apis::DoubleclickbidmanagerV1::DownloadLineItemsResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -91,10 +85,8 @@ module Google
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -107,15 +99,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def upload_line_items(upload_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'lineitems/uploadlineitems', options)
def upload_line_items(upload_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'doubleclickbidmanager/v1/lineitems/uploadlineitems', options)
command.request_representation = Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsRequest::Representation
command.request_object = upload_line_items_request_object
command.response_representation = Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsResponse::Representation
command.response_class = Google::Apis::DoubleclickbidmanagerV1::UploadLineItemsResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -124,10 +115,8 @@ module Google
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -140,15 +129,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_query(query_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'query', options)
def create_query(query_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'doubleclickbidmanager/v1/query', options)
command.request_representation = Google::Apis::DoubleclickbidmanagerV1::Query::Representation
command.request_object = query_object
command.response_representation = Google::Apis::DoubleclickbidmanagerV1::Query::Representation
command.response_class = Google::Apis::DoubleclickbidmanagerV1::Query
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -158,10 +146,8 @@ module Google
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -174,12 +160,11 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def deletequery(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:delete, 'query/{queryId}', options)
def deletequery(query_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'doubleclickbidmanager/v1/query/{queryId}', options)
command.params['queryId'] = query_id unless query_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -189,10 +174,8 @@ module Google
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -205,14 +188,13 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_query(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'query/{queryId}', options)
def get_query(query_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'doubleclickbidmanager/v1/query/{queryId}', options)
command.response_representation = Google::Apis::DoubleclickbidmanagerV1::Query::Representation
command.response_class = Google::Apis::DoubleclickbidmanagerV1::Query
command.params['queryId'] = query_id unless query_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -220,10 +202,8 @@ module Google
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -236,13 +216,12 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_queries(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'queries', options)
def list_queries(fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'doubleclickbidmanager/v1/queries', options)
command.response_representation = Google::Apis::DoubleclickbidmanagerV1::ListQueriesResponse::Representation
command.response_class = Google::Apis::DoubleclickbidmanagerV1::ListQueriesResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -253,10 +232,8 @@ module Google
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -269,14 +246,13 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def run_query(query_id, run_query_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'query/{queryId}', options)
def run_query(query_id, run_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'doubleclickbidmanager/v1/query/{queryId}', options)
command.request_representation = Google::Apis::DoubleclickbidmanagerV1::RunQueryRequest::Representation
command.request_object = run_query_request_object
command.params['queryId'] = query_id unless query_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -286,10 +262,8 @@ module Google
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -302,14 +276,13 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_reports(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'queries/{queryId}/reports', options)
def list_reports(query_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'doubleclickbidmanager/v1/queries/{queryId}/reports', options)
command.response_representation = Google::Apis::DoubleclickbidmanagerV1::ListReportsResponse::Representation
command.response_class = Google::Apis::DoubleclickbidmanagerV1::ListReportsResponse
command.params['queryId'] = query_id unless query_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -318,10 +291,8 @@ module Google
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -334,15 +305,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def download_sdf(download_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'sdf/download', options)
def download_sdf(download_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'doubleclickbidmanager/v1/sdf/download', options)
command.request_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadRequest::Representation
command.request_object = download_request_object
command.response_representation = Google::Apis::DoubleclickbidmanagerV1::DownloadResponse::Representation
command.response_class = Google::Apis::DoubleclickbidmanagerV1::DownloadResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -351,7 +321,6 @@ module Google
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
end
end
end

View File

@ -20,12 +20,13 @@ module Google
module Apis
# DoubleClick Bid Manager API
#
# API for viewing and managing your reports in DoubleClick Bid Manager.
# DoubleClick Bid Manager API allows users to manage and create campaigns and
# reports.
#
# @see https://developers.google.com/bid-manager/
module DoubleclickbidmanagerV1_1
VERSION = 'V1_1'
REVISION = '20200723'
REVISION = '20200731'
# View and manage your reports in DoubleClick Bid Manager
AUTH_DOUBLECLICKBIDMANAGER = 'https://www.googleapis.com/auth/doubleclickbidmanager'

View File

@ -38,8 +38,8 @@ module Google
# @return [String]
attr_accessor :name
# Rules within Channel Grouping. There is a limit of 100 rules that can be set
# per channel grouping.
# Rules within Channel Grouping. There is a limit of 100 rules that can be
# set per channel grouping.
# Corresponds to the JSON property `rules`
# @return [Array<Google::Apis::DoubleclickbidmanagerV1_1::Rule>]
attr_accessor :rules
@ -60,8 +60,8 @@ module Google
class DisjunctiveMatchStatement
include Google::Apis::Core::Hashable
# Filters. There is a limit of 100 filters that can be set per disjunctive match
# statement.
# Filters. There is a limit of 100 filters that can be set per disjunctive
# match statement.
# Corresponds to the JSON property `eventFilters`
# @return [Array<Google::Apis::DoubleclickbidmanagerV1_1::EventFilter>]
attr_accessor :event_filters
@ -80,8 +80,8 @@ module Google
class DownloadLineItemsRequest
include Google::Apis::Core::Hashable
# File specification (column names, types, order) in which the line items will
# be returned. Default to EWF.
# File specification (column names, types, order) in which the line items
# will be returned. Default to <code>EWF</code>.
# Corresponds to the JSON property `fileSpec`
# @return [String]
attr_accessor :file_spec
@ -97,7 +97,8 @@ module Google
# @return [String]
attr_accessor :filter_type
# Format in which the line items will be returned. Default to CSV.
# Format in which the line items will be returned. Default to
# <code>CSV</code>.
# Corresponds to the JSON property `format`
# @return [String]
attr_accessor :format
@ -119,8 +120,10 @@ module Google
class DownloadLineItemsResponse
include Google::Apis::Core::Hashable
# Retrieved line items in CSV format. For more information about file formats,
# see Entity Write File Format.
# Retrieved line items in CSV format. For more information about file
# formats, see <a
# href="https://developers.google.com/bid-manager/guides/entity-write/format">
# Entity Write File Format</a>.
# Corresponds to the JSON property `lineItems`
# @return [String]
attr_accessor :line_items
@ -140,21 +143,18 @@ module Google
class DownloadRequest
include Google::Apis::Core::Hashable
# File types that will be returned. If INVENTORY_SOURCE is requested, no other
# file types may be requested.
# Acceptable values are:
# - "AD"
# - "AD_GROUP"
# - "CAMPAIGN"
# - "INSERTION_ORDER"
# - "INVENTORY_SOURCE"
# - "LINE_ITEM"
# File types that will be returned. If INVENTORY_SOURCE is requested, no
# other file types may be requested. <br><br>Acceptable values are: <ul>
# <li>"<code>AD</code>"</li> <li>"<code>AD_GROUP</code>"</li>
# <li>"<code>CAMPAIGN</code>"</li> <li>"<code>INSERTION_ORDER</code>"</li>
# <li>"<code>INVENTORY_SOURCE</code>"</li> <li>"<code>LINE_ITEM</code>"</li>
# </ul>
# Corresponds to the JSON property `fileTypes`
# @return [Array<String>]
attr_accessor :file_types
# The IDs of the specified filter type. This is used to filter entities to fetch.
# At least one ID must be specified.
# The IDs of the specified filter type. This is used to filter entities to
# fetch. At least one ID must be specified.
# Corresponds to the JSON property `filterIds`
# @return [Array<Fixnum>]
attr_accessor :filter_ids
@ -166,7 +166,7 @@ module Google
attr_accessor :filter_type
# SDF Version (column names, types, order) in which the entities will be
# returned. Default to 5.
# returned. Default to <code>5</code>.
# Corresponds to the JSON property `version`
# @return [String]
attr_accessor :version
@ -282,8 +282,8 @@ module Google
class ListQueriesResponse
include Google::Apis::Core::Hashable
# Identifies what kind of resource this is. Value: the fixed string "
# doubleclickbidmanager#listQueriesResponse".
# Identifies what kind of resource this is. Value: the fixed string
# <code>"doubleclickbidmanager#listQueriesResponse"</code>.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
@ -314,8 +314,8 @@ module Google
class ListReportsResponse
include Google::Apis::Core::Hashable
# Identifies what kind of resource this is. Value: the fixed string "
# doubleclickbidmanager#listReportsResponse".
# Identifies what kind of resource this is. Value: the fixed string
# <code>"doubleclickbidmanager#listReportsResponse"</code>.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
@ -346,9 +346,9 @@ module Google
class Options
include Google::Apis::Core::Hashable
# Set to true and filter your report by `FILTER_INSERTION_ORDER` or `
# FILTER_LINE_ITEM` to include data for audience lists specifically targeted by
# those items.
# Set to true and filter your report by `FILTER_INSERTION_ORDER` or
# `FILTER_LINE_ITEM` to include data for audience lists specifically targeted
# by those items.
# Corresponds to the JSON property `includeOnlyTargetedUserLists`
# @return [Boolean]
attr_accessor :include_only_targeted_user_lists
@ -421,11 +421,10 @@ module Google
end
# Path filters specify which paths to include in a report. A path is the result
# of combining DV360 events based on User ID to create a workflow of users'
# actions.
# When a path filter is set, the resulting report will only include paths that
# match the specified event at the specified position. All other paths will be
# excluded.
# of combining DV360 events based on User ID to create a workflow of
# users' actions.<br><br> When a path filter is set, the resulting report will
# only include paths that match the specified event at the specified position.
# All other paths will be excluded.
class PathFilter
include Google::Apis::Core::Hashable
@ -434,8 +433,8 @@ module Google
# @return [Array<Google::Apis::DoubleclickbidmanagerV1_1::EventFilter>]
attr_accessor :event_filters
# Indicates the position of the path the filter should match to (first, last, or
# any event in path).
# Indicates the position of the path the filter should match to (first, last,
# or any event in path).
# Corresponds to the JSON property `pathMatchPosition`
# @return [String]
attr_accessor :path_match_position
@ -461,7 +460,8 @@ module Google
# @return [Google::Apis::DoubleclickbidmanagerV1_1::ChannelGrouping]
attr_accessor :channel_grouping
# Path Filters. There is a limit of 100 path filters that can be set per report.
# Path Filters. There is a limit of 100 path filters that can be set per
# report.
# Corresponds to the JSON property `pathFilters`
# @return [Array<Google::Apis::DoubleclickbidmanagerV1_1::PathFilter>]
attr_accessor :path_filters
@ -512,8 +512,8 @@ module Google
class Query
include Google::Apis::Core::Hashable
# Identifies what kind of resource this is. Value: the fixed string "
# doubleclickbidmanager#query".
# Identifies what kind of resource this is. Value: the fixed string
# <code>"doubleclickbidmanager#query"</code>.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
@ -534,15 +534,17 @@ module Google
attr_accessor :query_id
# The ending time for the data that is shown in the report. Note,
# reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and
# ignored otherwise.
# <code>reportDataEndTimeMs</code> is required if
# <code>metadata.dataRange</code> is <code>CUSTOM_DATES</code> and ignored
# otherwise.
# Corresponds to the JSON property `reportDataEndTimeMs`
# @return [Fixnum]
attr_accessor :report_data_end_time_ms
# The starting time for the data that is shown in the report. Note,
# reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and
# ignored otherwise.
# <code>reportDataStartTimeMs</code> is required if
# <code>metadata.dataRange</code> is <code>CUSTOM_DATES</code> and ignored
# otherwise.
# Corresponds to the JSON property `reportDataStartTimeMs`
# @return [Fixnum]
attr_accessor :report_data_start_time_ms
@ -552,7 +554,8 @@ module Google
# @return [Google::Apis::DoubleclickbidmanagerV1_1::QuerySchedule]
attr_accessor :schedule
# Canonical timezone code for report data time. Defaults to America/New_York.
# Canonical timezone code for report data time. Defaults to
# <code>America/New_York</code>.
# Corresponds to the JSON property `timezoneCode`
# @return [String]
attr_accessor :timezone_code
@ -604,11 +607,12 @@ module Google
# @return [Fixnum]
attr_accessor :latest_report_run_time_ms
# Locale of the generated reports. Valid values are cs CZECH de GERMAN en
# ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR
# BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-
# TW TAIWAN_CHINESE
# An locale string not in the list above will generate reports in English.
# Locale of the generated reports. Valid values are cs CZECH de
# GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja
# JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru
# RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW
# TAIWAN_CHINESE <br><br> An locale string not in the list above will
# generate reports in English.
# Corresponds to the JSON property `locale`
# @return [String]
attr_accessor :locale
@ -624,14 +628,15 @@ module Google
attr_accessor :running
alias_method :running?, :running
# Whether to send an email notification when a report is ready. Default to false.
# Whether to send an email notification when a report is ready. Default to
# false.
# Corresponds to the JSON property `sendNotification`
# @return [Boolean]
attr_accessor :send_notification
alias_method :send_notification?, :send_notification
# List of email addresses which are sent email notifications when the report is
# finished. Separate from sendNotification.
# List of email addresses which are sent email notifications when the report
# is finished. Separate from <code>sendNotification</code>.
# Corresponds to the JSON property `shareEmailAddress`
# @return [Array<String>]
attr_accessor :share_email_address
@ -681,8 +686,8 @@ module Google
# @return [Fixnum]
attr_accessor :next_run_minute_of_day
# Canonical timezone code for report generation time. Defaults to America/
# New_York.
# Canonical timezone code for report generation time. Defaults to
# <code>America/New_York</code>.
# Corresponds to the JSON property `nextRunTimezoneCode`
# @return [String]
attr_accessor :next_run_timezone_code
@ -785,7 +790,8 @@ module Google
class ReportMetadata
include Google::Apis::Core::Hashable
# The path to the location in Google Cloud Storage where the report is stored.
# The path to the location in Google Cloud Storage where the report is
# stored.
# Corresponds to the JSON property `googleCloudStoragePath`
# @return [String]
attr_accessor :google_cloud_storage_path
@ -906,9 +912,10 @@ module Google
end
end
# A Rule defines a name, and a boolean expression in [conjunctive normal form](
# http://mathworld.wolfram.com/ConjunctiveNormalForm.html)`.external` that can
# be applied to a path event to determine if that name should be applied.
# A Rule defines a name, and a boolean expression in [conjunctive normal
# form](http:
# //mathworld.wolfram.com/ConjunctiveNormalForm.html)`.external` that can be
# // applied to a path event to determine if that name should be applied.
class Rule
include Google::Apis::Core::Hashable
@ -943,20 +950,21 @@ module Google
attr_accessor :data_range
# The ending time for the data that is shown in the report. Note,
# reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored
# otherwise.
# <code>reportDataEndTimeMs</code> is required if <code>dataRange</code> is
# <code>CUSTOM_DATES</code> and ignored otherwise.
# Corresponds to the JSON property `reportDataEndTimeMs`
# @return [Fixnum]
attr_accessor :report_data_end_time_ms
# The starting time for the data that is shown in the report. Note,
# reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored
# otherwise.
# <code>reportDataStartTimeMs</code> is required if <code>dataRange</code> is
# <code>CUSTOM_DATES</code> and ignored otherwise.
# Corresponds to the JSON property `reportDataStartTimeMs`
# @return [Fixnum]
attr_accessor :report_data_start_time_ms
# Canonical timezone code for report data time. Defaults to America/New_York.
# Canonical timezone code for report data time. Defaults to
# <code>America/New_York</code>.
# Corresponds to the JSON property `timezoneCode`
# @return [String]
attr_accessor :timezone_code
@ -978,19 +986,21 @@ module Google
class UploadLineItemsRequest
include Google::Apis::Core::Hashable
# Set to true to get upload status without actually persisting the line items.
# Set to <code>true</code> to get upload status without actually persisting
# the line items.
# Corresponds to the JSON property `dryRun`
# @return [Boolean]
attr_accessor :dry_run
alias_method :dry_run?, :dry_run
# Format the line items are in. Default to CSV.
# Format the line items are in. Default to <code>CSV</code>.
# Corresponds to the JSON property `format`
# @return [String]
attr_accessor :format
# Line items in CSV to upload. Refer to Entity Write File Format for more
# information on file format.
# Line items in CSV to upload. Refer to <a
# href="https://developers.google.com/bid-manager/guides/entity-write/format">
# Entity Write File Format</a> for more information on file format.
# Corresponds to the JSON property `lineItems`
# @return [String]
attr_accessor :line_items

View File

@ -22,7 +22,8 @@ module Google
module DoubleclickbidmanagerV1_1
# DoubleClick Bid Manager API
#
# API for viewing and managing your reports in DoubleClick Bid Manager.
# DoubleClick Bid Manager API allows users to manage and create campaigns and
# reports.
#
# @example
# require 'google/apis/doubleclickbidmanager_v1_1'
@ -38,17 +39,13 @@ module Google
attr_accessor :key
# @return [String]
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
# @return [String]
# Deprecated. Please use quotaUser instead.
attr_accessor :user_ip
def initialize
super('https://www.googleapis.com/', 'doubleclickbidmanager/v1.1/')
@batch_path = 'batch/doubleclickbidmanager/v1.1'
super('https://www.googleapis.com/', '')
@batch_path = 'batch/doubleclickbidmanager'
end
# Retrieves line items in CSV format. YouTube & partners line items are not
@ -57,10 +54,8 @@ module Google
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -73,15 +68,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def downloadlineitems_lineitem(download_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'lineitems/downloadlineitems', options)
def downloadlineitems_lineitem(download_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'doubleclickbidmanager/v1.1/lineitems/downloadlineitems', options)
command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::DownloadLineItemsRequest::Representation
command.request_object = download_line_items_request_object
command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::DownloadLineItemsResponse::Representation
command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::DownloadLineItemsResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -91,10 +85,8 @@ module Google
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -107,30 +99,27 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def uploadlineitems_lineitem(upload_line_items_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'lineitems/uploadlineitems', options)
def uploadlineitems_lineitem(upload_line_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'doubleclickbidmanager/v1.1/lineitems/uploadlineitems', options)
command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::UploadLineItemsRequest::Representation
command.request_object = upload_line_items_request_object
command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::UploadLineItemsResponse::Representation
command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::UploadLineItemsResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Creates a query.
# @param [Google::Apis::DoubleclickbidmanagerV1_1::Query] query_object
# @param [Boolean] asynchronous
# If true, tries to run the query asynchronously. Only applicable when the
# frequency is ONE_TIME.
# If true, tries to run the query asynchronously. Only applicable when
# the frequency is <code>ONE_TIME</code>.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -143,8 +132,8 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def createquery_query(query_object = nil, asynchronous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'query', options)
def createquery_query(query_object = nil, asynchronous: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'doubleclickbidmanager/v1.1/query', options)
command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::Query::Representation
command.request_object = query_object
command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::Query::Representation
@ -152,7 +141,6 @@ module Google
command.query['asynchronous'] = asynchronous unless asynchronous.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -162,10 +150,8 @@ module Google
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -178,12 +164,11 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def deletequery_query(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:delete, 'query/{queryId}', options)
def deletequery_query(query_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'doubleclickbidmanager/v1.1/query/{queryId}', options)
command.params['queryId'] = query_id unless query_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -193,10 +178,8 @@ module Google
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -209,30 +192,27 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def getquery_query(query_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'query/{queryId}', options)
def getquery_query(query_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'doubleclickbidmanager/v1.1/query/{queryId}', options)
command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::Query::Representation
command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::Query
command.params['queryId'] = query_id unless query_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
# Retrieves stored queries.
# @param [Fixnum] page_size
# Maximum number of results per page. Must be between 1 and 100. Defaults to 100
# if unspecified.
# Maximum number of results per page. Must be between <code>1</code> and
# <code>100</code>. Defaults to <code>100</code> if unspecified.
# @param [String] page_token
# Optional pagination token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -245,15 +225,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def listqueries_query(page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'queries', options)
def listqueries_query(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'doubleclickbidmanager/v1.1/queries', options)
command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::ListQueriesResponse::Representation
command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::ListQueriesResponse
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -266,10 +245,8 @@ module Google
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -282,15 +259,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def runquery_query(query_id, run_query_request_object = nil, asynchronous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'query/{queryId}', options)
def runquery_query(query_id, run_query_request_object = nil, asynchronous: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'doubleclickbidmanager/v1.1/query/{queryId}', options)
command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::RunQueryRequest::Representation
command.request_object = run_query_request_object
command.params['queryId'] = query_id unless query_id.nil?
command.query['asynchronous'] = asynchronous unless asynchronous.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -298,17 +274,15 @@ module Google
# @param [Fixnum] query_id
# Query ID with which the reports are associated.
# @param [Fixnum] page_size
# Maximum number of results per page. Must be between 1 and 100. Defaults to 100
# if unspecified.
# Maximum number of results per page. Must be between <code>1</code> and
# <code>100</code>. Defaults to <code>100</code> if unspecified.
# @param [String] page_token
# Optional pagination token.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -321,8 +295,8 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def listreports_report(query_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'queries/{queryId}/reports', options)
def listreports_report(query_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'doubleclickbidmanager/v1.1/queries/{queryId}/reports', options)
command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::ListReportsResponse::Representation
command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::ListReportsResponse
command.params['queryId'] = query_id unless query_id.nil?
@ -330,7 +304,6 @@ module Google
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -339,10 +312,8 @@ module Google
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# An opaque string that represents a user for quota purposes. Must not exceed 40
# characters.
# @param [String] user_ip
# Deprecated. Please use quotaUser instead.
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
@ -355,15 +326,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def download_sdf(download_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'sdf/download', options)
def download_sdf(download_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'doubleclickbidmanager/v1.1/sdf/download', options)
command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::DownloadRequest::Representation
command.request_object = download_request_object
command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::DownloadResponse::Representation
command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::DownloadResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
execute_or_queue_command(command, &block)
end
@ -372,7 +342,6 @@ module Google
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['userIp'] = user_ip unless user_ip.nil?
end
end
end

View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/drive/
module DriveV2
VERSION = 'V2'
REVISION = '20200719'
REVISION = '20200723'
# See, edit, create, and delete all of your Google Drive files
AUTH_DRIVE = 'https://www.googleapis.com/auth/drive'

View File

@ -3175,6 +3175,12 @@ module Google
# @return [String]
attr_accessor :value
# Indicates the view for this permission. Only populated for permissions that
# belong to a view. published is the only supported value.
# Corresponds to the JSON property `view`
# @return [String]
attr_accessor :view
# Whether the link is required for this permission.
# Corresponds to the JSON property `withLink`
# @return [Boolean]
@ -3204,6 +3210,7 @@ module Google
@team_drive_permission_details = args[:team_drive_permission_details] if args.key?(:team_drive_permission_details)
@type = args[:type] if args.key?(:type)
@value = args[:value] if args.key?(:value)
@view = args[:view] if args.key?(:view)
@with_link = args[:with_link] if args.key?(:with_link)
end

View File

@ -1075,6 +1075,7 @@ module Google
property :type, as: 'type'
property :value, as: 'value'
property :view, as: 'view'
property :with_link, as: 'withLink'
end

View File

@ -278,6 +278,9 @@ module Google
# list of changes, for example by deletion or loss of access.
# @param [Boolean] include_items_from_all_drives
# Whether both My Drive and shared drive items should be included in results.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] include_subscribed
# Whether to include changes outside the My Drive hierarchy in the result. When
# set to false, changes to files such as those in the Application Data folder or
@ -320,7 +323,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_changes(drive_id: nil, include_corpus_removals: nil, include_deleted: nil, include_items_from_all_drives: nil, include_subscribed: nil, include_team_drive_items: nil, max_results: nil, page_token: nil, spaces: nil, start_change_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def list_changes(drive_id: nil, include_corpus_removals: nil, include_deleted: nil, include_items_from_all_drives: nil, include_permissions_for_view: nil, include_subscribed: nil, include_team_drive_items: nil, max_results: nil, page_token: nil, spaces: nil, start_change_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'changes', options)
command.response_representation = Google::Apis::DriveV2::ChangeList::Representation
command.response_class = Google::Apis::DriveV2::ChangeList
@ -328,6 +331,7 @@ module Google
command.query['includeCorpusRemovals'] = include_corpus_removals unless include_corpus_removals.nil?
command.query['includeDeleted'] = include_deleted unless include_deleted.nil?
command.query['includeItemsFromAllDrives'] = include_items_from_all_drives unless include_items_from_all_drives.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['includeSubscribed'] = include_subscribed unless include_subscribed.nil?
command.query['includeTeamDriveItems'] = include_team_drive_items unless include_team_drive_items.nil?
command.query['maxResults'] = max_results unless max_results.nil?
@ -359,6 +363,9 @@ module Google
# list of changes, for example by deletion or loss of access.
# @param [Boolean] include_items_from_all_drives
# Whether both My Drive and shared drive items should be included in results.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] include_subscribed
# Whether to include changes outside the My Drive hierarchy in the result. When
# set to false, changes to files such as those in the Application Data folder or
@ -401,7 +408,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def watch_change(channel_object = nil, drive_id: nil, include_corpus_removals: nil, include_deleted: nil, include_items_from_all_drives: nil, include_subscribed: nil, include_team_drive_items: nil, max_results: nil, page_token: nil, spaces: nil, start_change_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def watch_change(channel_object = nil, drive_id: nil, include_corpus_removals: nil, include_deleted: nil, include_items_from_all_drives: nil, include_permissions_for_view: nil, include_subscribed: nil, include_team_drive_items: nil, max_results: nil, page_token: nil, spaces: nil, start_change_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'changes/watch', options)
command.request_representation = Google::Apis::DriveV2::Channel::Representation
command.request_object = channel_object
@ -411,6 +418,7 @@ module Google
command.query['includeCorpusRemovals'] = include_corpus_removals unless include_corpus_removals.nil?
command.query['includeDeleted'] = include_deleted unless include_deleted.nil?
command.query['includeItemsFromAllDrives'] = include_items_from_all_drives unless include_items_from_all_drives.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['includeSubscribed'] = include_subscribed unless include_subscribed.nil?
command.query['includeTeamDriveItems'] = include_team_drive_items unless include_team_drive_items.nil?
command.query['maxResults'] = max_results unless max_results.nil?
@ -1141,6 +1149,9 @@ module Google
# Set to true to opt in to API behavior that aims for all items to have exactly
# one parent. This parameter only takes effect if the item is not in a shared
# drive. Requests that specify more than one parent fail.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] ocr
# Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
# @param [String] ocr_language
@ -1178,7 +1189,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def copy_file(file_id, file_object = nil, convert: nil, enforce_single_parent: nil, ocr: nil, ocr_language: nil, pinned: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def copy_file(file_id, file_object = nil, convert: nil, enforce_single_parent: nil, include_permissions_for_view: nil, ocr: nil, ocr_language: nil, pinned: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'files/{fileId}/copy', options)
command.request_representation = Google::Apis::DriveV2::File::Representation
command.request_object = file_object
@ -1187,6 +1198,7 @@ module Google
command.params['fileId'] = file_id unless file_id.nil?
command.query['convert'] = convert unless convert.nil?
command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['ocr'] = ocr unless ocr.nil?
command.query['ocrLanguage'] = ocr_language unless ocr_language.nil?
command.query['pinned'] = pinned unless pinned.nil?
@ -1352,6 +1364,9 @@ module Google
# @param [Boolean] acknowledge_abuse
# Whether the user is acknowledging the risk of downloading known malware or
# other abusive files.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [String] projection
# This parameter is deprecated and has no function.
# @param [String] revision_id
@ -1385,7 +1400,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_file(file_id, acknowledge_abuse: nil, projection: nil, revision_id: nil, supports_all_drives: nil, supports_team_drives: nil, update_viewed_date: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
def get_file(file_id, acknowledge_abuse: nil, include_permissions_for_view: nil, projection: nil, revision_id: nil, supports_all_drives: nil, supports_team_drives: nil, update_viewed_date: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
if download_dest.nil?
command = make_simple_command(:get, 'files/{fileId}', options)
else
@ -1396,6 +1411,7 @@ module Google
command.response_class = Google::Apis::DriveV2::File
command.params['fileId'] = file_id unless file_id.nil?
command.query['acknowledgeAbuse'] = acknowledge_abuse unless acknowledge_abuse.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['projection'] = projection unless projection.nil?
command.query['revisionId'] = revision_id unless revision_id.nil?
command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
@ -1415,6 +1431,9 @@ module Google
# Set to true to opt in to API behavior that aims for all items to have exactly
# one parent. This parameter only takes effect if the item is not in a shared
# drive. Requests that specify more than one parent fail.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] ocr
# Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
# @param [String] ocr_language
@ -1458,7 +1477,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def insert_file(file_object = nil, convert: nil, enforce_single_parent: nil, ocr: nil, ocr_language: nil, pinned: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, use_content_as_indexable_text: nil, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
def insert_file(file_object = nil, convert: nil, enforce_single_parent: nil, include_permissions_for_view: nil, ocr: nil, ocr_language: nil, pinned: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, use_content_as_indexable_text: nil, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
if upload_source.nil?
command = make_simple_command(:post, 'files', options)
else
@ -1472,6 +1491,7 @@ module Google
command.response_class = Google::Apis::DriveV2::File
command.query['convert'] = convert unless convert.nil?
command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['ocr'] = ocr unless ocr.nil?
command.query['ocrLanguage'] = ocr_language unless ocr_language.nil?
command.query['pinned'] = pinned unless pinned.nil?
@ -1502,6 +1522,9 @@ module Google
# ID of the shared drive to search.
# @param [Boolean] include_items_from_all_drives
# Whether both My Drive and shared drive items should be included in results.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] include_team_drive_items
# Deprecated use includeItemsFromAllDrives instead.
# @param [Fixnum] max_results
@ -1549,7 +1572,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_files(corpora: nil, corpus: nil, drive_id: nil, include_items_from_all_drives: nil, include_team_drive_items: nil, max_results: nil, order_by: nil, page_token: nil, projection: nil, q: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def list_files(corpora: nil, corpus: nil, drive_id: nil, include_items_from_all_drives: nil, include_permissions_for_view: nil, include_team_drive_items: nil, max_results: nil, order_by: nil, page_token: nil, projection: nil, q: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'files', options)
command.response_representation = Google::Apis::DriveV2::FileList::Representation
command.response_class = Google::Apis::DriveV2::FileList
@ -1557,6 +1580,7 @@ module Google
command.query['corpus'] = corpus unless corpus.nil?
command.query['driveId'] = drive_id unless drive_id.nil?
command.query['includeItemsFromAllDrives'] = include_items_from_all_drives unless include_items_from_all_drives.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['includeTeamDriveItems'] = include_team_drive_items unless include_team_drive_items.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['orderBy'] = order_by unless order_by.nil?
@ -1588,6 +1612,9 @@ module Google
# removed from all current folders and placed in the requested folder. Other
# requests that increase the number of parents fail, except when the
# canAddMyDriveParent file capability is true and a single parent is being added.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [String] modified_date_behavior
# Determines the behavior in which modifiedDate is updated. This overrides
# setModifiedDate.
@ -1645,7 +1672,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_file(file_id, file_object = nil, add_parents: nil, convert: nil, enforce_single_parent: nil, modified_date_behavior: nil, new_revision: nil, ocr: nil, ocr_language: nil, pinned: nil, remove_parents: nil, set_modified_date: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, update_viewed_date: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def patch_file(file_id, file_object = nil, add_parents: nil, convert: nil, enforce_single_parent: nil, include_permissions_for_view: nil, modified_date_behavior: nil, new_revision: nil, ocr: nil, ocr_language: nil, pinned: nil, remove_parents: nil, set_modified_date: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, update_viewed_date: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:patch, 'files/{fileId}', options)
command.request_representation = Google::Apis::DriveV2::File::Representation
command.request_object = file_object
@ -1655,6 +1682,7 @@ module Google
command.query['addParents'] = add_parents unless add_parents.nil?
command.query['convert'] = convert unless convert.nil?
command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['modifiedDateBehavior'] = modified_date_behavior unless modified_date_behavior.nil?
command.query['newRevision'] = new_revision unless new_revision.nil?
command.query['ocr'] = ocr unless ocr.nil?
@ -1677,6 +1705,9 @@ module Google
# Set the file's updated time to the current server time.
# @param [String] file_id
# The ID of the file to update.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] supports_all_drives
# Whether the requesting application supports both My Drives and shared drives.
# @param [Boolean] supports_team_drives
@ -1700,11 +1731,12 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def touch_file(file_id, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def touch_file(file_id, include_permissions_for_view: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'files/{fileId}/touch', options)
command.response_representation = Google::Apis::DriveV2::File::Representation
command.response_class = Google::Apis::DriveV2::File
command.params['fileId'] = file_id unless file_id.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
command.query['fields'] = fields unless fields.nil?
@ -1721,6 +1753,9 @@ module Google
# All users with access can copy, download, export, and share the file.
# @param [String] file_id
# The ID of the file to trash.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] supports_all_drives
# Whether the requesting application supports both My Drives and shared drives.
# @param [Boolean] supports_team_drives
@ -1744,11 +1779,12 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def trash_file(file_id, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def trash_file(file_id, include_permissions_for_view: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'files/{fileId}/trash', options)
command.response_representation = Google::Apis::DriveV2::File::Representation
command.response_class = Google::Apis::DriveV2::File
command.params['fileId'] = file_id unless file_id.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
command.query['fields'] = fields unless fields.nil?
@ -1762,6 +1798,9 @@ module Google
# the owner may untrash a file.
# @param [String] file_id
# The ID of the file to untrash.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] supports_all_drives
# Whether the requesting application supports both My Drives and shared drives.
# @param [Boolean] supports_team_drives
@ -1785,11 +1824,12 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def untrash_file(file_id, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def untrash_file(file_id, include_permissions_for_view: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'files/{fileId}/untrash', options)
command.response_representation = Google::Apis::DriveV2::File::Representation
command.response_class = Google::Apis::DriveV2::File
command.params['fileId'] = file_id unless file_id.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
command.query['fields'] = fields unless fields.nil?
@ -1813,6 +1853,9 @@ module Google
# removed from all current folders and placed in the requested folder. Other
# requests that increase the number of parents fail, except when the
# canAddMyDriveParent file capability is true and a single parent is being added.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [String] modified_date_behavior
# Determines the behavior in which modifiedDate is updated. This overrides
# setModifiedDate.
@ -1874,7 +1917,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_file(file_id, file_object = nil, add_parents: nil, convert: nil, enforce_single_parent: nil, modified_date_behavior: nil, new_revision: nil, ocr: nil, ocr_language: nil, pinned: nil, remove_parents: nil, set_modified_date: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, update_viewed_date: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
def update_file(file_id, file_object = nil, add_parents: nil, convert: nil, enforce_single_parent: nil, include_permissions_for_view: nil, modified_date_behavior: nil, new_revision: nil, ocr: nil, ocr_language: nil, pinned: nil, remove_parents: nil, set_modified_date: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, update_viewed_date: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
if upload_source.nil?
command = make_simple_command(:put, 'files/{fileId}', options)
else
@ -1890,6 +1933,7 @@ module Google
command.query['addParents'] = add_parents unless add_parents.nil?
command.query['convert'] = convert unless convert.nil?
command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['modifiedDateBehavior'] = modified_date_behavior unless modified_date_behavior.nil?
command.query['newRevision'] = new_revision unless new_revision.nil?
command.query['ocr'] = ocr unless ocr.nil?
@ -1916,6 +1960,9 @@ module Google
# @param [Boolean] acknowledge_abuse
# Whether the user is acknowledging the risk of downloading known malware or
# other abusive files.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [String] projection
# This parameter is deprecated and has no function.
# @param [String] revision_id
@ -1949,7 +1996,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def watch_file(file_id, channel_object = nil, acknowledge_abuse: nil, projection: nil, revision_id: nil, supports_all_drives: nil, supports_team_drives: nil, update_viewed_date: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
def watch_file(file_id, channel_object = nil, acknowledge_abuse: nil, include_permissions_for_view: nil, projection: nil, revision_id: nil, supports_all_drives: nil, supports_team_drives: nil, update_viewed_date: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
if download_dest.nil?
command = make_simple_command(:post, 'files/{fileId}/watch', options)
else
@ -1962,6 +2009,7 @@ module Google
command.response_class = Google::Apis::DriveV2::Channel
command.params['fileId'] = file_id unless file_id.nil?
command.query['acknowledgeAbuse'] = acknowledge_abuse unless acknowledge_abuse.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['projection'] = projection unless projection.nil?
command.query['revisionId'] = revision_id unless revision_id.nil?
command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
@ -2331,6 +2379,9 @@ module Google
# Lists a file's or shared drive's permissions.
# @param [String] file_id
# The ID for the file or shared drive.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Fixnum] max_results
# The maximum number of permissions to return per page. When not set for files
# in a shared drive, at most 100 results will be returned. When not set for
@ -2366,11 +2417,12 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_permissions(file_id, max_results: nil, page_token: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def list_permissions(file_id, include_permissions_for_view: nil, max_results: nil, page_token: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'files/{fileId}/permissions', options)
command.response_representation = Google::Apis::DriveV2::PermissionList::Representation
command.response_class = Google::Apis::DriveV2::PermissionList
command.params['fileId'] = file_id unless file_id.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['maxResults'] = max_results unless max_results.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?

View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/drive/
module DriveV3
VERSION = 'V3'
REVISION = '20200719'
REVISION = '20200723'
# See, edit, create, and delete all of your Google Drive files
AUTH_DRIVE = 'https://www.googleapis.com/auth/drive'

View File

@ -2169,6 +2169,12 @@ module Google
# @return [String]
attr_accessor :type
# Indicates the view for this permission. Only populated for permissions that
# belong to a view. published is the only supported value.
# Corresponds to the JSON property `view`
# @return [String]
attr_accessor :view
def initialize(**args)
update!(**args)
end
@ -2188,6 +2194,7 @@ module Google
@role = args[:role] if args.key?(:role)
@team_drive_permission_details = args[:team_drive_permission_details] if args.key?(:team_drive_permission_details)
@type = args[:type] if args.key?(:type)
@view = args[:view] if args.key?(:view)
end
#

View File

@ -734,6 +734,7 @@ module Google
collection :team_drive_permission_details, as: 'teamDrivePermissionDetails', class: Google::Apis::DriveV3::Permission::TeamDrivePermissionDetail, decorator: Google::Apis::DriveV3::Permission::TeamDrivePermissionDetail::Representation
property :type, as: 'type'
property :view, as: 'view'
end
class PermissionDetail

View File

@ -141,6 +141,9 @@ module Google
# for this file.
# @param [Boolean] include_items_from_all_drives
# Whether both My Drive and shared drive items should be included in results.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] include_removed
# Whether to include changes indicating that items have been removed from the
# list of changes, for example by deletion or loss of access.
@ -180,13 +183,14 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_changes(page_token, drive_id: nil, include_corpus_removals: nil, include_items_from_all_drives: nil, include_removed: nil, include_team_drive_items: nil, page_size: nil, restrict_to_my_drive: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def list_changes(page_token, drive_id: nil, include_corpus_removals: nil, include_items_from_all_drives: nil, include_permissions_for_view: nil, include_removed: nil, include_team_drive_items: nil, page_size: nil, restrict_to_my_drive: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'changes', options)
command.response_representation = Google::Apis::DriveV3::ChangeList::Representation
command.response_class = Google::Apis::DriveV3::ChangeList
command.query['driveId'] = drive_id unless drive_id.nil?
command.query['includeCorpusRemovals'] = include_corpus_removals unless include_corpus_removals.nil?
command.query['includeItemsFromAllDrives'] = include_items_from_all_drives unless include_items_from_all_drives.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['includeRemoved'] = include_removed unless include_removed.nil?
command.query['includeTeamDriveItems'] = include_team_drive_items unless include_team_drive_items.nil?
command.query['pageSize'] = page_size unless page_size.nil?
@ -219,6 +223,9 @@ module Google
# for this file.
# @param [Boolean] include_items_from_all_drives
# Whether both My Drive and shared drive items should be included in results.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] include_removed
# Whether to include changes indicating that items have been removed from the
# list of changes, for example by deletion or loss of access.
@ -258,7 +265,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def watch_change(page_token, channel_object = nil, drive_id: nil, include_corpus_removals: nil, include_items_from_all_drives: nil, include_removed: nil, include_team_drive_items: nil, page_size: nil, restrict_to_my_drive: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def watch_change(page_token, channel_object = nil, drive_id: nil, include_corpus_removals: nil, include_items_from_all_drives: nil, include_permissions_for_view: nil, include_removed: nil, include_team_drive_items: nil, page_size: nil, restrict_to_my_drive: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'changes/watch', options)
command.request_representation = Google::Apis::DriveV3::Channel::Representation
command.request_object = channel_object
@ -267,6 +274,7 @@ module Google
command.query['driveId'] = drive_id unless drive_id.nil?
command.query['includeCorpusRemovals'] = include_corpus_removals unless include_corpus_removals.nil?
command.query['includeItemsFromAllDrives'] = include_items_from_all_drives unless include_items_from_all_drives.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['includeRemoved'] = include_removed unless include_removed.nil?
command.query['includeTeamDriveItems'] = include_team_drive_items unless include_team_drive_items.nil?
command.query['pageSize'] = page_size unless page_size.nil?
@ -784,6 +792,9 @@ module Google
# file. Domain administrators can choose to make all uploaded files visible to
# the domain by default; this parameter bypasses that behavior for the request.
# Permissions are still inherited from parent folders.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] keep_revision_forever
# Whether to set the 'keepForever' field in the new head revision. This is only
# applicable to files with binary content in Google Drive. Only 200 revisions
@ -814,7 +825,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def copy_file(file_id, file_object = nil, enforce_single_parent: nil, ignore_default_visibility: nil, keep_revision_forever: nil, ocr_language: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def copy_file(file_id, file_object = nil, enforce_single_parent: nil, ignore_default_visibility: nil, include_permissions_for_view: nil, keep_revision_forever: nil, ocr_language: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'files/{fileId}/copy', options)
command.request_representation = Google::Apis::DriveV3::File::Representation
command.request_object = file_object
@ -823,6 +834,7 @@ module Google
command.params['fileId'] = file_id unless file_id.nil?
command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil?
command.query['ignoreDefaultVisibility'] = ignore_default_visibility unless ignore_default_visibility.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['keepRevisionForever'] = keep_revision_forever unless keep_revision_forever.nil?
command.query['ocrLanguage'] = ocr_language unless ocr_language.nil?
command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
@ -844,6 +856,9 @@ module Google
# file. Domain administrators can choose to make all uploaded files visible to
# the domain by default; this parameter bypasses that behavior for the request.
# Permissions are still inherited from parent folders.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] keep_revision_forever
# Whether to set the 'keepForever' field in the new head revision. This is only
# applicable to files with binary content in Google Drive. Only 200 revisions
@ -880,7 +895,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_file(file_object = nil, enforce_single_parent: nil, ignore_default_visibility: nil, keep_revision_forever: nil, ocr_language: nil, supports_all_drives: nil, supports_team_drives: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
def create_file(file_object = nil, enforce_single_parent: nil, ignore_default_visibility: nil, include_permissions_for_view: nil, keep_revision_forever: nil, ocr_language: nil, supports_all_drives: nil, supports_team_drives: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
if upload_source.nil?
command = make_simple_command(:post, 'files', options)
else
@ -894,6 +909,7 @@ module Google
command.response_class = Google::Apis::DriveV3::File
command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil?
command.query['ignoreDefaultVisibility'] = ignore_default_visibility unless ignore_default_visibility.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['keepRevisionForever'] = keep_revision_forever unless keep_revision_forever.nil?
command.query['ocrLanguage'] = ocr_language unless ocr_language.nil?
command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
@ -1058,6 +1074,9 @@ module Google
# @param [Boolean] acknowledge_abuse
# Whether the user is acknowledging the risk of downloading known malware or
# other abusive files. This is only applicable when alt=media.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] supports_all_drives
# Whether the requesting application supports both My Drives and shared drives.
# @param [Boolean] supports_team_drives
@ -1083,7 +1102,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_file(file_id, acknowledge_abuse: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
def get_file(file_id, acknowledge_abuse: nil, include_permissions_for_view: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
if download_dest.nil?
command = make_simple_command(:get, 'files/{fileId}', options)
else
@ -1094,6 +1113,7 @@ module Google
command.response_class = Google::Apis::DriveV3::File
command.params['fileId'] = file_id unless file_id.nil?
command.query['acknowledgeAbuse'] = acknowledge_abuse unless acknowledge_abuse.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
command.query['fields'] = fields unless fields.nil?
@ -1116,6 +1136,9 @@ module Google
# ID of the shared drive to search.
# @param [Boolean] include_items_from_all_drives
# Whether both My Drive and shared drive items should be included in results.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] include_team_drive_items
# Deprecated use includeItemsFromAllDrives instead.
# @param [String] order_by
@ -1163,7 +1186,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_files(corpora: nil, corpus: nil, drive_id: nil, include_items_from_all_drives: nil, include_team_drive_items: nil, order_by: nil, page_size: nil, page_token: nil, q: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def list_files(corpora: nil, corpus: nil, drive_id: nil, include_items_from_all_drives: nil, include_permissions_for_view: nil, include_team_drive_items: nil, order_by: nil, page_size: nil, page_token: nil, q: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'files', options)
command.response_representation = Google::Apis::DriveV3::FileList::Representation
command.response_class = Google::Apis::DriveV3::FileList
@ -1171,6 +1194,7 @@ module Google
command.query['corpus'] = corpus unless corpus.nil?
command.query['driveId'] = drive_id unless drive_id.nil?
command.query['includeItemsFromAllDrives'] = include_items_from_all_drives unless include_items_from_all_drives.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['includeTeamDriveItems'] = include_team_drive_items unless include_team_drive_items.nil?
command.query['orderBy'] = order_by unless order_by.nil?
command.query['pageSize'] = page_size unless page_size.nil?
@ -1199,6 +1223,9 @@ module Google
# removed from all current folders and placed in the requested folder. Other
# requests that increase the number of parents fail, except when the
# canAddMyDriveParent file capability is true and a single parent is being added.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] keep_revision_forever
# Whether to set the 'keepForever' field in the new head revision. This is only
# applicable to files with binary content in Google Drive. Only 200 revisions
@ -1237,7 +1264,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_file(file_id, file_object = nil, add_parents: nil, enforce_single_parent: nil, keep_revision_forever: nil, ocr_language: nil, remove_parents: nil, supports_all_drives: nil, supports_team_drives: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
def update_file(file_id, file_object = nil, add_parents: nil, enforce_single_parent: nil, include_permissions_for_view: nil, keep_revision_forever: nil, ocr_language: nil, remove_parents: nil, supports_all_drives: nil, supports_team_drives: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
if upload_source.nil?
command = make_simple_command(:patch, 'files/{fileId}', options)
else
@ -1252,6 +1279,7 @@ module Google
command.params['fileId'] = file_id unless file_id.nil?
command.query['addParents'] = add_parents unless add_parents.nil?
command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['keepRevisionForever'] = keep_revision_forever unless keep_revision_forever.nil?
command.query['ocrLanguage'] = ocr_language unless ocr_language.nil?
command.query['removeParents'] = remove_parents unless remove_parents.nil?
@ -1271,6 +1299,9 @@ module Google
# @param [Boolean] acknowledge_abuse
# Whether the user is acknowledging the risk of downloading known malware or
# other abusive files. This is only applicable when alt=media.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Boolean] supports_all_drives
# Whether the requesting application supports both My Drives and shared drives.
# @param [Boolean] supports_team_drives
@ -1296,7 +1327,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def watch_file(file_id, channel_object = nil, acknowledge_abuse: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
def watch_file(file_id, channel_object = nil, acknowledge_abuse: nil, include_permissions_for_view: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
if download_dest.nil?
command = make_simple_command(:post, 'files/{fileId}/watch', options)
else
@ -1309,6 +1340,7 @@ module Google
command.response_class = Google::Apis::DriveV3::Channel
command.params['fileId'] = file_id unless file_id.nil?
command.query['acknowledgeAbuse'] = acknowledge_abuse unless acknowledge_abuse.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
command.query['fields'] = fields unless fields.nil?
@ -1489,6 +1521,9 @@ module Google
# Lists a file's or shared drive's permissions.
# @param [String] file_id
# The ID of the file or shared drive.
# @param [String] include_permissions_for_view
# Specifies which additional view's permissions to include in the response. Only
# 'published' is supported.
# @param [Fixnum] page_size
# The maximum number of permissions to return per page. When not set for files
# in a shared drive, at most 100 results will be returned. When not set for
@ -1524,11 +1559,12 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_permissions(file_id, page_size: nil, page_token: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
def list_permissions(file_id, include_permissions_for_view: nil, page_size: nil, page_token: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'files/{fileId}/permissions', options)
command.response_representation = Google::Apis::DriveV3::PermissionList::Representation
command.response_class = Google::Apis::DriveV3::PermissionList
command.params['fileId'] = file_id unless file_id.nil?
command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/firestore
module FirestoreV1
VERSION = 'V1'
REVISION = '20200709'
REVISION = '20200725'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/firestore
module FirestoreV1beta1
VERSION = 'V1beta1'
REVISION = '20200709'
REVISION = '20200725'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/genomics
module GenomicsV1
VERSION = 'V1'
REVISION = '20200727'
REVISION = '20200804'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -73,9 +73,9 @@ module Google
end
end
# An event generated when a container is forcibly terminated by the
# worker. Currently, this only occurs when the container outlives the
# timeout specified by the user.
# An event generated when a container is forcibly terminated by the worker.
# Currently, this only occurs when the container outlives the timeout specified
# by the user.
class ContainerKilledEvent
include Google::Apis::Core::Hashable
@ -103,17 +103,17 @@ module Google
# @return [Fixnum]
attr_accessor :action_id
# The public IP address that can be used to connect to the container. This
# field is only populated when at least one port mapping is present. If the
# instance was created with a private address, this field will be empty even
# if port mappings exist.
# The public IP address that can be used to connect to the container. This field
# is only populated when at least one port mapping is present. If the instance
# was created with a private address, this field will be empty even if port
# mappings exist.
# Corresponds to the JSON property `ipAddress`
# @return [String]
attr_accessor :ip_address
# The container-to-host port mappings installed for this container. This
# set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag
# as well as any specified in the `Action` definition.
# The container-to-host port mappings installed for this container. This set
# will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well
# as any specified in the `Action` definition.
# Corresponds to the JSON property `portMappings`
# @return [Hash<String,Fixnum>]
attr_accessor :port_mappings
@ -144,13 +144,13 @@ module Google
# @return [Fixnum]
attr_accessor :exit_status
# The tail end of any content written to standard error by the container.
# If the content emits large amounts of debugging noise or contains
# sensitive information, you can prevent the content from being printed by
# setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag.
# Note that only a small amount of the end of the stream is captured here.
# The entire stream is stored in the `/google/logs` directory mounted into
# each action, and can be copied off the machine as described elsewhere.
# The tail end of any content written to standard error by the container. If the
# content emits large amounts of debugging noise or contains sensitive
# information, you can prevent the content from being printed by setting the `
# DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end
# of the stream is captured here. The entire stream is stored in the `/google/
# logs` directory mounted into each action, and can be copied off the machine as
# described elsewhere.
# Corresponds to the JSON property `stderr`
# @return [String]
attr_accessor :stderr
@ -167,22 +167,22 @@ module Google
end
end
# An event generated whenever a resource limitation or transient error
# delays execution of a pipeline that was otherwise ready to run.
# An event generated whenever a resource limitation or transient error delays
# execution of a pipeline that was otherwise ready to run.
class DelayedEvent
include Google::Apis::Core::Hashable
# A textual description of the cause of the delay. The string can change
# without notice because it is often generated by another service (such as
# Compute Engine).
# A textual description of the cause of the delay. The string can change without
# notice because it is often generated by another service (such as Compute
# Engine).
# Corresponds to the JSON property `cause`
# @return [String]
attr_accessor :cause
# If the delay was caused by a resource shortage, this field lists the
# Compute Engine metrics that are preventing this operation from running
# (for example, `CPUS` or `INSTANCES`). If the particular metric is not
# known, a single `UNKNOWN` metric will be present.
# If the delay was caused by a resource shortage, this field lists the Compute
# Engine metrics that are preventing this operation from running (for example, `
# CPUS` or `INSTANCES`). If the particular metric is not known, a single `
# UNKNOWN` metric will be present.
# Corresponds to the JSON property `metrics`
# @return [Array<String>]
attr_accessor :metrics
@ -198,13 +198,11 @@ module Google
end
end
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
@ -221,9 +219,9 @@ module Google
class Event
include Google::Apis::Core::Hashable
# A human-readable description of the event. Note that these strings can
# change at any time without notice. Any application logic must use the
# information in the `details` field.
# A human-readable description of the event. Note that these strings can change
# at any time without notice. Any application logic must use the information in
# the `details` field.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
@ -250,8 +248,8 @@ module Google
end
end
# An event generated when the execution of a pipeline has failed. Note
# that other events can continue to occur after this event.
# An event generated when the execution of a pipeline has failed. Note that
# other events can continue to occur after this event.
class FailedEvent
include Google::Apis::Core::Hashable
@ -306,20 +304,19 @@ module Google
class Operation
include Google::Apis::Core::Hashable
# 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.
# 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.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# 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).
# 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).
# Corresponds to the JSON property `error`
# @return [Google::Apis::GenomicsV1::Status]
attr_accessor :error
@ -331,7 +328,7 @@ module Google
attr_accessor :metadata
# The server-assigned name, which is only unique within the same service that
# originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-
# originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-
# qzoWAgEw`
# Corresponds to the JSON property `name`
# @return [String]
@ -408,15 +405,14 @@ module Google
# @return [String]
attr_accessor :end_time
# Optional event messages that were generated during the job's execution.
# This also contains any warnings that were generated during import
# or export.
# Optional event messages that were generated during the job's execution. This
# also contains any warnings that were generated during import or export.
# Corresponds to the JSON property `events`
# @return [Array<Google::Apis::GenomicsV1::OperationEvent>]
attr_accessor :events
# Optionally provided by the caller when submitting the request that creates
# the operation.
# Optionally provided by the caller when submitting the request that creates the
# operation.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
@ -427,8 +423,8 @@ module Google
attr_accessor :project_id
# The original request that started the operation. Note that this will be in
# current version of the API. If the operation was started with v1beta2 API
# and a GetOperation is performed on v1 API, a v1 request will be returned.
# current version of the API. If the operation was started with v1beta2 API and
# a GetOperation is performed on v1 API, a v1 request will be returned.
# Corresponds to the JSON property `request`
# @return [Hash<String,Object>]
attr_accessor :request
@ -513,9 +509,8 @@ module Google
end
end
# Runtime metadata that will be populated in the
# runtimeMetadata
# field of the Operation associated with a RunPipeline execution.
# Runtime metadata that will be populated in the runtimeMetadata field of the
# Operation associated with a RunPipeline execution.
class RuntimeMetadata
include Google::Apis::Core::Hashable
@ -535,12 +530,12 @@ module Google
end
end
# 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).
# 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).
class Status
include Google::Apis::Core::Hashable
@ -549,15 +544,15 @@ module Google
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# A developer-facing error message, which should be in English. Any user-facing
# error message should be localized and sent in the google.rpc.Status.details
# field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
@ -574,10 +569,10 @@ module Google
end
end
# An event generated when the execution of a container results in a
# non-zero exit status that was not otherwise ignored. Execution will
# continue, but only actions that are flagged as `ALWAYS_RUN` will be
# executed. Other actions will be skipped.
# An event generated when the execution of a container results in a non-zero
# exit status that was not otherwise ignored. Execution will continue, but only
# actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will
# be skipped.
class UnexpectedExitStatusEvent
include Google::Apis::Core::Hashable
@ -602,8 +597,7 @@ module Google
end
end
# An event generated after a worker VM has been assigned to run the
# pipeline.
# An event generated after a worker VM has been assigned to run the pipeline.
class WorkerAssignedEvent
include Google::Apis::Core::Hashable
@ -634,8 +628,8 @@ module Google
end
end
# An event generated when the worker VM that was assigned to the pipeline
# has been released (deleted).
# An event generated when the worker VM that was assigned to the pipeline has
# been released (deleted).
class WorkerReleasedEvent
include Google::Apis::Core::Hashable

View File

@ -47,15 +47,12 @@ module Google
@batch_path = 'batch'
end
# 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.
# 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&#58;
# * `genomics.operations.cancel`
# permission: * `genomics.operations.cancel`
# @param [String] name
# The name of the operation resource to be cancelled.
# @param [Google::Apis::GenomicsV1::CancelOperationRequest] cancel_operation_request_object
@ -88,12 +85,10 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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&#58;
# * `genomics.operations.get`
# permission: * `genomics.operations.get`
# @param [String] name
# The name of the operation resource.
# @param [String] fields
@ -123,39 +118,29 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists operations that match the specified filter in the request.
# Authorization requires the following [Google IAM](https://cloud.google.com/iam)
# permission&#58;
# * `genomics.operations.list`
# Lists operations that match the specified filter in the request. Authorization
# requires the following [Google IAM](https://cloud.google.com/iam) permission: *
# `genomics.operations.list`
# @param [String] name
# The name of the operation's parent resource.
# @param [String] filter
# A string for filtering Operations.
# In v2alpha1, the following filter fields are supported&#58;
# * createTime&#58; The time this job was created
# * events&#58; The set of event (names) that have occurred while running
# the pipeline. The &#58; operator can be used to determine if a
# particular event has occurred.
# * error&#58; If the pipeline is running, this value is NULL. Once the
# pipeline finishes, the value is the standard Google error code.
# * labels.key or labels."key with space" where key is a label key.
# * done&#58; If the pipeline is running, this value is false. Once the
# pipeline finishes, the value is true.
# In v1 and v1alpha2, the following filter fields are supported&#58;
# * projectId&#58; Required. Corresponds to
# OperationMetadata.projectId.
# * createTime&#58; The time this job was created, in seconds from the
# [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=`
# operators.
# * status&#58; Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only
# one status may be specified.
# * labels.key where key is a label key.
# Examples&#58;
# * `projectId = my-project AND createTime >= 1432140000`
# * `projectId = my-project AND createTime >= 1432140000 AND createTime <=
# 1432150000 AND status = RUNNING`
# * `projectId = my-project AND labels.color = *`
# * `projectId = my-project AND labels.color = red`
# A string for filtering Operations. In v2alpha1, the following filter fields
# are supported: * createTime: The time this job was created * events: The set
# of event (names) that have occurred while running the pipeline. The : operator
# can be used to determine if a particular event has occurred. * error: If the
# pipeline is running, this value is NULL. Once the pipeline finishes, the value
# is the standard Google error code. * labels.key or labels."key with space"
# where key is a label key. * done: If the pipeline is running, this value is
# false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the
# following filter fields are supported: * projectId: Required. Corresponds to
# OperationMetadata.projectId. * createTime: The time this job was created, in
# seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=`
# and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `
# CANCELED`. Only one status may be specified. * labels.key where key is a label
# key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `
# projectId = my-project AND createTime >= 1432140000 AND createTime <=
# 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *
# ` * `projectId = my-project AND labels.color = red`
# @param [Fixnum] page_size
# The maximum number of results to return. The maximum value is 256.
# @param [String] page_token

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/genomics
module GenomicsV1alpha2
VERSION = 'V1alpha2'
REVISION = '20200727'
REVISION = '20200804'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -73,9 +73,9 @@ module Google
end
end
# An event generated when a container is forcibly terminated by the
# worker. Currently, this only occurs when the container outlives the
# timeout specified by the user.
# An event generated when a container is forcibly terminated by the worker.
# Currently, this only occurs when the container outlives the timeout specified
# by the user.
class ContainerKilledEvent
include Google::Apis::Core::Hashable
@ -103,17 +103,17 @@ module Google
# @return [Fixnum]
attr_accessor :action_id
# The public IP address that can be used to connect to the container. This
# field is only populated when at least one port mapping is present. If the
# instance was created with a private address, this field will be empty even
# if port mappings exist.
# The public IP address that can be used to connect to the container. This field
# is only populated when at least one port mapping is present. If the instance
# was created with a private address, this field will be empty even if port
# mappings exist.
# Corresponds to the JSON property `ipAddress`
# @return [String]
attr_accessor :ip_address
# The container-to-host port mappings installed for this container. This
# set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag
# as well as any specified in the `Action` definition.
# The container-to-host port mappings installed for this container. This set
# will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well
# as any specified in the `Action` definition.
# Corresponds to the JSON property `portMappings`
# @return [Hash<String,Fixnum>]
attr_accessor :port_mappings
@ -144,13 +144,13 @@ module Google
# @return [Fixnum]
attr_accessor :exit_status
# The tail end of any content written to standard error by the container.
# If the content emits large amounts of debugging noise or contains
# sensitive information, you can prevent the content from being printed by
# setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag.
# Note that only a small amount of the end of the stream is captured here.
# The entire stream is stored in the `/google/logs` directory mounted into
# each action, and can be copied off the machine as described elsewhere.
# The tail end of any content written to standard error by the container. If the
# content emits large amounts of debugging noise or contains sensitive
# information, you can prevent the content from being printed by setting the `
# DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end
# of the stream is captured here. The entire stream is stored in the `/google/
# logs` directory mounted into each action, and can be copied off the machine as
# described elsewhere.
# Corresponds to the JSON property `stderr`
# @return [String]
attr_accessor :stderr
@ -167,9 +167,9 @@ module Google
end
end
# Stores the information that the controller will fetch from the
# server in order to run. Should only be used by VMs created by the
# Pipelines Service and not by end users.
# Stores the information that the controller will fetch from the server in order
# to run. Should only be used by VMs created by the Pipelines Service and not by
# end users.
class ControllerConfig
include Google::Apis::Core::Hashable
@ -230,22 +230,22 @@ module Google
end
end
# An event generated whenever a resource limitation or transient error
# delays execution of a pipeline that was otherwise ready to run.
# An event generated whenever a resource limitation or transient error delays
# execution of a pipeline that was otherwise ready to run.
class DelayedEvent
include Google::Apis::Core::Hashable
# A textual description of the cause of the delay. The string can change
# without notice because it is often generated by another service (such as
# Compute Engine).
# A textual description of the cause of the delay. The string can change without
# notice because it is often generated by another service (such as Compute
# Engine).
# Corresponds to the JSON property `cause`
# @return [String]
attr_accessor :cause
# If the delay was caused by a resource shortage, this field lists the
# Compute Engine metrics that are preventing this operation from running
# (for example, `CPUS` or `INSTANCES`). If the particular metric is not
# known, a single `UNKNOWN` metric will be present.
# If the delay was caused by a resource shortage, this field lists the Compute
# Engine metrics that are preventing this operation from running (for example, `
# CPUS` or `INSTANCES`). If the particular metric is not known, a single `
# UNKNOWN` metric will be present.
# Corresponds to the JSON property `metrics`
# @return [Array<String>]
attr_accessor :metrics
@ -265,51 +265,45 @@ module Google
class Disk
include Google::Apis::Core::Hashable
# Deprecated. Disks created by the Pipelines API will be deleted at the end
# of the pipeline run, regardless of what this field is set to.
# Deprecated. Disks created by the Pipelines API will be deleted at the end of
# the pipeline run, regardless of what this field is set to.
# Corresponds to the JSON property `autoDelete`
# @return [Boolean]
attr_accessor :auto_delete
alias_method :auto_delete?, :auto_delete
# Required at create time and cannot be overridden at run time.
# Specifies the path in the docker container where files on
# this disk should be located. For example, if `mountPoint`
# is `/mnt/disk`, and the parameter has `localPath`
# `inputs/file.txt`, the docker container can access the data at
# `/mnt/disk/inputs/file.txt`.
# Required at create time and cannot be overridden at run time. Specifies the
# path in the docker container where files on this disk should be located. For
# example, if `mountPoint` is `/mnt/disk`, and the parameter has `localPath` `
# inputs/file.txt`, the docker container can access the data at `/mnt/disk/
# inputs/file.txt`.
# Corresponds to the JSON property `mountPoint`
# @return [String]
attr_accessor :mount_point
# Required. The name of the disk that can be used in the pipeline
# parameters. Must be 1 - 63 characters.
# The name "boot" is reserved for system use.
# Required. The name of the disk that can be used in the pipeline parameters.
# Must be 1 - 63 characters. The name "boot" is reserved for system use.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Specifies how a sourced-base persistent disk will be mounted. See
# https://cloud.google.com/compute/docs/disks/persistent-disks#
# use_multi_instances
# for more details.
# Can only be set at create time.
# Specifies how a sourced-base persistent disk will be mounted. See https://
# cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances for
# more details. Can only be set at create time.
# Corresponds to the JSON property `readOnly`
# @return [Boolean]
attr_accessor :read_only
alias_method :read_only?, :read_only
# The size of the disk. Defaults to 500 (GB).
# This field is not applicable for local SSD.
# The size of the disk. Defaults to 500 (GB). This field is not applicable for
# local SSD.
# Corresponds to the JSON property `sizeGb`
# @return [Fixnum]
attr_accessor :size_gb
# The full or partial URL of the persistent disk to attach. See
# https://cloud.google.com/compute/docs/reference/latest/instances#resource
# and
# https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots
# for more details.
# The full or partial URL of the persistent disk to attach. See https://cloud.
# google.com/compute/docs/reference/latest/instances#resource and https://cloud.
# google.com/compute/docs/disks/persistent-disks#snapshots for more details.
# Corresponds to the JSON property `source`
# @return [String]
attr_accessor :source
@ -339,12 +333,11 @@ module Google
class DockerExecutor
include Google::Apis::Core::Hashable
# Required. The command or newline delimited script to run. The command
# string will be executed within a bash shell.
# If the command exits with a non-zero exit code, output parameter
# de-localization will be skipped and the pipeline operation's
# `error` field will be populated.
# Maximum command string length is 16384.
# Required. The command or newline delimited script to run. The command string
# will be executed within a bash shell. If the command exits with a non-zero
# exit code, output parameter de-localization will be skipped and the pipeline
# operation's `error` field will be populated. Maximum command string length is
# 16384.
# Corresponds to the JSON property `cmd`
# @return [String]
attr_accessor :cmd
@ -366,13 +359,11 @@ module Google
end
end
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
@ -389,9 +380,9 @@ module Google
class Event
include Google::Apis::Core::Hashable
# A human-readable description of the event. Note that these strings can
# change at any time without notice. Any application logic must use the
# information in the `details` field.
# A human-readable description of the event. Note that these strings can change
# at any time without notice. Any application logic must use the information in
# the `details` field.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
@ -418,8 +409,8 @@ module Google
end
end
# An event generated when the execution of a pipeline has failed. Note
# that other events can continue to occur after this event.
# An event generated when the execution of a pipeline has failed. Note that
# other events can continue to occur after this event.
class FailedEvent
include Google::Apis::Core::Hashable
@ -469,11 +460,10 @@ module Google
end
end
# The response of ListPipelines. Contains at most `pageSize`
# pipelines. If it contains `pageSize` pipelines, and more pipelines
# exist, then `nextPageToken` will be populated and should be
# used as the `pageToken` argument to a subsequent ListPipelines
# request.
# The response of ListPipelines. Contains at most `pageSize` pipelines. If it
# contains `pageSize` pipelines, and more pipelines exist, then `nextPageToken`
# will be populated and should be used as the `pageToken` argument to a
# subsequent ListPipelines request.
class ListPipelinesResponse
include Google::Apis::Core::Hashable
@ -502,17 +492,16 @@ module Google
class LocalCopy
include Google::Apis::Core::Hashable
# Required. The name of the disk where this parameter is
# located. Can be the name of one of the disks specified in the
# Resources field, or "boot", which represents the Docker
# instance's boot disk and has a mount point of `/`.
# Required. The name of the disk where this parameter is located. Can be the
# name of one of the disks specified in the Resources field, or "boot", which
# represents the Docker instance's boot disk and has a mount point of `/`.
# Corresponds to the JSON property `disk`
# @return [String]
attr_accessor :disk
# Required. The path within the user's docker container where
# this input should be localized to and from, relative to the specified
# disk's mount point. For example: file.txt,
# Required. The path within the user's docker container where this input should
# be localized to and from, relative to the specified disk's mount point. For
# example: file.txt,
# Corresponds to the JSON property `path`
# @return [String]
attr_accessor :path
@ -532,14 +521,13 @@ module Google
class LoggingOptions
include Google::Apis::Core::Hashable
# The location in Google Cloud Storage to which the pipeline logs
# will be copied. Can be specified as a fully qualified directory
# path, in which case logs will be output with a unique identifier
# as the filename in that directory, or as a fully specified path,
# which must end in `.log`, in which case that path will be
# used, and the user must ensure that logs are not
# overwritten. Stdout and stderr logs from the run are also
# generated and output as `-stdout.log` and `-stderr.log`.
# The location in Google Cloud Storage to which the pipeline logs will be copied.
# Can be specified as a fully qualified directory path, in which case logs will
# be output with a unique identifier as the filename in that directory, or as a
# fully specified path, which must end in `.log`, in which case that path will
# be used, and the user must ensure that logs are not overwritten. Stdout and
# stderr logs from the run are also generated and output as `-stdout.log` and `-
# stderr.log`.
# Corresponds to the JSON property `gcsPath`
# @return [String]
attr_accessor :gcs_path
@ -559,20 +547,19 @@ module Google
class Operation
include Google::Apis::Core::Hashable
# 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.
# 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.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# 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).
# 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).
# Corresponds to the JSON property `error`
# @return [Google::Apis::GenomicsV1alpha2::Status]
attr_accessor :error
@ -584,7 +571,7 @@ module Google
attr_accessor :metadata
# The server-assigned name, which is only unique within the same service that
# originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-
# originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-
# qzoWAgEw`
# Corresponds to the JSON property `name`
# @return [String]
@ -661,15 +648,14 @@ module Google
# @return [String]
attr_accessor :end_time
# Optional event messages that were generated during the job's execution.
# This also contains any warnings that were generated during import
# or export.
# Optional event messages that were generated during the job's execution. This
# also contains any warnings that were generated during import or export.
# Corresponds to the JSON property `events`
# @return [Array<Google::Apis::GenomicsV1alpha2::OperationEvent>]
attr_accessor :events
# Optionally provided by the caller when submitting the request that creates
# the operation.
# Optionally provided by the caller when submitting the request that creates the
# operation.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
@ -680,8 +666,8 @@ module Google
attr_accessor :project_id
# The original request that started the operation. Note that this will be in
# current version of the API. If the operation was started with v1beta2 API
# and a GetOperation is performed on v1 API, a v1 request will be returned.
# current version of the API. If the operation was started with v1beta2 API and
# a GetOperation is performed on v1 API, a v1 request will be returned.
# Corresponds to the JSON property `request`
# @return [Hash<String,Object>]
attr_accessor :request
@ -715,11 +701,11 @@ module Google
end
# The pipeline object. Represents a transformation from a set of input
# parameters to a set of output parameters. The transformation is defined
# as a docker image and command to run within that image. Each pipeline
# is run on a Google Compute Engine VM. A pipeline can be created with the
# `create` method and then later run with the `run` method, or a pipeline can
# be defined and run all at once with the `run` method.
# parameters to a set of output parameters. The transformation is defined as a
# docker image and command to run within that image. Each pipeline is run on a
# Google Compute Engine VM. A pipeline can be created with the `create` method
# and then later run with the `run` method, or a pipeline can be defined and run
# all at once with the `run` method.
class Pipeline
include Google::Apis::Core::Hashable
@ -738,8 +724,8 @@ module Google
# @return [Array<Google::Apis::GenomicsV1alpha2::PipelineParameter>]
attr_accessor :input_parameters
# Required. A user specified pipeline name that does not have to be unique.
# This name can be used for filtering Pipelines in ListPipelines.
# Required. A user specified pipeline name that does not have to be unique. This
# name can be used for filtering Pipelines in ListPipelines.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -749,11 +735,10 @@ module Google
# @return [Array<Google::Apis::GenomicsV1alpha2::PipelineParameter>]
attr_accessor :output_parameters
# Unique pipeline id that is generated by the service when CreatePipeline
# is called. Cannot be specified in the Pipeline used in the
# CreatePipelineRequest, and will be populated in the response to
# CreatePipeline and all subsequent Get and List calls. Indicates that the
# service has registered this pipeline.
# Unique pipeline id that is generated by the service when CreatePipeline is
# called. Cannot be specified in the Pipeline used in the CreatePipelineRequest,
# and will be populated in the response to CreatePipeline and all subsequent Get
# and List calls. Indicates that the service has registered this pipeline.
# Corresponds to the JSON property `pipelineId`
# @return [String]
attr_accessor :pipeline_id
@ -786,85 +771,45 @@ module Google
end
end
# Parameters facilitate setting and delivering data into the
# pipeline's execution environment. They are defined at create time,
# with optional defaults, and can be overridden at run time.
# If `localCopy` is unset, then the parameter specifies a string that
# is passed as-is into the pipeline, as the value of the environment
# variable with the given name. A default value can be optionally
# specified at create time. The default can be overridden at run time
# using the inputs map. If no default is given, a value must be
# supplied at runtime.
# If `localCopy` is defined, then the parameter specifies a data
# source or sink, both in Google Cloud Storage and on the Docker container
# where the pipeline computation is run. The service account associated with
# the Pipeline (by
# default the project's Compute Engine service account) must have access to the
# Google Cloud Storage paths.
# At run time, the Google Cloud Storage paths can be overridden if a default
# was provided at create time, or must be set otherwise. The pipeline runner
# should add a key/value pair to either the inputs or outputs map. The
# indicated data copies will be carried out before/after pipeline execution,
# just as if the corresponding arguments were provided to `gsutil cp`.
# For example: Given the following `PipelineParameter`, specified
# in the `inputParameters` list:
# ```
# `name: "input_file", localCopy: `path: "file.txt", disk: "pd1"``
# ```
# where `disk` is defined in the `PipelineResources` object as:
# ```
# `name: "pd1", mountPoint: "/mnt/disk/"`
# ```
# We create a disk named `pd1`, mount it on the host VM, and map
# `/mnt/pd1` to `/mnt/disk` in the docker container. At
# runtime, an entry for `input_file` would be required in the inputs
# map, such as:
# ```
# inputs["input_file"] = "gs://my-bucket/bar.txt"
# ```
# This would generate the following gsutil call:
# ```
# gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt
# ```
# The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the
# Docker container. Acceptable paths are:
# <table>
# <thead>
# <tr><th>Google Cloud storage path</th><th>Local path</th></tr>
# </thead>
# <tbody>
# <tr><td>file</td><td>file</td></tr>
# <tr><td>glob</td><td>directory</td></tr>
# </tbody>
# </table>
# For outputs, the direction of the copy is reversed:
# ```
# gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt
# ```
# Acceptable paths are:
# <table>
# <thead>
# <tr><th>Local path</th><th>Google Cloud Storage path</th></tr>
# </thead>
# <tbody>
# <tr><td>file</td><td>file</td></tr>
# <tr>
# <td>file</td>
# <td>directory - directory must already exist</td>
# </tr>
# <tr>
# <td>glob</td>
# <td>directory - directory will be created if it doesn't exist</td></tr>
# </tbody>
# </table>
# One restriction due to docker limitations, is that for outputs that are found
# on the boot disk, the local path cannot be a glob and must be a file.
# Parameters facilitate setting and delivering data into the pipeline's
# execution environment. They are defined at create time, with optional defaults,
# and can be overridden at run time. If `localCopy` is unset, then the
# parameter specifies a string that is passed as-is into the pipeline, as the
# value of the environment variable with the given name. A default value can be
# optionally specified at create time. The default can be overridden at run time
# using the inputs map. If no default is given, a value must be supplied at
# runtime. If `localCopy` is defined, then the parameter specifies a data source
# or sink, both in Google Cloud Storage and on the Docker container where the
# pipeline computation is run. The service account associated with the Pipeline (
# by default the project's Compute Engine service account) must have access to
# the Google Cloud Storage paths. At run time, the Google Cloud Storage paths
# can be overridden if a default was provided at create time, or must be set
# otherwise. The pipeline runner should add a key/value pair to either the
# inputs or outputs map. The indicated data copies will be carried out before/
# after pipeline execution, just as if the corresponding arguments were provided
# to `gsutil cp`. For example: Given the following `PipelineParameter`,
# specified in the `inputParameters` list: ``` `name: "input_file", localCopy: `
# path: "file.txt", disk: "pd1"`` ``` where `disk` is defined in the `
# PipelineResources` object as: ``` `name: "pd1", mountPoint: "/mnt/disk/"` ```
# We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/
# mnt/disk` in the docker container. At runtime, an entry for `input_file` would
# be required in the inputs map, such as: ``` inputs["input_file"] = "gs://my-
# bucket/bar.txt" ``` This would generate the following gsutil call: ``` gsutil
# cp gs://my-bucket/bar.txt /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt`
# maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are:
# Google Cloud storage pathLocal path file file glob directory For outputs, the
# direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my-
# bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path
# file file file directory - directory must already exist glob directory -
# directory will be created if it doesn't exist One restriction due to docker
# limitations, is that for outputs that are found on the boot disk, the local
# path cannot be a glob and must be a file.
class PipelineParameter
include Google::Apis::Core::Hashable
# The default value for this parameter. Can be overridden at runtime.
# If `localCopy` is present, then this must be a Google Cloud Storage path
# beginning with `gs://`.
# The default value for this parameter. Can be overridden at runtime. If `
# localCopy` is present, then this must be a Google Cloud Storage path beginning
# with `gs://`.
# Corresponds to the JSON property `defaultValue`
# @return [String]
attr_accessor :default_value
@ -879,8 +824,8 @@ module Google
# @return [Google::Apis::GenomicsV1alpha2::LocalCopy]
attr_accessor :local_copy
# Required. Name of the parameter - the pipeline runner uses this string
# as the key to the input and output maps in RunPipeline.
# Required. Name of the parameter - the pipeline runner uses this string as the
# key to the input and output maps in RunPipeline.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -902,20 +847,19 @@ module Google
class PipelineResources
include Google::Apis::Core::Hashable
# Optional. The number of accelerators of the specified type to attach.
# By specifying this parameter, you will download and install the following
# third-party software onto your managed Compute Engine instances:
# NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit.
# Optional. The number of accelerators of the specified type to attach. By
# specifying this parameter, you will download and install the following third-
# party software onto your managed Compute Engine instances: NVIDIA® Tesla®
# drivers and NVIDIA® CUDA toolkit.
# Corresponds to the JSON property `acceleratorCount`
# @return [Fixnum]
attr_accessor :accelerator_count
# Optional. The Compute Engine defined accelerator type.
# By specifying this parameter, you will download and install the following
# third-party software onto your managed Compute Engine instances: NVIDIA®
# Tesla® drivers and NVIDIA® CUDA toolkit.
# Please see https://cloud.google.com/compute/docs/gpus/ for a list of
# available accelerator types.
# Optional. The Compute Engine defined accelerator type. By specifying this
# parameter, you will download and install the following third-party software
# onto your managed Compute Engine instances: NVIDIA® Tesla® drivers and NVIDIA®
# CUDA toolkit. Please see https://cloud.google.com/compute/docs/gpus/ for a
# list of available accelerator types.
# Corresponds to the JSON property `acceleratorType`
# @return [String]
attr_accessor :accelerator_type
@ -941,17 +885,16 @@ module Google
attr_accessor :minimum_ram_gb
# Whether to assign an external IP to the instance. This is an experimental
# feature that may go away. Defaults to false.
# Corresponds to `--no_address` flag for [gcloud compute instances create]
# (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create).
# In order to use this, must be true for both create time and run time.
# Cannot be true at run time if false at create time. If you need to ssh into
# a private IP VM for debugging, you can ssh to a public VM and then ssh into
# the private VM's Internal IP. If noAddress is set, this pipeline run may
# only load docker images from Google Container Registry and not Docker Hub.
# Before using this, you must
# [configure access to Google services from internal
# IPs](https://cloud.google.com/compute/docs/configure-private-google-access#
# feature that may go away. Defaults to false. Corresponds to `--no_address`
# flag for [gcloud compute instances create] (https://cloud.google.com/sdk/
# gcloud/reference/compute/instances/create). In order to use this, must be true
# for both create time and run time. Cannot be true at run time if false at
# create time. If you need to ssh into a private IP VM for debugging, you can
# ssh to a public VM and then ssh into the private VM's Internal IP. If
# noAddress is set, this pipeline run may only load docker images from Google
# Container Registry and not Docker Hub. Before using this, you must [configure
# access to Google services from internal IPs](https://cloud.google.com/compute/
# docs/configure-private-google-access#
# configuring_access_to_google_services_from_internal_ips).
# Corresponds to the JSON property `noAddress`
# @return [Boolean]
@ -959,15 +902,15 @@ module Google
alias_method :no_address?, :no_address
# Whether to use preemptible VMs. Defaults to `false`. In order to use this,
# must be true for both create time and run time. Cannot be true at run time
# if false at create time.
# must be true for both create time and run time. Cannot be true at run time if
# false at create time.
# Corresponds to the JSON property `preemptible`
# @return [Boolean]
attr_accessor :preemptible
alias_method :preemptible?, :preemptible
# List of Google Compute Engine availability zones to which resource
# creation will restricted. If empty, any zone may be chosen.
# List of Google Compute Engine availability zones to which resource creation
# will restricted. If empty, any zone may be chosen.
# Corresponds to the JSON property `zones`
# @return [Array<String>]
attr_accessor :zones
@ -1057,32 +1000,29 @@ module Google
# @return [String]
attr_accessor :client_id
# Pipeline input arguments; keys are defined in the pipeline documentation.
# All input parameters that do not have default values must be specified.
# If parameters with defaults are specified here, the defaults will be
# overridden.
# Pipeline input arguments; keys are defined in the pipeline documentation. All
# input parameters that do not have default values must be specified. If
# parameters with defaults are specified here, the defaults will be overridden.
# Corresponds to the JSON property `inputs`
# @return [Hash<String,String>]
attr_accessor :inputs
# How long to keep the VM up after a failure (for example docker command
# failed, copying input or output files failed, etc). While the VM is up, one
# can ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.
# How long to keep the VM up after a failure (for example docker command failed,
# copying input or output files failed, etc). While the VM is up, one can ssh
# into the VM to debug. Default is 0; maximum allowed value is 1 day.
# Corresponds to the JSON property `keepVmAliveOnFailureDuration`
# @return [String]
attr_accessor :keep_vm_alive_on_failure_duration
# Labels to apply to this pipeline run. Labels will also be applied to
# compute resources (VM, disks) created by this pipeline run. When listing
# operations, operations can filtered by labels.
# Label keys may not be empty; label values may be empty. Non-empty labels
# must be 1-63 characters long, and comply with [RFC1035]
# (https://www.ietf.org/rfc/rfc1035.txt).
# 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.
# Labels to apply to this pipeline run. Labels will also be applied to compute
# resources (VM, disks) created by this pipeline run. When listing operations,
# operations can filtered by labels. Label keys may not be empty; label values
# may be empty. Non-empty labels must be 1-63 characters long, and comply with [
# RFC1035] (https://www.ietf.org/rfc/rfc1035.txt). 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.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
@ -1092,17 +1032,16 @@ module Google
# @return [Google::Apis::GenomicsV1alpha2::LoggingOptions]
attr_accessor :logging
# Pipeline output arguments; keys are defined in the pipeline
# documentation. All output parameters of without default values
# must be specified. If parameters with defaults are specified
# here, the defaults will be overridden.
# Pipeline output arguments; keys are defined in the pipeline documentation. All
# output parameters of without default values must be specified. If parameters
# with defaults are specified here, the defaults will be overridden.
# Corresponds to the JSON property `outputs`
# @return [Hash<String,String>]
attr_accessor :outputs
# Required. The project in which to run the pipeline. The caller must have
# WRITER access to all Google Cloud services and resources (e.g. Google
# Compute Engine) will be used.
# WRITER access to all Google Cloud services and resources (e.g. Google Compute
# Engine) will be used.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
@ -1135,22 +1074,20 @@ module Google
end
end
# The request to run a pipeline. If `pipelineId` is specified, it
# refers to a saved pipeline created with CreatePipeline and set as
# the `pipelineId` of the returned Pipeline object. If
# `ephemeralPipeline` is specified, that pipeline is run once
# with the given args and not saved. It is an error to specify both
# `pipelineId` and `ephemeralPipeline`. `pipelineArgs`
# must be specified.
# The request to run a pipeline. If `pipelineId` is specified, it refers to a
# saved pipeline created with CreatePipeline and set as the `pipelineId` of the
# returned Pipeline object. If `ephemeralPipeline` is specified, that pipeline
# is run once with the given args and not saved. It is an error to specify both `
# pipelineId` and `ephemeralPipeline`. `pipelineArgs` must be specified.
class RunPipelineRequest
include Google::Apis::Core::Hashable
# The pipeline object. Represents a transformation from a set of input
# parameters to a set of output parameters. The transformation is defined
# as a docker image and command to run within that image. Each pipeline
# is run on a Google Compute Engine VM. A pipeline can be created with the
# `create` method and then later run with the `run` method, or a pipeline can
# be defined and run all at once with the `run` method.
# parameters to a set of output parameters. The transformation is defined as a
# docker image and command to run within that image. Each pipeline is run on a
# Google Compute Engine VM. A pipeline can be created with the `create` method
# and then later run with the `run` method, or a pipeline can be defined and run
# all at once with the `run` method.
# Corresponds to the JSON property `ephemeralPipeline`
# @return [Google::Apis::GenomicsV1alpha2::Pipeline]
attr_accessor :ephemeral_pipeline
@ -1191,9 +1128,8 @@ module Google
end
end
# Runtime metadata that will be populated in the
# runtimeMetadata
# field of the Operation associated with a RunPipeline execution.
# Runtime metadata that will be populated in the runtimeMetadata field of the
# Operation associated with a RunPipeline execution.
class RuntimeMetadata
include Google::Apis::Core::Hashable
@ -1217,19 +1153,17 @@ module Google
class ServiceAccount
include Google::Apis::Core::Hashable
# Email address of the service account. Defaults to `default`,
# which uses the compute service account associated with the project.
# Email address of the service account. Defaults to `default`, which uses the
# compute service account associated with the project.
# Corresponds to the JSON property `email`
# @return [String]
attr_accessor :email
# List of scopes to be enabled for this service account on the VM.
# The following scopes are automatically included:
# * https://www.googleapis.com/auth/compute
# * https://www.googleapis.com/auth/devstorage.full_control
# * https://www.googleapis.com/auth/genomics
# * https://www.googleapis.com/auth/logging.write
# * https://www.googleapis.com/auth/monitoring.write
# List of scopes to be enabled for this service account on the VM. The following
# scopes are automatically included: * https://www.googleapis.com/auth/compute *
# https://www.googleapis.com/auth/devstorage.full_control * https://www.
# googleapis.com/auth/genomics * https://www.googleapis.com/auth/logging.write *
# https://www.googleapis.com/auth/monitoring.write
# Corresponds to the JSON property `scopes`
# @return [Array<String>]
attr_accessor :scopes
@ -1245,8 +1179,8 @@ module Google
end
end
# Request to set operation status. Should only be used by VMs
# created by the Pipelines Service and not by end users.
# Request to set operation status. Should only be used by VMs created by the
# Pipelines Service and not by end users.
class SetOperationStatusRequest
include Google::Apis::Core::Hashable
@ -1289,12 +1223,12 @@ module Google
end
end
# 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).
# 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).
class Status
include Google::Apis::Core::Hashable
@ -1303,15 +1237,15 @@ module Google
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# A developer-facing error message, which should be in English. Any user-facing
# error message should be localized and sent in the google.rpc.Status.details
# field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
@ -1354,10 +1288,10 @@ module Google
end
end
# An event generated when the execution of a container results in a
# non-zero exit status that was not otherwise ignored. Execution will
# continue, but only actions that are flagged as `ALWAYS_RUN` will be
# executed. Other actions will be skipped.
# An event generated when the execution of a container results in a non-zero
# exit status that was not otherwise ignored. Execution will continue, but only
# actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will
# be skipped.
class UnexpectedExitStatusEvent
include Google::Apis::Core::Hashable
@ -1382,8 +1316,7 @@ module Google
end
end
# An event generated after a worker VM has been assigned to run the
# pipeline.
# An event generated after a worker VM has been assigned to run the pipeline.
class WorkerAssignedEvent
include Google::Apis::Core::Hashable
@ -1414,8 +1347,8 @@ module Google
end
end
# An event generated when the worker VM that was assigned to the pipeline
# has been released (deleted).
# An event generated when the worker VM that was assigned to the pipeline has
# been released (deleted).
class WorkerReleasedEvent
include Google::Apis::Core::Hashable

View File

@ -47,15 +47,12 @@ module Google
@batch_path = 'batch'
end
# 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.
# 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&#58;
# * `genomics.operations.cancel`
# permission: * `genomics.operations.cancel`
# @param [String] name
# The name of the operation resource to be cancelled.
# @param [Google::Apis::GenomicsV1alpha2::CancelOperationRequest] cancel_operation_request_object
@ -88,12 +85,10 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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&#58;
# * `genomics.operations.get`
# permission: * `genomics.operations.get`
# @param [String] name
# The name of the operation resource.
# @param [String] fields
@ -123,39 +118,29 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists operations that match the specified filter in the request.
# Authorization requires the following [Google IAM](https://cloud.google.com/iam)
# permission&#58;
# * `genomics.operations.list`
# Lists operations that match the specified filter in the request. Authorization
# requires the following [Google IAM](https://cloud.google.com/iam) permission: *
# `genomics.operations.list`
# @param [String] name
# The name of the operation's parent resource.
# @param [String] filter
# A string for filtering Operations.
# In v2alpha1, the following filter fields are supported&#58;
# * createTime&#58; The time this job was created
# * events&#58; The set of event (names) that have occurred while running
# the pipeline. The &#58; operator can be used to determine if a
# particular event has occurred.
# * error&#58; If the pipeline is running, this value is NULL. Once the
# pipeline finishes, the value is the standard Google error code.
# * labels.key or labels."key with space" where key is a label key.
# * done&#58; If the pipeline is running, this value is false. Once the
# pipeline finishes, the value is true.
# In v1 and v1alpha2, the following filter fields are supported&#58;
# * projectId&#58; Required. Corresponds to
# OperationMetadata.projectId.
# * createTime&#58; The time this job was created, in seconds from the
# [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=`
# operators.
# * status&#58; Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only
# one status may be specified.
# * labels.key where key is a label key.
# Examples&#58;
# * `projectId = my-project AND createTime >= 1432140000`
# * `projectId = my-project AND createTime >= 1432140000 AND createTime <=
# 1432150000 AND status = RUNNING`
# * `projectId = my-project AND labels.color = *`
# * `projectId = my-project AND labels.color = red`
# A string for filtering Operations. In v2alpha1, the following filter fields
# are supported: * createTime: The time this job was created * events: The set
# of event (names) that have occurred while running the pipeline. The : operator
# can be used to determine if a particular event has occurred. * error: If the
# pipeline is running, this value is NULL. Once the pipeline finishes, the value
# is the standard Google error code. * labels.key or labels."key with space"
# where key is a label key. * done: If the pipeline is running, this value is
# false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the
# following filter fields are supported: * projectId: Required. Corresponds to
# OperationMetadata.projectId. * createTime: The time this job was created, in
# seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=`
# and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `
# CANCELED`. Only one status may be specified. * labels.key where key is a label
# key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `
# projectId = my-project AND createTime >= 1432140000 AND createTime <=
# 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *
# ` * `projectId = my-project AND labels.color = red`
# @param [Fixnum] page_size
# The maximum number of results to return. The maximum value is 256.
# @param [String] page_token
@ -190,11 +175,10 @@ module Google
execute_or_queue_command(command, &block)
end
# Creates a pipeline that can be run later. Create takes a Pipeline that
# has all fields other than `pipelineId` populated, and then returns
# the same pipeline with `pipelineId` populated. This id can be used
# to run the pipeline.
# Caller must have WRITE permission to the project.
# Creates a pipeline that can be run later. Create takes a Pipeline that has all
# fields other than `pipelineId` populated, and then returns the same pipeline
# with `pipelineId` populated. This id can be used to run the pipeline. Caller
# must have WRITE permission to the project.
# @param [Google::Apis::GenomicsV1alpha2::Pipeline] pipeline_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -224,11 +208,10 @@ module Google
execute_or_queue_command(command, &block)
end
# Deletes a pipeline based on ID.
# Caller must have WRITE permission to the project.
# Deletes a pipeline based on ID. Caller must have WRITE permission to the
# project.
# @param [String] pipeline_id
# Caller must have WRITE access to the project in which this pipeline
# is defined.
# Caller must have WRITE access to the project in which this pipeline is defined.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -256,11 +239,10 @@ module Google
execute_or_queue_command(command, &block)
end
# Retrieves a pipeline based on ID.
# Caller must have READ permission to the project.
# Retrieves a pipeline based on ID. Caller must have READ permission to the
# project.
# @param [String] pipeline_id
# Caller must have READ access to the project in which this pipeline
# is defined.
# Caller must have READ access to the project in which this pipeline is defined.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -288,8 +270,8 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets controller configuration information. Should only be called
# by VMs created by the Pipelines Service and not by end users.
# Gets controller configuration information. Should only be called by VMs
# created by the Pipelines Service and not by end users.
# @param [String] operation_id
# The operation to retrieve controller configuration for.
# @param [Fixnum] validation_token
@ -321,21 +303,18 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists pipelines.
# Caller must have READ permission to the project.
# Lists pipelines. Caller must have READ permission to the project.
# @param [String] name_prefix
# Pipelines with names that match this prefix should be
# returned. If unspecified, all pipelines in the project, up to
# `pageSize`, will be returned.
# Pipelines with names that match this prefix should be returned. If unspecified,
# all pipelines in the project, up to `pageSize`, will be returned.
# @param [Fixnum] page_size
# Number of pipelines to return at once. Defaults to 256, and max
# is 2048.
# Number of pipelines to return at once. Defaults to 256, and max is 2048.
# @param [String] page_token
# Token to use to indicate where to start getting results.
# If unspecified, returns the first page of results.
# Token to use to indicate where to start getting results. If unspecified,
# returns the first page of results.
# @param [String] project_id
# Required. The name of the project to search for pipelines. Caller
# must have READ access to this project.
# Required. The name of the project to search for pipelines. Caller must have
# READ access to this project.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -366,13 +345,12 @@ module Google
execute_or_queue_command(command, &block)
end
# Runs a pipeline. If `pipelineId` is specified in the request, then
# run a saved pipeline. If `ephemeralPipeline` is specified, then run
# that pipeline once without saving a copy.
# The caller must have READ permission to the project where the pipeline
# is stored and WRITE permission to the project where the pipeline will be
# run, as VMs will be created and storage will be used.
# If a pipeline operation is still running after 6 days, it will be canceled.
# Runs a pipeline. If `pipelineId` is specified in the request, then run a saved
# pipeline. If `ephemeralPipeline` is specified, then run that pipeline once
# without saving a copy. The caller must have READ permission to the project
# where the pipeline is stored and WRITE permission to the project where the
# pipeline will be run, as VMs will be created and storage will be used. If a
# pipeline operation is still running after 6 days, it will be canceled.
# @param [Google::Apis::GenomicsV1alpha2::RunPipelineRequest] run_pipeline_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/genomics
module GenomicsV2alpha1
VERSION = 'V2alpha1'
REVISION = '20200727'
REVISION = '20200804'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -31,13 +31,12 @@ module Google
# @return [Fixnum]
attr_accessor :count
# The accelerator type string (for example, "nvidia-tesla-k80").
# Only NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is
# attached, the required runtime libraries will be made available to all
# containers under `/usr/local/nvidia`. The driver version to install must
# be specified using the NVIDIA driver version parameter on the virtual
# machine specification. Note that attaching a GPU increases the worker VM
# startup time by a few minutes.
# The accelerator type string (for example, "nvidia-tesla-k80"). Only NVIDIA GPU
# accelerators are currently supported. If an NVIDIA GPU is attached, the
# required runtime libraries will be made available to all containers under `/
# usr/local/nvidia`. The driver version to install must be specified using the
# NVIDIA driver version parameter on the virtual machine specification. Note
# that attaching a GPU increases the worker VM startup time by a few minutes.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
@ -57,16 +56,16 @@ module Google
class Action
include Google::Apis::Core::Hashable
# If specified, overrides the `CMD` specified in the container. If the
# container also has an `ENTRYPOINT` the values are used as entrypoint
# arguments. Otherwise, they are used as a command and arguments to run
# inside the container.
# If specified, overrides the `CMD` specified in the container. If the container
# also has an `ENTRYPOINT` the values are used as entrypoint arguments.
# Otherwise, they are used as a command and arguments to run inside the
# container.
# Corresponds to the JSON property `commands`
# @return [Array<String>]
attr_accessor :commands
# Holds encrypted information that is only decrypted and stored in RAM
# by the worker VM when running the pipeline.
# Holds encrypted information that is only decrypted and stored in RAM by the
# worker VM when running the pipeline.
# Corresponds to the JSON property `credentials`
# @return [Google::Apis::GenomicsV2alpha1::Secret]
attr_accessor :credentials
@ -76,19 +75,17 @@ module Google
# @return [String]
attr_accessor :entrypoint
# The environment to pass into the container. This environment is merged
# with values specified in the google.genomics.v2alpha1.Pipeline
# message, overwriting any duplicate values.
# In addition to the values passed here, a few other values are
# automatically injected into the environment. These cannot be hidden or
# overwritten.
# `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline failed
# because an action has exited with a non-zero status (and did not have the
# `IGNORE_EXIT_STATUS` flag set). This can be used to determine if additional
# debug or logging actions should execute.
# `GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last
# non-background action that executed. This can be used by workflow engine
# authors to determine whether an individual action has succeeded or failed.
# The environment to pass into the container. This environment is merged with
# values specified in the google.genomics.v2alpha1.Pipeline message, overwriting
# any duplicate values. In addition to the values passed here, a few other
# values are automatically injected into the environment. These cannot be hidden
# or overwritten. `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline
# failed because an action has exited with a non-zero status (and did not have
# the `IGNORE_EXIT_STATUS` flag set). This can be used to determine if
# additional debug or logging actions should execute. `GOOGLE_LAST_EXIT_STATUS`
# will be set to the exit status of the last non-background action that executed.
# This can be used by workflow engine authors to determine whether an
# individual action has succeeded or failed.
# Corresponds to the JSON property `environment`
# @return [Hash<String,String>]
attr_accessor :environment
@ -99,78 +96,68 @@ module Google
attr_accessor :flags
# Required. The URI to pull the container image from. Note that all images
# referenced
# by actions in the pipeline are pulled before the first action runs. If
# multiple actions reference the same image, it is only pulled once,
# ensuring that the same image is used for all actions in a single pipeline.
# The image URI can be either a complete host and image specification (e.g.,
# quay.io/biocontainers/samtools), a library and image name (e.g.,
# google/cloud-sdk) or a bare image name ('bash') to pull from the default
# library. No schema is required in any of these cases.
# If the specified image is not public, the service account specified for
# the Virtual Machine must have access to pull the images from GCR, or
# appropriate credentials must be specified in the
# google.genomics.v2alpha1.Action.credentials field.
# referenced by actions in the pipeline are pulled before the first action runs.
# If multiple actions reference the same image, it is only pulled once, ensuring
# that the same image is used for all actions in a single pipeline. The image
# URI can be either a complete host and image specification (e.g., quay.io/
# biocontainers/samtools), a library and image name (e.g., google/cloud-sdk) or
# a bare image name ('bash') to pull from the default library. No schema is
# required in any of these cases. If the specified image is not public, the
# service account specified for the Virtual Machine must have access to pull the
# images from GCR, or appropriate credentials must be specified in the google.
# genomics.v2alpha1.Action.credentials field.
# Corresponds to the JSON property `imageUri`
# @return [String]
attr_accessor :image_uri
# Labels to associate with the action. This field is provided to assist
# workflow engine authors in identifying actions (for example, to indicate
# what sort of action they perform, such as localization or debugging).
# They are returned in the operation metadata, but are otherwise ignored.
# Labels to associate with the action. This field is provided to assist workflow
# engine authors in identifying actions (for example, to indicate what sort of
# action they perform, such as localization or debugging). They are returned in
# the operation metadata, but are otherwise ignored.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# A list of mounts to make available to the action.
# In addition to the values specified here, every action has a special
# virtual disk mounted under `/google` that contains log files and other
# operational components.
# <ul>
# <li><code>/google/logs</code> All logs written during the pipeline
# execution.</li>
# <li><code>/google/logs/output</code> The combined standard output and
# standard error of all actions run as part of the pipeline
# execution.</li>
# <li><code>/google/logs/action/*/stdout</code> The complete contents of
# each individual action's standard output.</li>
# <li><code>/google/logs/action/*/stderr</code> The complete contents of
# each individual action's standard error output.</li>
# </ul>
# A list of mounts to make available to the action. In addition to the values
# specified here, every action has a special virtual disk mounted under `/google`
# that contains log files and other operational components. - /google/logs All
# logs written during the pipeline execution. - /google/logs/output The combined
# standard output and standard error of all actions run as part of the pipeline
# execution. - /google/logs/action/*/stdout The complete contents of each
# individual action's standard output. - /google/logs/action/*/stderr The
# complete contents of each individual action's standard error output.
# Corresponds to the JSON property `mounts`
# @return [Array<Google::Apis::GenomicsV2alpha1::Mount>]
attr_accessor :mounts
# An optional name for the container. The container hostname will be set to
# this name, making it useful for inter-container communication. The name
# must contain only upper and lowercase alphanumeric characters and hypens
# and cannot start with a hyphen.
# An optional name for the container. The container hostname will be set to this
# name, making it useful for inter-container communication. The name must
# contain only upper and lowercase alphanumeric characters and hypens and cannot
# start with a hyphen.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# An optional identifier for a PID namespace to run the action inside.
# Multiple actions should use the same string to share a namespace. If
# unspecified, a separate isolated namespace is used.
# An optional identifier for a PID namespace to run the action inside. Multiple
# actions should use the same string to share a namespace. If unspecified, a
# separate isolated namespace is used.
# Corresponds to the JSON property `pidNamespace`
# @return [String]
attr_accessor :pid_namespace
# A map of containers to host port mappings for this container. If the
# container already specifies exposed ports, use the
# `PUBLISH_EXPOSED_PORTS` flag instead.
# The host port number must be less than 65536. If it is zero, an unused
# random port is assigned. To determine the resulting port number, consult
# the `ContainerStartedEvent` in the operation metadata.
# A map of containers to host port mappings for this container. If the container
# already specifies exposed ports, use the `PUBLISH_EXPOSED_PORTS` flag instead.
# The host port number must be less than 65536. If it is zero, an unused random
# port is assigned. To determine the resulting port number, consult the `
# ContainerStartedEvent` in the operation metadata.
# Corresponds to the JSON property `portMappings`
# @return [Hash<String,Fixnum>]
attr_accessor :port_mappings
# The maximum amount of time to give the action to complete. If the action
# fails to complete before the timeout, it will be terminated and the exit
# status will be non-zero. The pipeline will continue or terminate based
# on the rules defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags.
# The maximum amount of time to give the action to complete. If the action fails
# to complete before the timeout, it will be terminated and the exit status will
# be non-zero. The pipeline will continue or terminate based on the rules
# defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags.
# Corresponds to the JSON property `timeout`
# @return [String]
attr_accessor :timeout
@ -213,13 +200,11 @@ module Google
class CheckInRequest
include Google::Apis::Core::Hashable
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
# Corresponds to the JSON property `deadlineExpired`
# @return [Google::Apis::GenomicsV2alpha1::Empty]
attr_accessor :deadline_expired
@ -234,16 +219,22 @@ module Google
# @return [Array<Google::Apis::GenomicsV2alpha1::TimestampedEvent>]
attr_accessor :events
# 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).
# 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).
# Corresponds to the JSON property `result`
# @return [Google::Apis::GenomicsV2alpha1::Status]
attr_accessor :result
# An SOS report for an unexpected VM failure.
# Corresponds to the JSON property `sosReport`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :sos_report
# The status of the worker VM.
# Corresponds to the JSON property `workerStatus`
# @return [Google::Apis::GenomicsV2alpha1::WorkerStatus]
@ -259,6 +250,7 @@ module Google
@event = args[:event] if args.key?(:event)
@events = args[:events] if args.key?(:events)
@result = args[:result] if args.key?(:result)
@sos_report = args[:sos_report] if args.key?(:sos_report)
@worker_status = args[:worker_status] if args.key?(:worker_status)
end
end
@ -267,9 +259,9 @@ module Google
class CheckInResponse
include Google::Apis::Core::Hashable
# The deadline by which the worker must request an extension. The backend
# will allow for network transmission time and other delays, but the worker
# must attempt to transmit the extension request no later than the deadline.
# The deadline by which the worker must request an extension. The backend will
# allow for network transmission time and other delays, but the worker must
# attempt to transmit the extension request no later than the deadline.
# Corresponds to the JSON property `deadline`
# @return [String]
attr_accessor :deadline
@ -328,9 +320,9 @@ module Google
end
end
# An event generated when a container is forcibly terminated by the
# worker. Currently, this only occurs when the container outlives the
# timeout specified by the user.
# An event generated when a container is forcibly terminated by the worker.
# Currently, this only occurs when the container outlives the timeout specified
# by the user.
class ContainerKilledEvent
include Google::Apis::Core::Hashable
@ -358,17 +350,17 @@ module Google
# @return [Fixnum]
attr_accessor :action_id
# The public IP address that can be used to connect to the container. This
# field is only populated when at least one port mapping is present. If the
# instance was created with a private address, this field will be empty even
# if port mappings exist.
# The public IP address that can be used to connect to the container. This field
# is only populated when at least one port mapping is present. If the instance
# was created with a private address, this field will be empty even if port
# mappings exist.
# Corresponds to the JSON property `ipAddress`
# @return [String]
attr_accessor :ip_address
# The container-to-host port mappings installed for this container. This
# set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag
# as well as any specified in the `Action` definition.
# The container-to-host port mappings installed for this container. This set
# will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well
# as any specified in the `Action` definition.
# Corresponds to the JSON property `portMappings`
# @return [Hash<String,Fixnum>]
attr_accessor :port_mappings
@ -399,13 +391,13 @@ module Google
# @return [Fixnum]
attr_accessor :exit_status
# The tail end of any content written to standard error by the container.
# If the content emits large amounts of debugging noise or contains
# sensitive information, you can prevent the content from being printed by
# setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag.
# Note that only a small amount of the end of the stream is captured here.
# The entire stream is stored in the `/google/logs` directory mounted into
# each action, and can be copied off the machine as described elsewhere.
# The tail end of any content written to standard error by the container. If the
# content emits large amounts of debugging noise or contains sensitive
# information, you can prevent the content from being printed by setting the `
# DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end
# of the stream is captured here. The entire stream is stored in the `/google/
# logs` directory mounted into each action, and can be copied off the machine as
# described elsewhere.
# Corresponds to the JSON property `stderr`
# @return [String]
attr_accessor :stderr
@ -422,22 +414,22 @@ module Google
end
end
# An event generated whenever a resource limitation or transient error
# delays execution of a pipeline that was otherwise ready to run.
# An event generated whenever a resource limitation or transient error delays
# execution of a pipeline that was otherwise ready to run.
class DelayedEvent
include Google::Apis::Core::Hashable
# A textual description of the cause of the delay. The string can change
# without notice because it is often generated by another service (such as
# Compute Engine).
# A textual description of the cause of the delay. The string can change without
# notice because it is often generated by another service (such as Compute
# Engine).
# Corresponds to the JSON property `cause`
# @return [String]
attr_accessor :cause
# If the delay was caused by a resource shortage, this field lists the
# Compute Engine metrics that are preventing this operation from running
# (for example, `CPUS` or `INSTANCES`). If the particular metric is not
# known, a single `UNKNOWN` metric will be present.
# If the delay was caused by a resource shortage, this field lists the Compute
# Engine metrics that are preventing this operation from running (for example, `
# CPUS` or `INSTANCES`). If the particular metric is not known, a single `
# UNKNOWN` metric will be present.
# Corresponds to the JSON property `metrics`
# @return [Array<String>]
attr_accessor :metrics
@ -453,25 +445,24 @@ module Google
end
end
# Carries information about a disk that can be attached to a VM.
# See https://cloud.google.com/compute/docs/disks/performance for more
# information about disk type, size, and performance considerations.
# Carries information about a disk that can be attached to a VM. See https://
# cloud.google.com/compute/docs/disks/performance for more information about
# disk type, size, and performance considerations.
class Disk
include Google::Apis::Core::Hashable
# A user-supplied name for the disk. Used when mounting the disk into
# actions. The name must contain only upper and lowercase alphanumeric
# characters and hypens and cannot start with a hyphen.
# A user-supplied name for the disk. Used when mounting the disk into actions.
# The name must contain only upper and lowercase alphanumeric characters and
# hypens and cannot start with a hyphen.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The size, in GB, of the disk to attach. If the size is not
# specified, a default is chosen to ensure reasonable I/O performance.
# If the disk type is specified as `local-ssd`, multiple local drives are
# automatically combined to provide the requested size. Note, however, that
# each physical SSD is 375GB in size, and no more than 8 drives can be
# attached to a single instance.
# The size, in GB, of the disk to attach. If the size is not specified, a
# default is chosen to ensure reasonable I/O performance. If the disk type is
# specified as `local-ssd`, multiple local drives are automatically combined to
# provide the requested size. Note, however, that each physical SSD is 375GB in
# size, and no more than 8 drives can be attached to a single instance.
# Corresponds to the JSON property `sizeGb`
# @return [Fixnum]
attr_accessor :size_gb
@ -524,13 +515,11 @@ module Google
end
end
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
@ -547,9 +536,9 @@ module Google
class Event
include Google::Apis::Core::Hashable
# A human-readable description of the event. Note that these strings can
# change at any time without notice. Any application logic must use the
# information in the `details` field.
# A human-readable description of the event. Note that these strings can change
# at any time without notice. Any application logic must use the information in
# the `details` field.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
@ -576,8 +565,8 @@ module Google
end
end
# An event generated when the execution of a pipeline has failed. Note
# that other events can continue to occur after this event.
# An event generated when the execution of a pipeline has failed. Note that
# other events can continue to occur after this event.
class FailedEvent
include Google::Apis::Core::Hashable
@ -627,8 +616,8 @@ module Google
end
end
# Carries information about the pipeline execution that is returned
# in the long running operation's metadata field.
# Carries information about the pipeline execution that is returned in the long
# running operation's metadata field.
class Metadata
include Google::Apis::Core::Hashable
@ -714,30 +703,28 @@ module Google
class Network
include Google::Apis::Core::Hashable
# The network name to attach the VM's network interface to. The value will
# be prefixed with `global/networks/` unless it contains a `/`, in which
# case it is assumed to be a fully specified network resource URL.
# If unspecified, the global default network is used.
# The network name to attach the VM's network interface to. The value will be
# prefixed with `global/networks/` unless it contains a `/`, in which case it is
# assumed to be a fully specified network resource URL. If unspecified, the
# global default network is used.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# If the specified network is configured for custom subnet creation, the
# name of the subnetwork to attach the instance to must be specified here.
# The value is prefixed with `regions/*/subnetworks/` unless it contains a
# `/`, in which case it is assumed to be a fully specified subnetwork
# resource URL.
# If the `*` character appears in the value, it is replaced with the region
# that the virtual machine has been allocated in.
# If the specified network is configured for custom subnet creation, the name of
# the subnetwork to attach the instance to must be specified here. The value is
# prefixed with `regions/*/subnetworks/` unless it contains a `/`, in which case
# it is assumed to be a fully specified subnetwork resource URL. If the `*`
# character appears in the value, it is replaced with the region that the
# virtual machine has been allocated in.
# Corresponds to the JSON property `subnetwork`
# @return [String]
attr_accessor :subnetwork
# If set to true, do not attach a public IP address to the VM. Note that
# without a public IP address, additional configuration is required to
# allow the VM to access Google services.
# See https://cloud.google.com/vpc/docs/configure-private-google-access
# for more information.
# If set to true, do not attach a public IP address to the VM. Note that without
# a public IP address, additional configuration is required to allow the VM to
# access Google services. See https://cloud.google.com/vpc/docs/configure-
# private-google-access for more information.
# Corresponds to the JSON property `usePrivateAddress`
# @return [Boolean]
attr_accessor :use_private_address
@ -760,20 +747,19 @@ module Google
class Operation
include Google::Apis::Core::Hashable
# 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.
# 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.
# Corresponds to the JSON property `done`
# @return [Boolean]
attr_accessor :done
alias_method :done?, :done
# 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).
# 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).
# Corresponds to the JSON property `error`
# @return [Google::Apis::GenomicsV2alpha1::Status]
attr_accessor :error
@ -785,7 +771,7 @@ module Google
attr_accessor :metadata
# The server-assigned name, which is only unique within the same service that
# originally returns it. For example&#58; `operations/CJHU7Oi_ChDrveSpBRjfuL-
# originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-
# qzoWAgEw`
# Corresponds to the JSON property `name`
# @return [String]
@ -862,15 +848,14 @@ module Google
# @return [String]
attr_accessor :end_time
# Optional event messages that were generated during the job's execution.
# This also contains any warnings that were generated during import
# or export.
# Optional event messages that were generated during the job's execution. This
# also contains any warnings that were generated during import or export.
# Corresponds to the JSON property `events`
# @return [Array<Google::Apis::GenomicsV2alpha1::OperationEvent>]
attr_accessor :events
# Optionally provided by the caller when submitting the request that creates
# the operation.
# Optionally provided by the caller when submitting the request that creates the
# operation.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
@ -881,8 +866,8 @@ module Google
attr_accessor :project_id
# The original request that started the operation. Note that this will be in
# current version of the API. If the operation was started with v1beta2 API
# and a GetOperation is performed on v1 API, a v1 request will be returned.
# current version of the API. If the operation was started with v1beta2 API and
# a GetOperation is performed on v1 API, a v1 request will be returned.
# Corresponds to the JSON property `request`
# @return [Hash<String,Object>]
attr_accessor :request
@ -925,23 +910,22 @@ module Google
attr_accessor :actions
# The environment to pass into every action. Each action can also specify
# additional environment variables but cannot delete an entry from this map
# (though they can overwrite it with a different value).
# additional environment variables but cannot delete an entry from this map (
# though they can overwrite it with a different value).
# Corresponds to the JSON property `environment`
# @return [Hash<String,String>]
attr_accessor :environment
# The system resources for the pipeline run.
# At least one zone or region must be specified or the pipeline run will fail.
# The system resources for the pipeline run. At least one zone or region must be
# specified or the pipeline run will fail.
# Corresponds to the JSON property `resources`
# @return [Google::Apis::GenomicsV2alpha1::Resources]
attr_accessor :resources
# The maximum amount of time to give the pipeline to complete. This includes
# the time spent waiting for a worker to be allocated. If the pipeline fails
# to complete before the timeout, it will be cancelled and the error code
# will be set to DEADLINE_EXCEEDED.
# If unspecified, it will default to 7 days.
# The maximum amount of time to give the pipeline to complete. This includes the
# time spent waiting for a worker to be allocated. If the pipeline fails to
# complete before the timeout, it will be cancelled and the error code will be
# set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days.
# Corresponds to the JSON property `timeout`
# @return [String]
attr_accessor :timeout
@ -997,8 +981,8 @@ module Google
end
end
# The system resources for the pipeline run.
# At least one zone or region must be specified or the pipeline run will fail.
# The system resources for the pipeline run. At least one zone or region must be
# specified or the pipeline run will fail.
class Resources
include Google::Apis::Core::Hashable
@ -1007,8 +991,8 @@ module Google
# @return [String]
attr_accessor :project_id
# The list of regions allowed for VM allocation. If set, the `zones` field
# must not be set.
# The list of regions allowed for VM allocation. If set, the `zones` field must
# not be set.
# Corresponds to the JSON property `regions`
# @return [Array<String>]
attr_accessor :regions
@ -1018,8 +1002,8 @@ module Google
# @return [Google::Apis::GenomicsV2alpha1::VirtualMachine]
attr_accessor :virtual_machine
# The list of zones allowed for VM allocation. If set, the `regions` field
# must not be set.
# The list of zones allowed for VM allocation. If set, the `regions` field must
# not be set.
# Corresponds to the JSON property `zones`
# @return [Array<String>]
attr_accessor :zones
@ -1037,17 +1021,17 @@ module Google
end
end
# The arguments to the `RunPipeline` method. The requesting user must have
# the `iam.serviceAccounts.actAs` permission for the Cloud Genomics service
# account or the request will fail.
# The arguments to the `RunPipeline` method. The requesting user must have the `
# iam.serviceAccounts.actAs` permission for the Cloud Genomics service account
# or the request will fail.
class RunPipelineRequest
include Google::Apis::Core::Hashable
# User-defined labels to associate with the returned operation. These
# labels are not propagated to any Google Cloud Platform resources used by
# the operation, and can be modified at any time.
# To associate labels with resources created while executing the operation,
# see the appropriate resource message (for example, `VirtualMachine`).
# User-defined labels to associate with the returned operation. These labels are
# not propagated to any Google Cloud Platform resources used by the operation,
# and can be modified at any time. To associate labels with resources created
# while executing the operation, see the appropriate resource message (for
# example, `VirtualMachine`).
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
@ -1082,9 +1066,8 @@ module Google
end
end
# Runtime metadata that will be populated in the
# runtimeMetadata
# field of the Operation associated with a RunPipeline execution.
# Runtime metadata that will be populated in the runtimeMetadata field of the
# Operation associated with a RunPipeline execution.
class RuntimeMetadata
include Google::Apis::Core::Hashable
@ -1104,20 +1087,20 @@ module Google
end
end
# Holds encrypted information that is only decrypted and stored in RAM
# by the worker VM when running the pipeline.
# Holds encrypted information that is only decrypted and stored in RAM by the
# worker VM when running the pipeline.
class Secret
include Google::Apis::Core::Hashable
# The value of the cipherText response from the `encrypt` method. This field
# is intentionally unaudited.
# The value of the cipherText response from the `encrypt` method. This field is
# intentionally unaudited.
# Corresponds to the JSON property `cipherText`
# @return [String]
attr_accessor :cipher_text
# The name of the Cloud KMS key that will be used to decrypt the secret
# value. The VM service account must have the required permissions and
# authentication scopes to invoke the `decrypt` method on the specified key.
# The name of the Cloud KMS key that will be used to decrypt the secret value.
# The VM service account must have the required permissions and authentication
# scopes to invoke the `decrypt` method on the specified key.
# Corresponds to the JSON property `keyName`
# @return [String]
attr_accessor :key_name
@ -1137,14 +1120,14 @@ module Google
class ServiceAccount
include Google::Apis::Core::Hashable
# Email address of the service account. If not specified, the default
# Compute Engine service account for the project will be used.
# Email address of the service account. If not specified, the default Compute
# Engine service account for the project will be used.
# Corresponds to the JSON property `email`
# @return [String]
attr_accessor :email
# List of scopes to be enabled for this service account on the VM, in
# addition to the cloud-platform API scope that will be added by default.
# List of scopes to be enabled for this service account on the VM, in addition
# to the cloud-platform API scope that will be added by default.
# Corresponds to the JSON property `scopes`
# @return [Array<String>]
attr_accessor :scopes
@ -1160,12 +1143,12 @@ module Google
end
end
# 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).
# 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).
class Status
include Google::Apis::Core::Hashable
@ -1174,15 +1157,15 @@ module Google
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
# A developer-facing error message, which should be in English. Any user-facing
# error message should be localized and sent in the google.rpc.Status.details
# field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
@ -1199,8 +1182,8 @@ module Google
end
end
# An event that occured in the operation assigned to the
# worker and the time of occurance.
# An event that occured in the operation assigned to the worker and the time of
# occurance.
class TimestampedEvent
include Google::Apis::Core::Hashable
@ -1225,10 +1208,10 @@ module Google
end
end
# An event generated when the execution of a container results in a
# non-zero exit status that was not otherwise ignored. Execution will
# continue, but only actions that are flagged as `ALWAYS_RUN` will be
# executed. Other actions will be skipped.
# An event generated when the execution of a container results in a non-zero
# exit status that was not otherwise ignored. Execution will continue, but only
# actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will
# be skipped.
class UnexpectedExitStatusEvent
include Google::Apis::Core::Hashable
@ -1262,34 +1245,32 @@ module Google
# @return [Array<Google::Apis::GenomicsV2alpha1::Accelerator>]
attr_accessor :accelerators
# The size of the boot disk, in GB. The boot disk must be large
# enough to accommodate all of the Docker images from each action in the
# pipeline at the same time. If not specified, a small but reasonable
# default value is used.
# The size of the boot disk, in GB. The boot disk must be large enough to
# accommodate all of the Docker images from each action in the pipeline at the
# same time. If not specified, a small but reasonable default value is used.
# Corresponds to the JSON property `bootDiskSizeGb`
# @return [Fixnum]
attr_accessor :boot_disk_size_gb
# The host operating system image to use.
# Currently, only Container-Optimized OS images can be used.
# The default value is `projects/cos-cloud/global/images/family/cos-stable`,
# which selects the latest stable release of Container-Optimized OS.
# This option is provided to allow testing against the beta release of the
# operating system to ensure that the new version does not interact
# negatively with production pipelines.
# To test a pipeline against the beta release of Container-Optimized OS,
# use the value `projects/cos-cloud/global/images/family/cos-beta`.
# The host operating system image to use. Currently, only Container-Optimized OS
# images can be used. The default value is `projects/cos-cloud/global/images/
# family/cos-stable`, which selects the latest stable release of Container-
# Optimized OS. This option is provided to allow testing against the beta
# release of the operating system to ensure that the new version does not
# interact negatively with production pipelines. To test a pipeline against the
# beta release of Container-Optimized OS, use the value `projects/cos-cloud/
# global/images/family/cos-beta`.
# Corresponds to the JSON property `bootImage`
# @return [String]
attr_accessor :boot_image
# The CPU platform to request. An instance based on a newer platform can be
# allocated, but never one with fewer capabilities. The value of this
# parameter must be a valid Compute Engine CPU platform name (such as "Intel
# Skylake"). This parameter is only useful for carefully optimized work
# loads where the CPU platform has a significant impact.
# For more information about the effect of this parameter, see
# https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
# allocated, but never one with fewer capabilities. The value of this parameter
# must be a valid Compute Engine CPU platform name (such as "Intel Skylake").
# This parameter is only useful for carefully optimized work loads where the CPU
# platform has a significant impact. For more information about the effect of
# this parameter, see https://cloud.google.com/compute/docs/instances/specify-
# min-cpu-platform.
# Corresponds to the JSON property `cpuPlatform`
# @return [String]
attr_accessor :cpu_platform
@ -1300,12 +1281,12 @@ module Google
attr_accessor :disks
# The Compute Engine Disk Images to use as a Docker cache. The disks will be
# mounted into the Docker folder in a way that the images present in the
# cache will not need to be pulled. The digests of the cached images must
# match those of the tags used or the latest version will still be pulled.
# The root directory of the ext4 image must contain `image` and `overlay2`
# directories copied from the Docker directory of a VM where the desired
# Docker images have already been pulled. Only a single image is supported.
# mounted into the Docker folder in a way that the images present in the cache
# will not need to be pulled. The digests of the cached images must match those
# of the tags used or the latest version will still be pulled. The root
# directory of the ext4 image must contain `image` and `overlay2` directories
# copied from the Docker directory of a VM where the desired Docker images have
# already been pulled. Only a single image is supported.
# Corresponds to the JSON property `dockerCacheImages`
# @return [Array<String>]
attr_accessor :docker_cache_images
@ -1317,25 +1298,22 @@ module Google
alias_method :enable_stackdriver_monitoring?, :enable_stackdriver_monitoring
# Optional set of labels to apply to the VM and any attached disk resources.
# These labels must adhere to the [name and value
# restrictions](https://cloud.google.com/compute/docs/labeling-resources) on
# VM labels imposed by Compute Engine.
# Labels keys with the prefix 'google-' are reserved for use by Google.
# Labels applied at creation time to the VM. Applied on a best-effort basis
# to attached disk resources shortly after VM creation.
# These labels must adhere to the [name and value restrictions](https://cloud.
# google.com/compute/docs/labeling-resources) on VM labels imposed by Compute
# Engine. Labels keys with the prefix 'google-' are reserved for use by Google.
# Labels applied at creation time to the VM. Applied on a best-effort basis to
# attached disk resources shortly after VM creation.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# Required. The machine type of the virtual machine to create. Must be the short
# name
# of a standard machine type (such as "n1-standard-1") or a custom machine
# type (such as "custom-1-4096", where "1" indicates the number of vCPUs and
# "4096" indicates the memory in MB). See
# [Creating an instance with a custom machine
# type](https://cloud.google.com/compute/docs/instances/creating-instance-with-
# custom-machine-type#create)
# for more specifications on creating a custom machine type.
# name of a standard machine type (such as "n1-standard-1") or a custom machine
# type (such as "custom-1-4096", where "1" indicates the number of vCPUs and "
# 4096" indicates the memory in MB). See [Creating an instance with a custom
# machine type](https://cloud.google.com/compute/docs/instances/creating-
# instance-with-custom-machine-type#create) for more specifications on creating
# a custom machine type.
# Corresponds to the JSON property `machineType`
# @return [String]
attr_accessor :machine_type
@ -1345,10 +1323,10 @@ module Google
# @return [Google::Apis::GenomicsV2alpha1::Network]
attr_accessor :network
# The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator.
# The version specified here must be compatible with the GPU libraries
# contained in the container being executed, and must be one of the drivers
# hosted in the `nvidia-drivers-us-public` bucket on Google Cloud Storage.
# The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator. The
# version specified here must be compatible with the GPU libraries contained in
# the container being executed, and must be one of the drivers hosted in the `
# nvidia-drivers-us-public` bucket on Google Cloud Storage.
# Corresponds to the JSON property `nvidiaDriverVersion`
# @return [String]
attr_accessor :nvidia_driver_version
@ -1386,8 +1364,7 @@ module Google
end
end
# An event generated after a worker VM has been assigned to run the
# pipeline.
# An event generated after a worker VM has been assigned to run the pipeline.
class WorkerAssignedEvent
include Google::Apis::Core::Hashable
@ -1418,8 +1395,8 @@ module Google
end
end
# An event generated when the worker VM that was assigned to the pipeline
# has been released (deleted).
# An event generated when the worker VM that was assigned to the pipeline has
# been released (deleted).
class WorkerReleasedEvent
include Google::Apis::Core::Hashable

View File

@ -294,6 +294,7 @@ module Google
property :result, as: 'result', class: Google::Apis::GenomicsV2alpha1::Status, decorator: Google::Apis::GenomicsV2alpha1::Status::Representation
property :sos_report, :base64 => true, as: 'sosReport'
property :worker_status, as: 'workerStatus', class: Google::Apis::GenomicsV2alpha1::WorkerStatus, decorator: Google::Apis::GenomicsV2alpha1::WorkerStatus::Representation
end

View File

@ -47,21 +47,17 @@ module Google
@batch_path = 'batch'
end
# Runs a pipeline. The returned Operation's metadata field will contain a
# google.genomics.v2alpha1.Metadata object describing the status of the
# pipeline execution. The [response] field will contain a
# google.genomics.v2alpha1.RunPipelineResponse object if the pipeline
# completes successfully.
# **Note:** Before you can use this method, the Genomics Service Agent
# must have access to your project. This is done automatically when the
# Cloud Genomics API is first enabled, but if you delete this permission,
# or if you enabled the Cloud Genomics API before the v2alpha1 API
# launch, you must disable and re-enable the API to grant the Genomics
# Service Agent the required permissions.
# Authorization requires the following [Google
# IAM](https://cloud.google.com/iam/) permission:
# * `genomics.operations.create`
# [1]: /genomics/gsa
# Runs a pipeline. The returned Operation's metadata field will contain a google.
# genomics.v2alpha1.Metadata object describing the status of the pipeline
# execution. The [response] field will contain a google.genomics.v2alpha1.
# RunPipelineResponse object if the pipeline completes successfully. **Note:**
# Before you can use this method, the Genomics Service Agent must have access to
# your project. This is done automatically when the Cloud Genomics API is first
# enabled, but if you delete this permission, or if you enabled the Cloud
# Genomics API before the v2alpha1 API launch, you must disable and re-enable
# the API to grant the Genomics Service Agent the required permissions.
# Authorization requires the following [Google IAM](https://cloud.google.com/iam/
# ) permission: * `genomics.operations.create` [1]: /genomics/gsa
# @param [Google::Apis::GenomicsV2alpha1::RunPipelineRequest] run_pipeline_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -91,15 +87,12 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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&#58;
# * `genomics.operations.cancel`
# permission: * `genomics.operations.cancel`
# @param [String] name
# The name of the operation resource to be cancelled.
# @param [Google::Apis::GenomicsV2alpha1::CancelOperationRequest] cancel_operation_request_object
@ -132,12 +125,10 @@ module Google
execute_or_queue_command(command, &block)
end
# 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.
# 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&#58;
# * `genomics.operations.get`
# permission: * `genomics.operations.get`
# @param [String] name
# The name of the operation resource.
# @param [String] fields
@ -167,39 +158,29 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists operations that match the specified filter in the request.
# Authorization requires the following [Google IAM](https://cloud.google.com/iam)
# permission&#58;
# * `genomics.operations.list`
# Lists operations that match the specified filter in the request. Authorization
# requires the following [Google IAM](https://cloud.google.com/iam) permission: *
# `genomics.operations.list`
# @param [String] name
# The name of the operation's parent resource.
# @param [String] filter
# A string for filtering Operations.
# In v2alpha1, the following filter fields are supported&#58;
# * createTime&#58; The time this job was created
# * events&#58; The set of event (names) that have occurred while running
# the pipeline. The &#58; operator can be used to determine if a
# particular event has occurred.
# * error&#58; If the pipeline is running, this value is NULL. Once the
# pipeline finishes, the value is the standard Google error code.
# * labels.key or labels."key with space" where key is a label key.
# * done&#58; If the pipeline is running, this value is false. Once the
# pipeline finishes, the value is true.
# In v1 and v1alpha2, the following filter fields are supported&#58;
# * projectId&#58; Required. Corresponds to
# OperationMetadata.projectId.
# * createTime&#58; The time this job was created, in seconds from the
# [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=`
# operators.
# * status&#58; Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only
# one status may be specified.
# * labels.key where key is a label key.
# Examples&#58;
# * `projectId = my-project AND createTime >= 1432140000`
# * `projectId = my-project AND createTime >= 1432140000 AND createTime <=
# 1432150000 AND status = RUNNING`
# * `projectId = my-project AND labels.color = *`
# * `projectId = my-project AND labels.color = red`
# A string for filtering Operations. In v2alpha1, the following filter fields
# are supported: * createTime: The time this job was created * events: The set
# of event (names) that have occurred while running the pipeline. The : operator
# can be used to determine if a particular event has occurred. * error: If the
# pipeline is running, this value is NULL. Once the pipeline finishes, the value
# is the standard Google error code. * labels.key or labels."key with space"
# where key is a label key. * done: If the pipeline is running, this value is
# false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the
# following filter fields are supported: * projectId: Required. Corresponds to
# OperationMetadata.projectId. * createTime: The time this job was created, in
# seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=`
# and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `
# CANCELED`. Only one status may be specified. * labels.key where key is a label
# key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `
# projectId = my-project AND createTime >= 1432140000 AND createTime <=
# 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *
# ` * `projectId = my-project AND labels.color = red`
# @param [Fixnum] page_size
# The maximum number of results to return. The maximum value is 256.
# @param [String] page_token
@ -234,11 +215,11 @@ module Google
execute_or_queue_command(command, &block)
end
# The worker uses this method to retrieve the assigned operation and
# provide periodic status updates.
# The worker uses this method to retrieve the assigned operation and provide
# periodic status updates.
# @param [String] id
# The VM identity token for authenticating the VM instance.
# https://cloud.google.com/compute/docs/instances/verifying-instance-identity
# The VM identity token for authenticating the VM instance. https://cloud.google.
# com/compute/docs/instances/verifying-instance-identity
# @param [Google::Apis::GenomicsV2alpha1::CheckInRequest] check_in_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -269,11 +250,11 @@ module Google
execute_or_queue_command(command, &block)
end
# The worker uses this method to retrieve the assigned operation and
# provide periodic status updates.
# The worker uses this method to retrieve the assigned operation and provide
# periodic status updates.
# @param [String] id
# The VM identity token for authenticating the VM instance.
# https://cloud.google.com/compute/docs/instances/verifying-instance-identity
# The VM identity token for authenticating the VM instance. https://cloud.google.
# com/compute/docs/instances/verifying-instance-identity
# @param [Google::Apis::GenomicsV2alpha1::CheckInRequest] check_in_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.

View File

@ -29,7 +29,7 @@ module Google
# @see https://cloud.google.com/monitoring/api/
module MonitoringV1
VERSION = 'V1'
REVISION = '20200728'
REVISION = '20200803'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -342,11 +342,9 @@ module Google
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for Empty is empty JSON object ``.
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# Empty is empty JSON object ``.
class Empty
include Google::Apis::Core::Hashable
@ -708,14 +706,14 @@ module Google
# x is above/below a warning threshold that triggers above/below, then the
# scorecard is in a warning state - unless x also puts it in a danger state. (
# Danger trumps warning.)As an example, consider a scorecard with the following
# four thresholds: ` value: 90, category: 'DANGER', trigger: 'ABOVE', `, `
# value: 70, category: 'WARNING', trigger: 'ABOVE', `, ` value: 10, category:
# 'DANGER', trigger: 'BELOW', `, ` value: 20, category: 'WARNING', trigger:
# 'BELOW', `Then: values less than or equal to 10 would put the scorecard in a
# DANGER state, values greater than 10 but less than or equal to 20 a WARNING
# state, values strictly between 20 and 70 an OK state, values greater than or
# equal to 70 but less than 90 a WARNING state, and values greater than or equal
# to 90 a DANGER state.
# four thresholds: ` value: 90, category: 'DANGER', trigger: 'ABOVE', `, ` value:
# 70, category: 'WARNING', trigger: 'ABOVE', `, ` value: 10, category: 'DANGER',
# trigger: 'BELOW', `, ` value: 20, category: 'WARNING', trigger: 'BELOW', `
# Then: values less than or equal to 10 would put the scorecard in a DANGER
# state, values greater than 10 but less than or equal to 20 a WARNING state,
# values strictly between 20 and 70 an OK state, values greater than or equal to
# 70 but less than 90 a WARNING state, and values greater than or equal to 90 a
# DANGER state.
# Corresponds to the JSON property `thresholds`
# @return [Array<Google::Apis::MonitoringV1::Threshold>]
attr_accessor :thresholds
@ -761,17 +759,16 @@ module Google
end
# The context of a span, attached to Exemplars in Distribution values during
# aggregation.It contains the name of a span with format:
# projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID]
# aggregation.It contains the name of a span with format: projects/[
# PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID]
class SpanContext
include Google::Apis::Core::Hashable
# The resource name of the span. The format is:
# projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID]
# [TRACE_ID] is a unique identifier for a trace within a project; it is a 32-
# character hexadecimal encoding of a 16-byte array.[SPAN_ID] is a unique
# identifier for a span within a trace; it is a 16-character hexadecimal
# encoding of an 8-byte array.
# The resource name of the span. The format is: projects/[PROJECT_ID_OR_NUMBER]/
# traces/[TRACE_ID]/spans/[SPAN_ID] [TRACE_ID] is a unique identifier for a
# trace within a project; it is a 32-character hexadecimal encoding of a 16-byte
# array.[SPAN_ID] is a unique identifier for a span within a trace; it is a 16-
# character hexadecimal encoding of an 8-byte array.
# Corresponds to the JSON property `spanName`
# @return [String]
attr_accessor :span_name
@ -1179,11 +1176,9 @@ module Google
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for Empty is empty JSON object ``.
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# Empty is empty JSON object ``.
# Corresponds to the JSON property `blank`
# @return [Google::Apis::MonitoringV1::Empty]
attr_accessor :blank

View File

@ -55,9 +55,9 @@ module Google
# create permission on the specified project. For more information, see Google
# Cloud IAM (https://cloud.google.com/iam).
# @param [String] parent
# Required. The project on which to execute the request. The format is:
# projects/[PROJECT_ID_OR_NUMBER]
# The [PROJECT_ID_OR_NUMBER] must match the dashboard resource name.
# Required. The project on which to execute the request. The format is: projects/
# [PROJECT_ID_OR_NUMBER] The [PROJECT_ID_OR_NUMBER] must match the dashboard
# resource name.
# @param [Google::Apis::MonitoringV1::Dashboard] dashboard_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -92,8 +92,8 @@ module Google
# dashboards.delete permission on the specified dashboard. For more information,
# see Google Cloud IAM (https://cloud.google.com/iam).
# @param [String] name
# Required. The resource name of the Dashboard. The format is:
# projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]
# Required. The resource name of the Dashboard. The format is: projects/[
# PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -125,10 +125,9 @@ module Google
# get permission on the specified dashboard. For more information, see Google
# Cloud IAM (https://cloud.google.com/iam).
# @param [String] name
# Required. The resource name of the Dashboard. The format is one of:
# dashboards/[DASHBOARD_ID] (for system dashboards)
# projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID] (for custom
# dashboards).
# Required. The resource name of the Dashboard. The format is one of: dashboards/
# [DASHBOARD_ID] (for system dashboards) projects/[PROJECT_ID_OR_NUMBER]/
# dashboards/[DASHBOARD_ID] (for custom dashboards).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -160,8 +159,8 @@ module Google
# list permission on the specified project. For more information, see Google
# Cloud IAM (https://cloud.google.com/iam).
# @param [String] parent
# Required. The scope of the dashboards to list. The format is:
# projects/[PROJECT_ID_OR_NUMBER]
# Required. The scope of the dashboards to list. The format is: projects/[
# PROJECT_ID_OR_NUMBER]
# @param [Fixnum] page_size
# A positive number that is the maximum number of results to return. If
# unspecified, a default of 1000 is used.

View File

@ -29,7 +29,7 @@ module Google
# @see https://cloud.google.com/monitoring/api/
module MonitoringV3
VERSION = 'V3'
REVISION = '20200728'
REVISION = '20200803'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

Some files were not shown because too many files have changed in this diff Show More