diff --git a/api_names_out.yaml b/api_names_out.yaml index 85a7dfd76..8a0a7df3b 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -20864,6 +20864,80 @@ "/cloudfunctions:v1beta2/fields": fields "/cloudfunctions:v1beta2/key": key "/cloudfunctions:v1beta2/quotaUser": quota_user +"/cloudidentity:v1/AndroidAttributes": android_attributes +"/cloudidentity:v1/AndroidAttributes/enabledUnknownSources": enabled_unknown_sources +"/cloudidentity:v1/AndroidAttributes/ownerProfileAccount": owner_profile_account +"/cloudidentity:v1/AndroidAttributes/ownershipPrivilege": ownership_privilege +"/cloudidentity:v1/AndroidAttributes/supportsWorkProfile": supports_work_profile +"/cloudidentity:v1/ApproveDeviceUserResponse": approve_device_user_response +"/cloudidentity:v1/ApproveDeviceUserResponse/deviceUser": device_user +"/cloudidentity:v1/BlockDeviceUserResponse": block_device_user_response +"/cloudidentity:v1/BlockDeviceUserResponse/deviceUser": device_user +"/cloudidentity:v1/CancelWipeDeviceResponse": cancel_wipe_device_response +"/cloudidentity:v1/CancelWipeDeviceResponse/device": device +"/cloudidentity:v1/CancelWipeDeviceUserResponse": cancel_wipe_device_user_response +"/cloudidentity:v1/CancelWipeDeviceUserResponse/deviceUser": device_user +"/cloudidentity:v1/ClientState": client_state +"/cloudidentity:v1/ClientState/assetTags": asset_tags +"/cloudidentity:v1/ClientState/assetTags/asset_tag": asset_tag +"/cloudidentity:v1/ClientState/complianceState": compliance_state +"/cloudidentity:v1/ClientState/createTime": create_time +"/cloudidentity:v1/ClientState/customId": custom_id +"/cloudidentity:v1/ClientState/etag": etag +"/cloudidentity:v1/ClientState/healthScore": health_score +"/cloudidentity:v1/ClientState/keyValuePairs": key_value_pairs +"/cloudidentity:v1/ClientState/keyValuePairs/key_value_pair": key_value_pair +"/cloudidentity:v1/ClientState/lastUpdateTime": last_update_time +"/cloudidentity:v1/ClientState/managed": managed +"/cloudidentity:v1/ClientState/name": name +"/cloudidentity:v1/ClientState/ownerType": owner_type +"/cloudidentity:v1/ClientState/scoreReason": score_reason +"/cloudidentity:v1/CustomAttributeValue": custom_attribute_value +"/cloudidentity:v1/CustomAttributeValue/boolValue": bool_value +"/cloudidentity:v1/CustomAttributeValue/numberValue": number_value +"/cloudidentity:v1/CustomAttributeValue/stringValue": string_value +"/cloudidentity:v1/Device": device +"/cloudidentity:v1/Device/androidSpecificAttributes": android_specific_attributes +"/cloudidentity:v1/Device/assetTag": asset_tag +"/cloudidentity:v1/Device/basebandVersion": baseband_version +"/cloudidentity:v1/Device/bootloaderVersion": bootloader_version +"/cloudidentity:v1/Device/brand": brand +"/cloudidentity:v1/Device/buildNumber": build_number +"/cloudidentity:v1/Device/compromisedState": compromised_state +"/cloudidentity:v1/Device/createTime": create_time +"/cloudidentity:v1/Device/deviceType": device_type +"/cloudidentity:v1/Device/enabledDeveloperOptions": enabled_developer_options +"/cloudidentity:v1/Device/enabledUsbDebugging": enabled_usb_debugging +"/cloudidentity:v1/Device/encryptionState": encryption_state +"/cloudidentity:v1/Device/imei": imei +"/cloudidentity:v1/Device/kernelVersion": kernel_version +"/cloudidentity:v1/Device/lastSyncTime": last_sync_time +"/cloudidentity:v1/Device/managementState": management_state +"/cloudidentity:v1/Device/manufacturer": manufacturer +"/cloudidentity:v1/Device/meid": meid +"/cloudidentity:v1/Device/model": model +"/cloudidentity:v1/Device/name": name +"/cloudidentity:v1/Device/networkOperator": network_operator +"/cloudidentity:v1/Device/osVersion": os_version +"/cloudidentity:v1/Device/otherAccounts": other_accounts +"/cloudidentity:v1/Device/otherAccounts/other_account": other_account +"/cloudidentity:v1/Device/ownerType": owner_type +"/cloudidentity:v1/Device/releaseVersion": release_version +"/cloudidentity:v1/Device/securityPatchTime": security_patch_time +"/cloudidentity:v1/Device/serialNumber": serial_number +"/cloudidentity:v1/Device/wifiMacAddresses": wifi_mac_addresses +"/cloudidentity:v1/Device/wifiMacAddresses/wifi_mac_address": wifi_mac_address +"/cloudidentity:v1/DeviceUser": device_user +"/cloudidentity:v1/DeviceUser/compromisedState": compromised_state +"/cloudidentity:v1/DeviceUser/createTime": create_time +"/cloudidentity:v1/DeviceUser/firstSyncTime": first_sync_time +"/cloudidentity:v1/DeviceUser/languageCode": language_code +"/cloudidentity:v1/DeviceUser/lastSyncTime": last_sync_time +"/cloudidentity:v1/DeviceUser/managementState": management_state +"/cloudidentity:v1/DeviceUser/name": name +"/cloudidentity:v1/DeviceUser/passwordState": password_state +"/cloudidentity:v1/DeviceUser/userAgent": user_agent +"/cloudidentity:v1/DeviceUser/userEmail": user_email "/cloudidentity:v1/EntityKey": entity_key "/cloudidentity:v1/EntityKey/id": id "/cloudidentity:v1/EntityKey/namespace": namespace @@ -20916,6 +20990,10 @@ "/cloudidentity:v1/Status/details/detail": detail "/cloudidentity:v1/Status/details/detail/detail": detail "/cloudidentity:v1/Status/message": message +"/cloudidentity:v1/WipeDeviceResponse": wipe_device_response +"/cloudidentity:v1/WipeDeviceResponse/device": device +"/cloudidentity:v1/WipeDeviceUserResponse": wipe_device_user_response +"/cloudidentity:v1/WipeDeviceUserResponse/deviceUser": device_user "/cloudidentity:v1/cloudidentity.groups.create": create_group "/cloudidentity:v1/cloudidentity.groups.delete": delete_group "/cloudidentity:v1/cloudidentity.groups.delete/name": name @@ -20960,12 +21038,20 @@ "/cloudidentity:v1beta1/AndroidAttributes/ownerProfileAccount": owner_profile_account "/cloudidentity:v1beta1/AndroidAttributes/ownershipPrivilege": ownership_privilege "/cloudidentity:v1beta1/AndroidAttributes/supportsWorkProfile": supports_work_profile +"/cloudidentity:v1beta1/ApproveDeviceUserRequest": approve_device_user_request +"/cloudidentity:v1beta1/ApproveDeviceUserRequest/customer": customer "/cloudidentity:v1beta1/ApproveDeviceUserResponse": approve_device_user_response "/cloudidentity:v1beta1/ApproveDeviceUserResponse/deviceUser": device_user +"/cloudidentity:v1beta1/BlockDeviceUserRequest": block_device_user_request +"/cloudidentity:v1beta1/BlockDeviceUserRequest/customer": customer "/cloudidentity:v1beta1/BlockDeviceUserResponse": block_device_user_response "/cloudidentity:v1beta1/BlockDeviceUserResponse/deviceUser": device_user +"/cloudidentity:v1beta1/CancelWipeDeviceRequest": cancel_wipe_device_request +"/cloudidentity:v1beta1/CancelWipeDeviceRequest/customer": customer "/cloudidentity:v1beta1/CancelWipeDeviceResponse": cancel_wipe_device_response "/cloudidentity:v1beta1/CancelWipeDeviceResponse/device": device +"/cloudidentity:v1beta1/CancelWipeDeviceUserRequest": cancel_wipe_device_user_request +"/cloudidentity:v1beta1/CancelWipeDeviceUserRequest/customer": customer "/cloudidentity:v1beta1/CancelWipeDeviceUserResponse": cancel_wipe_device_user_response "/cloudidentity:v1beta1/CancelWipeDeviceUserResponse/deviceUser": device_user "/cloudidentity:v1beta1/ClientState": client_state @@ -20983,6 +21069,9 @@ "/cloudidentity:v1beta1/ClientState/name": name "/cloudidentity:v1beta1/ClientState/ownerType": owner_type "/cloudidentity:v1beta1/ClientState/scoreReason": score_reason +"/cloudidentity:v1beta1/CreateDeviceRequest": create_device_request +"/cloudidentity:v1beta1/CreateDeviceRequest/customer": customer +"/cloudidentity:v1beta1/CreateDeviceRequest/device": device "/cloudidentity:v1beta1/CustomAttributeValue": custom_attribute_value "/cloudidentity:v1beta1/CustomAttributeValue/boolValue": bool_value "/cloudidentity:v1beta1/CustomAttributeValue/numberValue": number_value @@ -21138,10 +21227,67 @@ "/cloudidentity:v1beta1/UpdateMembershipRolesParams": update_membership_roles_params "/cloudidentity:v1beta1/UpdateMembershipRolesParams/fieldMask": field_mask "/cloudidentity:v1beta1/UpdateMembershipRolesParams/membershipRole": membership_role +"/cloudidentity:v1beta1/WipeDeviceRequest": wipe_device_request +"/cloudidentity:v1beta1/WipeDeviceRequest/customer": customer "/cloudidentity:v1beta1/WipeDeviceResponse": wipe_device_response "/cloudidentity:v1beta1/WipeDeviceResponse/device": device +"/cloudidentity:v1beta1/WipeDeviceUserRequest": wipe_device_user_request +"/cloudidentity:v1beta1/WipeDeviceUserRequest/customer": customer "/cloudidentity:v1beta1/WipeDeviceUserResponse": wipe_device_user_response "/cloudidentity:v1beta1/WipeDeviceUserResponse/deviceUser": device_user +"/cloudidentity:v1beta1/cloudidentity.devices.cancelWipe": cancel_wipe_device +"/cloudidentity:v1beta1/cloudidentity.devices.cancelWipe/name": name +"/cloudidentity:v1beta1/cloudidentity.devices.create": create_device +"/cloudidentity:v1beta1/cloudidentity.devices.delete": delete_device +"/cloudidentity:v1beta1/cloudidentity.devices.delete/customer": customer +"/cloudidentity:v1beta1/cloudidentity.devices.delete/name": name +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.approve": approve_device_user +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.approve/name": name +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.block": block_device_user +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.block/name": name +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.cancelWipe": cancel_wipe_device_user +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.cancelWipe/name": name +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.clientStates.get": get_device_device_user_client_state +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.clientStates.get/customer": customer +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.clientStates.get/name": name +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.clientStates.patch": patch_device_device_user_client_state +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.clientStates.patch/customer": customer +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.clientStates.patch/name": name +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.clientStates.patch/updateMask": update_mask +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.delete": delete_device_device_user +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.delete/customer": customer +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.delete/name": name +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.get": get_device_device_user +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.get/customer": customer +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.get/name": name +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.list": list_device_device_users +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.list/customer": customer +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.list/filter": filter +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.list/orderBy": order_by +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.list/pageSize": page_size +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.list/pageToken": page_token +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.list/parent": parent +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.lookup": lookup_device_device_user +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.lookup/androidId": android_id +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.lookup/pageSize": page_size +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.lookup/pageToken": page_token +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.lookup/parent": parent +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.lookup/rawResourceId": raw_resource_id +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.lookup/userId": user_id +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.wipe": wipe_device_user +"/cloudidentity:v1beta1/cloudidentity.devices.deviceUsers.wipe/name": name +"/cloudidentity:v1beta1/cloudidentity.devices.get": get_device +"/cloudidentity:v1beta1/cloudidentity.devices.get/customer": customer +"/cloudidentity:v1beta1/cloudidentity.devices.get/name": name +"/cloudidentity:v1beta1/cloudidentity.devices.list": list_devices +"/cloudidentity:v1beta1/cloudidentity.devices.list/customer": customer +"/cloudidentity:v1beta1/cloudidentity.devices.list/filter": filter +"/cloudidentity:v1beta1/cloudidentity.devices.list/orderBy": order_by +"/cloudidentity:v1beta1/cloudidentity.devices.list/pageSize": page_size +"/cloudidentity:v1beta1/cloudidentity.devices.list/pageToken": page_token +"/cloudidentity:v1beta1/cloudidentity.devices.list/view": view +"/cloudidentity:v1beta1/cloudidentity.devices.wipe": wipe_device +"/cloudidentity:v1beta1/cloudidentity.devices.wipe/name": name "/cloudidentity:v1beta1/cloudidentity.groups.create": create_group "/cloudidentity:v1beta1/cloudidentity.groups.create/initialGroupConfig": initial_group_config "/cloudidentity:v1beta1/cloudidentity.groups.delete": delete_group @@ -80857,6 +81003,8 @@ "/dfareporting:v3.4/key": key "/dfareporting:v3.4/quotaUser": quota_user "/dfareporting:v3.4/userIp": user_ip +"/dialogflow:v2/GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata": google_cloud_dialogflow_cx_v3beta1_create_version_operation_metadata +"/dialogflow:v2/GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata/version": version "/dialogflow:v2/GoogleCloudDialogflowCxV3beta1ExportAgentResponse": google_cloud_dialogflow_cx_v3beta1_export_agent_response "/dialogflow:v2/GoogleCloudDialogflowCxV3beta1ExportAgentResponse/agentContent": agent_content "/dialogflow:v2/GoogleCloudDialogflowCxV3beta1ExportAgentResponse/agentUri": agent_uri @@ -81755,6 +81903,8 @@ "/dialogflow:v2/GoogleCloudDialogflowV2beta1WebhookResponse/sessionEntityTypes": session_entity_types "/dialogflow:v2/GoogleCloudDialogflowV2beta1WebhookResponse/sessionEntityTypes/session_entity_type": session_entity_type "/dialogflow:v2/GoogleCloudDialogflowV2beta1WebhookResponse/source": source +"/dialogflow:v2/GoogleCloudDialogflowV3alpha1CreateVersionOperationMetadata": google_cloud_dialogflow_v3alpha1_create_version_operation_metadata +"/dialogflow:v2/GoogleCloudDialogflowV3alpha1CreateVersionOperationMetadata/version": version "/dialogflow:v2/GoogleCloudDialogflowV3alpha1ExportAgentResponse": google_cloud_dialogflow_v3alpha1_export_agent_response "/dialogflow:v2/GoogleCloudDialogflowV3alpha1ExportAgentResponse/agentContent": agent_content "/dialogflow:v2/GoogleCloudDialogflowV3alpha1ExportAgentResponse/agentUri": agent_uri @@ -82060,6 +82210,8 @@ "/dialogflow:v2beta1/ExportAgentResponse": export_agent_response "/dialogflow:v2beta1/ExportAgentResponse/agentContent": agent_content "/dialogflow:v2beta1/ExportAgentResponse/agentUri": agent_uri +"/dialogflow:v2beta1/GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata": google_cloud_dialogflow_cx_v3beta1_create_version_operation_metadata +"/dialogflow:v2beta1/GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata/version": version "/dialogflow:v2beta1/GoogleCloudDialogflowCxV3beta1ExportAgentResponse": google_cloud_dialogflow_cx_v3beta1_export_agent_response "/dialogflow:v2beta1/GoogleCloudDialogflowCxV3beta1ExportAgentResponse/agentContent": agent_content "/dialogflow:v2beta1/GoogleCloudDialogflowCxV3beta1ExportAgentResponse/agentUri": agent_uri @@ -83161,6 +83313,8 @@ "/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1WebhookResponse/sessionEntityTypes": session_entity_types "/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1WebhookResponse/sessionEntityTypes/session_entity_type": session_entity_type "/dialogflow:v2beta1/GoogleCloudDialogflowV2beta1WebhookResponse/source": source +"/dialogflow:v2beta1/GoogleCloudDialogflowV3alpha1CreateVersionOperationMetadata": google_cloud_dialogflow_v3alpha1_create_version_operation_metadata +"/dialogflow:v2beta1/GoogleCloudDialogflowV3alpha1CreateVersionOperationMetadata/version": version "/dialogflow:v2beta1/GoogleCloudDialogflowV3alpha1ExportAgentResponse": google_cloud_dialogflow_v3alpha1_export_agent_response "/dialogflow:v2beta1/GoogleCloudDialogflowV3alpha1ExportAgentResponse/agentContent": agent_content "/dialogflow:v2beta1/GoogleCloudDialogflowV3alpha1ExportAgentResponse/agentUri": agent_uri @@ -116210,11 +116364,26 @@ "/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest/name": name "/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest": google_devtools_remotebuildexecution_admin_v1alpha_delete_worker_pool_request "/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest/name": name +"/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy": google_devtools_remotebuildexecution_admin_v1alpha_feature_policy +"/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/containerImageSources": container_image_sources +"/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerAddCapabilities": docker_add_capabilities +"/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerChrootPath": docker_chroot_path +"/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerNetwork": docker_network +"/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerPrivileged": docker_privileged +"/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerRunAsRoot": docker_run_as_root +"/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerRuntime": docker_runtime +"/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerSiblingContainers": docker_sibling_containers +"/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/linuxIsolation": linux_isolation +"/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature": google_devtools_remotebuildexecution_admin_v1alpha_feature_policy_feature +"/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature/allowedValues": allowed_values +"/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature/allowedValues/allowed_value": allowed_value +"/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature/policy": policy "/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest": google_devtools_remotebuildexecution_admin_v1alpha_get_instance_request "/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest/name": name "/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest": google_devtools_remotebuildexecution_admin_v1alpha_get_worker_pool_request "/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest/name": name "/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance": google_devtools_remotebuildexecution_admin_v1alpha_instance +"/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance/featurePolicy": feature_policy "/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance/location": location "/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance/loggingEnabled": logging_enabled "/remotebuildexecution:v1/GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance/name": name @@ -116616,11 +116785,26 @@ "/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest/name": name "/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest": google_devtools_remotebuildexecution_admin_v1alpha_delete_worker_pool_request "/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest/name": name +"/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy": google_devtools_remotebuildexecution_admin_v1alpha_feature_policy +"/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/containerImageSources": container_image_sources +"/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerAddCapabilities": docker_add_capabilities +"/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerChrootPath": docker_chroot_path +"/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerNetwork": docker_network +"/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerPrivileged": docker_privileged +"/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerRunAsRoot": docker_run_as_root +"/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerRuntime": docker_runtime +"/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerSiblingContainers": docker_sibling_containers +"/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/linuxIsolation": linux_isolation +"/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature": google_devtools_remotebuildexecution_admin_v1alpha_feature_policy_feature +"/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature/allowedValues": allowed_values +"/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature/allowedValues/allowed_value": allowed_value +"/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature/policy": policy "/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest": google_devtools_remotebuildexecution_admin_v1alpha_get_instance_request "/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest/name": name "/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest": google_devtools_remotebuildexecution_admin_v1alpha_get_worker_pool_request "/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest/name": name "/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance": google_devtools_remotebuildexecution_admin_v1alpha_instance +"/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance/featurePolicy": feature_policy "/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance/location": location "/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance/loggingEnabled": logging_enabled "/remotebuildexecution:v1alpha/GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance/name": name @@ -116824,6 +117008,11 @@ "/remotebuildexecution:v1alpha/remotebuildexecution.projects.instances.get/name": name "/remotebuildexecution:v1alpha/remotebuildexecution.projects.instances.list": list_project_instances "/remotebuildexecution:v1alpha/remotebuildexecution.projects.instances.list/parent": parent +"/remotebuildexecution:v1alpha/remotebuildexecution.projects.instances.patch": patch_project_instance +"/remotebuildexecution:v1alpha/remotebuildexecution.projects.instances.patch/loggingEnabled": logging_enabled +"/remotebuildexecution:v1alpha/remotebuildexecution.projects.instances.patch/name": name +"/remotebuildexecution:v1alpha/remotebuildexecution.projects.instances.patch/name1": name1 +"/remotebuildexecution:v1alpha/remotebuildexecution.projects.instances.patch/updateMask": update_mask "/remotebuildexecution:v1alpha/remotebuildexecution.projects.instances.workerpools.create": create_project_instance_workerpool "/remotebuildexecution:v1alpha/remotebuildexecution.projects.instances.workerpools.create/parent": parent "/remotebuildexecution:v1alpha/remotebuildexecution.projects.instances.workerpools.delete": delete_project_instance_workerpool @@ -117084,11 +117273,26 @@ "/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest/name": name "/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest": google_devtools_remotebuildexecution_admin_v1alpha_delete_worker_pool_request "/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest/name": name +"/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy": google_devtools_remotebuildexecution_admin_v1alpha_feature_policy +"/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/containerImageSources": container_image_sources +"/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerAddCapabilities": docker_add_capabilities +"/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerChrootPath": docker_chroot_path +"/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerNetwork": docker_network +"/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerPrivileged": docker_privileged +"/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerRunAsRoot": docker_run_as_root +"/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerRuntime": docker_runtime +"/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/dockerSiblingContainers": docker_sibling_containers +"/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy/linuxIsolation": linux_isolation +"/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature": google_devtools_remotebuildexecution_admin_v1alpha_feature_policy_feature +"/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature/allowedValues": allowed_values +"/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature/allowedValues/allowed_value": allowed_value +"/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature/policy": policy "/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest": google_devtools_remotebuildexecution_admin_v1alpha_get_instance_request "/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest/name": name "/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest": google_devtools_remotebuildexecution_admin_v1alpha_get_worker_pool_request "/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest/name": name "/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance": google_devtools_remotebuildexecution_admin_v1alpha_instance +"/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance/featurePolicy": feature_policy "/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance/location": location "/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance/loggingEnabled": logging_enabled "/remotebuildexecution:v2/GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance/name": name diff --git a/generated/google/apis/accesscontextmanager_v1.rb b/generated/google/apis/accesscontextmanager_v1.rb index d83f52d56..f589e19f4 100644 --- a/generated/google/apis/accesscontextmanager_v1.rb +++ b/generated/google/apis/accesscontextmanager_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/access-context-manager/docs/reference/rest/ module AccesscontextmanagerV1 VERSION = 'V1' - REVISION = '20200405' + REVISION = '20200801' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/accesscontextmanager_v1/classes.rb b/generated/google/apis/accesscontextmanager_v1/classes.rb index 984a11ee9..bd3a56a07 100644 --- a/generated/google/apis/accesscontextmanager_v1/classes.rb +++ b/generated/google/apis/accesscontextmanager_v1/classes.rb @@ -34,8 +34,8 @@ module Google attr_accessor :basic # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language - # to represent the necessary conditions for the level to apply to a request. - # See CEL spec at: https://github.com/google/cel-spec + # to represent the necessary conditions for the level to apply to a request. See + # CEL spec at: https://github.com/google/cel-spec # Corresponds to the JSON property `custom` # @return [Google::Apis::AccesscontextmanagerV1::CustomLevel] attr_accessor :custom @@ -45,10 +45,10 @@ module Google # @return [String] attr_accessor :description - # Required. Resource name for the Access Level. The `short_name` component - # must begin with a letter and only include alphanumeric and '_'. Format: - # `accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length - # of the `short_name` component is 50 characters. + # Required. Resource name for the Access Level. The `short_name` component must + # begin with a letter and only include alphanumeric and '_'. Format: ` + # accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length of + # the `short_name` component is 50 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -73,30 +73,29 @@ module Google end # `AccessPolicy` is a container for `AccessLevels` (which define the necessary - # attributes to use Google Cloud services) and `ServicePerimeters` (which - # define regions of services able to freely pass data within a perimeter). An - # access policy is globally visible within an organization, and the - # restrictions it specifies apply to all projects within an organization. + # attributes to use Google Cloud services) and `ServicePerimeters` (which define + # regions of services able to freely pass data within a perimeter). An access + # policy is globally visible within an organization, and the restrictions it + # specifies apply to all projects within an organization. class AccessPolicy include Google::Apis::Core::Hashable - # Output only. An opaque identifier for the current version of the - # `AccessPolicy`. This will always be a strongly validated etag, meaning that - # two Access Polices will be identical if and only if their etags are - # identical. Clients should not expect this to be in any specific format. + # Output only. An opaque identifier for the current version of the `AccessPolicy` + # . This will always be a strongly validated etag, meaning that two Access + # Polices will be identical if and only if their etags are identical. Clients + # should not expect this to be in any specific format. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # Output only. Resource name of the `AccessPolicy`. Format: - # `accessPolicies/`policy_id`` + # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/` + # policy_id`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The parent of this `AccessPolicy` in the Cloud Resource - # Hierarchy. Currently immutable once created. Format: - # `organizations/`organization_id`` + # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. + # Currently immutable once created. Format: `organizations/`organization_id`` # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -124,10 +123,10 @@ module Google include Google::Apis::Core::Hashable # How the `conditions` list should be combined to determine if a request is - # granted this `AccessLevel`. If AND is used, each `Condition` in - # `conditions` must be satisfied for the `AccessLevel` to be applied. If OR - # is used, at least one `Condition` in `conditions` must be satisfied for the - # `AccessLevel` to be applied. Default behavior is AND. + # granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` + # must be satisfied for the `AccessLevel` to be applied. If OR is used, at least + # one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be + # applied. Default behavior is AND. # Corresponds to the JSON property `combiningFunction` # @return [String] attr_accessor :combining_function @@ -161,17 +160,17 @@ module Google end end - # A request to commit dry-run specs in all Service Perimeters belonging to - # an Access Policy. + # A request to commit dry-run specs in all Service Perimeters belonging to an + # Access Policy. class CommitServicePerimetersRequest include Google::Apis::Core::Hashable - # Optional. The etag for the version of the Access Policy that this - # commit operation is to be performed on. If, at the time of commit, the - # etag for the Access Policy stored in Access Context Manager is different - # from the specified etag, then the commit operation will not be performed - # and the call will fail. This field is not required. If etag is not - # provided, the operation will be performed as if a valid etag is provided. + # Optional. The etag for the version of the Access Policy that this commit + # operation is to be performed on. If, at the time of commit, the etag for the + # Access Policy stored in Access Context Manager is different from the specified + # etag, then the commit operation will not be performed and the call will fail. + # This field is not required. If etag is not provided, the operation will be + # performed as if a valid etag is provided. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -191,8 +190,7 @@ module Google class CommitServicePerimetersResponse include Google::Apis::Core::Hashable - # List of all the Service Perimeter instances in - # the Access Policy. + # List of all the Service Perimeter instances in the Access Policy. # Corresponds to the JSON property `servicePerimeters` # @return [Array] attr_accessor :service_perimeters @@ -220,54 +218,48 @@ module Google # devices to be granted access levels, it does not do any enforcement on the # device. `DevicePolicy` acts as an AND over all specified fields, and each # repeated field is an OR over its elements. Any unset fields are ignored. For - # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : - # DESKTOP_LINUX, encryption_status: ENCRYPTED`, then the DevicePolicy will be - # true for requests originating from encrypted Linux desktops and encrypted - # Windows desktops. + # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, + # encryption_status: ENCRYPTED`, then the DevicePolicy will be true for requests + # originating from encrypted Linux desktops and encrypted Windows desktops. # Corresponds to the JSON property `devicePolicy` # @return [Google::Apis::AccesscontextmanagerV1::DevicePolicy] attr_accessor :device_policy - # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for - # a CIDR IP address block, the specified IP address portion must be properly + # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a + # CIDR IP address block, the specified IP address portion must be properly # truncated (i.e. all the host bits must be zero) or the input is considered - # malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is - # not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas - # "2001:db8::1/32" is not. The originating IP of a request must be in one of - # the listed subnets in order for this Condition to be true. If empty, all IP - # addresses are allowed. + # malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. + # Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is + # not. The originating IP of a request must be in one of the listed subnets in + # order for this Condition to be true. If empty, all IP addresses are allowed. # Corresponds to the JSON property `ipSubnetworks` # @return [Array] attr_accessor :ip_subnetworks - # The request must be made by one of the provided user or service - # accounts. Groups are not supported. - # Syntax: - # `user:`emailid`` - # `serviceAccount:`emailid`` + # The request must be made by one of the provided user or service accounts. + # Groups are not supported. Syntax: `user:`emailid`` `serviceAccount:`emailid`` # If not specified, a request may come from any user. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members # Whether to negate the Condition. If true, the Condition becomes a NAND over - # its non-empty fields, each field must be false for the Condition overall to - # be satisfied. Defaults to false. + # its non-empty fields, each field must be false for the Condition overall to be + # satisfied. Defaults to false. # Corresponds to the JSON property `negate` # @return [Boolean] attr_accessor :negate alias_method :negate?, :negate - # The request must originate from one of the provided countries/regions. - # Must be valid ISO 3166-1 alpha-2 codes. + # The request must originate from one of the provided countries/regions. Must be + # valid ISO 3166-1 alpha-2 codes. # Corresponds to the JSON property `regions` # @return [Array] attr_accessor :regions # A list of other access levels defined in the same `Policy`, referenced by - # resource name. Referencing an `AccessLevel` which does not exist is an - # error. All access levels listed must be granted for the Condition - # to be true. Example: + # resource name. Referencing an `AccessLevel` which does not exist is an error. + # All access levels listed must be granted for the Condition to be true. Example: # "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` # Corresponds to the JSON property `requiredAccessLevels` # @return [Array] @@ -289,33 +281,26 @@ module Google end # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language - # to represent the necessary conditions for the level to apply to a request. - # See CEL spec at: https://github.com/google/cel-spec + # to represent the necessary conditions for the level to apply to a request. See + # CEL spec at: https://github.com/google/cel-spec class CustomLevel 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 `expr` # @return [Google::Apis::AccesscontextmanagerV1::Expr] attr_accessor :expr @@ -335,15 +320,13 @@ module Google # devices to be granted access levels, it does not do any enforcement on the # device. `DevicePolicy` acts as an AND over all specified fields, and each # repeated field is an OR over its elements. Any unset fields are ignored. For - # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : - # DESKTOP_LINUX, encryption_status: ENCRYPTED`, then the DevicePolicy will be - # true for requests originating from encrypted Linux desktops and encrypted - # Windows desktops. + # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, + # encryption_status: ENCRYPTED`, then the DevicePolicy will be true for requests + # originating from encrypted Linux desktops and encrypted Windows desktops. class DevicePolicy include Google::Apis::Core::Hashable - # Allowed device management levels, an empty list allows all management - # levels. + # Allowed device management levels, an empty list allows all management levels. # Corresponds to the JSON property `allowedDeviceManagementLevels` # @return [Array] attr_accessor :allowed_device_management_levels @@ -392,13 +375,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 @@ -411,52 +392,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 @@ -582,47 +554,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::AccesscontextmanagerV1::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] 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] attr_accessor :response @@ -645,9 +615,9 @@ module Google class OsConstraint include Google::Apis::Core::Hashable - # The minimum allowed OS version. If not set, any version of this OS - # satisfies the constraint. Format: `"major.minor.patch"`. - # Examples: `"10.5.301"`, `"9.2.1"`. + # The minimum allowed OS version. If not set, any version of this OS satisfies + # the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1" + # `. # Corresponds to the JSON property `minimumVersion` # @return [String] attr_accessor :minimum_version @@ -657,10 +627,10 @@ module Google # @return [String] attr_accessor :os_type - # Only allows requests from devices with a verified Chrome OS. - # Verifications includes requirements that the device is enterprise-managed, - # conformant to domain policies, and the caller has permission to call - # the API targeted by the request. + # Only allows requests from devices with a verified Chrome OS. Verifications + # includes requirements that the device is enterprise-managed, conformant to + # domain policies, and the caller has permission to call the API targeted by the + # request. # Corresponds to the JSON property `requireVerifiedChromeOs` # @return [Boolean] attr_accessor :require_verified_chrome_os @@ -678,24 +648,23 @@ module Google end end - # A request to replace all existing Access Levels in an Access Policy with - # the Access Levels provided. This is done atomically. + # A request to replace all existing Access Levels in an Access Policy with the + # Access Levels provided. This is done atomically. class ReplaceAccessLevelsRequest include Google::Apis::Core::Hashable - # Required. The desired Access Levels that should - # replace all existing Access Levels in the - # Access Policy. + # Required. The desired Access Levels that should replace all existing Access + # Levels in the Access Policy. # Corresponds to the JSON property `accessLevels` # @return [Array] attr_accessor :access_levels - # Optional. The etag for the version of the Access Policy that this - # replace operation is to be performed on. If, at the time of replace, the - # etag for the Access Policy stored in Access Context Manager is different - # from the specified etag, then the replace operation will not be performed - # and the call will fail. This field is not required. If etag is not - # provided, the operation will be performed as if a valid etag is provided. + # Optional. The etag for the version of the Access Policy that this replace + # operation is to be performed on. If, at the time of replace, the etag for the + # Access Policy stored in Access Context Manager is different from the specified + # etag, then the replace operation will not be performed and the call will fail. + # This field is not required. If etag is not provided, the operation will be + # performed as if a valid etag is provided. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -711,8 +680,8 @@ module Google end end - # A response to ReplaceAccessLevelsRequest. This will be put inside of - # Operation.response field. + # A response to ReplaceAccessLevelsRequest. This will be put inside of Operation. + # response field. class ReplaceAccessLevelsResponse include Google::Apis::Core::Hashable @@ -731,24 +700,23 @@ module Google end end - # A request to replace all existing Service Perimeters in an Access Policy - # with the Service Perimeters provided. This is done atomically. + # A request to replace all existing Service Perimeters in an Access Policy with + # the Service Perimeters provided. This is done atomically. class ReplaceServicePerimetersRequest include Google::Apis::Core::Hashable - # Optional. The etag for the version of the Access Policy that this - # replace operation is to be performed on. If, at the time of replace, the - # etag for the Access Policy stored in Access Context Manager is different - # from the specified etag, then the replace operation will not be performed - # and the call will fail. This field is not required. If etag is not - # provided, the operation will be performed as if a valid etag is provided. + # Optional. The etag for the version of the Access Policy that this replace + # operation is to be performed on. If, at the time of replace, the etag for the + # Access Policy stored in Access Context Manager is different from the specified + # etag, then the replace operation will not be performed and the call will fail. + # This field is not required. If etag is not provided, the operation will be + # performed as if a valid etag is provided. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # Required. The desired Service Perimeters that should - # replace all existing Service Perimeters in the - # Access Policy. + # Required. The desired Service Perimeters that should replace all existing + # Service Perimeters in the Access Policy. # Corresponds to the JSON property `servicePerimeters` # @return [Array] attr_accessor :service_perimeters @@ -785,37 +753,34 @@ module Google end # `ServicePerimeter` describes a set of Google Cloud resources which can freely - # import and export data amongst themselves, but not export outside of the - # `ServicePerimeter`. If a request with a source within this `ServicePerimeter` + # import and export data amongst themselves, but not export outside of the ` + # ServicePerimeter`. If a request with a source within this `ServicePerimeter` # has a target outside of the `ServicePerimeter`, the request will be blocked. # Otherwise the request is allowed. There are two types of Service Perimeter - - # Regular and Bridge. Regular Service Perimeters cannot overlap, a single - # Google Cloud project can only belong to a single regular Service Perimeter. - # Service Perimeter Bridges can contain only Google Cloud projects as members, - # a single Google Cloud project may belong to multiple Service Perimeter - # Bridges. + # Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google + # Cloud project can only belong to a single regular Service Perimeter. Service + # Perimeter Bridges can contain only Google Cloud projects as members, a single + # Google Cloud project may belong to multiple Service Perimeter Bridges. class ServicePerimeter include Google::Apis::Core::Hashable - # Description of the `ServicePerimeter` and its use. Does not affect - # behavior. + # Description of the `ServicePerimeter` and its use. Does not affect behavior. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Required. Resource name for the ServicePerimeter. The `short_name` - # component must begin with a letter and only include alphanumeric and '_'. - # Format: `accessPolicies/`policy_id`/servicePerimeters/`short_name`` + # Required. Resource name for the ServicePerimeter. The `short_name` component + # must begin with a letter and only include alphanumeric and '_'. Format: ` + # accessPolicies/`policy_id`/servicePerimeters/`short_name`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Perimeter type indicator. A single project is - # allowed to be a member of single regular perimeter, but multiple service - # perimeter bridges. A project cannot be a included in a perimeter bridge - # without being included in regular perimeter. For perimeter bridges, - # the restricted service list as well as access level lists must be - # empty. + # Perimeter type indicator. A single project is allowed to be a member of single + # regular perimeter, but multiple service perimeter bridges. A project cannot be + # a included in a perimeter bridge without being included in regular perimeter. + # For perimeter bridges, the restricted service list as well as access level + # lists must be empty. # Corresponds to the JSON property `perimeterType` # @return [String] attr_accessor :perimeter_type @@ -837,16 +802,15 @@ module Google # @return [String] attr_accessor :title - # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly - # exists for all Service Perimeters, and that spec is identical to the - # status for those Service Perimeters. When this flag is set, it inhibits the - # generation of the implicit spec, thereby allowing the user to explicitly - # provide a configuration ("spec") to use in a dry-run version of the Service - # Perimeter. This allows the user to test changes to the enforced config - # ("status") without actually enforcing them. This testing is done through - # analyzing the differences between currently enforced and suggested - # restrictions. use_explicit_dry_run_spec must bet set to True if any of the - # fields in the spec are set to non-default values. + # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists + # for all Service Perimeters, and that spec is identical to the status for those + # Service Perimeters. When this flag is set, it inhibits the generation of the + # implicit spec, thereby allowing the user to explicitly provide a configuration + # ("spec") to use in a dry-run version of the Service Perimeter. This allows the + # user to test changes to the enforced config ("status") without actually + # enforcing them. This testing is done through analyzing the differences between + # currently enforced and suggested restrictions. use_explicit_dry_run_spec must + # bet set to True if any of the fields in the spec are set to non-default values. # Corresponds to the JSON property `useExplicitDryRunSpec` # @return [Boolean] attr_accessor :use_explicit_dry_run_spec @@ -873,14 +837,13 @@ module Google class ServicePerimeterConfig include Google::Apis::Core::Hashable - # A list of `AccessLevel` resource names that allow resources within the - # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed - # must be in the same policy as this `ServicePerimeter`. Referencing a - # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are - # listed, resources within the perimeter can only be accessed via Google - # Cloud calls with request origins within the perimeter. Example: - # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. - # For Service Perimeter Bridge, must be empty. + # A list of `AccessLevel` resource names that allow resources within the ` + # ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must + # be in the same policy as this `ServicePerimeter`. Referencing a nonexistent ` + # AccessLevel` is a syntax error. If no `AccessLevel` names are listed, + # resources within the perimeter can only be accessed via Google Cloud calls + # with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/ + # accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. # Corresponds to the JSON property `accessLevels` # @return [Array] attr_accessor :access_levels @@ -891,16 +854,14 @@ module Google # @return [Array] attr_accessor :resources - # Google Cloud services that are subject to the Service Perimeter - # restrictions. For example, if `storage.googleapis.com` is specified, access - # to the storage buckets inside the perimeter must meet the perimeter's - # access restrictions. + # Google Cloud services that are subject to the Service Perimeter restrictions. + # For example, if `storage.googleapis.com` is specified, access to the storage + # buckets inside the perimeter must meet the perimeter's access restrictions. # Corresponds to the JSON property `restrictedServices` # @return [Array] attr_accessor :restricted_services - # Specifies how APIs are allowed to communicate within the Service - # Perimeter. + # Specifies how APIs are allowed to communicate within the Service Perimeter. # Corresponds to the JSON property `vpcAccessibleServices` # @return [Google::Apis::AccesscontextmanagerV1::VpcAccessibleServices] attr_accessor :vpc_accessible_services @@ -918,12 +879,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 @@ -932,15 +893,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>] 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 @@ -957,19 +918,20 @@ module Google end end - # Specifies how APIs are allowed to communicate within the Service - # Perimeter. + # Specifies how APIs are allowed to communicate within the Service Perimeter. class VpcAccessibleServices include Google::Apis::Core::Hashable - # The list of APIs usable within the Service Perimeter. Must be empty - # unless 'enable_restriction' is True. + # The list of APIs usable within the Service Perimeter. Must be empty unless ' + # enable_restriction' is True. You can specify a list of individual services, as + # well as include the 'RESTRICTED-SERVICES' value, which automatically includes + # all of the services protected by the perimeter. # Corresponds to the JSON property `allowedServices` # @return [Array] attr_accessor :allowed_services - # Whether to restrict API calls within the Service Perimeter to the list of - # APIs specified in 'allowed_services'. + # Whether to restrict API calls within the Service Perimeter to the list of APIs + # specified in 'allowed_services'. # Corresponds to the JSON property `enableRestriction` # @return [Boolean] attr_accessor :enable_restriction diff --git a/generated/google/apis/accesscontextmanager_v1/service.rb b/generated/google/apis/accesscontextmanager_v1/service.rb index ef14239ac..42e4dccec 100644 --- a/generated/google/apis/accesscontextmanager_v1/service.rb +++ b/generated/google/apis/accesscontextmanager_v1/service.rb @@ -47,11 +47,10 @@ module Google @batch_path = 'batch' end - # Create an `AccessPolicy`. Fails if this organization already has a - # `AccessPolicy`. The longrunning Operation will have a successful status - # once the `AccessPolicy` has propagated to long-lasting storage. - # Syntactic and basic semantic errors will be returned in `metadata` as a - # BadRequest proto. + # Create an `AccessPolicy`. Fails if this organization already has a ` + # AccessPolicy`. The longrunning Operation will have a successful status once + # the `AccessPolicy` has propagated to long-lasting storage. Syntactic and basic + # semantic errors will be returned in `metadata` as a BadRequest proto. # @param [Google::Apis::AccesscontextmanagerV1::AccessPolicy] access_policy_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -81,13 +80,12 @@ module Google execute_or_queue_command(command, &block) end - # Delete an AccessPolicy by resource - # name. The longrunning Operation will have a successful status once the - # AccessPolicy - # has been removed from long-lasting storage. + # Delete an AccessPolicy by resource name. The longrunning Operation will have a + # successful status once the AccessPolicy has been removed from long-lasting + # storage. # @param [String] name - # Required. Resource name for the access policy to delete. - # Format `accessPolicies/`policy_id`` + # Required. Resource name for the access policy to delete. Format ` + # accessPolicies/`policy_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -117,8 +115,8 @@ module Google # Get an AccessPolicy by name. # @param [String] name - # Required. Resource name for the access policy to get. - # Format `accessPolicies/`policy_id`` + # Required. Resource name for the access policy to get. Format `accessPolicies/` + # policy_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -146,18 +144,15 @@ module Google execute_or_queue_command(command, &block) end - # List all AccessPolicies under a - # container. + # List all AccessPolicies under a container. # @param [Fixnum] page_size # Number of AccessPolicy instances to include in the list. Default 100. # @param [String] page_token - # Next page token for the next batch of AccessPolicy instances. Defaults to - # the first page of results. + # Next page token for the next batch of AccessPolicy instances. Defaults to the + # first page of results. # @param [String] parent - # Required. Resource name for the container to list AccessPolicy instances - # from. - # Format: - # `organizations/`org_id`` + # Required. Resource name for the container to list AccessPolicy instances from. + # Format: `organizations/`org_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -187,14 +182,13 @@ module Google execute_or_queue_command(command, &block) end - # Update an AccessPolicy. The - # longrunning Operation from this RPC will have a successful status once the - # changes to the AccessPolicy have propagated - # to long-lasting storage. Syntactic and basic semantic errors will be - # returned in `metadata` as a BadRequest proto. + # Update an AccessPolicy. The longrunning Operation from this RPC will have a + # successful status once the changes to the AccessPolicy have propagated to long- + # lasting storage. Syntactic and basic semantic errors will be returned in ` + # metadata` as a BadRequest proto. # @param [String] name - # Output only. Resource name of the `AccessPolicy`. Format: - # `accessPolicies/`policy_id`` + # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/` + # policy_id`` # @param [Google::Apis::AccesscontextmanagerV1::AccessPolicy] access_policy_object # @param [String] update_mask # Required. Mask to control which fields get updated. Must be non-empty. @@ -228,14 +222,12 @@ module Google execute_or_queue_command(command, &block) end - # Create an Access Level. The longrunning - # operation from this RPC will have a successful status once the Access - # Level has - # propagated to long-lasting storage. Access Levels containing - # errors will result in an error response for the first error encountered. + # Create an Access Level. The longrunning operation from this RPC will have a + # successful status once the Access Level has propagated to long-lasting storage. + # Access Levels containing errors will result in an error response for the + # first error encountered. # @param [String] parent - # Required. Resource name for the access policy which owns this Access - # Level. + # Required. Resource name for the access policy which owns this Access Level. # Format: `accessPolicies/`policy_id`` # @param [Google::Apis::AccesscontextmanagerV1::AccessLevel] access_level_object # @param [String] fields @@ -267,14 +259,12 @@ module Google execute_or_queue_command(command, &block) end - # Delete an Access Level by resource - # name. The longrunning operation from this RPC will have a successful status - # once the Access Level has been removed - # from long-lasting storage. + # Delete an Access Level by resource name. The longrunning operation from this + # RPC will have a successful status once the Access Level has been removed from + # long-lasting storage. # @param [String] name - # Required. Resource name for the Access Level. - # Format: - # `accessPolicies/`policy_id`/accessLevels/`access_level_id`` + # Required. Resource name for the Access Level. Format: `accessPolicies/` + # policy_id`/accessLevels/`access_level_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -302,20 +292,16 @@ module Google execute_or_queue_command(command, &block) end - # Get an Access Level by resource - # name. + # Get an Access Level by resource name. # @param [String] name - # Required. Resource name for the Access Level. - # Format: - # `accessPolicies/`policy_id`/accessLevels/`access_level_id`` + # Required. Resource name for the Access Level. Format: `accessPolicies/` + # policy_id`/accessLevels/`access_level_id`` # @param [String] access_level_format - # Whether to return `BasicLevels` in the Cloud Common Expression - # Language rather than as `BasicLevels`. Defaults to AS_DEFINED, where - # Access Levels - # are returned as `BasicLevels` or `CustomLevels` based on how they were - # created. If set to CEL, all Access Levels are returned as - # `CustomLevels`. In the CEL case, `BasicLevels` are translated to equivalent - # `CustomLevels`. + # Whether to return `BasicLevels` in the Cloud Common Expression Language rather + # than as `BasicLevels`. Defaults to AS_DEFINED, where Access Levels are + # returned as `BasicLevels` or `CustomLevels` based on how they were created. If + # set to CEL, all Access Levels are returned as `CustomLevels`. In the CEL case, + # `BasicLevels` are translated to equivalent `CustomLevels`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -344,22 +330,19 @@ module Google execute_or_queue_command(command, &block) end - # List all Access Levels for an access - # policy. + # List all Access Levels for an access policy. # @param [String] parent # Required. Resource name for the access policy to list Access Levels from. - # Format: - # `accessPolicies/`policy_id`` + # Format: `accessPolicies/`policy_id`` # @param [String] access_level_format - # Whether to return `BasicLevels` in the Cloud Common Expression language, as - # `CustomLevels`, rather than as `BasicLevels`. Defaults to returning - # `AccessLevels` in the format they were defined. + # Whether to return `BasicLevels` in the Cloud Common Expression language, as ` + # CustomLevels`, rather than as `BasicLevels`. Defaults to returning ` + # AccessLevels` in the format they were defined. # @param [Fixnum] page_size - # Number of Access Levels to include in - # the list. Default 100. + # Number of Access Levels to include in the list. Default 100. # @param [String] page_token - # Next page token for the next batch of Access Level instances. - # Defaults to the first page of results. + # Next page token for the next batch of Access Level instances. Defaults to the + # first page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -390,16 +373,15 @@ module Google execute_or_queue_command(command, &block) end - # Update an Access Level. The longrunning - # operation from this RPC will have a successful status once the changes to - # the Access Level have propagated - # to long-lasting storage. Access Levels containing - # errors will result in an error response for the first error encountered. + # Update an Access Level. The longrunning operation from this RPC will have a + # successful status once the changes to the Access Level have propagated to long- + # lasting storage. Access Levels containing errors will result in an error + # response for the first error encountered. # @param [String] name - # Required. Resource name for the Access Level. The `short_name` component - # must begin with a letter and only include alphanumeric and '_'. Format: - # `accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length - # of the `short_name` component is 50 characters. + # Required. Resource name for the Access Level. The `short_name` component must + # begin with a letter and only include alphanumeric and '_'. Format: ` + # accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length of + # the `short_name` component is 50 characters. # @param [Google::Apis::AccesscontextmanagerV1::AccessLevel] access_level_object # @param [String] update_mask # Required. Mask to control which fields get updated. Must be non-empty. @@ -433,21 +415,16 @@ module Google execute_or_queue_command(command, &block) end - # Replace all existing Access Levels in an Access - # Policy with - # the Access Levels provided. This - # is done atomically. The longrunning operation from this RPC will have a - # successful status once all replacements have propagated to long-lasting - # storage. Replacements containing errors will result in an error response - # for the first error encountered. Replacement will be cancelled on error, - # existing Access Levels will not be - # affected. Operation.response field will contain - # ReplaceAccessLevelsResponse. Removing Access Levels contained in existing - # Service Perimeters will result in - # error. + # Replace all existing Access Levels in an Access Policy with the Access Levels + # provided. This is done atomically. The longrunning operation from this RPC + # will have a successful status once all replacements have propagated to long- + # lasting storage. Replacements containing errors will result in an error + # response for the first error encountered. Replacement will be cancelled on + # error, existing Access Levels will not be affected. Operation.response field + # will contain ReplaceAccessLevelsResponse. Removing Access Levels contained in + # existing Service Perimeters will result in error. # @param [String] parent - # Required. Resource name for the access policy which owns these - # Access Levels. + # Required. Resource name for the access policy which owns these Access Levels. # Format: `accessPolicies/`policy_id`` # @param [Google::Apis::AccesscontextmanagerV1::ReplaceAccessLevelsRequest] replace_access_levels_request_object # @param [String] fields @@ -479,23 +456,21 @@ module Google execute_or_queue_command(command, &block) end - # Commit the dry-run spec for all the Service Perimeters in an - # Access Policy. - # A commit operation on a Service Perimeter involves copying its `spec` field - # to that Service Perimeter's `status` field. Only Service Perimeters with - # `use_explicit_dry_run_spec` field set to true are affected by a commit + # Commit the dry-run spec for all the Service Perimeters in an Access Policy. A + # commit operation on a Service Perimeter involves copying its `spec` field to + # that Service Perimeter's `status` field. Only Service Perimeters with ` + # use_explicit_dry_run_spec` field set to true are affected by a commit # operation. The longrunning operation from this RPC will have a successful # status once the dry-run specs for all the Service Perimeters have been # committed. If a commit fails, it will cause the longrunning operation to # return an error response and the entire commit operation will be cancelled. # When successful, Operation.response field will contain - # CommitServicePerimetersResponse. The `dry_run` and the `spec` fields will - # be cleared after a successful commit operation. + # CommitServicePerimetersResponse. The `dry_run` and the `spec` fields will be + # cleared after a successful commit operation. # @param [String] parent - # Required. Resource name for the parent Access Policy which owns all - # Service Perimeters in scope for - # the commit operation. - # Format: `accessPolicies/`policy_id`` + # Required. Resource name for the parent Access Policy which owns all Service + # Perimeters in scope for the commit operation. Format: `accessPolicies/` + # policy_id`` # @param [Google::Apis::AccesscontextmanagerV1::CommitServicePerimetersRequest] commit_service_perimeters_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -526,15 +501,13 @@ module Google execute_or_queue_command(command, &block) end - # Create a Service Perimeter. The - # longrunning operation from this RPC will have a successful status once the - # Service Perimeter has - # propagated to long-lasting storage. Service Perimeters containing - # errors will result in an error response for the first error encountered. + # Create a Service Perimeter. The longrunning operation from this RPC will have + # a successful status once the Service Perimeter has propagated to long-lasting + # storage. Service Perimeters containing errors will result in an error response + # for the first error encountered. # @param [String] parent # Required. Resource name for the access policy which owns this Service - # Perimeter. - # Format: `accessPolicies/`policy_id`` + # Perimeter. Format: `accessPolicies/`policy_id`` # @param [Google::Apis::AccesscontextmanagerV1::ServicePerimeter] service_perimeter_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -565,14 +538,12 @@ module Google execute_or_queue_command(command, &block) end - # Delete a Service Perimeter by resource - # name. The longrunning operation from this RPC will have a successful status - # once the Service Perimeter has been + # Delete a Service Perimeter by resource name. The longrunning operation from + # this RPC will have a successful status once the Service Perimeter has been # removed from long-lasting storage. # @param [String] name - # Required. Resource name for the Service Perimeter. - # Format: - # `accessPolicies/`policy_id`/servicePerimeters/`service_perimeter_id`` + # Required. Resource name for the Service Perimeter. Format: `accessPolicies/` + # policy_id`/servicePerimeters/`service_perimeter_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -600,12 +571,10 @@ module Google execute_or_queue_command(command, &block) end - # Get a Service Perimeter by resource - # name. + # Get a Service Perimeter by resource name. # @param [String] name - # Required. Resource name for the Service Perimeter. - # Format: - # `accessPolicies/`policy_id`/servicePerimeters/`service_perimeters_id`` + # Required. Resource name for the Service Perimeter. Format: `accessPolicies/` + # policy_id`/servicePerimeters/`service_perimeters_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -633,18 +602,15 @@ module Google execute_or_queue_command(command, &block) end - # List all Service Perimeters for an - # access policy. + # List all Service Perimeters for an access policy. # @param [String] parent # Required. Resource name for the access policy to list Service Perimeters from. - # Format: - # `accessPolicies/`policy_id`` + # Format: `accessPolicies/`policy_id`` # @param [Fixnum] page_size - # Number of Service Perimeters to include - # in the list. Default 100. + # Number of Service Perimeters to include in the list. Default 100. # @param [String] page_token - # Next page token for the next batch of Service Perimeter instances. - # Defaults to the first page of results. + # Next page token for the next batch of Service Perimeter instances. Defaults to + # the first page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -674,15 +640,14 @@ module Google execute_or_queue_command(command, &block) end - # Update a Service Perimeter. The - # longrunning operation from this RPC will have a successful status once the - # changes to the Service Perimeter have - # propagated to long-lasting storage. Service Perimeter containing - # errors will result in an error response for the first error encountered. + # Update a Service Perimeter. The longrunning operation from this RPC will have + # a successful status once the changes to the Service Perimeter have propagated + # to long-lasting storage. Service Perimeter containing errors will result in an + # error response for the first error encountered. # @param [String] name - # Required. Resource name for the ServicePerimeter. The `short_name` - # component must begin with a letter and only include alphanumeric and '_'. - # Format: `accessPolicies/`policy_id`/servicePerimeters/`short_name`` + # Required. Resource name for the ServicePerimeter. The `short_name` component + # must begin with a letter and only include alphanumeric and '_'. Format: ` + # accessPolicies/`policy_id`/servicePerimeters/`short_name`` # @param [Google::Apis::AccesscontextmanagerV1::ServicePerimeter] service_perimeter_object # @param [String] update_mask # Required. Mask to control which fields get updated. Must be non-empty. @@ -716,20 +681,16 @@ module Google execute_or_queue_command(command, &block) end - # Replace all existing Service Perimeters in an - # Access Policy - # with the Service Perimeters provided. - # This is done atomically. The longrunning operation from this - # RPC will have a successful status once all replacements have propagated to - # long-lasting storage. Replacements containing errors will result in an - # error response for the first error encountered. Replacement will be - # cancelled on error, existing Service Perimeters will not be - # affected. Operation.response field will contain - # ReplaceServicePerimetersResponse. + # Replace all existing Service Perimeters in an Access Policy with the Service + # Perimeters provided. This is done atomically. The longrunning operation from + # this RPC will have a successful status once all replacements have propagated + # to long-lasting storage. Replacements containing errors will result in an + # error response for the first error encountered. Replacement will be cancelled + # on error, existing Service Perimeters will not be affected. Operation.response + # field will contain ReplaceServicePerimetersResponse. # @param [String] parent - # Required. Resource name for the access policy which owns these - # Service Perimeters. - # Format: `accessPolicies/`policy_id`` + # Required. Resource name for the access policy which owns these Service + # Perimeters. Format: `accessPolicies/`policy_id`` # @param [Google::Apis::AccesscontextmanagerV1::ReplaceServicePerimetersRequest] replace_service_perimeters_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -760,15 +721,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. @@ -802,10 +761,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 @@ -835,9 +794,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 @@ -867,15 +825,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 diff --git a/generated/google/apis/accesscontextmanager_v1beta.rb b/generated/google/apis/accesscontextmanager_v1beta.rb index 21b9d6b23..f0ff2ec9d 100644 --- a/generated/google/apis/accesscontextmanager_v1beta.rb +++ b/generated/google/apis/accesscontextmanager_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/access-context-manager/docs/reference/rest/ module AccesscontextmanagerV1beta VERSION = 'V1beta' - REVISION = '20200405' + REVISION = '20200801' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/accesscontextmanager_v1beta/classes.rb b/generated/google/apis/accesscontextmanager_v1beta/classes.rb index 30cc67195..6ed0ebe6b 100644 --- a/generated/google/apis/accesscontextmanager_v1beta/classes.rb +++ b/generated/google/apis/accesscontextmanager_v1beta/classes.rb @@ -34,8 +34,8 @@ module Google attr_accessor :basic # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language - # to represent the necessary conditions for the level to apply to a request. - # See CEL spec at: https://github.com/google/cel-spec + # to represent the necessary conditions for the level to apply to a request. See + # CEL spec at: https://github.com/google/cel-spec # Corresponds to the JSON property `custom` # @return [Google::Apis::AccesscontextmanagerV1beta::CustomLevel] attr_accessor :custom @@ -45,10 +45,10 @@ module Google # @return [String] attr_accessor :description - # Required. Resource name for the Access Level. The `short_name` component - # must begin with a letter and only include alphanumeric and '_'. Format: - # `accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length - # // of the `short_name` component is 50 characters. + # Required. Resource name for the Access Level. The `short_name` component must + # begin with a letter and only include alphanumeric and '_'. Format: ` + # accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length // + # of the `short_name` component is 50 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -73,22 +73,21 @@ module Google end # `AccessPolicy` is a container for `AccessLevels` (which define the necessary - # attributes to use Google Cloud services) and `ServicePerimeters` (which - # define regions of services able to freely pass data within a perimeter). An - # access policy is globally visible within an organization, and the - # restrictions it specifies apply to all projects within an organization. + # attributes to use Google Cloud services) and `ServicePerimeters` (which define + # regions of services able to freely pass data within a perimeter). An access + # policy is globally visible within an organization, and the restrictions it + # specifies apply to all projects within an organization. class AccessPolicy include Google::Apis::Core::Hashable - # Output only. Resource name of the `AccessPolicy`. Format: - # `accessPolicies/`policy_id`` + # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/` + # policy_id`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The parent of this `AccessPolicy` in the Cloud Resource - # Hierarchy. Currently immutable once created. Format: - # `organizations/`organization_id`` + # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. + # Currently immutable once created. Format: `organizations/`organization_id`` # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -115,10 +114,10 @@ module Google include Google::Apis::Core::Hashable # How the `conditions` list should be combined to determine if a request is - # granted this `AccessLevel`. If AND is used, each `Condition` in - # `conditions` must be satisfied for the `AccessLevel` to be applied. If OR - # is used, at least one `Condition` in `conditions` must be satisfied for the - # `AccessLevel` to be applied. Default behavior is AND. + # granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` + # must be satisfied for the `AccessLevel` to be applied. If OR is used, at least + # one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be + # applied. Default behavior is AND. # Corresponds to the JSON property `combiningFunction` # @return [String] attr_accessor :combining_function @@ -152,54 +151,48 @@ module Google # devices to be granted access levels, it does not do any enforcement on the # device. `DevicePolicy` acts as an AND over all specified fields, and each # repeated field is an OR over its elements. Any unset fields are ignored. For - # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : - # DESKTOP_LINUX, encryption_status: ENCRYPTED`, then the DevicePolicy will be - # true for requests originating from encrypted Linux desktops and encrypted - # Windows desktops. + # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, + # encryption_status: ENCRYPTED`, then the DevicePolicy will be true for requests + # originating from encrypted Linux desktops and encrypted Windows desktops. # Corresponds to the JSON property `devicePolicy` # @return [Google::Apis::AccesscontextmanagerV1beta::DevicePolicy] attr_accessor :device_policy - # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for - # a CIDR IP address block, the specified IP address portion must be properly + # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a + # CIDR IP address block, the specified IP address portion must be properly # truncated (i.e. all the host bits must be zero) or the input is considered - # malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is - # not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas - # "2001:db8::1/32" is not. The originating IP of a request must be in one of - # the listed subnets in order for this Condition to be true. If empty, all IP - # addresses are allowed. + # malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. + # Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is + # not. The originating IP of a request must be in one of the listed subnets in + # order for this Condition to be true. If empty, all IP addresses are allowed. # Corresponds to the JSON property `ipSubnetworks` # @return [Array] attr_accessor :ip_subnetworks - # The request must be made by one of the provided user or service - # accounts. Groups are not supported. - # Syntax: - # `user:`emailid`` - # `serviceAccount:`emailid`` + # The request must be made by one of the provided user or service accounts. + # Groups are not supported. Syntax: `user:`emailid`` `serviceAccount:`emailid`` # If not specified, a request may come from any user. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members # Whether to negate the Condition. If true, the Condition becomes a NAND over - # its non-empty fields, each field must be false for the Condition overall to - # be satisfied. Defaults to false. + # its non-empty fields, each field must be false for the Condition overall to be + # satisfied. Defaults to false. # Corresponds to the JSON property `negate` # @return [Boolean] attr_accessor :negate alias_method :negate?, :negate - # The request must originate from one of the provided countries/regions. - # Must be valid ISO 3166-1 alpha-2 codes. + # The request must originate from one of the provided countries/regions. Must be + # valid ISO 3166-1 alpha-2 codes. # Corresponds to the JSON property `regions` # @return [Array] attr_accessor :regions # A list of other access levels defined in the same `Policy`, referenced by - # resource name. Referencing an `AccessLevel` which does not exist is an - # error. All access levels listed must be granted for the Condition - # to be true. Example: + # resource name. Referencing an `AccessLevel` which does not exist is an error. + # All access levels listed must be granted for the Condition to be true. Example: # "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` # Corresponds to the JSON property `requiredAccessLevels` # @return [Array] @@ -221,33 +214,26 @@ module Google end # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language - # to represent the necessary conditions for the level to apply to a request. - # See CEL spec at: https://github.com/google/cel-spec + # to represent the necessary conditions for the level to apply to a request. See + # CEL spec at: https://github.com/google/cel-spec class CustomLevel 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 `expr` # @return [Google::Apis::AccesscontextmanagerV1beta::Expr] attr_accessor :expr @@ -267,15 +253,13 @@ module Google # devices to be granted access levels, it does not do any enforcement on the # device. `DevicePolicy` acts as an AND over all specified fields, and each # repeated field is an OR over its elements. Any unset fields are ignored. For - # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : - # DESKTOP_LINUX, encryption_status: ENCRYPTED`, then the DevicePolicy will be - # true for requests originating from encrypted Linux desktops and encrypted - # Windows desktops. + # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, + # encryption_status: ENCRYPTED`, then the DevicePolicy will be true for requests + # originating from encrypted Linux desktops and encrypted Windows desktops. class DevicePolicy include Google::Apis::Core::Hashable - # Allowed device management levels, an empty list allows all management - # levels. + # Allowed device management levels, an empty list allows all management levels. # Corresponds to the JSON property `allowedDeviceManagementLevels` # @return [Array] attr_accessor :allowed_device_management_levels @@ -324,52 +308,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 @@ -470,47 +445,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::AccesscontextmanagerV1beta::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] 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] attr_accessor :response @@ -533,9 +506,9 @@ module Google class OsConstraint include Google::Apis::Core::Hashable - # The minimum allowed OS version. If not set, any version of this OS - # satisfies the constraint. Format: `"major.minor.patch"`. - # Examples: `"10.5.301"`, `"9.2.1"`. + # The minimum allowed OS version. If not set, any version of this OS satisfies + # the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1" + # `. # Corresponds to the JSON property `minimumVersion` # @return [String] attr_accessor :minimum_version @@ -545,10 +518,10 @@ module Google # @return [String] attr_accessor :os_type - # Only allows requests from devices with a verified Chrome OS. - # Verifications includes requirements that the device is enterprise-managed, - # conformant to domain policies, and the caller has permission to call - # the API targeted by the request. + # Only allows requests from devices with a verified Chrome OS. Verifications + # includes requirements that the device is enterprise-managed, conformant to + # domain policies, and the caller has permission to call the API targeted by the + # request. # Corresponds to the JSON property `requireVerifiedChromeOs` # @return [Boolean] attr_accessor :require_verified_chrome_os @@ -567,37 +540,34 @@ module Google end # `ServicePerimeter` describes a set of Google Cloud resources which can freely - # import and export data amongst themselves, but not export outside of the - # `ServicePerimeter`. If a request with a source within this `ServicePerimeter` + # import and export data amongst themselves, but not export outside of the ` + # ServicePerimeter`. If a request with a source within this `ServicePerimeter` # has a target outside of the `ServicePerimeter`, the request will be blocked. # Otherwise the request is allowed. There are two types of Service Perimeter - - # Regular and Bridge. Regular Service Perimeters cannot overlap, a single - # Google Cloud project can only belong to a single regular Service Perimeter. - # Service Perimeter Bridges can contain only Google Cloud projects as members, - # a single Google Cloud project may belong to multiple Service Perimeter - # Bridges. + # Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google + # Cloud project can only belong to a single regular Service Perimeter. Service + # Perimeter Bridges can contain only Google Cloud projects as members, a single + # Google Cloud project may belong to multiple Service Perimeter Bridges. class ServicePerimeter include Google::Apis::Core::Hashable - # Description of the `ServicePerimeter` and its use. Does not affect - # behavior. + # Description of the `ServicePerimeter` and its use. Does not affect behavior. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Required. Resource name for the ServicePerimeter. The `short_name` - # component must begin with a letter and only include alphanumeric and '_'. - # Format: `accessPolicies/`policy_id`/servicePerimeters/`short_name`` + # Required. Resource name for the ServicePerimeter. The `short_name` component + # must begin with a letter and only include alphanumeric and '_'. Format: ` + # accessPolicies/`policy_id`/servicePerimeters/`short_name`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Perimeter type indicator. A single project is - # allowed to be a member of single regular perimeter, but multiple service - # perimeter bridges. A project cannot be a included in a perimeter bridge - # without being included in regular perimeter. For perimeter bridges, - # restricted/unrestricted service lists as well as access lists must be - # empty. + # Perimeter type indicator. A single project is allowed to be a member of single + # regular perimeter, but multiple service perimeter bridges. A project cannot be + # a included in a perimeter bridge without being included in regular perimeter. + # For perimeter bridges, restricted/unrestricted service lists as well as access + # lists must be empty. # Corresponds to the JSON property `perimeterType` # @return [String] attr_accessor :perimeter_type @@ -632,14 +602,13 @@ module Google class ServicePerimeterConfig include Google::Apis::Core::Hashable - # A list of `AccessLevel` resource names that allow resources within the - # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed - # must be in the same policy as this `ServicePerimeter`. Referencing a - # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are - # listed, resources within the perimeter can only be accessed via Google - # Cloud calls with request origins within the perimeter. Example: - # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. - # For Service Perimeter Bridge, must be empty. + # A list of `AccessLevel` resource names that allow resources within the ` + # ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must + # be in the same policy as this `ServicePerimeter`. Referencing a nonexistent ` + # AccessLevel` is a syntax error. If no `AccessLevel` names are listed, + # resources within the perimeter can only be accessed via Google Cloud calls + # with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/ + # accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. # Corresponds to the JSON property `accessLevels` # @return [Array] attr_accessor :access_levels @@ -650,24 +619,23 @@ module Google # @return [Array] attr_accessor :resources - # Google Cloud services that are subject to the Service Perimeter - # restrictions. Must contain a list of services. For example, if - # `storage.googleapis.com` is specified, access to the storage buckets - # inside the perimeter must meet the perimeter's access restrictions. + # Google Cloud services that are subject to the Service Perimeter restrictions. + # Must contain a list of services. For example, if `storage.googleapis.com` is + # specified, access to the storage buckets inside the perimeter must meet the + # perimeter's access restrictions. # Corresponds to the JSON property `restrictedServices` # @return [Array] attr_accessor :restricted_services # Google Cloud services that are not subject to the Service Perimeter - # restrictions. Deprecated. Must be set to a single wildcard "*". - # The wildcard means that unless explicitly specified by - # "restricted_services" list, any service is treated as unrestricted. + # restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard + # means that unless explicitly specified by "restricted_services" list, any + # service is treated as unrestricted. # Corresponds to the JSON property `unrestrictedServices` # @return [Array] attr_accessor :unrestricted_services - # Specifies how APIs are allowed to communicate within the Service - # Perimeter. + # Specifies how APIs are allowed to communicate within the Service Perimeter. # Corresponds to the JSON property `vpcAccessibleServices` # @return [Google::Apis::AccesscontextmanagerV1beta::VpcAccessibleServices] attr_accessor :vpc_accessible_services @@ -686,12 +654,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 @@ -700,15 +668,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>] 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 @@ -725,19 +693,20 @@ module Google end end - # Specifies how APIs are allowed to communicate within the Service - # Perimeter. + # Specifies how APIs are allowed to communicate within the Service Perimeter. class VpcAccessibleServices include Google::Apis::Core::Hashable - # The list of APIs usable within the Service Perimeter. Must be empty - # unless 'enable_restriction' is True. + # The list of APIs usable within the Service Perimeter. Must be empty unless ' + # enable_restriction' is True. You can specify a list of individual services, as + # well as include the 'RESTRICTED-SERVICES' value, which automatically includes + # all of the services protected by the perimeter. # Corresponds to the JSON property `allowedServices` # @return [Array] attr_accessor :allowed_services - # Whether to restrict API calls within the Service Perimeter to the list of - # APIs specified in 'allowed_services'. + # Whether to restrict API calls within the Service Perimeter to the list of APIs + # specified in 'allowed_services'. # Corresponds to the JSON property `enableRestriction` # @return [Boolean] attr_accessor :enable_restriction diff --git a/generated/google/apis/accesscontextmanager_v1beta/service.rb b/generated/google/apis/accesscontextmanager_v1beta/service.rb index b422cfed6..55ae76b71 100644 --- a/generated/google/apis/accesscontextmanager_v1beta/service.rb +++ b/generated/google/apis/accesscontextmanager_v1beta/service.rb @@ -47,11 +47,10 @@ module Google @batch_path = 'batch' end - # Create an `AccessPolicy`. Fails if this organization already has a - # `AccessPolicy`. The longrunning Operation will have a successful status - # once the `AccessPolicy` has propagated to long-lasting storage. - # Syntactic and basic semantic errors will be returned in `metadata` as a - # BadRequest proto. + # Create an `AccessPolicy`. Fails if this organization already has a ` + # AccessPolicy`. The longrunning Operation will have a successful status once + # the `AccessPolicy` has propagated to long-lasting storage. Syntactic and basic + # semantic errors will be returned in `metadata` as a BadRequest proto. # @param [Google::Apis::AccesscontextmanagerV1beta::AccessPolicy] access_policy_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -81,13 +80,12 @@ module Google execute_or_queue_command(command, &block) end - # Delete an AccessPolicy by resource - # name. The longrunning Operation will have a successful status once the - # AccessPolicy - # has been removed from long-lasting storage. + # Delete an AccessPolicy by resource name. The longrunning Operation will have a + # successful status once the AccessPolicy has been removed from long-lasting + # storage. # @param [String] name - # Required. Resource name for the access policy to delete. - # Format `accessPolicies/`policy_id`` + # Required. Resource name for the access policy to delete. Format ` + # accessPolicies/`policy_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -117,8 +115,8 @@ module Google # Get an AccessPolicy by name. # @param [String] name - # Required. Resource name for the access policy to get. - # Format `accessPolicies/`policy_id`` + # Required. Resource name for the access policy to get. Format `accessPolicies/` + # policy_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -146,18 +144,15 @@ module Google execute_or_queue_command(command, &block) end - # List all AccessPolicies under a - # container. + # List all AccessPolicies under a container. # @param [Fixnum] page_size # Number of AccessPolicy instances to include in the list. Default 100. # @param [String] page_token - # Next page token for the next batch of AccessPolicy instances. Defaults to - # the first page of results. + # Next page token for the next batch of AccessPolicy instances. Defaults to the + # first page of results. # @param [String] parent - # Required. Resource name for the container to list AccessPolicy instances - # from. - # Format: - # `organizations/`org_id`` + # Required. Resource name for the container to list AccessPolicy instances from. + # Format: `organizations/`org_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -187,14 +182,13 @@ module Google execute_or_queue_command(command, &block) end - # Update an AccessPolicy. The - # longrunning Operation from this RPC will have a successful status once the - # changes to the AccessPolicy have propagated - # to long-lasting storage. Syntactic and basic semantic errors will be - # returned in `metadata` as a BadRequest proto. + # Update an AccessPolicy. The longrunning Operation from this RPC will have a + # successful status once the changes to the AccessPolicy have propagated to long- + # lasting storage. Syntactic and basic semantic errors will be returned in ` + # metadata` as a BadRequest proto. # @param [String] name - # Output only. Resource name of the `AccessPolicy`. Format: - # `accessPolicies/`policy_id`` + # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/` + # policy_id`` # @param [Google::Apis::AccesscontextmanagerV1beta::AccessPolicy] access_policy_object # @param [String] update_mask # Required. Mask to control which fields get updated. Must be non-empty. @@ -228,14 +222,12 @@ module Google execute_or_queue_command(command, &block) end - # Create an Access Level. The longrunning - # operation from this RPC will have a successful status once the Access - # Level has - # propagated to long-lasting storage. Access Levels containing - # errors will result in an error response for the first error encountered. + # Create an Access Level. The longrunning operation from this RPC will have a + # successful status once the Access Level has propagated to long-lasting storage. + # Access Levels containing errors will result in an error response for the + # first error encountered. # @param [String] parent - # Required. Resource name for the access policy which owns this Access - # Level. + # Required. Resource name for the access policy which owns this Access Level. # Format: `accessPolicies/`policy_id`` # @param [Google::Apis::AccesscontextmanagerV1beta::AccessLevel] access_level_object # @param [String] fields @@ -267,14 +259,12 @@ module Google execute_or_queue_command(command, &block) end - # Delete an Access Level by resource - # name. The longrunning operation from this RPC will have a successful status - # once the Access Level has been removed - # from long-lasting storage. + # Delete an Access Level by resource name. The longrunning operation from this + # RPC will have a successful status once the Access Level has been removed from + # long-lasting storage. # @param [String] name - # Required. Resource name for the Access Level. - # Format: - # `accessPolicies/`policy_id`/accessLevels/`access_level_id`` + # Required. Resource name for the Access Level. Format: `accessPolicies/` + # policy_id`/accessLevels/`access_level_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -302,20 +292,16 @@ module Google execute_or_queue_command(command, &block) end - # Get an Access Level by resource - # name. + # Get an Access Level by resource name. # @param [String] name - # Required. Resource name for the Access Level. - # Format: - # `accessPolicies/`policy_id`/accessLevels/`access_level_id`` + # Required. Resource name for the Access Level. Format: `accessPolicies/` + # policy_id`/accessLevels/`access_level_id`` # @param [String] access_level_format - # Whether to return `BasicLevels` in the Cloud Common Expression - # Language rather than as `BasicLevels`. Defaults to AS_DEFINED, where - # Access Levels - # are returned as `BasicLevels` or `CustomLevels` based on how they were - # created. If set to CEL, all Access Levels are returned as - # `CustomLevels`. In the CEL case, `BasicLevels` are translated to equivalent - # `CustomLevels`. + # Whether to return `BasicLevels` in the Cloud Common Expression Language rather + # than as `BasicLevels`. Defaults to AS_DEFINED, where Access Levels are + # returned as `BasicLevels` or `CustomLevels` based on how they were created. If + # set to CEL, all Access Levels are returned as `CustomLevels`. In the CEL case, + # `BasicLevels` are translated to equivalent `CustomLevels`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -344,22 +330,19 @@ module Google execute_or_queue_command(command, &block) end - # List all Access Levels for an access - # policy. + # List all Access Levels for an access policy. # @param [String] parent # Required. Resource name for the access policy to list Access Levels from. - # Format: - # `accessPolicies/`policy_id`` + # Format: `accessPolicies/`policy_id`` # @param [String] access_level_format - # Whether to return `BasicLevels` in the Cloud Common Expression language, as - # `CustomLevels`, rather than as `BasicLevels`. Defaults to returning - # `AccessLevels` in the format they were defined. + # Whether to return `BasicLevels` in the Cloud Common Expression language, as ` + # CustomLevels`, rather than as `BasicLevels`. Defaults to returning ` + # AccessLevels` in the format they were defined. # @param [Fixnum] page_size - # Number of Access Levels to include in - # the list. Default 100. + # Number of Access Levels to include in the list. Default 100. # @param [String] page_token - # Next page token for the next batch of Access Level instances. - # Defaults to the first page of results. + # Next page token for the next batch of Access Level instances. Defaults to the + # first page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -390,16 +373,15 @@ module Google execute_or_queue_command(command, &block) end - # Update an Access Level. The longrunning - # operation from this RPC will have a successful status once the changes to - # the Access Level have propagated - # to long-lasting storage. Access Levels containing - # errors will result in an error response for the first error encountered. + # Update an Access Level. The longrunning operation from this RPC will have a + # successful status once the changes to the Access Level have propagated to long- + # lasting storage. Access Levels containing errors will result in an error + # response for the first error encountered. # @param [String] name - # Required. Resource name for the Access Level. The `short_name` component - # must begin with a letter and only include alphanumeric and '_'. Format: - # `accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length - # // of the `short_name` component is 50 characters. + # Required. Resource name for the Access Level. The `short_name` component must + # begin with a letter and only include alphanumeric and '_'. Format: ` + # accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length // + # of the `short_name` component is 50 characters. # @param [Google::Apis::AccesscontextmanagerV1beta::AccessLevel] access_level_object # @param [String] update_mask # Required. Mask to control which fields get updated. Must be non-empty. @@ -433,15 +415,13 @@ module Google execute_or_queue_command(command, &block) end - # Create a Service Perimeter. The - # longrunning operation from this RPC will have a successful status once the - # Service Perimeter has - # propagated to long-lasting storage. Service Perimeters containing - # errors will result in an error response for the first error encountered. + # Create a Service Perimeter. The longrunning operation from this RPC will have + # a successful status once the Service Perimeter has propagated to long-lasting + # storage. Service Perimeters containing errors will result in an error response + # for the first error encountered. # @param [String] parent # Required. Resource name for the access policy which owns this Service - # Perimeter. - # Format: `accessPolicies/`policy_id`` + # Perimeter. Format: `accessPolicies/`policy_id`` # @param [Google::Apis::AccesscontextmanagerV1beta::ServicePerimeter] service_perimeter_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -472,14 +452,12 @@ module Google execute_or_queue_command(command, &block) end - # Delete a Service Perimeter by resource - # name. The longrunning operation from this RPC will have a successful status - # once the Service Perimeter has been + # Delete a Service Perimeter by resource name. The longrunning operation from + # this RPC will have a successful status once the Service Perimeter has been # removed from long-lasting storage. # @param [String] name - # Required. Resource name for the Service Perimeter. - # Format: - # `accessPolicies/`policy_id`/servicePerimeters/`service_perimeter_id`` + # Required. Resource name for the Service Perimeter. Format: `accessPolicies/` + # policy_id`/servicePerimeters/`service_perimeter_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -507,12 +485,10 @@ module Google execute_or_queue_command(command, &block) end - # Get a Service Perimeter by resource - # name. + # Get a Service Perimeter by resource name. # @param [String] name - # Required. Resource name for the Service Perimeter. - # Format: - # `accessPolicies/`policy_id`/servicePerimeters/`service_perimeters_id`` + # Required. Resource name for the Service Perimeter. Format: `accessPolicies/` + # policy_id`/servicePerimeters/`service_perimeters_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -540,18 +516,15 @@ module Google execute_or_queue_command(command, &block) end - # List all Service Perimeters for an - # access policy. + # List all Service Perimeters for an access policy. # @param [String] parent # Required. Resource name for the access policy to list Service Perimeters from. - # Format: - # `accessPolicies/`policy_id`` + # Format: `accessPolicies/`policy_id`` # @param [Fixnum] page_size - # Number of Service Perimeters to include - # in the list. Default 100. + # Number of Service Perimeters to include in the list. Default 100. # @param [String] page_token - # Next page token for the next batch of Service Perimeter instances. - # Defaults to the first page of results. + # Next page token for the next batch of Service Perimeter instances. Defaults to + # the first page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -581,15 +554,14 @@ module Google execute_or_queue_command(command, &block) end - # Update a Service Perimeter. The - # longrunning operation from this RPC will have a successful status once the - # changes to the Service Perimeter have - # propagated to long-lasting storage. Service Perimeter containing - # errors will result in an error response for the first error encountered. + # Update a Service Perimeter. The longrunning operation from this RPC will have + # a successful status once the changes to the Service Perimeter have propagated + # to long-lasting storage. Service Perimeter containing errors will result in an + # error response for the first error encountered. # @param [String] name - # Required. Resource name for the ServicePerimeter. The `short_name` - # component must begin with a letter and only include alphanumeric and '_'. - # Format: `accessPolicies/`policy_id`/servicePerimeters/`short_name`` + # Required. Resource name for the ServicePerimeter. The `short_name` component + # must begin with a letter and only include alphanumeric and '_'. Format: ` + # accessPolicies/`policy_id`/servicePerimeters/`short_name`` # @param [Google::Apis::AccesscontextmanagerV1beta::ServicePerimeter] service_perimeter_object # @param [String] update_mask # Required. Mask to control which fields get updated. Must be non-empty. @@ -623,9 +595,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 diff --git a/generated/google/apis/admin_datatransfer_v1.rb b/generated/google/apis/admin_datatransfer_v1.rb index a69e064f4..85cf4efe8 100644 --- a/generated/google/apis/admin_datatransfer_v1.rb +++ b/generated/google/apis/admin_datatransfer_v1.rb @@ -18,14 +18,16 @@ require 'google/apis/admin_datatransfer_v1/representations.rb' module Google module Apis - # Admin Data Transfer API + # Admin SDK # - # Transfers user data from one user to another. + # Admin SDK lets administrators of enterprise domains to view and manage + # resources like user, groups etc. It also provides audit and usage reports of + # domain. # - # @see https://developers.google.com/admin-sdk/data-transfer/ + # @see http://developers.google.com/admin-sdk/ module AdminDatatransferV1 VERSION = 'DatatransferV1' - REVISION = '20190829' + REVISION = '20200810' # View and manage data transfers between users in your organization AUTH_ADMIN_DATATRANSFER = 'https://www.googleapis.com/auth/admin.datatransfer' diff --git a/generated/google/apis/admin_datatransfer_v1/classes.rb b/generated/google/apis/admin_datatransfer_v1/classes.rb index aa6261e09..bfb3c3a2f 100644 --- a/generated/google/apis/admin_datatransfer_v1/classes.rb +++ b/generated/google/apis/admin_datatransfer_v1/classes.rb @@ -22,7 +22,10 @@ module Google module Apis module AdminDatatransferV1 - # The JSON template for an Application resource. + # The JSON template for an Application resource. STEPLADDER: Generated unstable + # field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) + # STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/ + # stepladder-help#fieldNumber) class Application include Google::Apis::Core::Hashable @@ -124,7 +127,10 @@ module Google end end - # Template for a collection of Applications. + # Template for a collection of Applications. STEPLADDER: Generated unstable + # field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) + # STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/ + # stepladder-help#fieldNumber) class ApplicationsListResponse include Google::Apis::Core::Hashable @@ -162,7 +168,10 @@ module Google end end - # The JSON template for a DataTransfer resource. + # The JSON template for a DataTransfer resource. STEPLADDER: Generated unstable + # field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) + # STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/ + # stepladder-help#fieldNumber) class DataTransfer include Google::Apis::Core::Hashable @@ -226,7 +235,10 @@ module Google end end - # Template for a collection of DataTransfer resources. + # Template for a collection of DataTransfer resources. STEPLADDER: Generated + # unstable field number for field 'kind'. (See http://go/stepladder-help# + # fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. ( + # See http://go/stepladder-help#fieldNumber) class DataTransfersListResponse include Google::Apis::Core::Hashable diff --git a/generated/google/apis/admin_datatransfer_v1/service.rb b/generated/google/apis/admin_datatransfer_v1/service.rb index 7cdc01320..2e897ecf8 100644 --- a/generated/google/apis/admin_datatransfer_v1/service.rb +++ b/generated/google/apis/admin_datatransfer_v1/service.rb @@ -20,9 +20,11 @@ require 'google/apis/errors' module Google module Apis module AdminDatatransferV1 - # Admin Data Transfer API + # Admin SDK # - # Transfers user data from one user to another. + # Admin SDK lets administrators of enterprise domains to view and manage + # resources like user, groups etc. It also provides audit and usage reports of + # domain. # # @example # require 'google/apis/admin_datatransfer_v1' @@ -30,7 +32,7 @@ module Google # Admin = Google::Apis::AdminDatatransferV1 # Alias the module # service = Admin::DataTransferService.new # - # @see https://developers.google.com/admin-sdk/data-transfer/ + # @see http://developers.google.com/admin-sdk/ class DataTransferService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -38,16 +40,12 @@ 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/', 'admin/datatransfer/v1/') + super('https://www.googleapis.com/', '') @batch_path = 'batch/admin/datatransfer_v1' end @@ -57,10 +55,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,20 +69,19 @@ 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_application(application_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'applications/{applicationId}', options) + def get_application(application_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/datatransfer/v1/applications/{applicationId}', options) command.response_representation = Google::Apis::AdminDatatransferV1::Application::Representation command.response_class = Google::Apis::AdminDatatransferV1::Application command.params['applicationId'] = application_id unless application_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 # Lists the applications available for data transfer for a customer. # @param [String] customer_id - # Immutable ID of the G Suite account. + # Immutable ID of the Google Apps account. # @param [Fixnum] max_results # Maximum number of results to return. Default is 100. # @param [String] page_token @@ -94,10 +89,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 # @@ -110,8 +103,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 list_applications(customer_id: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'applications', options) + def list_applications(customer_id: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/datatransfer/v1/applications', options) command.response_representation = Google::Apis::AdminDatatransferV1::ApplicationsListResponse::Representation command.response_class = Google::Apis::AdminDatatransferV1::ApplicationsListResponse command.query['customerId'] = customer_id unless customer_id.nil? @@ -119,7 +112,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 @@ -130,10 +122,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 # @@ -146,14 +136,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_transfer(data_transfer_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'transfers/{dataTransferId}', options) + def get_transfer(data_transfer_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/datatransfer/v1/transfers/{dataTransferId}', options) command.response_representation = Google::Apis::AdminDatatransferV1::DataTransfer::Representation command.response_class = Google::Apis::AdminDatatransferV1::DataTransfer command.params['dataTransferId'] = data_transfer_id unless data_transfer_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 @@ -162,10 +151,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,21 +165,20 @@ 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_transfer(data_transfer_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'transfers', options) + def insert_transfer(data_transfer_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'admin/datatransfer/v1/transfers', options) command.request_representation = Google::Apis::AdminDatatransferV1::DataTransfer::Representation command.request_object = data_transfer_object command.response_representation = Google::Apis::AdminDatatransferV1::DataTransfer::Representation command.response_class = Google::Apis::AdminDatatransferV1::DataTransfer 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 # Lists the transfers for a customer by source user, destination user, or status. # @param [String] customer_id - # Immutable ID of the G Suite account. + # Immutable ID of the Google Apps account. # @param [Fixnum] max_results # Maximum number of results to return. Default is 100. # @param [String] new_owner_user_id @@ -206,10 +192,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 # @@ -222,8 +206,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 list_transfers(customer_id: nil, max_results: nil, new_owner_user_id: nil, old_owner_user_id: nil, page_token: nil, status: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'transfers', options) + def list_transfers(customer_id: nil, max_results: nil, new_owner_user_id: nil, old_owner_user_id: nil, page_token: nil, status: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'admin/datatransfer/v1/transfers', options) command.response_representation = Google::Apis::AdminDatatransferV1::DataTransfersListResponse::Representation command.response_class = Google::Apis::AdminDatatransferV1::DataTransfersListResponse command.query['customerId'] = customer_id unless customer_id.nil? @@ -234,7 +218,6 @@ module Google command.query['status'] = status unless status.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 @@ -243,7 +226,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 diff --git a/generated/google/apis/cloudasset_v1.rb b/generated/google/apis/cloudasset_v1.rb index 7bafdc7be..b5d329f88 100644 --- a/generated/google/apis/cloudasset_v1.rb +++ b/generated/google/apis/cloudasset_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/asset-inventory/docs/quickstart module CloudassetV1 VERSION = 'V1' - REVISION = '20200731' + REVISION = '20200810' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudasset_v1/classes.rb b/generated/google/apis/cloudasset_v1/classes.rb index 15ef6b504..dca0c1b2c 100644 --- a/generated/google/apis/cloudasset_v1/classes.rb +++ b/generated/google/apis/cloudasset_v1/classes.rb @@ -22,15 +22,12 @@ module Google module Apis module CloudassetV1 - # An asset in Google Cloud. An asset can be any resource in the Google Cloud - # [resource - # hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform- - # resource-hierarchy), - # a resource outside the Google Cloud resource hierarchy (such as Google - # Kubernetes Engine clusters and objects), or a policy (e.g. Cloud IAM policy). - # See [Supported asset - # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - # for more information. + # An asset in Google Cloud. An asset can be any resource in the Google Cloud [ + # resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud- + # platform-resource-hierarchy), a resource outside the Google Cloud resource + # hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy + # (e.g. Cloud IAM policy). See [Supported asset types](https://cloud.google.com/ + # asset-inventory/docs/supported-asset-types) for more information. class Asset include Google::Apis::Core::Hashable @@ -42,114 +39,74 @@ module Google attr_accessor :access_level # `AccessPolicy` is a container for `AccessLevels` (which define the necessary - # attributes to use Google Cloud services) and `ServicePerimeters` (which - # define regions of services able to freely pass data within a perimeter). An - # access policy is globally visible within an organization, and the - # restrictions it specifies apply to all projects within an organization. + # attributes to use Google Cloud services) and `ServicePerimeters` (which define + # regions of services able to freely pass data within a perimeter). An access + # policy is globally visible within an organization, and the restrictions it + # specifies apply to all projects within an organization. # Corresponds to the JSON property `accessPolicy` # @return [Google::Apis::CloudassetV1::GoogleIdentityAccesscontextmanagerV1AccessPolicy] attr_accessor :access_policy - # The ancestry path of an asset in Google Cloud [resource - # hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform- - # resource-hierarchy), - # represented as a list of relative resource names. An ancestry path starts - # with the closest ancestor in the hierarchy and ends at root. If the asset - # is a project, folder, or organization, the ancestry path starts from the - # asset itself. - # Example: `["projects/123456789", "folders/5432", "organizations/1234"]` + # The ancestry path of an asset in Google Cloud [resource hierarchy](https:// + # cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), + # represented as a list of relative resource names. An ancestry path starts with + # the closest ancestor in the hierarchy and ends at root. If the asset is a + # project, folder, or organization, the ancestry path starts from the asset + # itself. Example: `["projects/123456789", "folders/5432", "organizations/1234"]` # Corresponds to the JSON property `ancestors` # @return [Array] attr_accessor :ancestors - # The type of the asset. Example: `compute.googleapis.com/Disk` - # See [Supported asset - # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - # for more information. + # The type of the asset. Example: `compute.googleapis.com/Disk` See [Supported + # asset types](https://cloud.google.com/asset-inventory/docs/supported-asset- + # types) for more information. # Corresponds to the JSON property `assetType` # @return [String] attr_accessor :asset_type # 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 `iamPolicy` # @return [Google::Apis::CloudassetV1::Policy] attr_accessor :iam_policy - # The full name of the asset. Example: - # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/ - # instance1` - # See [Resource - # names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - # for more information. + # The full name of the asset. Example: `//compute.googleapis.com/projects/ + # my_project_123/zones/zone1/instances/instance1` See [Resource names](https:// + # cloud.google.com/apis/design/resource_names#full_resource_name) for more + # information. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # A representation of an [organization - # policy](https://cloud.google.com/resource-manager/docs/organization-policy/ - # overview#organization_policy). - # There can be more than one organization policy with different constraints - # set on a given resource. + # A representation of an [organization policy](https://cloud.google.com/resource- + # manager/docs/organization-policy/overview#organization_policy). There can be + # more than one organization policy with different constraints set on a given + # resource. # Corresponds to the JSON property `orgPolicy` # @return [Array] attr_accessor :org_policy @@ -160,21 +117,20 @@ module Google attr_accessor :resource # `ServicePerimeter` describes a set of Google Cloud resources which can freely - # import and export data amongst themselves, but not export outside of the - # `ServicePerimeter`. If a request with a source within this `ServicePerimeter` + # import and export data amongst themselves, but not export outside of the ` + # ServicePerimeter`. If a request with a source within this `ServicePerimeter` # has a target outside of the `ServicePerimeter`, the request will be blocked. # Otherwise the request is allowed. There are two types of Service Perimeter - - # Regular and Bridge. Regular Service Perimeters cannot overlap, a single - # Google Cloud project can only belong to a single regular Service Perimeter. - # Service Perimeter Bridges can contain only Google Cloud projects as members, - # a single Google Cloud project may belong to multiple Service Perimeter - # Bridges. + # Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google + # Cloud project can only belong to a single regular Service Perimeter. Service + # Perimeter Bridges can contain only Google Cloud projects as members, a single + # Google Cloud project may belong to multiple Service Perimeter Bridges. # Corresponds to the JSON property `servicePerimeter` # @return [Google::Apis::CloudassetV1::GoogleIdentityAccesscontextmanagerV1ServicePerimeter] attr_accessor :service_perimeter - # The last update timestamp of an asset. update_time is updated when - # create/update/delete operation is performed. + # The last update timestamp of an asset. update_time is updated when create/ + # update/delete operation is performed. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -198,53 +154,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 @@ -253,9 +177,9 @@ module Google # @return [Array] 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 @@ -271,28 +195,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] @@ -337,26 +248,24 @@ module Google class BigQueryDestination include Google::Apis::Core::Hashable - # Required. The BigQuery dataset in format - # "projects/projectId/datasets/datasetId", to which the snapshot result - # should be exported. If this dataset does not exist, the export call returns - # an INVALID_ARGUMENT error. + # Required. The BigQuery dataset in format "projects/projectId/datasets/ + # datasetId", to which the snapshot result should be exported. If this dataset + # does not exist, the export call returns an INVALID_ARGUMENT error. # Corresponds to the JSON property `dataset` # @return [String] attr_accessor :dataset - # If the destination table already exists and this flag is `TRUE`, the - # table will be overwritten by the contents of assets snapshot. If the flag - # is `FALSE` or unset and the destination table already exists, the export - # call returns an INVALID_ARGUMEMT error. + # If the destination table already exists and this flag is `TRUE`, the table + # will be overwritten by the contents of assets snapshot. If the flag is `FALSE` + # or unset and the destination table already exists, the export call returns an + # INVALID_ARGUMEMT error. # Corresponds to the JSON property `force` # @return [Boolean] attr_accessor :force alias_method :force?, :force - # Required. The BigQuery table to which the snapshot result should be - # written. If this table does not exist, a new table with the given name - # will be created. + # Required. The BigQuery table to which the snapshot result should be written. + # If this table does not exist, a new table with the given name will be created. # Corresponds to the JSON property `table` # @return [String] attr_accessor :table @@ -377,69 +286,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::CloudassetV1::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] 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 @@ -460,17 +357,16 @@ module Google class CreateFeedRequest include Google::Apis::Core::Hashable - # An asset feed used to export asset updates to a destinations. - # An asset feed filter controls what updates are exported. - # The asset feed must be created within a project, organization, or - # folder. Supported destinations are: - # Pub/Sub topics. + # An asset feed used to export asset updates to a destinations. An asset feed + # filter controls what updates are exported. The asset feed must be created + # within a project, organization, or folder. Supported destinations are: Pub/Sub + # topics. # Corresponds to the JSON property `feed` # @return [Google::Apis::CloudassetV1::Feed] attr_accessor :feed - # Required. This is the client-assigned asset feed identifier and it needs to - # be unique under a specific parent project/folder/organization. + # Required. This is the client-assigned asset feed identifier and it needs to be + # unique under a specific parent project/folder/organization. # Corresponds to the JSON property `feedId` # @return [String] attr_accessor :feed_id @@ -486,13 +382,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 @@ -509,13 +403,13 @@ module Google class Explanation include Google::Apis::Core::Hashable - # The map from roles to their included permissions that match the - # permission query (i.e., a query containing `policy.role.permissions:`). - # Example: if query `policy.role.permissions : "compute.disk.get"` - # matches a policy binding that contains owner role, the - # matched_permissions will be ``"roles/owner": ["compute.disk.get"]``. The - # roles can also be found in the returned `policy` bindings. Note that the - # map is populated only for requests with permission queries. + # The map from roles to their included permissions that match the permission + # query (i.e., a query containing `policy.role.permissions:`). Example: if query + # `policy.role.permissions:compute.disk.get` matches a policy binding that + # contains owner role, the matched_permissions will be ``"roles/owner": [" + # compute.disk.get"]``. The roles can also be found in the returned `policy` + # bindings. Note that the map is populated only for requests with permission + # queries. # Corresponds to the JSON property `matchedPermissions` # @return [Hash] attr_accessor :matched_permissions @@ -534,20 +428,17 @@ module Google class ExportAssetsRequest include Google::Apis::Core::Hashable - # A list of asset types to take a snapshot for. For example: - # "compute.googleapis.com/Disk". - # Regular expressions are also supported. For example: - # * "compute.googleapis.com.*" snapshots resources whose asset type starts - # with "compute.googleapis.com". - # * ".*Instance" snapshots resources whose asset type ends with "Instance". - # * ".*Instance.*" snapshots resources whose asset type contains "Instance". - # See [RE2](https://github.com/google/re2/wiki/Syntax) for all supported - # regular expression syntax. If the regular expression does not match any - # supported asset type, an INVALID_ARGUMENT error will be returned. - # If specified, only matching assets will be returned, otherwise, it will - # snapshot all asset types. See [Introduction to Cloud Asset - # Inventory](https://cloud.google.com/asset-inventory/docs/overview) - # for all supported asset types. + # A list of asset types to take a snapshot for. For example: "compute.googleapis. + # com/Disk". Regular expressions are also supported. For example: * "compute. + # googleapis.com.*" snapshots resources whose asset type starts with "compute. + # googleapis.com". * ".*Instance" snapshots resources whose asset type ends with + # "Instance". * ".*Instance.*" snapshots resources whose asset type contains " + # Instance". See [RE2](https://github.com/google/re2/wiki/Syntax) for all + # supported regular expression syntax. If the regular expression does not match + # any supported asset type, an INVALID_ARGUMENT error will be returned. If + # specified, only matching assets will be returned, otherwise, it will snapshot + # all asset types. See [Introduction to Cloud Asset Inventory](https://cloud. + # google.com/asset-inventory/docs/overview) for all supported asset types. # Corresponds to the JSON property `assetTypes` # @return [Array] attr_accessor :asset_types @@ -564,10 +455,10 @@ module Google attr_accessor :output_config # Timestamp to take an asset snapshot. This can only be set to a timestamp - # between the current time and the current time minus 35 days (inclusive). - # If not specified, the current time will be used. Due to delays in resource - # data collection and indexing, there is a volatile window during which - # running the same query may get different results. + # between the current time and the current time minus 35 days (inclusive). If + # not specified, the current time will be used. Due to delays in resource data + # collection and indexing, there is a volatile window during which running the + # same query may get different results. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -585,52 +476,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 @@ -648,66 +530,53 @@ module Google end end - # An asset feed used to export asset updates to a destinations. - # An asset feed filter controls what updates are exported. - # The asset feed must be created within a project, organization, or - # folder. Supported destinations are: - # Pub/Sub topics. + # An asset feed used to export asset updates to a destinations. An asset feed + # filter controls what updates are exported. The asset feed must be created + # within a project, organization, or folder. Supported destinations are: Pub/Sub + # topics. class Feed include Google::Apis::Core::Hashable # A list of the full names of the assets to receive updates. You must specify # either or both of asset_names and asset_types. Only asset updates matching - # specified asset_names or asset_types are exported to the feed. - # Example: - # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/ - # instance1`. - # See [Resource - # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - # for more info. + # specified asset_names or asset_types are exported to the feed. Example: `// + # compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1` + # . See [Resource Names](https://cloud.google.com/apis/design/resource_names# + # full_resource_name) for more info. # Corresponds to the JSON property `assetNames` # @return [Array] attr_accessor :asset_names - # A list of types of the assets to receive updates. You must specify either - # or both of asset_names and asset_types. Only asset updates matching - # specified asset_names or asset_types are exported to the feed. - # Example: `"compute.googleapis.com/Disk"` - # See [this - # topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - # for a list of all supported asset types. + # A list of types of the assets to receive updates. You must specify either or + # both of asset_names and asset_types. Only asset updates matching specified + # asset_names or asset_types are exported to the feed. Example: `"compute. + # googleapis.com/Disk"` See [this topic](https://cloud.google.com/asset- + # inventory/docs/supported-asset-types) for a list of all supported asset types. # Corresponds to the JSON property `assetTypes` # @return [Array] attr_accessor :asset_types - # 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::CloudassetV1::Expr] attr_accessor :condition - # Asset content type. If not specified, no content but the asset name and - # type will be returned. + # Asset content type. If not specified, no content but the asset name and type + # will be returned. # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type @@ -717,12 +586,11 @@ module Google # @return [Google::Apis::CloudassetV1::FeedOutputConfig] attr_accessor :feed_output_config - # Required. The format will be - # projects/`project_number`/feeds/`client-assigned_feed_identifier` or - # folders/`folder_number`/feeds/`client-assigned_feed_identifier` or - # organizations/`organization_number`/feeds/`client-assigned_feed_identifier` - # The client-assigned feed identifier must be unique within the parent - # project/folder/organization. + # Required. The format will be projects/`project_number`/feeds/`client- + # assigned_feed_identifier` or folders/`folder_number`/feeds/`client- + # assigned_feed_identifier` or organizations/`organization_number`/feeds/`client- + # assigned_feed_identifier` The client-assigned feed identifier must be unique + # within the parent project/folder/organization. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -765,24 +633,22 @@ module Google class GcsDestination include Google::Apis::Core::Hashable - # The uri of the Cloud Storage object. It's the same uri that is used by - # gsutil. Example: "gs://bucket_name/object_name". See [Viewing and - # Editing Object - # Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) - # for more information. + # The uri of the Cloud Storage object. It's the same uri that is used by gsutil. + # Example: "gs://bucket_name/object_name". See [Viewing and Editing Object + # Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for + # more information. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri - # The uri prefix of all generated Cloud Storage objects. Example: - # "gs://bucket_name/object_name_prefix". Each object uri is in format: - # "gs://bucket_name/object_name_prefix// and only - # contains assets for that type. starts from 0. Example: - # "gs://bucket_name/object_name_prefix/compute.googleapis.com/Disk/0" is - # the first shard of output objects containing all - # compute.googleapis.com/Disk assets. An INVALID_ARGUMENT error will be - # returned if file with the same name "gs://bucket_name/object_name_prefix" - # already exists. + # The uri prefix of all generated Cloud Storage objects. Example: "gs:// + # bucket_name/object_name_prefix". Each object uri is in format: "gs:// + # bucket_name/object_name_prefix// and only contains assets for that type. + # starts from 0. Example: "gs://bucket_name/object_name_prefix/compute. + # googleapis.com/Disk/0" is the first shard of output objects containing all + # compute.googleapis.com/Disk assets. An INVALID_ARGUMENT error will be returned + # if file with the same name "gs://bucket_name/object_name_prefix" already + # exists. # Corresponds to the JSON property `uriPrefix` # @return [String] attr_accessor :uri_prefix @@ -803,45 +669,29 @@ module Google class GoogleCloudOrgpolicyV1BooleanPolicy include Google::Apis::Core::Hashable - # If `true`, then the `Policy` is enforced. If `false`, then any - # configuration is acceptable. - # Suppose you have a `Constraint` - # `constraints/compute.disableSerialPortAccess` with `constraint_default` - # set to `ALLOW`. A `Policy` for that `Constraint` exhibits the following - # behavior: - # - If the `Policy` at this resource has enforced set to `false`, serial - # port connection attempts will be allowed. - # - If the `Policy` at this resource has enforced set to `true`, serial - # port connection attempts will be refused. - # - If the `Policy` at this resource is `RestoreDefault`, serial port - # connection attempts will be allowed. - # - If no `Policy` is set at this resource or anywhere higher in the - # resource hierarchy, serial port connection attempts will be allowed. - # - If no `Policy` is set at this resource, but one exists higher in the - # resource hierarchy, the behavior is as if the`Policy` were set at - # this resource. - # The following examples demonstrate the different possible layerings: - # Example 1 (nearest `Constraint` wins): - # `organizations/foo` has a `Policy` with: - # `enforced: false` - # `projects/bar` has no `Policy` set. - # The constraint at `projects/bar` and `organizations/foo` will not be - # enforced. - # Example 2 (enforcement gets replaced): - # `organizations/foo` has a `Policy` with: - # `enforced: false` - # `projects/bar` has a `Policy` with: - # `enforced: true` - # The constraint at `organizations/foo` is not enforced. - # The constraint at `projects/bar` is enforced. - # Example 3 (RestoreDefault): - # `organizations/foo` has a `Policy` with: - # `enforced: true` - # `projects/bar` has a `Policy` with: - # `RestoreDefault: ``` - # The constraint at `organizations/foo` is enforced. - # The constraint at `projects/bar` is not enforced, because - # `constraint_default` for the `Constraint` is `ALLOW`. + # If `true`, then the `Policy` is enforced. If `false`, then any configuration + # is acceptable. Suppose you have a `Constraint` `constraints/compute. + # disableSerialPortAccess` with `constraint_default` set to `ALLOW`. A `Policy` + # for that `Constraint` exhibits the following behavior: - If the `Policy` at + # this resource has enforced set to `false`, serial port connection attempts + # will be allowed. - If the `Policy` at this resource has enforced set to `true`, + # serial port connection attempts will be refused. - If the `Policy` at this + # resource is `RestoreDefault`, serial port connection attempts will be allowed. + # - If no `Policy` is set at this resource or anywhere higher in the resource + # hierarchy, serial port connection attempts will be allowed. - If no `Policy` + # is set at this resource, but one exists higher in the resource hierarchy, the + # behavior is as if the`Policy` were set at this resource. The following + # examples demonstrate the different possible layerings: Example 1 (nearest ` + # Constraint` wins): `organizations/foo` has a `Policy` with: `enforced: false` ` + # projects/bar` has no `Policy` set. The constraint at `projects/bar` and ` + # organizations/foo` will not be enforced. Example 2 (enforcement gets replaced): + # `organizations/foo` has a `Policy` with: `enforced: false` `projects/bar` has + # a `Policy` with: `enforced: true` The constraint at `organizations/foo` is not + # enforced. The constraint at `projects/bar` is enforced. Example 3 ( + # RestoreDefault): `organizations/foo` has a `Policy` with: `enforced: true` ` + # projects/bar` has a `Policy` with: `RestoreDefault: ``` The constraint at ` + # organizations/foo` is enforced. The constraint at `projects/bar` is not + # enforced, because `constraint_default` for the `Constraint` is `ALLOW`. # Corresponds to the JSON property `enforced` # @return [Boolean] attr_accessor :enforced @@ -857,26 +707,22 @@ module Google end end - # Used in `policy_type` to specify how `list_policy` behaves at this - # resource. - # `ListPolicy` can define specific values and subtrees of Cloud Resource - # Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that - # are allowed or denied by setting the `allowed_values` and `denied_values` - # fields. This is achieved by using the `under:` and optional `is:` prefixes. - # The `under:` prefix is used to denote resource subtree values. - # The `is:` prefix is used to denote specific values, and is required only - # if the value contains a ":". Values prefixed with "is:" are treated the - # same as values with no prefix. - # Ancestry subtrees must be in one of the following formats: - # - "projects/", e.g. "projects/tokyo-rain-123" - # - "folders/", e.g. "folders/1234" - # - "organizations/", e.g. "organizations/1234" - # The `supports_under` field of the associated `Constraint` defines whether - # ancestry prefixes can be used. You can set `allowed_values` and - # `denied_values` in the same `Policy` if `all_values` is - # `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all - # values. If `all_values` is set to either `ALLOW` or `DENY`, - # `allowed_values` and `denied_values` must be unset. + # Used in `policy_type` to specify how `list_policy` behaves at this resource. ` + # ListPolicy` can define specific values and subtrees of Cloud Resource Manager + # resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed + # or denied by setting the `allowed_values` and `denied_values` fields. This is + # achieved by using the `under:` and optional `is:` prefixes. The `under:` + # prefix is used to denote resource subtree values. The `is:` prefix is used to + # denote specific values, and is required only if the value contains a ":". + # Values prefixed with "is:" are treated the same as values with no prefix. + # Ancestry subtrees must be in one of the following formats: - "projects/", e.g. + # "projects/tokyo-rain-123" - "folders/", e.g. "folders/1234" - "organizations/", + # e.g. "organizations/1234" The `supports_under` field of the associated ` + # Constraint` defines whether ancestry prefixes can be used. You can set ` + # allowed_values` and `denied_values` in the same `Policy` if `all_values` is ` + # ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all + # values. If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values` + # and `denied_values` must be unset. class GoogleCloudOrgpolicyV1ListPolicy include Google::Apis::Core::Hashable @@ -885,112 +731,83 @@ module Google # @return [String] attr_accessor :all_values - # List of values allowed at this resource. Can only be set if `all_values` - # is set to `ALL_VALUES_UNSPECIFIED`. + # List of values allowed at this resource. Can only be set if `all_values` is + # set to `ALL_VALUES_UNSPECIFIED`. # Corresponds to the JSON property `allowedValues` # @return [Array] attr_accessor :allowed_values - # List of values denied at this resource. Can only be set if `all_values` - # is set to `ALL_VALUES_UNSPECIFIED`. + # List of values denied at this resource. Can only be set if `all_values` is set + # to `ALL_VALUES_UNSPECIFIED`. # Corresponds to the JSON property `deniedValues` # @return [Array] attr_accessor :denied_values - # Determines the inheritance behavior for this `Policy`. - # By default, a `ListPolicy` set at a resource supersedes any `Policy` set - # anywhere up the resource hierarchy. However, if `inherit_from_parent` is - # set to `true`, then the values from the effective `Policy` of the parent - # resource are inherited, meaning the values set in this `Policy` are - # added to the values inherited up the hierarchy. - # Setting `Policy` hierarchies that inherit both allowed values and denied - # values isn't recommended in most circumstances to keep the configuration - # simple and understandable. However, it is possible to set a `Policy` with - # `allowed_values` set that inherits a `Policy` with `denied_values` set. - # In this case, the values that are allowed must be in `allowed_values` and - # not present in `denied_values`. - # For example, suppose you have a `Constraint` - # `constraints/serviceuser.services`, which has a `constraint_type` of - # `list_constraint`, and with `constraint_default` set to `ALLOW`. - # Suppose that at the Organization level, a `Policy` is applied that - # restricts the allowed API activations to ``E1`, `E2``. Then, if a - # `Policy` is applied to a project below the Organization that has - # `inherit_from_parent` set to `false` and field all_values set to DENY, - # then an attempt to activate any API will be denied. - # The following examples demonstrate different possible layerings for - # `projects/bar` parented by `organizations/foo`: - # Example 1 (no inherited values): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values:"E2"` - # `projects/bar` has `inherit_from_parent` `false` and values: - # `allowed_values: "E3" allowed_values: "E4"` - # The accepted values at `organizations/foo` are `E1`, `E2`. - # The accepted values at `projects/bar` are `E3`, and `E4`. - # Example 2 (inherited values): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values:"E2"` - # `projects/bar` has a `Policy` with values: - # `value: "E3" value: "E4" inherit_from_parent: true` - # The accepted values at `organizations/foo` are `E1`, `E2`. - # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`. - # Example 3 (inheriting both allowed and denied values): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values: "E2"` - # `projects/bar` has a `Policy` with: - # `denied_values: "E1"` - # The accepted values at `organizations/foo` are `E1`, `E2`. - # The value accepted at `projects/bar` is `E2`. - # Example 4 (RestoreDefault): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values:"E2"` - # `projects/bar` has a `Policy` with values: - # `RestoreDefault: ``` - # The accepted values at `organizations/foo` are `E1`, `E2`. - # The accepted values at `projects/bar` are either all or none depending on - # the value of `constraint_default` (if `ALLOW`, all; if - # `DENY`, none). - # Example 5 (no policy inherits parent policy): - # `organizations/foo` has no `Policy` set. - # `projects/bar` has no `Policy` set. - # The accepted values at both levels are either all or none depending on - # the value of `constraint_default` (if `ALLOW`, all; if - # `DENY`, none). - # Example 6 (ListConstraint allowing all): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values: "E2"` - # `projects/bar` has a `Policy` with: - # `all: ALLOW` - # The accepted values at `organizations/foo` are `E1`, E2`. - # Any value is accepted at `projects/bar`. - # Example 7 (ListConstraint allowing none): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values: "E2"` - # `projects/bar` has a `Policy` with: - # `all: DENY` - # The accepted values at `organizations/foo` are `E1`, E2`. - # No value is accepted at `projects/bar`. - # Example 10 (allowed and denied subtrees of Resource Manager hierarchy): - # Given the following resource hierarchy - # O1->`F1, F2`; F1->`P1`; F2->`P2, P3`, - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "under:organizations/O1"` - # `projects/bar` has a `Policy` with: - # `allowed_values: "under:projects/P3"` - # `denied_values: "under:folders/F2"` - # The accepted values at `organizations/foo` are `organizations/O1`, - # `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`, - # `projects/P3`. - # The accepted values at `projects/bar` are `organizations/O1`, - # `folders/F1`, `projects/P1`. + # Determines the inheritance behavior for this `Policy`. By default, a ` + # ListPolicy` set at a resource supersedes any `Policy` set anywhere up the + # resource hierarchy. However, if `inherit_from_parent` is set to `true`, then + # the values from the effective `Policy` of the parent resource are inherited, + # meaning the values set in this `Policy` are added to the values inherited up + # the hierarchy. Setting `Policy` hierarchies that inherit both allowed values + # and denied values isn't recommended in most circumstances to keep the + # configuration simple and understandable. However, it is possible to set a ` + # Policy` with `allowed_values` set that inherits a `Policy` with `denied_values` + # set. In this case, the values that are allowed must be in `allowed_values` + # and not present in `denied_values`. For example, suppose you have a ` + # Constraint` `constraints/serviceuser.services`, which has a `constraint_type` + # of `list_constraint`, and with `constraint_default` set to `ALLOW`. Suppose + # that at the Organization level, a `Policy` is applied that restricts the + # allowed API activations to ``E1`, `E2``. Then, if a `Policy` is applied to a + # project below the Organization that has `inherit_from_parent` set to `false` + # and field all_values set to DENY, then an attempt to activate any API will be + # denied. The following examples demonstrate different possible layerings for ` + # projects/bar` parented by `organizations/foo`: Example 1 (no inherited values): + # `organizations/foo` has a `Policy` with values: `allowed_values: "E1" + # allowed_values:"E2"` `projects/bar` has `inherit_from_parent` `false` and + # values: `allowed_values: "E3" allowed_values: "E4"` The accepted values at ` + # organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are ` + # E3`, and `E4`. Example 2 (inherited values): `organizations/foo` has a `Policy` + # with values: `allowed_values: "E1" allowed_values:"E2"` `projects/bar` has a ` + # Policy` with values: `value: "E3" value: "E4" inherit_from_parent: true` The + # accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at ` + # projects/bar` are `E1`, `E2`, `E3`, and `E4`. Example 3 (inheriting both + # allowed and denied values): `organizations/foo` has a `Policy` with values: ` + # allowed_values: "E1" allowed_values: "E2"` `projects/bar` has a `Policy` with: + # `denied_values: "E1"` The accepted values at `organizations/foo` are `E1`, `E2` + # . The value accepted at `projects/bar` is `E2`. Example 4 (RestoreDefault): ` + # organizations/foo` has a `Policy` with values: `allowed_values: "E1" + # allowed_values:"E2"` `projects/bar` has a `Policy` with values: ` + # RestoreDefault: ``` The accepted values at `organizations/foo` are `E1`, `E2`. + # The accepted values at `projects/bar` are either all or none depending on the + # value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 5 ( + # no policy inherits parent policy): `organizations/foo` has no `Policy` set. ` + # projects/bar` has no `Policy` set. The accepted values at both levels are + # either all or none depending on the value of `constraint_default` (if `ALLOW`, + # all; if `DENY`, none). Example 6 (ListConstraint allowing all): `organizations/ + # foo` has a `Policy` with values: `allowed_values: "E1" allowed_values: "E2"` ` + # projects/bar` has a `Policy` with: `all: ALLOW` The accepted values at ` + # organizations/foo` are `E1`, E2`. Any value is accepted at `projects/bar`. + # Example 7 (ListConstraint allowing none): `organizations/foo` has a `Policy` + # with values: `allowed_values: "E1" allowed_values: "E2"` `projects/bar` has a ` + # Policy` with: `all: DENY` The accepted values at `organizations/foo` are `E1`, + # E2`. No value is accepted at `projects/bar`. Example 10 (allowed and denied + # subtrees of Resource Manager hierarchy): Given the following resource + # hierarchy O1->`F1, F2`; F1->`P1`; F2->`P2, P3`, `organizations/foo` has a ` + # Policy` with values: `allowed_values: "under:organizations/O1"` `projects/bar` + # has a `Policy` with: `allowed_values: "under:projects/P3"` `denied_values: " + # under:folders/F2"` The accepted values at `organizations/foo` are ` + # organizations/O1`, `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`, ` + # projects/P3`. The accepted values at `projects/bar` are `organizations/O1`, ` + # folders/F1`, `projects/P1`. # Corresponds to the JSON property `inheritFromParent` # @return [Boolean] attr_accessor :inherit_from_parent alias_method :inherit_from_parent?, :inherit_from_parent - # Optional. The Google Cloud Console will try to default to a configuration - # that matches the value specified in this `Policy`. If `suggested_value` - # is not set, it will inherit the value specified higher in the hierarchy, - # unless `inherit_from_parent` is `false`. + # Optional. The Google Cloud Console will try to default to a configuration that + # matches the value specified in this `Policy`. If `suggested_value` is not set, + # it will inherit the value specified higher in the hierarchy, unless ` + # inherit_from_parent` is `false`. # Corresponds to the JSON property `suggestedValue` # @return [String] attr_accessor :suggested_value @@ -1020,76 +837,65 @@ module Google # @return [Google::Apis::CloudassetV1::GoogleCloudOrgpolicyV1BooleanPolicy] attr_accessor :boolean_policy - # The name of the `Constraint` the `Policy` is configuring, for example, - # `constraints/serviceuser.services`. - # A [list of available - # constraints](/resource-manager/docs/organization-policy/org-policy-constraints) - # is available. + # The name of the `Constraint` the `Policy` is configuring, for example, ` + # constraints/serviceuser.services`. A [list of available constraints](/resource- + # manager/docs/organization-policy/org-policy-constraints) is available. # Immutable after creation. # Corresponds to the JSON property `constraint` # @return [String] attr_accessor :constraint # An opaque tag indicating the current version of the `Policy`, used for - # concurrency control. - # When the `Policy` is returned from either a `GetPolicy` or a - # `ListOrgPolicy` request, this `etag` indicates the version of the current - # `Policy` to use when executing a read-modify-write loop. - # When the `Policy` is returned from a `GetEffectivePolicy` request, the - # `etag` will be unset. - # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value - # that was returned from a `GetOrgPolicy` request as part of a - # read-modify-write loop for concurrency control. Not setting the `etag`in a - # `SetOrgPolicy` request will result in an unconditional write of the - # `Policy`. + # concurrency control. When the `Policy` is returned from either a `GetPolicy` + # or a `ListOrgPolicy` request, this `etag` indicates the version of the current + # `Policy` to use when executing a read-modify-write loop. When the `Policy` is + # returned from a `GetEffectivePolicy` request, the `etag` will be unset. When + # the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value that was + # returned from a `GetOrgPolicy` request as part of a read-modify-write loop for + # concurrency control. Not setting the `etag`in a `SetOrgPolicy` request will + # result in an unconditional write of the `Policy`. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag - # Used in `policy_type` to specify how `list_policy` behaves at this - # resource. - # `ListPolicy` can define specific values and subtrees of Cloud Resource - # Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that - # are allowed or denied by setting the `allowed_values` and `denied_values` - # fields. This is achieved by using the `under:` and optional `is:` prefixes. - # The `under:` prefix is used to denote resource subtree values. - # The `is:` prefix is used to denote specific values, and is required only - # if the value contains a ":". Values prefixed with "is:" are treated the - # same as values with no prefix. - # Ancestry subtrees must be in one of the following formats: - # - "projects/", e.g. "projects/tokyo-rain-123" - # - "folders/", e.g. "folders/1234" - # - "organizations/", e.g. "organizations/1234" - # The `supports_under` field of the associated `Constraint` defines whether - # ancestry prefixes can be used. You can set `allowed_values` and - # `denied_values` in the same `Policy` if `all_values` is - # `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all - # values. If `all_values` is set to either `ALLOW` or `DENY`, - # `allowed_values` and `denied_values` must be unset. + # Used in `policy_type` to specify how `list_policy` behaves at this resource. ` + # ListPolicy` can define specific values and subtrees of Cloud Resource Manager + # resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed + # or denied by setting the `allowed_values` and `denied_values` fields. This is + # achieved by using the `under:` and optional `is:` prefixes. The `under:` + # prefix is used to denote resource subtree values. The `is:` prefix is used to + # denote specific values, and is required only if the value contains a ":". + # Values prefixed with "is:" are treated the same as values with no prefix. + # Ancestry subtrees must be in one of the following formats: - "projects/", e.g. + # "projects/tokyo-rain-123" - "folders/", e.g. "folders/1234" - "organizations/", + # e.g. "organizations/1234" The `supports_under` field of the associated ` + # Constraint` defines whether ancestry prefixes can be used. You can set ` + # allowed_values` and `denied_values` in the same `Policy` if `all_values` is ` + # ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all + # values. If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values` + # and `denied_values` must be unset. # Corresponds to the JSON property `listPolicy` # @return [Google::Apis::CloudassetV1::GoogleCloudOrgpolicyV1ListPolicy] attr_accessor :list_policy - # Ignores policies set above this resource and restores the - # `constraint_default` enforcement behavior of the specific `Constraint` at - # this resource. - # Suppose that `constraint_default` is set to `ALLOW` for the - # `Constraint` `constraints/serviceuser.services`. Suppose that organization - # foo.com sets a `Policy` at their Organization resource node that restricts - # the allowed service activations to deny all service activations. They - # could then set a `Policy` with the `policy_type` `restore_default` on - # several experimental projects, restoring the `constraint_default` - # enforcement of the `Constraint` for only those projects, allowing those - # projects to have all services activated. + # Ignores policies set above this resource and restores the `constraint_default` + # enforcement behavior of the specific `Constraint` at this resource. Suppose + # that `constraint_default` is set to `ALLOW` for the `Constraint` `constraints/ + # serviceuser.services`. Suppose that organization foo.com sets a `Policy` at + # their Organization resource node that restricts the allowed service + # activations to deny all service activations. They could then set a `Policy` + # with the `policy_type` `restore_default` on several experimental projects, + # restoring the `constraint_default` enforcement of the `Constraint` for only + # those projects, allowing those projects to have all services activated. # Corresponds to the JSON property `restoreDefault` # @return [Google::Apis::CloudassetV1::GoogleCloudOrgpolicyV1RestoreDefault] attr_accessor :restore_default - # The time stamp the `Policy` was previously updated. This is set by the - # server, not specified by the caller, and represents the last time a call to - # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will - # be ignored. + # The time stamp the `Policy` was previously updated. This is set by the server, + # not specified by the caller, and represents the last time a call to ` + # SetOrgPolicy` was made for that `Policy`. Any value set by the client will be + # ignored. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -1115,17 +921,15 @@ module Google end end - # Ignores policies set above this resource and restores the - # `constraint_default` enforcement behavior of the specific `Constraint` at - # this resource. - # Suppose that `constraint_default` is set to `ALLOW` for the - # `Constraint` `constraints/serviceuser.services`. Suppose that organization - # foo.com sets a `Policy` at their Organization resource node that restricts - # the allowed service activations to deny all service activations. They - # could then set a `Policy` with the `policy_type` `restore_default` on - # several experimental projects, restoring the `constraint_default` - # enforcement of the `Constraint` for only those projects, allowing those - # projects to have all services activated. + # Ignores policies set above this resource and restores the `constraint_default` + # enforcement behavior of the specific `Constraint` at this resource. Suppose + # that `constraint_default` is set to `ALLOW` for the `Constraint` `constraints/ + # serviceuser.services`. Suppose that organization foo.com sets a `Policy` at + # their Organization resource node that restricts the allowed service + # activations to deny all service activations. They could then set a `Policy` + # with the `policy_type` `restore_default` on several experimental projects, + # restoring the `constraint_default` enforcement of the `Constraint` for only + # those projects, allowing those projects to have all services activated. class GoogleCloudOrgpolicyV1RestoreDefault include Google::Apis::Core::Hashable @@ -1150,8 +954,8 @@ module Google attr_accessor :basic # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language - # to represent the necessary conditions for the level to apply to a request. - # See CEL spec at: https://github.com/google/cel-spec + # to represent the necessary conditions for the level to apply to a request. See + # CEL spec at: https://github.com/google/cel-spec # Corresponds to the JSON property `custom` # @return [Google::Apis::CloudassetV1::GoogleIdentityAccesscontextmanagerV1CustomLevel] attr_accessor :custom @@ -1161,10 +965,10 @@ module Google # @return [String] attr_accessor :description - # Required. Resource name for the Access Level. The `short_name` component - # must begin with a letter and only include alphanumeric and '_'. Format: - # `accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length - # of the `short_name` component is 50 characters. + # Required. Resource name for the Access Level. The `short_name` component must + # begin with a letter and only include alphanumeric and '_'. Format: ` + # accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length of + # the `short_name` component is 50 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1189,30 +993,29 @@ module Google end # `AccessPolicy` is a container for `AccessLevels` (which define the necessary - # attributes to use Google Cloud services) and `ServicePerimeters` (which - # define regions of services able to freely pass data within a perimeter). An - # access policy is globally visible within an organization, and the - # restrictions it specifies apply to all projects within an organization. + # attributes to use Google Cloud services) and `ServicePerimeters` (which define + # regions of services able to freely pass data within a perimeter). An access + # policy is globally visible within an organization, and the restrictions it + # specifies apply to all projects within an organization. class GoogleIdentityAccesscontextmanagerV1AccessPolicy include Google::Apis::Core::Hashable - # Output only. An opaque identifier for the current version of the - # `AccessPolicy`. This will always be a strongly validated etag, meaning that - # two Access Polices will be identical if and only if their etags are - # identical. Clients should not expect this to be in any specific format. + # Output only. An opaque identifier for the current version of the `AccessPolicy` + # . This will always be a strongly validated etag, meaning that two Access + # Polices will be identical if and only if their etags are identical. Clients + # should not expect this to be in any specific format. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # Output only. Resource name of the `AccessPolicy`. Format: - # `accessPolicies/`policy_id`` + # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/` + # policy_id`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The parent of this `AccessPolicy` in the Cloud Resource - # Hierarchy. Currently immutable once created. Format: - # `organizations/`organization_id`` + # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. + # Currently immutable once created. Format: `organizations/`organization_id`` # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -1240,10 +1043,10 @@ module Google include Google::Apis::Core::Hashable # How the `conditions` list should be combined to determine if a request is - # granted this `AccessLevel`. If AND is used, each `Condition` in - # `conditions` must be satisfied for the `AccessLevel` to be applied. If OR - # is used, at least one `Condition` in `conditions` must be satisfied for the - # `AccessLevel` to be applied. Default behavior is AND. + # granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` + # must be satisfied for the `AccessLevel` to be applied. If OR is used, at least + # one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be + # applied. Default behavior is AND. # Corresponds to the JSON property `combiningFunction` # @return [String] attr_accessor :combining_function @@ -1277,54 +1080,48 @@ module Google # devices to be granted access levels, it does not do any enforcement on the # device. `DevicePolicy` acts as an AND over all specified fields, and each # repeated field is an OR over its elements. Any unset fields are ignored. For - # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : - # DESKTOP_LINUX, encryption_status: ENCRYPTED`, then the DevicePolicy will be - # true for requests originating from encrypted Linux desktops and encrypted - # Windows desktops. + # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, + # encryption_status: ENCRYPTED`, then the DevicePolicy will be true for requests + # originating from encrypted Linux desktops and encrypted Windows desktops. # Corresponds to the JSON property `devicePolicy` # @return [Google::Apis::CloudassetV1::GoogleIdentityAccesscontextmanagerV1DevicePolicy] attr_accessor :device_policy - # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for - # a CIDR IP address block, the specified IP address portion must be properly + # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a + # CIDR IP address block, the specified IP address portion must be properly # truncated (i.e. all the host bits must be zero) or the input is considered - # malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is - # not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas - # "2001:db8::1/32" is not. The originating IP of a request must be in one of - # the listed subnets in order for this Condition to be true. If empty, all IP - # addresses are allowed. + # malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. + # Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is + # not. The originating IP of a request must be in one of the listed subnets in + # order for this Condition to be true. If empty, all IP addresses are allowed. # Corresponds to the JSON property `ipSubnetworks` # @return [Array] attr_accessor :ip_subnetworks - # The request must be made by one of the provided user or service - # accounts. Groups are not supported. - # Syntax: - # `user:`emailid`` - # `serviceAccount:`emailid`` + # The request must be made by one of the provided user or service accounts. + # Groups are not supported. Syntax: `user:`emailid`` `serviceAccount:`emailid`` # If not specified, a request may come from any user. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members # Whether to negate the Condition. If true, the Condition becomes a NAND over - # its non-empty fields, each field must be false for the Condition overall to - # be satisfied. Defaults to false. + # its non-empty fields, each field must be false for the Condition overall to be + # satisfied. Defaults to false. # Corresponds to the JSON property `negate` # @return [Boolean] attr_accessor :negate alias_method :negate?, :negate - # The request must originate from one of the provided countries/regions. - # Must be valid ISO 3166-1 alpha-2 codes. + # The request must originate from one of the provided countries/regions. Must be + # valid ISO 3166-1 alpha-2 codes. # Corresponds to the JSON property `regions` # @return [Array] attr_accessor :regions # A list of other access levels defined in the same `Policy`, referenced by - # resource name. Referencing an `AccessLevel` which does not exist is an - # error. All access levels listed must be granted for the Condition - # to be true. Example: + # resource name. Referencing an `AccessLevel` which does not exist is an error. + # All access levels listed must be granted for the Condition to be true. Example: # "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` # Corresponds to the JSON property `requiredAccessLevels` # @return [Array] @@ -1346,33 +1143,26 @@ module Google end # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language - # to represent the necessary conditions for the level to apply to a request. - # See CEL spec at: https://github.com/google/cel-spec + # to represent the necessary conditions for the level to apply to a request. See + # CEL spec at: https://github.com/google/cel-spec class GoogleIdentityAccesscontextmanagerV1CustomLevel 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 `expr` # @return [Google::Apis::CloudassetV1::Expr] attr_accessor :expr @@ -1392,15 +1182,13 @@ module Google # devices to be granted access levels, it does not do any enforcement on the # device. `DevicePolicy` acts as an AND over all specified fields, and each # repeated field is an OR over its elements. Any unset fields are ignored. For - # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : - # DESKTOP_LINUX, encryption_status: ENCRYPTED`, then the DevicePolicy will be - # true for requests originating from encrypted Linux desktops and encrypted - # Windows desktops. + # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, + # encryption_status: ENCRYPTED`, then the DevicePolicy will be true for requests + # originating from encrypted Linux desktops and encrypted Windows desktops. class GoogleIdentityAccesscontextmanagerV1DevicePolicy include Google::Apis::Core::Hashable - # Allowed device management levels, an empty list allows all management - # levels. + # Allowed device management levels, an empty list allows all management levels. # Corresponds to the JSON property `allowedDeviceManagementLevels` # @return [Array] attr_accessor :allowed_device_management_levels @@ -1453,9 +1241,9 @@ module Google class GoogleIdentityAccesscontextmanagerV1OsConstraint include Google::Apis::Core::Hashable - # The minimum allowed OS version. If not set, any version of this OS - # satisfies the constraint. Format: `"major.minor.patch"`. - # Examples: `"10.5.301"`, `"9.2.1"`. + # The minimum allowed OS version. If not set, any version of this OS satisfies + # the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1" + # `. # Corresponds to the JSON property `minimumVersion` # @return [String] attr_accessor :minimum_version @@ -1465,10 +1253,10 @@ module Google # @return [String] attr_accessor :os_type - # Only allows requests from devices with a verified Chrome OS. - # Verifications includes requirements that the device is enterprise-managed, - # conformant to domain policies, and the caller has permission to call - # the API targeted by the request. + # Only allows requests from devices with a verified Chrome OS. Verifications + # includes requirements that the device is enterprise-managed, conformant to + # domain policies, and the caller has permission to call the API targeted by the + # request. # Corresponds to the JSON property `requireVerifiedChromeOs` # @return [Boolean] attr_accessor :require_verified_chrome_os @@ -1487,37 +1275,34 @@ module Google end # `ServicePerimeter` describes a set of Google Cloud resources which can freely - # import and export data amongst themselves, but not export outside of the - # `ServicePerimeter`. If a request with a source within this `ServicePerimeter` + # import and export data amongst themselves, but not export outside of the ` + # ServicePerimeter`. If a request with a source within this `ServicePerimeter` # has a target outside of the `ServicePerimeter`, the request will be blocked. # Otherwise the request is allowed. There are two types of Service Perimeter - - # Regular and Bridge. Regular Service Perimeters cannot overlap, a single - # Google Cloud project can only belong to a single regular Service Perimeter. - # Service Perimeter Bridges can contain only Google Cloud projects as members, - # a single Google Cloud project may belong to multiple Service Perimeter - # Bridges. + # Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google + # Cloud project can only belong to a single regular Service Perimeter. Service + # Perimeter Bridges can contain only Google Cloud projects as members, a single + # Google Cloud project may belong to multiple Service Perimeter Bridges. class GoogleIdentityAccesscontextmanagerV1ServicePerimeter include Google::Apis::Core::Hashable - # Description of the `ServicePerimeter` and its use. Does not affect - # behavior. + # Description of the `ServicePerimeter` and its use. Does not affect behavior. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Required. Resource name for the ServicePerimeter. The `short_name` - # component must begin with a letter and only include alphanumeric and '_'. - # Format: `accessPolicies/`policy_id`/servicePerimeters/`short_name`` + # Required. Resource name for the ServicePerimeter. The `short_name` component + # must begin with a letter and only include alphanumeric and '_'. Format: ` + # accessPolicies/`policy_id`/servicePerimeters/`short_name`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Perimeter type indicator. A single project is - # allowed to be a member of single regular perimeter, but multiple service - # perimeter bridges. A project cannot be a included in a perimeter bridge - # without being included in regular perimeter. For perimeter bridges, - # the restricted service list as well as access level lists must be - # empty. + # Perimeter type indicator. A single project is allowed to be a member of single + # regular perimeter, but multiple service perimeter bridges. A project cannot be + # a included in a perimeter bridge without being included in regular perimeter. + # For perimeter bridges, the restricted service list as well as access level + # lists must be empty. # Corresponds to the JSON property `perimeterType` # @return [String] attr_accessor :perimeter_type @@ -1539,16 +1324,15 @@ module Google # @return [String] attr_accessor :title - # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly - # exists for all Service Perimeters, and that spec is identical to the - # status for those Service Perimeters. When this flag is set, it inhibits the - # generation of the implicit spec, thereby allowing the user to explicitly - # provide a configuration ("spec") to use in a dry-run version of the Service - # Perimeter. This allows the user to test changes to the enforced config - # ("status") without actually enforcing them. This testing is done through - # analyzing the differences between currently enforced and suggested - # restrictions. use_explicit_dry_run_spec must bet set to True if any of the - # fields in the spec are set to non-default values. + # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists + # for all Service Perimeters, and that spec is identical to the status for those + # Service Perimeters. When this flag is set, it inhibits the generation of the + # implicit spec, thereby allowing the user to explicitly provide a configuration + # ("spec") to use in a dry-run version of the Service Perimeter. This allows the + # user to test changes to the enforced config ("status") without actually + # enforcing them. This testing is done through analyzing the differences between + # currently enforced and suggested restrictions. use_explicit_dry_run_spec must + # bet set to True if any of the fields in the spec are set to non-default values. # Corresponds to the JSON property `useExplicitDryRunSpec` # @return [Boolean] attr_accessor :use_explicit_dry_run_spec @@ -1575,14 +1359,13 @@ module Google class GoogleIdentityAccesscontextmanagerV1ServicePerimeterConfig include Google::Apis::Core::Hashable - # A list of `AccessLevel` resource names that allow resources within the - # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed - # must be in the same policy as this `ServicePerimeter`. Referencing a - # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are - # listed, resources within the perimeter can only be accessed via Google - # Cloud calls with request origins within the perimeter. Example: - # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. - # For Service Perimeter Bridge, must be empty. + # A list of `AccessLevel` resource names that allow resources within the ` + # ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must + # be in the same policy as this `ServicePerimeter`. Referencing a nonexistent ` + # AccessLevel` is a syntax error. If no `AccessLevel` names are listed, + # resources within the perimeter can only be accessed via Google Cloud calls + # with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/ + # accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. # Corresponds to the JSON property `accessLevels` # @return [Array] attr_accessor :access_levels @@ -1593,16 +1376,14 @@ module Google # @return [Array] attr_accessor :resources - # Google Cloud services that are subject to the Service Perimeter - # restrictions. For example, if `storage.googleapis.com` is specified, access - # to the storage buckets inside the perimeter must meet the perimeter's - # access restrictions. + # Google Cloud services that are subject to the Service Perimeter restrictions. + # For example, if `storage.googleapis.com` is specified, access to the storage + # buckets inside the perimeter must meet the perimeter's access restrictions. # Corresponds to the JSON property `restrictedServices` # @return [Array] attr_accessor :restricted_services - # Specifies how APIs are allowed to communicate within the Service - # Perimeter. + # Specifies how APIs are allowed to communicate within the Service Perimeter. # Corresponds to the JSON property `vpcAccessibleServices` # @return [Google::Apis::CloudassetV1::GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices] attr_accessor :vpc_accessible_services @@ -1620,21 +1401,20 @@ module Google end end - # Specifies how APIs are allowed to communicate within the Service - # Perimeter. + # Specifies how APIs are allowed to communicate within the Service Perimeter. class GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices include Google::Apis::Core::Hashable - # The list of APIs usable within the Service Perimeter. Must be empty - # unless 'enable_restriction' is True. You can specify a list of individual - # services, as well as include the 'RESTRICTED-SERVICES' value, which - # automatically includes all of the services protected by the perimeter. + # The list of APIs usable within the Service Perimeter. Must be empty unless ' + # enable_restriction' is True. You can specify a list of individual services, as + # well as include the 'RESTRICTED-SERVICES' value, which automatically includes + # all of the services protected by the perimeter. # Corresponds to the JSON property `allowedServices` # @return [Array] attr_accessor :allowed_services - # Whether to restrict API calls within the Service Perimeter to the list of - # APIs specified in 'allowed_services'. + # Whether to restrict API calls within the Service Perimeter to the list of APIs + # specified in 'allowed_services'. # Corresponds to the JSON property `enableRestriction` # @return [Boolean] attr_accessor :enable_restriction @@ -1661,90 +1441,52 @@ module Google attr_accessor :explanation # 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::CloudassetV1::Policy] attr_accessor :policy # The project that the associated GCP resource belongs to, in the form of # projects/`PROJECT_NUMBER`. If an IAM policy is set on a resource (like VM - # instance, Cloud Storage bucket), the project field will indicate the - # project that contains the resource. If an IAM policy is set on a folder or - # orgnization, the project field will be empty. - # To search against the `project`: - # * specify the `scope` field as this project in your search request. + # instance, Cloud Storage bucket), the project field will indicate the project + # that contains the resource. If an IAM policy is set on a folder or orgnization, + # the project field will be empty. To search against the `project`: * specify + # the `scope` field as this project in your search request. # Corresponds to the JSON property `project` # @return [String] attr_accessor :project # The full resource name of the resource associated with this IAM policy. - # Example: - # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/ - # instance1`. - # See [Cloud Asset Inventory Resource Name - # Format](https://cloud.google.com/asset-inventory/docs/resource-name-format) - # for more information. - # To search against the `resource`: - # * use a field query. Example: `resource : "organizations/123"` + # Example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/ + # instances/instance1`. See [Cloud Asset Inventory Resource Name Format](https:// + # cloud.google.com/asset-inventory/docs/resource-name-format) for more + # information. To search against the `resource`: * use a field query. Example: ` + # resource:organizations/123` # Corresponds to the JSON property `resource` # @return [String] attr_accessor :resource @@ -1786,47 +1528,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::CloudassetV1::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] 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] attr_accessor :response @@ -1890,66 +1630,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 @@ -1958,48 +1664,44 @@ module Google # @return [Array] 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] 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 @@ -2021,8 +1723,8 @@ module Google class PubsubDestination include Google::Apis::Core::Hashable - # The name of the Pub/Sub topic to publish to. - # Example: `projects/PROJECT_ID/topics/TOPIC_ID`. + # The name of the Pub/Sub topic to publish to. Example: `projects/PROJECT_ID/ + # topics/TOPIC_ID`. # Corresponds to the JSON property `topic` # @return [String] attr_accessor :topic @@ -2041,53 +1743,48 @@ module Google class Resource include Google::Apis::Core::Hashable - # The content of the resource, in which some sensitive fields are removed - # and may not be present. + # The content of the resource, in which some sensitive fields are removed and + # may not be present. # Corresponds to the JSON property `data` # @return [Hash] attr_accessor :data # The URL of the discovery document containing the resource's JSON schema. - # Example: - # `https://www.googleapis.com/discovery/v1/apis/compute/v1/rest` - # This value is unspecified for resources that do not have an API based on a + # Example: `https://www.googleapis.com/discovery/v1/apis/compute/v1/rest` This + # value is unspecified for resources that do not have an API based on a # discovery document, such as Cloud Bigtable. # Corresponds to the JSON property `discoveryDocumentUri` # @return [String] attr_accessor :discovery_document_uri - # The JSON schema name listed in the discovery document. Example: - # `Project` - # This value is unspecified for resources that do not have an API based on a + # The JSON schema name listed in the discovery document. Example: `Project` This + # value is unspecified for resources that do not have an API based on a # discovery document, such as Cloud Bigtable. # Corresponds to the JSON property `discoveryName` # @return [String] attr_accessor :discovery_name - # The location of the resource in Google Cloud, such as its zone and region. - # For more information, see https://cloud.google.com/about/locations/. + # The location of the resource in Google Cloud, such as its zone and region. For + # more information, see https://cloud.google.com/about/locations/. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # The full name of the immediate parent of this resource. See - # [Resource - # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - # for more information. - # For Google Cloud assets, this value is the parent resource defined in the - # [Cloud IAM policy - # hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy). - # Example: - # `//cloudresourcemanager.googleapis.com/projects/my_project_123` - # For third-party assets, this field may be set differently. + # The full name of the immediate parent of this resource. See [Resource Names]( + # https://cloud.google.com/apis/design/resource_names#full_resource_name) for + # more information. For Google Cloud assets, this value is the parent resource + # defined in the [Cloud IAM policy hierarchy](https://cloud.google.com/iam/docs/ + # overview#policy_hierarchy). Example: `//cloudresourcemanager.googleapis.com/ + # projects/my_project_123` For third-party assets, this field may be set + # differently. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # The REST URL for accessing the resource. An HTTP `GET` request using this - # URL returns the resource itself. Example: - # `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123` - # This value is unspecified for resources without a REST API. + # The REST URL for accessing the resource. An HTTP `GET` request using this URL + # returns the resource itself. Example: `https://cloudresourcemanager.googleapis. + # com/v1/projects/my-project-123` This value is unspecified for resources + # without a REST API. # Corresponds to the JSON property `resourceUrl` # @return [String] attr_accessor :resource_url @@ -2117,103 +1814,86 @@ module Google class ResourceSearchResult include Google::Apis::Core::Hashable - # The additional searchable attributes of this resource. The attributes may - # vary from one resource type to another. Examples: `projectId` for Project, - # `dnsName` for DNS ManagedZone. This field contains a subset of the resource - # metadata fields that are returned by the List or Get APIs provided by the - # corresponding GCP service (e.g., Compute Engine). see [API references and - # supported searchable - # attributes](https://cloud.google.com/asset-inventory/docs/supported-asset- - # types#searchable_asset_types) - # for more information. - # You can search values of these fields through free text search. However, - # you should not consume the field programically as the field names and - # values may change as the GCP service updates to a new incompatible API - # version. - # To search against the `additional_attributes`: - # * use a free text query to match the attributes values. Example: to search - # `additional_attributes = ` dnsName: "foobar" ``, you can issue a query - # `"foobar"`. + # The additional searchable attributes of this resource. The attributes may vary + # from one resource type to another. Examples: `projectId` for Project, `dnsName` + # for DNS ManagedZone. This field contains a subset of the resource metadata + # fields that are returned by the List or Get APIs provided by the corresponding + # GCP service (e.g., Compute Engine). see [API references and supported + # searchable attributes](https://cloud.google.com/asset-inventory/docs/supported- + # asset-types#searchable_asset_types) for more information. You can search + # values of these fields through free text search. However, you should not + # consume the field programically as the field names and values may change as + # the GCP service updates to a new incompatible API version. To search against + # the `additional_attributes`: * use a free text query to match the attributes + # values. Example: to search `additional_attributes = ` dnsName: "foobar" ``, + # you can issue a query `foobar`. # Corresponds to the JSON property `additionalAttributes` # @return [Hash] attr_accessor :additional_attributes - # The type of this resource. Example: `compute.googleapis.com/Disk`. - # To search against the `asset_type`: - # * specify the `asset_type` field in your search request. + # The type of this resource. Example: `compute.googleapis.com/Disk`. To search + # against the `asset_type`: * specify the `asset_type` field in your search + # request. # Corresponds to the JSON property `assetType` # @return [String] attr_accessor :asset_type # One or more paragraphs of text description of this resource. Maximum length - # could be up to 1M bytes. - # To search against the `description`: - # * use a field query. Example: `description : "*important instance*"` - # * use a free text query. Example: `"*important instance*"` + # could be up to 1M bytes. To search against the `description`: * use a field + # query. Example: `description:"*important instance*"` * use a free text query. + # Example: `"*important instance*"` # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The display name of this resource. - # To search against the `display_name`: - # * use a field query. Example: `displayName : "My Instance"` - # * use a free text query. Example: `"My Instance"` + # The display name of this resource. To search against the `display_name`: * use + # a field query. Example: `displayName:"My Instance"` * use a free text query. + # Example: `"My Instance"` # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Labels associated with this resource. See [Labelling and grouping GCP # resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping- - # your-google-cloud-platform-resources) - # for more information. - # To search against the `labels`: - # * use a field query, as following: - # - query on any label's key or value. Example: `labels : "prod"` - # - query by a given label. Example: `labels.env : "prod"` - # - query by a given label'sexistence. Example: `labels.env : *` - # * use a free text query. Example: `"prod"` + # your-google-cloud-platform-resources) for more information. To search against + # the `labels`: * use a field query: - query on any label's key or value. + # Example: `labels:prod` - query by a given label. Example: `labels.env:prod` - + # query by a given label's existence. Example: `labels.env:*` * use a free text + # query. Example: `prod` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Location can be `global`, regional like `us-east1`, or zonal like - # `us-west1-b`. - # To search against the `location`: - # * use a field query. Example: `location : "us-west*"` - # * use a free text query. Example: `"us-west*"` + # Location can be `global`, regional like `us-east1`, or zonal like `us-west1-b`. + # To search against the `location`: * use a field query. Example: `location:us- + # west*` * use a free text query. Example: `us-west*` # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # The full resource name of this resource. Example: - # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/ - # instance1`. - # See [Cloud Asset Inventory Resource Name - # Format](https://cloud.google.com/asset-inventory/docs/resource-name-format) - # for more information. - # To search against the `name`: - # * use a field query. Example: `name : "instance1"` - # * use a free text query. Example: `"instance1"` + # The full resource name of this resource. Example: `//compute.googleapis.com/ + # projects/my_project_123/zones/zone1/instances/instance1`. See [Cloud Asset + # Inventory Resource Name Format](https://cloud.google.com/asset-inventory/docs/ + # resource-name-format) for more information. To search against the `name`: * + # use a field query. Example: `name:instance1` * use a free text query. Example: + # `instance1` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Network tags associated with this resource. Like labels, network tags are a - # type of annotations used to group GCP resources. See [Labelling GCP - # resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping- - # your-google-cloud-platform-resources) - # for more information. - # To search against the `network_tags`: - # * use a field query. Example: `networkTags : "internal"` - # * use a free text query. Example: `"internal"` + # type of annotations used to group GCP resources. See [Labelling GCP resources]( + # https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google- + # cloud-platform-resources) for more information. To search against the ` + # network_tags`: * use a field query. Example: `networkTags:internal` * use a + # free text query. Example: `internal` # Corresponds to the JSON property `networkTags` # @return [Array] attr_accessor :network_tags - # The project that this resource belongs to, in the form of - # projects/`PROJECT_NUMBER`. - # To search against the `project`: - # * specify the `scope` field as this project in your search request. + # The project that this resource belongs to, in the form of projects/` + # PROJECT_NUMBER`. To search against the `project`: * specify the `scope` field + # as this project in your search request. # Corresponds to the JSON property `project` # @return [String] attr_accessor :project @@ -2241,14 +1921,14 @@ module Google include Google::Apis::Core::Hashable # Set if there are more results than those appearing in this response; to get - # the next set of results, call this method again, using this value as the - # `page_token`. + # the next set of results, call this method again, using this value as the ` + # page_token`. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # A list of IamPolicy that match the search query. Related information such - # as the associated resource is returned along with the policy. + # A list of IamPolicy that match the search query. Related information such as + # the associated resource is returned along with the policy. # Corresponds to the JSON property `results` # @return [Array] attr_accessor :results @@ -2268,9 +1948,9 @@ module Google class SearchAllResourcesResponse include Google::Apis::Core::Hashable - # If there are more results than those appearing in this response, then - # `next_page_token` is included. To get the next set of results, call this - # method again using the value of `next_page_token` as `page_token`. + # If there are more results than those appearing in this response, then ` + # next_page_token` is included. To get the next set of results, call this method + # again using the value of `next_page_token` as `page_token`. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -2292,12 +1972,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 @@ -2306,15 +1986,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>] 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 @@ -2336,15 +2016,12 @@ module Google class TemporalAsset include Google::Apis::Core::Hashable - # An asset in Google Cloud. An asset can be any resource in the Google Cloud - # [resource - # hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform- - # resource-hierarchy), - # a resource outside the Google Cloud resource hierarchy (such as Google - # Kubernetes Engine clusters and objects), or a policy (e.g. Cloud IAM policy). - # See [Supported asset - # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - # for more information. + # An asset in Google Cloud. An asset can be any resource in the Google Cloud [ + # resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud- + # platform-resource-hierarchy), a resource outside the Google Cloud resource + # hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy + # (e.g. Cloud IAM policy). See [Supported asset types](https://cloud.google.com/ + # asset-inventory/docs/supported-asset-types) for more information. # Corresponds to the JSON property `asset` # @return [Google::Apis::CloudassetV1::Asset] attr_accessor :asset @@ -2355,15 +2032,12 @@ module Google attr_accessor :deleted alias_method :deleted?, :deleted - # An asset in Google Cloud. An asset can be any resource in the Google Cloud - # [resource - # hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform- - # resource-hierarchy), - # a resource outside the Google Cloud resource hierarchy (such as Google - # Kubernetes Engine clusters and objects), or a policy (e.g. Cloud IAM policy). - # See [Supported asset - # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - # for more information. + # An asset in Google Cloud. An asset can be any resource in the Google Cloud [ + # resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud- + # platform-resource-hierarchy), a resource outside the Google Cloud resource + # hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy + # (e.g. Cloud IAM policy). See [Supported asset types](https://cloud.google.com/ + # asset-inventory/docs/supported-asset-types) for more information. # Corresponds to the JSON property `priorAsset` # @return [Google::Apis::CloudassetV1::Asset] attr_accessor :prior_asset @@ -2422,18 +2096,17 @@ module Google class UpdateFeedRequest include Google::Apis::Core::Hashable - # An asset feed used to export asset updates to a destinations. - # An asset feed filter controls what updates are exported. - # The asset feed must be created within a project, organization, or - # folder. Supported destinations are: - # Pub/Sub topics. + # An asset feed used to export asset updates to a destinations. An asset feed + # filter controls what updates are exported. The asset feed must be created + # within a project, organization, or folder. Supported destinations are: Pub/Sub + # topics. # Corresponds to the JSON property `feed` # @return [Google::Apis::CloudassetV1::Feed] attr_accessor :feed - # Required. Only updates the `feed` fields indicated by this mask. - # The field mask must not be empty, and it must not contain fields that - # are immutable or only set by the server. + # Required. Only updates the `feed` fields indicated by this mask. The field + # mask must not be empty, and it must not contain fields that are immutable or + # only set by the server. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/cloudasset_v1/service.rb b/generated/google/apis/cloudasset_v1/service.rb index 907b36fd3..d3225bf5e 100644 --- a/generated/google/apis/cloudasset_v1/service.rb +++ b/generated/google/apis/cloudasset_v1/service.rb @@ -47,14 +47,13 @@ module Google @batch_path = 'batch' end - # Creates a feed in a parent project/folder/organization to listen to its - # asset updates. + # Creates a feed in a parent project/folder/organization to listen to its asset + # updates. # @param [String] parent - # Required. The name of the project/folder/organization where this feed - # should be created in. It can only be an organization number (such as - # "organizations/123"), a folder number (such as "folders/123"), a project ID - # (such as "projects/my-project-id")", or a project number (such as - # "projects/12345"). + # Required. The name of the project/folder/organization where this feed should + # be created in. It can only be an organization number (such as "organizations/ + # 123"), a folder number (such as "folders/123"), a project ID (such as " + # projects/my-project-id")", or a project number (such as "projects/12345"). # @param [Google::Apis::CloudassetV1::CreateFeedRequest] create_feed_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -87,10 +86,9 @@ module Google # Deletes an asset feed. # @param [String] name - # Required. The name of the feed and it must be in the format of: - # projects/project_number/feeds/feed_id - # folders/folder_number/feeds/feed_id - # organizations/organization_number/feeds/feed_id + # Required. The name of the feed and it must be in the format of: projects/ + # project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/ + # organization_number/feeds/feed_id # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -120,10 +118,9 @@ module Google # Gets details about an asset feed. # @param [String] name - # Required. The name of the Feed and it must be in the format of: - # projects/project_number/feeds/feed_id - # folders/folder_number/feeds/feed_id - # organizations/organization_number/feeds/feed_id + # Required. The name of the Feed and it must be in the format of: projects/ + # project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/ + # organization_number/feeds/feed_id # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -153,9 +150,9 @@ module Google # Lists all asset feeds in a parent project/folder/organization. # @param [String] parent - # Required. The parent project/folder/organization whose feeds are to be - # listed. It can only be using project/folder/organization number (such as - # "folders/12345")", or a project ID (such as "projects/my-project-id"). + # Required. The parent project/folder/organization whose feeds are to be listed. + # It can only be using project/folder/organization number (such as "folders/ + # 12345")", or a project ID (such as "projects/my-project-id"). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -185,12 +182,11 @@ module Google # Updates an asset feed configuration. # @param [String] name - # Required. The format will be - # projects/`project_number`/feeds/`client-assigned_feed_identifier` or - # folders/`folder_number`/feeds/`client-assigned_feed_identifier` or - # organizations/`organization_number`/feeds/`client-assigned_feed_identifier` - # The client-assigned feed identifier must be unique within the parent - # project/folder/organization. + # Required. The format will be projects/`project_number`/feeds/`client- + # assigned_feed_identifier` or folders/`folder_number`/feeds/`client- + # assigned_feed_identifier` or organizations/`organization_number`/feeds/`client- + # assigned_feed_identifier` The client-assigned feed identifier must be unique + # within the parent project/folder/organization. # @param [Google::Apis::CloudassetV1::UpdateFeedRequest] update_feed_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -221,9 +217,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 @@ -253,25 +248,21 @@ module Google execute_or_queue_command(command, &block) end - # Batch gets the update history of assets that overlap a time window. - # For IAM_POLICY content, this API outputs history when the asset and its - # attached IAM POLICY both exist. This can create gaps in the output history. - # Otherwise, this API outputs history with asset in both non-delete or - # deleted status. - # If a specified asset does not exist, this API returns an INVALID_ARGUMENT - # error. + # Batch gets the update history of assets that overlap a time window. For + # IAM_POLICY content, this API outputs history when the asset and its attached + # IAM POLICY both exist. This can create gaps in the output history. Otherwise, + # this API outputs history with asset in both non-delete or deleted status. If a + # specified asset does not exist, this API returns an INVALID_ARGUMENT error. # @param [String] parent - # Required. The relative name of the root asset. It can only be an - # organization number (such as "organizations/123"), a project ID (such as - # "projects/my-project-id")", or a project number (such as "projects/12345"). + # Required. The relative name of the root asset. It can only be an organization + # number (such as "organizations/123"), a project ID (such as "projects/my- + # project-id")", or a project number (such as "projects/12345"). # @param [Array, String] asset_names - # A list of the full names of the assets. - # See: https://cloud.google.com/asset-inventory/docs/resource-name-format - # Example: - # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/ - # instance1`. - # The request becomes a no-op if the asset name list is empty, and the max - # size of the asset name list is 100 in one request. + # A list of the full names of the assets. See: https://cloud.google.com/asset- + # inventory/docs/resource-name-format Example: `//compute.googleapis.com/ + # projects/my_project_123/zones/zone1/instances/instance1`. The request becomes + # a no-op if the asset name list is empty, and the max size of the asset name + # list is 100 in one request. # @param [String] content_type # Optional. The content type. # @param [String] read_time_window_end_time @@ -310,21 +301,20 @@ module Google execute_or_queue_command(command, &block) end - # Exports assets with time and resource types to a given Cloud Storage - # location/BigQuery table. For Cloud Storage location destinations, the - # output format is newline-delimited JSON. Each line represents a - # google.cloud.asset.v1.Asset in the JSON format; for BigQuery table - # destinations, the output table stores the fields in asset proto as columns. - # This API implements the google.longrunning.Operation API - # , which allows you to keep track of the export. We recommend intervals of - # at least 2 seconds with exponential retry to poll the export operation - # result. For regular-size resource parent, the export operation usually - # finishes within 5 minutes. + # Exports assets with time and resource types to a given Cloud Storage location/ + # BigQuery table. For Cloud Storage location destinations, the output format is + # newline-delimited JSON. Each line represents a google.cloud.asset.v1.Asset in + # the JSON format; for BigQuery table destinations, the output table stores the + # fields in asset proto as columns. This API implements the google.longrunning. + # Operation API , which allows you to keep track of the export. We recommend + # intervals of at least 2 seconds with exponential retry to poll the export + # operation result. For regular-size resource parent, the export operation + # usually finishes within 5 minutes. # @param [String] parent # Required. The relative name of the root asset. This can only be an - # organization number (such as "organizations/123"), a project ID (such as - # "projects/my-project-id"), or a project number (such as "projects/12345"), - # or a folder number (such as "folders/123"). + # organization number (such as "organizations/123"), a project ID (such as " + # projects/my-project-id"), or a project number (such as "projects/12345"), or a + # folder number (such as "folders/123"). # @param [Google::Apis::CloudassetV1::ExportAssetsRequest] export_assets_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -356,60 +346,47 @@ module Google end # Searches all IAM policies within the specified scope, such as a project, - # folder, or organization. The caller must be granted the - # `cloudasset.assets.searchAllIamPolicies` permission on the desired scope, - # otherwise the request will be rejected. + # folder, or organization. The caller must be granted the `cloudasset.assets. + # searchAllIamPolicies` permission on the desired scope, otherwise the request + # will be rejected. # @param [String] scope # Required. A scope can be a project, a folder, or an organization. The search - # is - # limited to the IAM policies within the `scope`. The caller must be granted - # the - # [`cloudasset.assets.searchAllIamPolicies`](http://cloud.google.com/asset- - # inventory/docs/access-control#required_permissions) - # permission on the desired scope. - # The allowed values are: - # * projects/`PROJECT_ID` (e.g., "projects/foo-bar") - # * projects/`PROJECT_NUMBER` (e.g., "projects/12345678") - # * folders/`FOLDER_NUMBER` (e.g., "folders/1234567") - # * organizations/`ORGANIZATION_NUMBER` (e.g., "organizations/123456") + # is limited to the IAM policies within the `scope`. The caller must be granted + # the [`cloudasset.assets.searchAllIamPolicies`](http://cloud.google.com/asset- + # inventory/docs/access-control#required_permissions) permission on the desired + # scope. The allowed values are: * projects/`PROJECT_ID` (e.g., "projects/foo- + # bar") * projects/`PROJECT_NUMBER` (e.g., "projects/12345678") * folders/` + # FOLDER_NUMBER` (e.g., "folders/1234567") * organizations/`ORGANIZATION_NUMBER` + # (e.g., "organizations/123456") # @param [Fixnum] page_size # Optional. The page size for search result pagination. Page size is capped at - # 500 even - # if a larger value is given. If set to zero, server will pick an appropriate - # default. Returned results may be fewer than requested. When this happens, - # there could be more results as long as `next_page_token` is returned. + # 500 even if a larger value is given. If set to zero, server will pick an + # appropriate default. Returned results may be fewer than requested. When this + # happens, there could be more results as long as `next_page_token` is returned. # @param [String] page_token # Optional. If present, retrieve the next batch of results from the preceding - # call to - # this method. `page_token` must be the value of `next_page_token` from the - # previous response. The values of all other method parameters must be + # call to this method. `page_token` must be the value of `next_page_token` from + # the previous response. The values of all other method parameters must be # identical to those in the previous call. # @param [String] query - # Optional. The query statement. See [how to construct a - # query](https://cloud.google.com/asset-inventory/docs/searching-iam-policies# - # how_to_construct_a_query) - # for more information. If not specified or empty, it will search all the - # IAM policies within the specified `scope`. - # Examples: - # * `policy : "amy@gmail.com"` to find IAM policy bindings that specify user - # "amy@gmail.com". - # * `policy : "roles/compute.admin"` to find IAM policy bindings that specify - # the Compute Admin role. - # * `policy.role.permissions : "storage.buckets.update"` to find IAM policy - # bindings that specify a role containing "storage.buckets.update" - # permission. Note that if callers don't have `iam.roles.get` access to a - # role's included permissions, policy bindings that specify this role will - # be dropped from the search results. - # * `resource : "organizations/123456"` to find IAM policy bindings - # that are set on "organizations/123456". - # * `"Important"` to find IAM policy bindings that contain "Important" as a - # word in any of the searchable fields (except for the included - # permissions). - # * `"*por*"` to find IAM policy bindings which contain "por" as a substring - # in any of the searchable fields (except for the included permissions). - # * `(resource : ("instance1" OR "instance2") AND policy : "amy")` to find - # IAM policy bindings that are set on resources "instance1" or - # "instance2" and also specify user "amy". + # Optional. The query statement. See [how to construct a query](https://cloud. + # google.com/asset-inventory/docs/searching-iam-policies# + # how_to_construct_a_query) for more information. If not specified or empty, it + # will search all the IAM policies within the specified `scope`. Examples: * ` + # policy:amy@gmail.com` to find IAM policy bindings that specify user "amy@gmail. + # com". * `policy:roles/compute.admin` to find IAM policy bindings that specify + # the Compute Admin role. * `policy.role.permissions:storage.buckets.update` to + # find IAM policy bindings that specify a role containing "storage.buckets. + # update" permission. Note that if callers don't have `iam.roles.get` access to + # a role's included permissions, policy bindings that specify this role will be + # dropped from the search results. * `resource:organizations/123456` to find IAM + # policy bindings that are set on "organizations/123456". * `Important` to find + # IAM policy bindings that contain "Important" as a word in any of the + # searchable fields (except for the included permissions). * `*por*` to find IAM + # policy bindings that contain "por" as a substring in any of the searchable + # fields (except for the included permissions). * `resource:(instance1 OR + # instance2) policy:amy` to find IAM policy bindings that are set on resources " + # instance1" or "instance2" and also specify user "amy". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -441,83 +418,64 @@ module Google end # Searches all Cloud resources within the specified scope, such as a project, - # folder, or organization. The caller must be granted the - # `cloudasset.assets.searchAllResources` permission on the desired scope, - # otherwise the request will be rejected. + # folder, or organization. The caller must be granted the `cloudasset.assets. + # searchAllResources` permission on the desired scope, otherwise the request + # will be rejected. # @param [String] scope # Required. A scope can be a project, a folder, or an organization. The search - # is - # limited to the resources within the `scope`. The caller must be granted the + # is limited to the resources within the `scope`. The caller must be granted the # [`cloudasset.assets.searchAllResources`](http://cloud.google.com/asset- - # inventory/docs/access-control#required_permissions) - # permission on the desired scope. - # The allowed values are: - # * projects/`PROJECT_ID` (e.g., "projects/foo-bar") - # * projects/`PROJECT_NUMBER` (e.g., "projects/12345678") - # * folders/`FOLDER_NUMBER` (e.g., "folders/1234567") - # * organizations/`ORGANIZATION_NUMBER` (e.g., "organizations/123456") + # inventory/docs/access-control#required_permissions) permission on the desired + # scope. The allowed values are: * projects/`PROJECT_ID` (e.g., "projects/foo- + # bar") * projects/`PROJECT_NUMBER` (e.g., "projects/12345678") * folders/` + # FOLDER_NUMBER` (e.g., "folders/1234567") * organizations/`ORGANIZATION_NUMBER` + # (e.g., "organizations/123456") # @param [Array, String] asset_types # Optional. A list of asset types that this request searches for. If empty, it - # will - # search all the [searchable asset - # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types# - # searchable_asset_types). + # will search all the [searchable asset types](https://cloud.google.com/asset- + # inventory/docs/supported-asset-types#searchable_asset_types). # @param [String] order_by # Optional. A comma separated list of fields specifying the sorting order of the - # results. The default order is ascending. Add " DESC" after the field name - # to indicate descending order. Redundant space characters are ignored. - # Example: "location DESC, name". Only string fields in the response are - # sortable, including `name`, `displayName`, `description`, `location`. All - # the other fields such as repeated fields (e.g., `networkTags`), map - # fields (e.g., `labels`) and struct fields (e.g., `additionalAttributes`) - # are not supported. + # results. The default order is ascending. Add " DESC" after the field name to + # indicate descending order. Redundant space characters are ignored. Example: " + # location DESC, name". Only string fields in the response are sortable, + # including `name`, `displayName`, `description`, `location`. All the other + # fields such as repeated fields (e.g., `networkTags`), map fields (e.g., ` + # labels`) and struct fields (e.g., `additionalAttributes`) are not supported. # @param [Fixnum] page_size # Optional. The page size for search result pagination. Page size is capped at - # 500 even - # if a larger value is given. If set to zero, server will pick an appropriate - # default. Returned results may be fewer than requested. When this happens, - # there could be more results as long as `next_page_token` is returned. + # 500 even if a larger value is given. If set to zero, server will pick an + # appropriate default. Returned results may be fewer than requested. When this + # happens, there could be more results as long as `next_page_token` is returned. # @param [String] page_token # Optional. If present, then retrieve the next batch of results from the - # preceding call - # to this method. `page_token` must be the value of `next_page_token` from - # the previous response. The values of all other method parameters, must be - # identical to those in the previous call. + # preceding call to this method. `page_token` must be the value of ` + # next_page_token` from the previous response. The values of all other method + # parameters, must be identical to those in the previous call. # @param [String] query - # Optional. The query statement. See [how to construct a - # query](http://cloud.google.com/asset-inventory/docs/searching-resources# - # how_to_construct_a_query) + # Optional. The query statement. See [how to construct a query](http://cloud. + # google.com/asset-inventory/docs/searching-resources#how_to_construct_a_query) # for more information. If not specified or empty, it will search all the - # resources within the specified `scope`. Note that the query string is - # compared against each Cloud IAM policy binding, including its members, - # roles, and Cloud IAM conditions. The returned Cloud IAM policies will only - # contain the bindings that match your query. To learn more about the IAM - # policy structure, see [IAM policy - # doc](https://cloud.google.com/iam/docs/policies#structure). - # Examples: - # * `name : "Important"` to find Cloud resources whose name contains - # "Important" as a word. - # * `displayName : "Impor*"` to find Cloud resources whose display name - # contains "Impor" as a prefix. - # * `description : "*por*"` to find Cloud resources whose description - # contains "por" as a substring. - # * `location : "us-west*"` to find Cloud resources whose location is - # prefixed with "us-west". - # * `labels : "prod"` to find Cloud resources whose labels contain "prod" as - # a key or value. - # * `labels.env : "prod"` to find Cloud resources which have a label "env" - # and its value is "prod". - # * `labels.env : *` to find Cloud resources which have a label "env". - # * `"Important"` to find Cloud resources which contain "Important" as a word - # in any of the searchable fields. - # * `"Impor*"` to find Cloud resources which contain "Impor" as a prefix - # in any of the searchable fields. - # * `"*por*"` to find Cloud resources which contain "por" as a substring in - # any of the searchable fields. - # * `("Important" AND location : ("us-west1" OR "global"))` to find Cloud - # resources which contain "Important" as a word in any of the searchable - # fields and are also located in the "us-west1" region or the "global" - # location. + # resources within the specified `scope`. Note that the query string is compared + # against each Cloud IAM policy binding, including its members, roles, and Cloud + # IAM conditions. The returned Cloud IAM policies will only contain the bindings + # that match your query. To learn more about the IAM policy structure, see [IAM + # policy doc](https://cloud.google.com/iam/docs/policies#structure). Examples: * + # `name:Important` to find Cloud resources whose name contains "Important" as a + # word. * `displayName:Impor*` to find Cloud resources whose display name + # contains "Impor" as a prefix. * `description:*por*` to find Cloud resources + # whose description contains "por" as a substring. * `location:us-west*` to find + # Cloud resources whose location is prefixed with "us-west". * `labels:prod` to + # find Cloud resources whose labels contain "prod" as a key or value. * `labels. + # env:prod` to find Cloud resources that have a label "env" and its value is " + # prod". * `labels.env:*` to find Cloud resources that have a label "env". * ` + # Important` to find Cloud resources that contain "Important" as a word in any + # of the searchable fields. * `Impor*` to find Cloud resources that contain " + # Impor" as a prefix in any of the searchable fields. * `*por*` to find Cloud + # resources that contain "por" as a substring in any of the searchable fields. * + # `Important location:(us-west1 OR global)` to find Cloud resources that contain + # "Important" as a word in any of the searchable fields and are also located in + # the "us-west1" region or the "global" location. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/cloudasset_v1beta1.rb b/generated/google/apis/cloudasset_v1beta1.rb index e3bf070a1..a789e0827 100644 --- a/generated/google/apis/cloudasset_v1beta1.rb +++ b/generated/google/apis/cloudasset_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/asset-inventory/docs/quickstart module CloudassetV1beta1 VERSION = 'V1beta1' - REVISION = '20200731' + REVISION = '20200810' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudasset_v1beta1/classes.rb b/generated/google/apis/cloudasset_v1beta1/classes.rb index cf04eaf47..1264334e3 100644 --- a/generated/google/apis/cloudasset_v1beta1/classes.rb +++ b/generated/google/apis/cloudasset_v1beta1/classes.rb @@ -22,15 +22,12 @@ module Google module Apis module CloudassetV1beta1 - # An asset in Google Cloud. An asset can be any resource in the Google Cloud - # [resource - # hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform- - # resource-hierarchy), - # a resource outside the Google Cloud resource hierarchy (such as Google - # Kubernetes Engine clusters and objects), or a policy (e.g. Cloud IAM policy). - # See [Supported asset - # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - # for more information. + # An asset in Google Cloud. An asset can be any resource in the Google Cloud [ + # resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud- + # platform-resource-hierarchy), a resource outside the Google Cloud resource + # hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy + # (e.g. Cloud IAM policy). See [Supported asset types](https://cloud.google.com/ + # asset-inventory/docs/supported-asset-types) for more information. class Asset include Google::Apis::Core::Hashable @@ -42,102 +39,64 @@ module Google attr_accessor :access_level # `AccessPolicy` is a container for `AccessLevels` (which define the necessary - # attributes to use Google Cloud services) and `ServicePerimeters` (which - # define regions of services able to freely pass data within a perimeter). An - # access policy is globally visible within an organization, and the - # restrictions it specifies apply to all projects within an organization. + # attributes to use Google Cloud services) and `ServicePerimeters` (which define + # regions of services able to freely pass data within a perimeter). An access + # policy is globally visible within an organization, and the restrictions it + # specifies apply to all projects within an organization. # Corresponds to the JSON property `accessPolicy` # @return [Google::Apis::CloudassetV1beta1::GoogleIdentityAccesscontextmanagerV1AccessPolicy] attr_accessor :access_policy - # The type of the asset. Example: `compute.googleapis.com/Disk` - # See [Supported asset - # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - # for more information. + # The type of the asset. Example: `compute.googleapis.com/Disk` See [Supported + # asset types](https://cloud.google.com/asset-inventory/docs/supported-asset- + # types) for more information. # Corresponds to the JSON property `assetType` # @return [String] attr_accessor :asset_type # 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 `iamPolicy` # @return [Google::Apis::CloudassetV1beta1::Policy] attr_accessor :iam_policy - # The full name of the asset. Example: - # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/ - # instance1` - # See [Resource - # names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - # for more information. + # The full name of the asset. Example: `//compute.googleapis.com/projects/ + # my_project_123/zones/zone1/instances/instance1` See [Resource names](https:// + # cloud.google.com/apis/design/resource_names#full_resource_name) for more + # information. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # A representation of an [organization - # policy](https://cloud.google.com/resource-manager/docs/organization-policy/ - # overview#organization_policy). - # There can be more than one organization policy with different constraints - # set on a given resource. + # A representation of an [organization policy](https://cloud.google.com/resource- + # manager/docs/organization-policy/overview#organization_policy). There can be + # more than one organization policy with different constraints set on a given + # resource. # Corresponds to the JSON property `orgPolicy` # @return [Array] attr_accessor :org_policy @@ -148,15 +107,14 @@ module Google attr_accessor :resource # `ServicePerimeter` describes a set of Google Cloud resources which can freely - # import and export data amongst themselves, but not export outside of the - # `ServicePerimeter`. If a request with a source within this `ServicePerimeter` + # import and export data amongst themselves, but not export outside of the ` + # ServicePerimeter`. If a request with a source within this `ServicePerimeter` # has a target outside of the `ServicePerimeter`, the request will be blocked. # Otherwise the request is allowed. There are two types of Service Perimeter - - # Regular and Bridge. Regular Service Perimeters cannot overlap, a single - # Google Cloud project can only belong to a single regular Service Perimeter. - # Service Perimeter Bridges can contain only Google Cloud projects as members, - # a single Google Cloud project may belong to multiple Service Perimeter - # Bridges. + # Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google + # Cloud project can only belong to a single regular Service Perimeter. Service + # Perimeter Bridges can contain only Google Cloud projects as members, a single + # Google Cloud project may belong to multiple Service Perimeter Bridges. # Corresponds to the JSON property `servicePerimeter` # @return [Google::Apis::CloudassetV1beta1::GoogleIdentityAccesscontextmanagerV1ServicePerimeter] attr_accessor :service_perimeter @@ -178,53 +136,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 @@ -233,9 +159,9 @@ module Google # @return [Array] 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 @@ -251,28 +177,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] @@ -317,69 +230,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::CloudassetV1beta1::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] 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 @@ -400,12 +301,10 @@ module Google class ExportAssetsRequest include Google::Apis::Core::Hashable - # A list of asset types of which to take a snapshot for. For example: - # "google.compute.Disk". If specified, only matching assets will be returned. - # See [Introduction to Cloud Asset - # Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset- - # inventory/overview) - # for all supported asset types. + # A list of asset types of which to take a snapshot for. For example: "google. + # compute.Disk". If specified, only matching assets will be returned. See [ + # Introduction to Cloud Asset Inventory](https://cloud.google.com/resource- + # manager/docs/cloud-asset-inventory/overview) for all supported asset types. # Corresponds to the JSON property `assetTypes` # @return [Array] attr_accessor :asset_types @@ -422,10 +321,10 @@ module Google attr_accessor :output_config # Timestamp to take an asset snapshot. This can only be set to a timestamp - # between 2018-10-02 UTC (inclusive) and the current time. If not specified, - # the current time will be used. Due to delays in resource data collection - # and indexing, there is a volatile window during which running the same - # query may get different results. + # between 2018-10-02 UTC (inclusive) and the current time. If not specified, the + # current time will be used. Due to delays in resource data collection and + # indexing, there is a volatile window during which running the same query may + # get different results. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -443,52 +342,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 @@ -510,23 +400,21 @@ module Google class GcsDestination include Google::Apis::Core::Hashable - # The uri of the Cloud Storage object. It's the same uri that is used by - # gsutil. For example: "gs://bucket_name/object_name". See [Viewing and - # Editing Object - # Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) - # for more information. + # The uri of the Cloud Storage object. It's the same uri that is used by gsutil. + # For example: "gs://bucket_name/object_name". See [Viewing and Editing Object + # Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for + # more information. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri - # The uri prefix of all generated Cloud Storage objects. For example: - # "gs://bucket_name/object_name_prefix". Each object uri is in format: - # "gs://bucket_name/object_name_prefix// and only - # contains assets for that type. starts from 0. For example: - # "gs://bucket_name/object_name_prefix/google.compute.disk/0" is the first - # shard of output objects containing all google.compute.disk assets. - # An INVALID_ARGUMENT error will be returned if file with the same name - # "gs://bucket_name/object_name_prefix" already exists. + # The uri prefix of all generated Cloud Storage objects. For example: "gs:// + # bucket_name/object_name_prefix". Each object uri is in format: "gs:// + # bucket_name/object_name_prefix// and only contains assets for that type. + # starts from 0. For example: "gs://bucket_name/object_name_prefix/google. + # compute.disk/0" is the first shard of output objects containing all google. + # compute.disk assets. An INVALID_ARGUMENT error will be returned if file with + # the same name "gs://bucket_name/object_name_prefix" already exists. # Corresponds to the JSON property `uriPrefix` # @return [String] attr_accessor :uri_prefix @@ -547,45 +435,29 @@ module Google class GoogleCloudOrgpolicyV1BooleanPolicy include Google::Apis::Core::Hashable - # If `true`, then the `Policy` is enforced. If `false`, then any - # configuration is acceptable. - # Suppose you have a `Constraint` - # `constraints/compute.disableSerialPortAccess` with `constraint_default` - # set to `ALLOW`. A `Policy` for that `Constraint` exhibits the following - # behavior: - # - If the `Policy` at this resource has enforced set to `false`, serial - # port connection attempts will be allowed. - # - If the `Policy` at this resource has enforced set to `true`, serial - # port connection attempts will be refused. - # - If the `Policy` at this resource is `RestoreDefault`, serial port - # connection attempts will be allowed. - # - If no `Policy` is set at this resource or anywhere higher in the - # resource hierarchy, serial port connection attempts will be allowed. - # - If no `Policy` is set at this resource, but one exists higher in the - # resource hierarchy, the behavior is as if the`Policy` were set at - # this resource. - # The following examples demonstrate the different possible layerings: - # Example 1 (nearest `Constraint` wins): - # `organizations/foo` has a `Policy` with: - # `enforced: false` - # `projects/bar` has no `Policy` set. - # The constraint at `projects/bar` and `organizations/foo` will not be - # enforced. - # Example 2 (enforcement gets replaced): - # `organizations/foo` has a `Policy` with: - # `enforced: false` - # `projects/bar` has a `Policy` with: - # `enforced: true` - # The constraint at `organizations/foo` is not enforced. - # The constraint at `projects/bar` is enforced. - # Example 3 (RestoreDefault): - # `organizations/foo` has a `Policy` with: - # `enforced: true` - # `projects/bar` has a `Policy` with: - # `RestoreDefault: ``` - # The constraint at `organizations/foo` is enforced. - # The constraint at `projects/bar` is not enforced, because - # `constraint_default` for the `Constraint` is `ALLOW`. + # If `true`, then the `Policy` is enforced. If `false`, then any configuration + # is acceptable. Suppose you have a `Constraint` `constraints/compute. + # disableSerialPortAccess` with `constraint_default` set to `ALLOW`. A `Policy` + # for that `Constraint` exhibits the following behavior: - If the `Policy` at + # this resource has enforced set to `false`, serial port connection attempts + # will be allowed. - If the `Policy` at this resource has enforced set to `true`, + # serial port connection attempts will be refused. - If the `Policy` at this + # resource is `RestoreDefault`, serial port connection attempts will be allowed. + # - If no `Policy` is set at this resource or anywhere higher in the resource + # hierarchy, serial port connection attempts will be allowed. - If no `Policy` + # is set at this resource, but one exists higher in the resource hierarchy, the + # behavior is as if the`Policy` were set at this resource. The following + # examples demonstrate the different possible layerings: Example 1 (nearest ` + # Constraint` wins): `organizations/foo` has a `Policy` with: `enforced: false` ` + # projects/bar` has no `Policy` set. The constraint at `projects/bar` and ` + # organizations/foo` will not be enforced. Example 2 (enforcement gets replaced): + # `organizations/foo` has a `Policy` with: `enforced: false` `projects/bar` has + # a `Policy` with: `enforced: true` The constraint at `organizations/foo` is not + # enforced. The constraint at `projects/bar` is enforced. Example 3 ( + # RestoreDefault): `organizations/foo` has a `Policy` with: `enforced: true` ` + # projects/bar` has a `Policy` with: `RestoreDefault: ``` The constraint at ` + # organizations/foo` is enforced. The constraint at `projects/bar` is not + # enforced, because `constraint_default` for the `Constraint` is `ALLOW`. # Corresponds to the JSON property `enforced` # @return [Boolean] attr_accessor :enforced @@ -601,26 +473,22 @@ module Google end end - # Used in `policy_type` to specify how `list_policy` behaves at this - # resource. - # `ListPolicy` can define specific values and subtrees of Cloud Resource - # Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that - # are allowed or denied by setting the `allowed_values` and `denied_values` - # fields. This is achieved by using the `under:` and optional `is:` prefixes. - # The `under:` prefix is used to denote resource subtree values. - # The `is:` prefix is used to denote specific values, and is required only - # if the value contains a ":". Values prefixed with "is:" are treated the - # same as values with no prefix. - # Ancestry subtrees must be in one of the following formats: - # - "projects/", e.g. "projects/tokyo-rain-123" - # - "folders/", e.g. "folders/1234" - # - "organizations/", e.g. "organizations/1234" - # The `supports_under` field of the associated `Constraint` defines whether - # ancestry prefixes can be used. You can set `allowed_values` and - # `denied_values` in the same `Policy` if `all_values` is - # `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all - # values. If `all_values` is set to either `ALLOW` or `DENY`, - # `allowed_values` and `denied_values` must be unset. + # Used in `policy_type` to specify how `list_policy` behaves at this resource. ` + # ListPolicy` can define specific values and subtrees of Cloud Resource Manager + # resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed + # or denied by setting the `allowed_values` and `denied_values` fields. This is + # achieved by using the `under:` and optional `is:` prefixes. The `under:` + # prefix is used to denote resource subtree values. The `is:` prefix is used to + # denote specific values, and is required only if the value contains a ":". + # Values prefixed with "is:" are treated the same as values with no prefix. + # Ancestry subtrees must be in one of the following formats: - "projects/", e.g. + # "projects/tokyo-rain-123" - "folders/", e.g. "folders/1234" - "organizations/", + # e.g. "organizations/1234" The `supports_under` field of the associated ` + # Constraint` defines whether ancestry prefixes can be used. You can set ` + # allowed_values` and `denied_values` in the same `Policy` if `all_values` is ` + # ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all + # values. If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values` + # and `denied_values` must be unset. class GoogleCloudOrgpolicyV1ListPolicy include Google::Apis::Core::Hashable @@ -629,112 +497,83 @@ module Google # @return [String] attr_accessor :all_values - # List of values allowed at this resource. Can only be set if `all_values` - # is set to `ALL_VALUES_UNSPECIFIED`. + # List of values allowed at this resource. Can only be set if `all_values` is + # set to `ALL_VALUES_UNSPECIFIED`. # Corresponds to the JSON property `allowedValues` # @return [Array] attr_accessor :allowed_values - # List of values denied at this resource. Can only be set if `all_values` - # is set to `ALL_VALUES_UNSPECIFIED`. + # List of values denied at this resource. Can only be set if `all_values` is set + # to `ALL_VALUES_UNSPECIFIED`. # Corresponds to the JSON property `deniedValues` # @return [Array] attr_accessor :denied_values - # Determines the inheritance behavior for this `Policy`. - # By default, a `ListPolicy` set at a resource supersedes any `Policy` set - # anywhere up the resource hierarchy. However, if `inherit_from_parent` is - # set to `true`, then the values from the effective `Policy` of the parent - # resource are inherited, meaning the values set in this `Policy` are - # added to the values inherited up the hierarchy. - # Setting `Policy` hierarchies that inherit both allowed values and denied - # values isn't recommended in most circumstances to keep the configuration - # simple and understandable. However, it is possible to set a `Policy` with - # `allowed_values` set that inherits a `Policy` with `denied_values` set. - # In this case, the values that are allowed must be in `allowed_values` and - # not present in `denied_values`. - # For example, suppose you have a `Constraint` - # `constraints/serviceuser.services`, which has a `constraint_type` of - # `list_constraint`, and with `constraint_default` set to `ALLOW`. - # Suppose that at the Organization level, a `Policy` is applied that - # restricts the allowed API activations to ``E1`, `E2``. Then, if a - # `Policy` is applied to a project below the Organization that has - # `inherit_from_parent` set to `false` and field all_values set to DENY, - # then an attempt to activate any API will be denied. - # The following examples demonstrate different possible layerings for - # `projects/bar` parented by `organizations/foo`: - # Example 1 (no inherited values): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values:"E2"` - # `projects/bar` has `inherit_from_parent` `false` and values: - # `allowed_values: "E3" allowed_values: "E4"` - # The accepted values at `organizations/foo` are `E1`, `E2`. - # The accepted values at `projects/bar` are `E3`, and `E4`. - # Example 2 (inherited values): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values:"E2"` - # `projects/bar` has a `Policy` with values: - # `value: "E3" value: "E4" inherit_from_parent: true` - # The accepted values at `organizations/foo` are `E1`, `E2`. - # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`. - # Example 3 (inheriting both allowed and denied values): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values: "E2"` - # `projects/bar` has a `Policy` with: - # `denied_values: "E1"` - # The accepted values at `organizations/foo` are `E1`, `E2`. - # The value accepted at `projects/bar` is `E2`. - # Example 4 (RestoreDefault): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values:"E2"` - # `projects/bar` has a `Policy` with values: - # `RestoreDefault: ``` - # The accepted values at `organizations/foo` are `E1`, `E2`. - # The accepted values at `projects/bar` are either all or none depending on - # the value of `constraint_default` (if `ALLOW`, all; if - # `DENY`, none). - # Example 5 (no policy inherits parent policy): - # `organizations/foo` has no `Policy` set. - # `projects/bar` has no `Policy` set. - # The accepted values at both levels are either all or none depending on - # the value of `constraint_default` (if `ALLOW`, all; if - # `DENY`, none). - # Example 6 (ListConstraint allowing all): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values: "E2"` - # `projects/bar` has a `Policy` with: - # `all: ALLOW` - # The accepted values at `organizations/foo` are `E1`, E2`. - # Any value is accepted at `projects/bar`. - # Example 7 (ListConstraint allowing none): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values: "E2"` - # `projects/bar` has a `Policy` with: - # `all: DENY` - # The accepted values at `organizations/foo` are `E1`, E2`. - # No value is accepted at `projects/bar`. - # Example 10 (allowed and denied subtrees of Resource Manager hierarchy): - # Given the following resource hierarchy - # O1->`F1, F2`; F1->`P1`; F2->`P2, P3`, - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "under:organizations/O1"` - # `projects/bar` has a `Policy` with: - # `allowed_values: "under:projects/P3"` - # `denied_values: "under:folders/F2"` - # The accepted values at `organizations/foo` are `organizations/O1`, - # `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`, - # `projects/P3`. - # The accepted values at `projects/bar` are `organizations/O1`, - # `folders/F1`, `projects/P1`. + # Determines the inheritance behavior for this `Policy`. By default, a ` + # ListPolicy` set at a resource supersedes any `Policy` set anywhere up the + # resource hierarchy. However, if `inherit_from_parent` is set to `true`, then + # the values from the effective `Policy` of the parent resource are inherited, + # meaning the values set in this `Policy` are added to the values inherited up + # the hierarchy. Setting `Policy` hierarchies that inherit both allowed values + # and denied values isn't recommended in most circumstances to keep the + # configuration simple and understandable. However, it is possible to set a ` + # Policy` with `allowed_values` set that inherits a `Policy` with `denied_values` + # set. In this case, the values that are allowed must be in `allowed_values` + # and not present in `denied_values`. For example, suppose you have a ` + # Constraint` `constraints/serviceuser.services`, which has a `constraint_type` + # of `list_constraint`, and with `constraint_default` set to `ALLOW`. Suppose + # that at the Organization level, a `Policy` is applied that restricts the + # allowed API activations to ``E1`, `E2``. Then, if a `Policy` is applied to a + # project below the Organization that has `inherit_from_parent` set to `false` + # and field all_values set to DENY, then an attempt to activate any API will be + # denied. The following examples demonstrate different possible layerings for ` + # projects/bar` parented by `organizations/foo`: Example 1 (no inherited values): + # `organizations/foo` has a `Policy` with values: `allowed_values: "E1" + # allowed_values:"E2"` `projects/bar` has `inherit_from_parent` `false` and + # values: `allowed_values: "E3" allowed_values: "E4"` The accepted values at ` + # organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are ` + # E3`, and `E4`. Example 2 (inherited values): `organizations/foo` has a `Policy` + # with values: `allowed_values: "E1" allowed_values:"E2"` `projects/bar` has a ` + # Policy` with values: `value: "E3" value: "E4" inherit_from_parent: true` The + # accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at ` + # projects/bar` are `E1`, `E2`, `E3`, and `E4`. Example 3 (inheriting both + # allowed and denied values): `organizations/foo` has a `Policy` with values: ` + # allowed_values: "E1" allowed_values: "E2"` `projects/bar` has a `Policy` with: + # `denied_values: "E1"` The accepted values at `organizations/foo` are `E1`, `E2` + # . The value accepted at `projects/bar` is `E2`. Example 4 (RestoreDefault): ` + # organizations/foo` has a `Policy` with values: `allowed_values: "E1" + # allowed_values:"E2"` `projects/bar` has a `Policy` with values: ` + # RestoreDefault: ``` The accepted values at `organizations/foo` are `E1`, `E2`. + # The accepted values at `projects/bar` are either all or none depending on the + # value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 5 ( + # no policy inherits parent policy): `organizations/foo` has no `Policy` set. ` + # projects/bar` has no `Policy` set. The accepted values at both levels are + # either all or none depending on the value of `constraint_default` (if `ALLOW`, + # all; if `DENY`, none). Example 6 (ListConstraint allowing all): `organizations/ + # foo` has a `Policy` with values: `allowed_values: "E1" allowed_values: "E2"` ` + # projects/bar` has a `Policy` with: `all: ALLOW` The accepted values at ` + # organizations/foo` are `E1`, E2`. Any value is accepted at `projects/bar`. + # Example 7 (ListConstraint allowing none): `organizations/foo` has a `Policy` + # with values: `allowed_values: "E1" allowed_values: "E2"` `projects/bar` has a ` + # Policy` with: `all: DENY` The accepted values at `organizations/foo` are `E1`, + # E2`. No value is accepted at `projects/bar`. Example 10 (allowed and denied + # subtrees of Resource Manager hierarchy): Given the following resource + # hierarchy O1->`F1, F2`; F1->`P1`; F2->`P2, P3`, `organizations/foo` has a ` + # Policy` with values: `allowed_values: "under:organizations/O1"` `projects/bar` + # has a `Policy` with: `allowed_values: "under:projects/P3"` `denied_values: " + # under:folders/F2"` The accepted values at `organizations/foo` are ` + # organizations/O1`, `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`, ` + # projects/P3`. The accepted values at `projects/bar` are `organizations/O1`, ` + # folders/F1`, `projects/P1`. # Corresponds to the JSON property `inheritFromParent` # @return [Boolean] attr_accessor :inherit_from_parent alias_method :inherit_from_parent?, :inherit_from_parent - # Optional. The Google Cloud Console will try to default to a configuration - # that matches the value specified in this `Policy`. If `suggested_value` - # is not set, it will inherit the value specified higher in the hierarchy, - # unless `inherit_from_parent` is `false`. + # Optional. The Google Cloud Console will try to default to a configuration that + # matches the value specified in this `Policy`. If `suggested_value` is not set, + # it will inherit the value specified higher in the hierarchy, unless ` + # inherit_from_parent` is `false`. # Corresponds to the JSON property `suggestedValue` # @return [String] attr_accessor :suggested_value @@ -764,76 +603,65 @@ module Google # @return [Google::Apis::CloudassetV1beta1::GoogleCloudOrgpolicyV1BooleanPolicy] attr_accessor :boolean_policy - # The name of the `Constraint` the `Policy` is configuring, for example, - # `constraints/serviceuser.services`. - # A [list of available - # constraints](/resource-manager/docs/organization-policy/org-policy-constraints) - # is available. + # The name of the `Constraint` the `Policy` is configuring, for example, ` + # constraints/serviceuser.services`. A [list of available constraints](/resource- + # manager/docs/organization-policy/org-policy-constraints) is available. # Immutable after creation. # Corresponds to the JSON property `constraint` # @return [String] attr_accessor :constraint # An opaque tag indicating the current version of the `Policy`, used for - # concurrency control. - # When the `Policy` is returned from either a `GetPolicy` or a - # `ListOrgPolicy` request, this `etag` indicates the version of the current - # `Policy` to use when executing a read-modify-write loop. - # When the `Policy` is returned from a `GetEffectivePolicy` request, the - # `etag` will be unset. - # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value - # that was returned from a `GetOrgPolicy` request as part of a - # read-modify-write loop for concurrency control. Not setting the `etag`in a - # `SetOrgPolicy` request will result in an unconditional write of the - # `Policy`. + # concurrency control. When the `Policy` is returned from either a `GetPolicy` + # or a `ListOrgPolicy` request, this `etag` indicates the version of the current + # `Policy` to use when executing a read-modify-write loop. When the `Policy` is + # returned from a `GetEffectivePolicy` request, the `etag` will be unset. When + # the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value that was + # returned from a `GetOrgPolicy` request as part of a read-modify-write loop for + # concurrency control. Not setting the `etag`in a `SetOrgPolicy` request will + # result in an unconditional write of the `Policy`. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag - # Used in `policy_type` to specify how `list_policy` behaves at this - # resource. - # `ListPolicy` can define specific values and subtrees of Cloud Resource - # Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that - # are allowed or denied by setting the `allowed_values` and `denied_values` - # fields. This is achieved by using the `under:` and optional `is:` prefixes. - # The `under:` prefix is used to denote resource subtree values. - # The `is:` prefix is used to denote specific values, and is required only - # if the value contains a ":". Values prefixed with "is:" are treated the - # same as values with no prefix. - # Ancestry subtrees must be in one of the following formats: - # - "projects/", e.g. "projects/tokyo-rain-123" - # - "folders/", e.g. "folders/1234" - # - "organizations/", e.g. "organizations/1234" - # The `supports_under` field of the associated `Constraint` defines whether - # ancestry prefixes can be used. You can set `allowed_values` and - # `denied_values` in the same `Policy` if `all_values` is - # `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all - # values. If `all_values` is set to either `ALLOW` or `DENY`, - # `allowed_values` and `denied_values` must be unset. + # Used in `policy_type` to specify how `list_policy` behaves at this resource. ` + # ListPolicy` can define specific values and subtrees of Cloud Resource Manager + # resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed + # or denied by setting the `allowed_values` and `denied_values` fields. This is + # achieved by using the `under:` and optional `is:` prefixes. The `under:` + # prefix is used to denote resource subtree values. The `is:` prefix is used to + # denote specific values, and is required only if the value contains a ":". + # Values prefixed with "is:" are treated the same as values with no prefix. + # Ancestry subtrees must be in one of the following formats: - "projects/", e.g. + # "projects/tokyo-rain-123" - "folders/", e.g. "folders/1234" - "organizations/", + # e.g. "organizations/1234" The `supports_under` field of the associated ` + # Constraint` defines whether ancestry prefixes can be used. You can set ` + # allowed_values` and `denied_values` in the same `Policy` if `all_values` is ` + # ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all + # values. If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values` + # and `denied_values` must be unset. # Corresponds to the JSON property `listPolicy` # @return [Google::Apis::CloudassetV1beta1::GoogleCloudOrgpolicyV1ListPolicy] attr_accessor :list_policy - # Ignores policies set above this resource and restores the - # `constraint_default` enforcement behavior of the specific `Constraint` at - # this resource. - # Suppose that `constraint_default` is set to `ALLOW` for the - # `Constraint` `constraints/serviceuser.services`. Suppose that organization - # foo.com sets a `Policy` at their Organization resource node that restricts - # the allowed service activations to deny all service activations. They - # could then set a `Policy` with the `policy_type` `restore_default` on - # several experimental projects, restoring the `constraint_default` - # enforcement of the `Constraint` for only those projects, allowing those - # projects to have all services activated. + # Ignores policies set above this resource and restores the `constraint_default` + # enforcement behavior of the specific `Constraint` at this resource. Suppose + # that `constraint_default` is set to `ALLOW` for the `Constraint` `constraints/ + # serviceuser.services`. Suppose that organization foo.com sets a `Policy` at + # their Organization resource node that restricts the allowed service + # activations to deny all service activations. They could then set a `Policy` + # with the `policy_type` `restore_default` on several experimental projects, + # restoring the `constraint_default` enforcement of the `Constraint` for only + # those projects, allowing those projects to have all services activated. # Corresponds to the JSON property `restoreDefault` # @return [Google::Apis::CloudassetV1beta1::GoogleCloudOrgpolicyV1RestoreDefault] attr_accessor :restore_default - # The time stamp the `Policy` was previously updated. This is set by the - # server, not specified by the caller, and represents the last time a call to - # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will - # be ignored. + # The time stamp the `Policy` was previously updated. This is set by the server, + # not specified by the caller, and represents the last time a call to ` + # SetOrgPolicy` was made for that `Policy`. Any value set by the client will be + # ignored. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -859,17 +687,15 @@ module Google end end - # Ignores policies set above this resource and restores the - # `constraint_default` enforcement behavior of the specific `Constraint` at - # this resource. - # Suppose that `constraint_default` is set to `ALLOW` for the - # `Constraint` `constraints/serviceuser.services`. Suppose that organization - # foo.com sets a `Policy` at their Organization resource node that restricts - # the allowed service activations to deny all service activations. They - # could then set a `Policy` with the `policy_type` `restore_default` on - # several experimental projects, restoring the `constraint_default` - # enforcement of the `Constraint` for only those projects, allowing those - # projects to have all services activated. + # Ignores policies set above this resource and restores the `constraint_default` + # enforcement behavior of the specific `Constraint` at this resource. Suppose + # that `constraint_default` is set to `ALLOW` for the `Constraint` `constraints/ + # serviceuser.services`. Suppose that organization foo.com sets a `Policy` at + # their Organization resource node that restricts the allowed service + # activations to deny all service activations. They could then set a `Policy` + # with the `policy_type` `restore_default` on several experimental projects, + # restoring the `constraint_default` enforcement of the `Constraint` for only + # those projects, allowing those projects to have all services activated. class GoogleCloudOrgpolicyV1RestoreDefault include Google::Apis::Core::Hashable @@ -894,8 +720,8 @@ module Google attr_accessor :basic # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language - # to represent the necessary conditions for the level to apply to a request. - # See CEL spec at: https://github.com/google/cel-spec + # to represent the necessary conditions for the level to apply to a request. See + # CEL spec at: https://github.com/google/cel-spec # Corresponds to the JSON property `custom` # @return [Google::Apis::CloudassetV1beta1::GoogleIdentityAccesscontextmanagerV1CustomLevel] attr_accessor :custom @@ -905,10 +731,10 @@ module Google # @return [String] attr_accessor :description - # Required. Resource name for the Access Level. The `short_name` component - # must begin with a letter and only include alphanumeric and '_'. Format: - # `accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length - # of the `short_name` component is 50 characters. + # Required. Resource name for the Access Level. The `short_name` component must + # begin with a letter and only include alphanumeric and '_'. Format: ` + # accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length of + # the `short_name` component is 50 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -933,30 +759,29 @@ module Google end # `AccessPolicy` is a container for `AccessLevels` (which define the necessary - # attributes to use Google Cloud services) and `ServicePerimeters` (which - # define regions of services able to freely pass data within a perimeter). An - # access policy is globally visible within an organization, and the - # restrictions it specifies apply to all projects within an organization. + # attributes to use Google Cloud services) and `ServicePerimeters` (which define + # regions of services able to freely pass data within a perimeter). An access + # policy is globally visible within an organization, and the restrictions it + # specifies apply to all projects within an organization. class GoogleIdentityAccesscontextmanagerV1AccessPolicy include Google::Apis::Core::Hashable - # Output only. An opaque identifier for the current version of the - # `AccessPolicy`. This will always be a strongly validated etag, meaning that - # two Access Polices will be identical if and only if their etags are - # identical. Clients should not expect this to be in any specific format. + # Output only. An opaque identifier for the current version of the `AccessPolicy` + # . This will always be a strongly validated etag, meaning that two Access + # Polices will be identical if and only if their etags are identical. Clients + # should not expect this to be in any specific format. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # Output only. Resource name of the `AccessPolicy`. Format: - # `accessPolicies/`policy_id`` + # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/` + # policy_id`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The parent of this `AccessPolicy` in the Cloud Resource - # Hierarchy. Currently immutable once created. Format: - # `organizations/`organization_id`` + # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. + # Currently immutable once created. Format: `organizations/`organization_id`` # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -984,10 +809,10 @@ module Google include Google::Apis::Core::Hashable # How the `conditions` list should be combined to determine if a request is - # granted this `AccessLevel`. If AND is used, each `Condition` in - # `conditions` must be satisfied for the `AccessLevel` to be applied. If OR - # is used, at least one `Condition` in `conditions` must be satisfied for the - # `AccessLevel` to be applied. Default behavior is AND. + # granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` + # must be satisfied for the `AccessLevel` to be applied. If OR is used, at least + # one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be + # applied. Default behavior is AND. # Corresponds to the JSON property `combiningFunction` # @return [String] attr_accessor :combining_function @@ -1021,54 +846,48 @@ module Google # devices to be granted access levels, it does not do any enforcement on the # device. `DevicePolicy` acts as an AND over all specified fields, and each # repeated field is an OR over its elements. Any unset fields are ignored. For - # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : - # DESKTOP_LINUX, encryption_status: ENCRYPTED`, then the DevicePolicy will be - # true for requests originating from encrypted Linux desktops and encrypted - # Windows desktops. + # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, + # encryption_status: ENCRYPTED`, then the DevicePolicy will be true for requests + # originating from encrypted Linux desktops and encrypted Windows desktops. # Corresponds to the JSON property `devicePolicy` # @return [Google::Apis::CloudassetV1beta1::GoogleIdentityAccesscontextmanagerV1DevicePolicy] attr_accessor :device_policy - # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for - # a CIDR IP address block, the specified IP address portion must be properly + # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a + # CIDR IP address block, the specified IP address portion must be properly # truncated (i.e. all the host bits must be zero) or the input is considered - # malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is - # not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas - # "2001:db8::1/32" is not. The originating IP of a request must be in one of - # the listed subnets in order for this Condition to be true. If empty, all IP - # addresses are allowed. + # malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. + # Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is + # not. The originating IP of a request must be in one of the listed subnets in + # order for this Condition to be true. If empty, all IP addresses are allowed. # Corresponds to the JSON property `ipSubnetworks` # @return [Array] attr_accessor :ip_subnetworks - # The request must be made by one of the provided user or service - # accounts. Groups are not supported. - # Syntax: - # `user:`emailid`` - # `serviceAccount:`emailid`` + # The request must be made by one of the provided user or service accounts. + # Groups are not supported. Syntax: `user:`emailid`` `serviceAccount:`emailid`` # If not specified, a request may come from any user. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members # Whether to negate the Condition. If true, the Condition becomes a NAND over - # its non-empty fields, each field must be false for the Condition overall to - # be satisfied. Defaults to false. + # its non-empty fields, each field must be false for the Condition overall to be + # satisfied. Defaults to false. # Corresponds to the JSON property `negate` # @return [Boolean] attr_accessor :negate alias_method :negate?, :negate - # The request must originate from one of the provided countries/regions. - # Must be valid ISO 3166-1 alpha-2 codes. + # The request must originate from one of the provided countries/regions. Must be + # valid ISO 3166-1 alpha-2 codes. # Corresponds to the JSON property `regions` # @return [Array] attr_accessor :regions # A list of other access levels defined in the same `Policy`, referenced by - # resource name. Referencing an `AccessLevel` which does not exist is an - # error. All access levels listed must be granted for the Condition - # to be true. Example: + # resource name. Referencing an `AccessLevel` which does not exist is an error. + # All access levels listed must be granted for the Condition to be true. Example: # "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` # Corresponds to the JSON property `requiredAccessLevels` # @return [Array] @@ -1090,33 +909,26 @@ module Google end # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language - # to represent the necessary conditions for the level to apply to a request. - # See CEL spec at: https://github.com/google/cel-spec + # to represent the necessary conditions for the level to apply to a request. See + # CEL spec at: https://github.com/google/cel-spec class GoogleIdentityAccesscontextmanagerV1CustomLevel 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 `expr` # @return [Google::Apis::CloudassetV1beta1::Expr] attr_accessor :expr @@ -1136,15 +948,13 @@ module Google # devices to be granted access levels, it does not do any enforcement on the # device. `DevicePolicy` acts as an AND over all specified fields, and each # repeated field is an OR over its elements. Any unset fields are ignored. For - # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : - # DESKTOP_LINUX, encryption_status: ENCRYPTED`, then the DevicePolicy will be - # true for requests originating from encrypted Linux desktops and encrypted - # Windows desktops. + # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, + # encryption_status: ENCRYPTED`, then the DevicePolicy will be true for requests + # originating from encrypted Linux desktops and encrypted Windows desktops. class GoogleIdentityAccesscontextmanagerV1DevicePolicy include Google::Apis::Core::Hashable - # Allowed device management levels, an empty list allows all management - # levels. + # Allowed device management levels, an empty list allows all management levels. # Corresponds to the JSON property `allowedDeviceManagementLevels` # @return [Array] attr_accessor :allowed_device_management_levels @@ -1197,9 +1007,9 @@ module Google class GoogleIdentityAccesscontextmanagerV1OsConstraint include Google::Apis::Core::Hashable - # The minimum allowed OS version. If not set, any version of this OS - # satisfies the constraint. Format: `"major.minor.patch"`. - # Examples: `"10.5.301"`, `"9.2.1"`. + # The minimum allowed OS version. If not set, any version of this OS satisfies + # the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1" + # `. # Corresponds to the JSON property `minimumVersion` # @return [String] attr_accessor :minimum_version @@ -1209,10 +1019,10 @@ module Google # @return [String] attr_accessor :os_type - # Only allows requests from devices with a verified Chrome OS. - # Verifications includes requirements that the device is enterprise-managed, - # conformant to domain policies, and the caller has permission to call - # the API targeted by the request. + # Only allows requests from devices with a verified Chrome OS. Verifications + # includes requirements that the device is enterprise-managed, conformant to + # domain policies, and the caller has permission to call the API targeted by the + # request. # Corresponds to the JSON property `requireVerifiedChromeOs` # @return [Boolean] attr_accessor :require_verified_chrome_os @@ -1231,37 +1041,34 @@ module Google end # `ServicePerimeter` describes a set of Google Cloud resources which can freely - # import and export data amongst themselves, but not export outside of the - # `ServicePerimeter`. If a request with a source within this `ServicePerimeter` + # import and export data amongst themselves, but not export outside of the ` + # ServicePerimeter`. If a request with a source within this `ServicePerimeter` # has a target outside of the `ServicePerimeter`, the request will be blocked. # Otherwise the request is allowed. There are two types of Service Perimeter - - # Regular and Bridge. Regular Service Perimeters cannot overlap, a single - # Google Cloud project can only belong to a single regular Service Perimeter. - # Service Perimeter Bridges can contain only Google Cloud projects as members, - # a single Google Cloud project may belong to multiple Service Perimeter - # Bridges. + # Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google + # Cloud project can only belong to a single regular Service Perimeter. Service + # Perimeter Bridges can contain only Google Cloud projects as members, a single + # Google Cloud project may belong to multiple Service Perimeter Bridges. class GoogleIdentityAccesscontextmanagerV1ServicePerimeter include Google::Apis::Core::Hashable - # Description of the `ServicePerimeter` and its use. Does not affect - # behavior. + # Description of the `ServicePerimeter` and its use. Does not affect behavior. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Required. Resource name for the ServicePerimeter. The `short_name` - # component must begin with a letter and only include alphanumeric and '_'. - # Format: `accessPolicies/`policy_id`/servicePerimeters/`short_name`` + # Required. Resource name for the ServicePerimeter. The `short_name` component + # must begin with a letter and only include alphanumeric and '_'. Format: ` + # accessPolicies/`policy_id`/servicePerimeters/`short_name`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Perimeter type indicator. A single project is - # allowed to be a member of single regular perimeter, but multiple service - # perimeter bridges. A project cannot be a included in a perimeter bridge - # without being included in regular perimeter. For perimeter bridges, - # the restricted service list as well as access level lists must be - # empty. + # Perimeter type indicator. A single project is allowed to be a member of single + # regular perimeter, but multiple service perimeter bridges. A project cannot be + # a included in a perimeter bridge without being included in regular perimeter. + # For perimeter bridges, the restricted service list as well as access level + # lists must be empty. # Corresponds to the JSON property `perimeterType` # @return [String] attr_accessor :perimeter_type @@ -1283,16 +1090,15 @@ module Google # @return [String] attr_accessor :title - # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly - # exists for all Service Perimeters, and that spec is identical to the - # status for those Service Perimeters. When this flag is set, it inhibits the - # generation of the implicit spec, thereby allowing the user to explicitly - # provide a configuration ("spec") to use in a dry-run version of the Service - # Perimeter. This allows the user to test changes to the enforced config - # ("status") without actually enforcing them. This testing is done through - # analyzing the differences between currently enforced and suggested - # restrictions. use_explicit_dry_run_spec must bet set to True if any of the - # fields in the spec are set to non-default values. + # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists + # for all Service Perimeters, and that spec is identical to the status for those + # Service Perimeters. When this flag is set, it inhibits the generation of the + # implicit spec, thereby allowing the user to explicitly provide a configuration + # ("spec") to use in a dry-run version of the Service Perimeter. This allows the + # user to test changes to the enforced config ("status") without actually + # enforcing them. This testing is done through analyzing the differences between + # currently enforced and suggested restrictions. use_explicit_dry_run_spec must + # bet set to True if any of the fields in the spec are set to non-default values. # Corresponds to the JSON property `useExplicitDryRunSpec` # @return [Boolean] attr_accessor :use_explicit_dry_run_spec @@ -1319,14 +1125,13 @@ module Google class GoogleIdentityAccesscontextmanagerV1ServicePerimeterConfig include Google::Apis::Core::Hashable - # A list of `AccessLevel` resource names that allow resources within the - # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed - # must be in the same policy as this `ServicePerimeter`. Referencing a - # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are - # listed, resources within the perimeter can only be accessed via Google - # Cloud calls with request origins within the perimeter. Example: - # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. - # For Service Perimeter Bridge, must be empty. + # A list of `AccessLevel` resource names that allow resources within the ` + # ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must + # be in the same policy as this `ServicePerimeter`. Referencing a nonexistent ` + # AccessLevel` is a syntax error. If no `AccessLevel` names are listed, + # resources within the perimeter can only be accessed via Google Cloud calls + # with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/ + # accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. # Corresponds to the JSON property `accessLevels` # @return [Array] attr_accessor :access_levels @@ -1337,16 +1142,14 @@ module Google # @return [Array] attr_accessor :resources - # Google Cloud services that are subject to the Service Perimeter - # restrictions. For example, if `storage.googleapis.com` is specified, access - # to the storage buckets inside the perimeter must meet the perimeter's - # access restrictions. + # Google Cloud services that are subject to the Service Perimeter restrictions. + # For example, if `storage.googleapis.com` is specified, access to the storage + # buckets inside the perimeter must meet the perimeter's access restrictions. # Corresponds to the JSON property `restrictedServices` # @return [Array] attr_accessor :restricted_services - # Specifies how APIs are allowed to communicate within the Service - # Perimeter. + # Specifies how APIs are allowed to communicate within the Service Perimeter. # Corresponds to the JSON property `vpcAccessibleServices` # @return [Google::Apis::CloudassetV1beta1::GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices] attr_accessor :vpc_accessible_services @@ -1364,21 +1167,20 @@ module Google end end - # Specifies how APIs are allowed to communicate within the Service - # Perimeter. + # Specifies how APIs are allowed to communicate within the Service Perimeter. class GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices include Google::Apis::Core::Hashable - # The list of APIs usable within the Service Perimeter. Must be empty - # unless 'enable_restriction' is True. You can specify a list of individual - # services, as well as include the 'RESTRICTED-SERVICES' value, which - # automatically includes all of the services protected by the perimeter. + # The list of APIs usable within the Service Perimeter. Must be empty unless ' + # enable_restriction' is True. You can specify a list of individual services, as + # well as include the 'RESTRICTED-SERVICES' value, which automatically includes + # all of the services protected by the perimeter. # Corresponds to the JSON property `allowedServices` # @return [Array] attr_accessor :allowed_services - # Whether to restrict API calls within the Service Perimeter to the list of - # APIs specified in 'allowed_services'. + # Whether to restrict API calls within the Service Perimeter to the list of APIs + # specified in 'allowed_services'. # Corresponds to the JSON property `enableRestriction` # @return [Boolean] attr_accessor :enable_restriction @@ -1400,47 +1202,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::CloudassetV1beta1::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] 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] attr_accessor :response @@ -1479,66 +1279,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 @@ -1547,48 +1313,44 @@ module Google # @return [Array] 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] 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 @@ -1610,47 +1372,42 @@ module Google class Resource include Google::Apis::Core::Hashable - # The content of the resource, in which some sensitive fields are removed - # and may not be present. + # The content of the resource, in which some sensitive fields are removed and + # may not be present. # Corresponds to the JSON property `data` # @return [Hash] attr_accessor :data # The URL of the discovery document containing the resource's JSON schema. - # Example: - # `https://www.googleapis.com/discovery/v1/apis/compute/v1/rest` - # This value is unspecified for resources that do not have an API based on a + # Example: `https://www.googleapis.com/discovery/v1/apis/compute/v1/rest` This + # value is unspecified for resources that do not have an API based on a # discovery document, such as Cloud Bigtable. # Corresponds to the JSON property `discoveryDocumentUri` # @return [String] attr_accessor :discovery_document_uri - # The JSON schema name listed in the discovery document. Example: - # `Project` - # This value is unspecified for resources that do not have an API based on a + # The JSON schema name listed in the discovery document. Example: `Project` This + # value is unspecified for resources that do not have an API based on a # discovery document, such as Cloud Bigtable. # Corresponds to the JSON property `discoveryName` # @return [String] attr_accessor :discovery_name - # The full name of the immediate parent of this resource. See - # [Resource - # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - # for more information. - # For Google Cloud assets, this value is the parent resource defined in the - # [Cloud IAM policy - # hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy). - # Example: - # `//cloudresourcemanager.googleapis.com/projects/my_project_123` - # For third-party assets, this field may be set differently. + # The full name of the immediate parent of this resource. See [Resource Names]( + # https://cloud.google.com/apis/design/resource_names#full_resource_name) for + # more information. For Google Cloud assets, this value is the parent resource + # defined in the [Cloud IAM policy hierarchy](https://cloud.google.com/iam/docs/ + # overview#policy_hierarchy). Example: `//cloudresourcemanager.googleapis.com/ + # projects/my_project_123` For third-party assets, this field may be set + # differently. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # The REST URL for accessing the resource. An HTTP `GET` request using this - # URL returns the resource itself. Example: - # `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123` - # This value is unspecified for resources without a REST API. + # The REST URL for accessing the resource. An HTTP `GET` request using this URL + # returns the resource itself. Example: `https://cloudresourcemanager.googleapis. + # com/v1/projects/my-project-123` This value is unspecified for resources + # without a REST API. # Corresponds to the JSON property `resourceUrl` # @return [String] attr_accessor :resource_url @@ -1675,12 +1432,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 @@ -1689,15 +1446,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>] 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 @@ -1719,15 +1476,12 @@ module Google class TemporalAsset include Google::Apis::Core::Hashable - # An asset in Google Cloud. An asset can be any resource in the Google Cloud - # [resource - # hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform- - # resource-hierarchy), - # a resource outside the Google Cloud resource hierarchy (such as Google - # Kubernetes Engine clusters and objects), or a policy (e.g. Cloud IAM policy). - # See [Supported asset - # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - # for more information. + # An asset in Google Cloud. An asset can be any resource in the Google Cloud [ + # resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud- + # platform-resource-hierarchy), a resource outside the Google Cloud resource + # hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy + # (e.g. Cloud IAM policy). See [Supported asset types](https://cloud.google.com/ + # asset-inventory/docs/supported-asset-types) for more information. # Corresponds to the JSON property `asset` # @return [Google::Apis::CloudassetV1beta1::Asset] attr_accessor :asset diff --git a/generated/google/apis/cloudasset_v1beta1/service.rb b/generated/google/apis/cloudasset_v1beta1/service.rb index 9efca310f..33dd71775 100644 --- a/generated/google/apis/cloudasset_v1beta1/service.rb +++ b/generated/google/apis/cloudasset_v1beta1/service.rb @@ -47,18 +47,17 @@ module Google @batch_path = 'batch' end - # Exports assets with time and resource types to a given Cloud Storage - # location. The output format is newline-delimited JSON. - # This API implements the google.longrunning.Operation API allowing you - # to keep track of the export. We recommend intervals of at least 2 seconds - # with exponential retry to poll the export operation result. For - # regular-size resource parent, the export operation usually finishes within - # 5 minutes. + # Exports assets with time and resource types to a given Cloud Storage location. + # The output format is newline-delimited JSON. This API implements the google. + # longrunning.Operation API allowing you to keep track of the export. We + # recommend intervals of at least 2 seconds with exponential retry to poll the + # export operation result. For regular-size resource parent, the export + # operation usually finishes within 5 minutes. # @param [String] parent # Required. The relative name of the root asset. This can only be an - # organization number (such as "organizations/123"), a project ID (such as - # "projects/my-project-id"), a project number (such as "projects/12345"), or - # a folder number (such as "folders/123"). + # organization number (such as "organizations/123"), a project ID (such as " + # projects/my-project-id"), a project number (such as "projects/12345"), or a + # folder number (such as "folders/123"). # @param [Google::Apis::CloudassetV1beta1::ExportAssetsRequest] export_assets_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -89,9 +88,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 @@ -121,26 +119,21 @@ module Google execute_or_queue_command(command, &block) end - # Batch gets the update history of assets that overlap a time window. - # For IAM_POLICY content, this API outputs history when the asset and its - # attached IAM POLICY both exist. This can create gaps in the output history. - # Otherwise, this API outputs history with asset in both non-delete or - # deleted status. - # If a specified asset does not exist, this API returns an INVALID_ARGUMENT - # error. + # Batch gets the update history of assets that overlap a time window. For + # IAM_POLICY content, this API outputs history when the asset and its attached + # IAM POLICY both exist. This can create gaps in the output history. Otherwise, + # this API outputs history with asset in both non-delete or deleted status. If a + # specified asset does not exist, this API returns an INVALID_ARGUMENT error. # @param [String] parent - # Required. The relative name of the root asset. It can only be an - # organization number (such as "organizations/123"), a project ID (such as - # "projects/my-project-id")", or a project number (such as "projects/12345"). + # Required. The relative name of the root asset. It can only be an organization + # number (such as "organizations/123"), a project ID (such as "projects/my- + # project-id")", or a project number (such as "projects/12345"). # @param [Array, String] asset_names - # A list of the full names of the assets. For example: - # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/ - # instance1`. - # See [Resource - # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - # for more info. - # The request becomes a no-op if the asset name list is empty, and the max - # size of the asset name list is 100 in one request. + # A list of the full names of the assets. For example: `//compute.googleapis.com/ + # projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names]( + # https://cloud.google.com/apis/design/resource_names#full_resource_name) for + # more info. The request becomes a no-op if the asset name list is empty, and + # the max size of the asset name list is 100 in one request. # @param [String] content_type # Optional. The content type. # @param [String] read_time_window_end_time @@ -179,18 +172,17 @@ module Google execute_or_queue_command(command, &block) end - # Exports assets with time and resource types to a given Cloud Storage - # location. The output format is newline-delimited JSON. - # This API implements the google.longrunning.Operation API allowing you - # to keep track of the export. We recommend intervals of at least 2 seconds - # with exponential retry to poll the export operation result. For - # regular-size resource parent, the export operation usually finishes within - # 5 minutes. + # Exports assets with time and resource types to a given Cloud Storage location. + # The output format is newline-delimited JSON. This API implements the google. + # longrunning.Operation API allowing you to keep track of the export. We + # recommend intervals of at least 2 seconds with exponential retry to poll the + # export operation result. For regular-size resource parent, the export + # operation usually finishes within 5 minutes. # @param [String] parent # Required. The relative name of the root asset. This can only be an - # organization number (such as "organizations/123"), a project ID (such as - # "projects/my-project-id"), a project number (such as "projects/12345"), or - # a folder number (such as "folders/123"). + # organization number (such as "organizations/123"), a project ID (such as " + # projects/my-project-id"), a project number (such as "projects/12345"), or a + # folder number (such as "folders/123"). # @param [Google::Apis::CloudassetV1beta1::ExportAssetsRequest] export_assets_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -221,9 +213,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 @@ -253,26 +244,21 @@ module Google execute_or_queue_command(command, &block) end - # Batch gets the update history of assets that overlap a time window. - # For IAM_POLICY content, this API outputs history when the asset and its - # attached IAM POLICY both exist. This can create gaps in the output history. - # Otherwise, this API outputs history with asset in both non-delete or - # deleted status. - # If a specified asset does not exist, this API returns an INVALID_ARGUMENT - # error. + # Batch gets the update history of assets that overlap a time window. For + # IAM_POLICY content, this API outputs history when the asset and its attached + # IAM POLICY both exist. This can create gaps in the output history. Otherwise, + # this API outputs history with asset in both non-delete or deleted status. If a + # specified asset does not exist, this API returns an INVALID_ARGUMENT error. # @param [String] parent - # Required. The relative name of the root asset. It can only be an - # organization number (such as "organizations/123"), a project ID (such as - # "projects/my-project-id")", or a project number (such as "projects/12345"). + # Required. The relative name of the root asset. It can only be an organization + # number (such as "organizations/123"), a project ID (such as "projects/my- + # project-id")", or a project number (such as "projects/12345"). # @param [Array, String] asset_names - # A list of the full names of the assets. For example: - # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/ - # instance1`. - # See [Resource - # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - # for more info. - # The request becomes a no-op if the asset name list is empty, and the max - # size of the asset name list is 100 in one request. + # A list of the full names of the assets. For example: `//compute.googleapis.com/ + # projects/my_project_123/zones/zone1/instances/instance1`. See [Resource Names]( + # https://cloud.google.com/apis/design/resource_names#full_resource_name) for + # more info. The request becomes a no-op if the asset name list is empty, and + # the max size of the asset name list is 100 in one request. # @param [String] content_type # Optional. The content type. # @param [String] read_time_window_end_time @@ -311,18 +297,17 @@ module Google execute_or_queue_command(command, &block) end - # Exports assets with time and resource types to a given Cloud Storage - # location. The output format is newline-delimited JSON. - # This API implements the google.longrunning.Operation API allowing you - # to keep track of the export. We recommend intervals of at least 2 seconds - # with exponential retry to poll the export operation result. For - # regular-size resource parent, the export operation usually finishes within - # 5 minutes. + # Exports assets with time and resource types to a given Cloud Storage location. + # The output format is newline-delimited JSON. This API implements the google. + # longrunning.Operation API allowing you to keep track of the export. We + # recommend intervals of at least 2 seconds with exponential retry to poll the + # export operation result. For regular-size resource parent, the export + # operation usually finishes within 5 minutes. # @param [String] parent # Required. The relative name of the root asset. This can only be an - # organization number (such as "organizations/123"), a project ID (such as - # "projects/my-project-id"), a project number (such as "projects/12345"), or - # a folder number (such as "folders/123"). + # organization number (such as "organizations/123"), a project ID (such as " + # projects/my-project-id"), a project number (such as "projects/12345"), or a + # folder number (such as "folders/123"). # @param [Google::Apis::CloudassetV1beta1::ExportAssetsRequest] export_assets_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -353,9 +338,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 diff --git a/generated/google/apis/cloudasset_v1p1beta1.rb b/generated/google/apis/cloudasset_v1p1beta1.rb index 21b30d987..a49027afd 100644 --- a/generated/google/apis/cloudasset_v1p1beta1.rb +++ b/generated/google/apis/cloudasset_v1p1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/asset-inventory/docs/quickstart module CloudassetV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20200605' + REVISION = '20200810' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudasset_v1p1beta1/classes.rb b/generated/google/apis/cloudasset_v1p1beta1/classes.rb index 773c3c2ac..a5fb1fcb2 100644 --- a/generated/google/apis/cloudasset_v1p1beta1/classes.rb +++ b/generated/google/apis/cloudasset_v1p1beta1/classes.rb @@ -22,53 +22,21 @@ module Google module Apis module CloudassetV1p1beta1 - # 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 @@ -77,9 +45,9 @@ module Google # @return [Array] 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 @@ -95,28 +63,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] @@ -142,69 +97,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::CloudassetV1p1beta1::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] 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 @@ -225,11 +168,11 @@ module Google class Explanation include Google::Apis::Core::Hashable - # The map from roles to their included permission matching the permission - # query (e.g. containing `policy.role.permissions:`). A sample role string: - # "roles/compute.instanceAdmin". The roles can also be found in the - # returned `policy` bindings. Note that the map is populated only if - # requesting with a permission query. + # The map from roles to their included permission matching the permission query ( + # e.g. containing `policy.role.permissions:`). A sample role string: "roles/ + # compute.instanceAdmin". The roles can also be found in the returned `policy` + # bindings. Note that the map is populated only if requesting with a permission + # query. # Corresponds to the JSON property `matchedPermissions` # @return [Hash] attr_accessor :matched_permissions @@ -244,52 +187,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 @@ -317,82 +251,47 @@ module Google attr_accessor :explanation # 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::CloudassetV1p1beta1::Policy] attr_accessor :policy - # The project that the associated GCP resource belongs to, in the form of - # `projects/`project_number``. If an IAM policy is set on a resource (like VM - # instance, Cloud Storage bucket), the project field will indicate the - # project that contains the resource. If an IAM policy is set on a folder or - # orgnization, the project field will be empty. + # The project that the associated GCP resource belongs to, in the form of ` + # projects/`project_number``. If an IAM policy is set on a resource (like VM + # instance, Cloud Storage bucket), the project field will indicate the project + # that contains the resource. If an IAM policy is set on a folder or orgnization, + # the project field will be empty. # Corresponds to the JSON property `project` # @return [String] attr_accessor :project - # The [full resource - # name](https://cloud.google.com/apis/design/resource_names#full_resource_name) - # of the resource associated with this IAM policy. + # The [full resource name](https://cloud.google.com/apis/design/resource_names# + # full_resource_name) of the resource associated with this IAM policy. # Corresponds to the JSON property `resource` # @return [String] attr_accessor :resource @@ -430,66 +329,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 @@ -498,48 +363,44 @@ module Google # @return [Array] 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] 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 @@ -562,14 +423,14 @@ module Google include Google::Apis::Core::Hashable # Set if there are more results than those appearing in this response; to get - # the next set of results, call this method again, using this value as the - # `page_token`. + # the next set of results, call this method again, using this value as the ` + # page_token`. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # A list of IamPolicy that match the search query. Related information such - # as the associated resource is returned along with the policy. + # A list of IamPolicy that match the search query. Related information such as + # the associated resource is returned along with the policy. # Corresponds to the JSON property `results` # @return [Array] attr_accessor :results @@ -589,9 +450,9 @@ module Google class SearchAllResourcesResponse include Google::Apis::Core::Hashable - # If there are more results than those appearing in this response, then - # `next_page_token` is included. To get the next set of results, call this - # method again using the value of `next_page_token` as `page_token`. + # If there are more results than those appearing in this response, then ` + # next_page_token` is included. To get the next set of results, call this method + # again using the value of `next_page_token` as `page_token`. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -616,15 +477,14 @@ module Google class StandardResourceMetadata include Google::Apis::Core::Hashable - # Additional searchable attributes of this resource. - # Informational only. The exact set of attributes is subject to change. - # For example: project id, DNS name etc. + # Additional searchable attributes of this resource. Informational only. The + # exact set of attributes is subject to change. For example: project id, DNS + # name etc. # Corresponds to the JSON property `additionalAttributes` # @return [Array] attr_accessor :additional_attributes - # The type of this resource. - # For example: "compute.googleapis.com/Disk". + # The type of this resource. For example: "compute.googleapis.com/Disk". # Corresponds to the JSON property `assetType` # @return [String] attr_accessor :asset_type @@ -642,39 +502,34 @@ module Google # Labels associated with this resource. See [Labelling and grouping GCP # resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping- - # your-google-cloud-platform-resources) - # for more information. + # your-google-cloud-platform-resources) for more information. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Location can be "global", regional like "us-east1", or zonal like - # "us-west1-b". + # Location can be "global", regional like "us-east1", or zonal like "us-west1-b". # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # The full resource name. For example: - # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/ - # instance1`. - # See [Resource - # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - # for more information. + # The full resource name. For example: `//compute.googleapis.com/projects/ + # my_project_123/zones/zone1/instances/instance1`. See [Resource Names](https:// + # cloud.google.com/apis/design/resource_names#full_resource_name) for more + # information. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Network tags associated with this resource. Like labels, network tags are a - # type of annotations used to group GCP resources. See [Labelling GCP - # resources](lhttps://cloud.google.com/blog/products/gcp/labelling-and-grouping- - # your-google-cloud-platform-resources) - # for more information. + # type of annotations used to group GCP resources. See [Labelling GCP resources]( + # lhttps://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google- + # cloud-platform-resources) for more information. # Corresponds to the JSON property `networkTags` # @return [Array] attr_accessor :network_tags - # The project that this resource belongs to, in the form of - # `projects/`project_number``. + # The project that this resource belongs to, in the form of `projects/` + # project_number``. # Corresponds to the JSON property `project` # @return [String] attr_accessor :project diff --git a/generated/google/apis/cloudasset_v1p1beta1/service.rb b/generated/google/apis/cloudasset_v1p1beta1/service.rb index 0f304c1df..86a060217 100644 --- a/generated/google/apis/cloudasset_v1p1beta1/service.rb +++ b/generated/google/apis/cloudasset_v1p1beta1/service.rb @@ -47,36 +47,30 @@ module Google @batch_path = 'batch' end - # Searches all the IAM policies within a given accessible CRM scope - # (project/folder/organization). This RPC gives callers especially - # administrators the ability to search all the IAM policies within a scope, - # even if they don't have `.getIamPolicy` permission of all the IAM policies. - # Callers should have `cloud.assets.SearchAllIamPolicies` permission on the - # requested scope, otherwise the request will be rejected. + # Searches all the IAM policies within a given accessible CRM scope (project/ + # folder/organization). This RPC gives callers especially administrators the + # ability to search all the IAM policies within a scope, even if they don't have + # `.getIamPolicy` permission of all the IAM policies. Callers should have `cloud. + # assets.SearchAllIamPolicies` permission on the requested scope, otherwise the + # request will be rejected. # @param [String] scope # Required. The relative name of an asset. The search is limited to the - # resources - # within the `scope`. The allowed value must be: - # * Organization number (such as "organizations/123") - # * Folder number(such as "folders/1234") - # * Project number (such as "projects/12345") - # * Project id (such as "projects/abc") + # resources within the `scope`. The allowed value must be: * Organization number + # (such as "organizations/123") * Folder number(such as "folders/1234") * + # Project number (such as "projects/12345") * Project id (such as "projects/abc") # @param [Fixnum] page_size # Optional. The page size for search result pagination. Page size is capped at - # 500 even - # if a larger value is given. If set to zero, server will pick an appropriate - # default. Returned results may be fewer than requested. When this happens, - # there could be more results as long as `next_page_token` is returned. + # 500 even if a larger value is given. If set to zero, server will pick an + # appropriate default. Returned results may be fewer than requested. When this + # happens, there could be more results as long as `next_page_token` is returned. # @param [String] page_token # Optional. If present, retrieve the next batch of results from the preceding - # call to - # this method. `page_token` must be the value of `next_page_token` from the - # previous response. The values of all other method parameters must be + # call to this method. `page_token` must be the value of `next_page_token` from + # the previous response. The values of all other method parameters must be # identical to those in the previous call. # @param [String] query - # Optional. The query statement. Examples: - # * "policy:myuser@mydomain.com" - # * "policy:(myuser@mydomain.com viewer)" + # Optional. The query statement. Examples: * "policy:myuser@mydomain.com" * " + # policy:(myuser@mydomain.com viewer)" # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -107,41 +101,35 @@ module Google execute_or_queue_command(command, &block) end - # Searches all the resources within a given accessible CRM scope - # (project/folder/organization). This RPC gives callers especially - # administrators the ability to search all the resources within a scope, even - # if they don't have `.get` permission of all the resources. Callers should - # have `cloud.assets.SearchAllResources` permission on the requested scope, - # otherwise the request will be rejected. + # Searches all the resources within a given accessible CRM scope (project/folder/ + # organization). This RPC gives callers especially administrators the ability to + # search all the resources within a scope, even if they don't have `.get` + # permission of all the resources. Callers should have `cloud.assets. + # SearchAllResources` permission on the requested scope, otherwise the request + # will be rejected. # @param [String] scope # Required. The relative name of an asset. The search is limited to the - # resources - # within the `scope`. The allowed value must be: - # * Organization number (such as "organizations/123") - # * Folder number(such as "folders/1234") - # * Project number (such as "projects/12345") - # * Project id (such as "projects/abc") + # resources within the `scope`. The allowed value must be: * Organization number + # (such as "organizations/123") * Folder number(such as "folders/1234") * + # Project number (such as "projects/12345") * Project id (such as "projects/abc") # @param [Array, String] asset_types # Optional. A list of asset types that this request searches for. If empty, it - # will - # search all the supported asset types. + # will search all the supported asset types. # @param [String] order_by # Optional. A comma separated list of fields specifying the sorting order of the - # results. The default order is ascending. Add ` DESC` after the field name - # to indicate descending order. Redundant space characters are ignored. For - # example, ` location DESC , name `. + # results. The default order is ascending. Add ` DESC` after the field name to + # indicate descending order. Redundant space characters are ignored. For example, + # ` location DESC , name `. # @param [Fixnum] page_size # Optional. The page size for search result pagination. Page size is capped at - # 500 even - # if a larger value is given. If set to zero, server will pick an appropriate - # default. Returned results may be fewer than requested. When this happens, - # there could be more results as long as `next_page_token` is returned. + # 500 even if a larger value is given. If set to zero, server will pick an + # appropriate default. Returned results may be fewer than requested. When this + # happens, there could be more results as long as `next_page_token` is returned. # @param [String] page_token # Optional. If present, then retrieve the next batch of results from the - # preceding call - # to this method. `page_token` must be the value of `next_page_token` from - # the previous response. The values of all other method parameters, must be - # identical to those in the previous call. + # preceding call to this method. `page_token` must be the value of ` + # next_page_token` from the previous response. The values of all other method + # parameters, must be identical to those in the previous call. # @param [String] query # Optional. The query statement. # @param [String] fields diff --git a/generated/google/apis/cloudasset_v1p4beta1.rb b/generated/google/apis/cloudasset_v1p4beta1.rb index f297a5e92..1a24c197d 100644 --- a/generated/google/apis/cloudasset_v1p4beta1.rb +++ b/generated/google/apis/cloudasset_v1p4beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/asset-inventory/docs/quickstart module CloudassetV1p4beta1 VERSION = 'V1p4beta1' - REVISION = '20200731' + REVISION = '20200810' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudasset_v1p4beta1/classes.rb b/generated/google/apis/cloudasset_v1p4beta1/classes.rb index 0f4d48e69..624e6004f 100644 --- a/generated/google/apis/cloudasset_v1p4beta1/classes.rb +++ b/generated/google/apis/cloudasset_v1p4beta1/classes.rb @@ -23,9 +23,9 @@ module Google module CloudassetV1p4beta1 # Specifies roles and/or permissions to analyze, to determine both the - # identities possessing them and the resources they control. If multiple - # values are specified, results will include identities and resources - # matching any of them. + # identities possessing them and the resources they control. If multiple values + # are specified, results will include identities and resources matching any of + # them. class AccessSelector include Google::Apis::Core::Hashable @@ -55,8 +55,8 @@ module Google include Google::Apis::Core::Hashable # Represents whether all entries in the main_analysis and - # service_account_impersonation_analysis have been fully explored to - # answer the query in the request. + # service_account_impersonation_analysis have been fully explored to answer the + # query in the request. # Corresponds to the JSON property `fullyExplored` # @return [Boolean] attr_accessor :fully_explored @@ -67,15 +67,14 @@ module Google # @return [Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysis] attr_accessor :main_analysis - # A list of non-critical errors happened during the request handling to - # explain why `fully_explored` is false, or empty if no error happened. + # A list of non-critical errors happened during the request handling to explain + # why `fully_explored` is false, or empty if no error happened. # Corresponds to the JSON property `nonCriticalErrors` # @return [Array] attr_accessor :non_critical_errors - # The service account impersonation analysis if - # AnalyzeIamPolicyRequest.analyze_service_account_impersonation is - # enabled. + # The service account impersonation analysis if AnalyzeIamPolicyRequest. + # analyze_service_account_impersonation is enabled. # Corresponds to the JSON property `serviceAccountImpersonationAnalysis` # @return [Array] attr_accessor :service_account_impersonation_analysis @@ -97,69 +96,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::CloudassetV1p4beta1::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] 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 @@ -207,52 +194,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 @@ -275,11 +253,9 @@ module Google include Google::Apis::Core::Hashable # Required. The uri of the Cloud Storage object. It's the same uri that is used - # by - # gsutil. For example: "gs://bucket_name/object_name". See [Viewing and - # Editing Object - # Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) - # for more information. + # by gsutil. For example: "gs://bucket_name/object_name". See [Viewing and + # Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing- + # metadata) for more information. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -298,8 +274,8 @@ module Google class GoogleCloudAssetV1p4beta1Access include Google::Apis::Core::Hashable - # Represents the detailed state of an entity under analysis, such as a - # resource, an identity or an access. + # Represents the detailed state of an entity under analysis, such as a resource, + # an identity or an access. # Corresponds to the JSON property `analysisState` # @return [Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AnalysisState] attr_accessor :analysis_state @@ -327,39 +303,36 @@ module Google end # An access control list, derived from the above IAM policy binding, which - # contains a set of resources and accesses. May include one - # item from each set to compose an access control entry. - # NOTICE that there could be multiple access control lists for one IAM policy - # binding. The access control lists are created based on resource and access - # combinations. - # For example, assume we have the following cases in one IAM policy binding: - # - Permission P1 and P2 apply to resource R1 and R2; - # - Permission P3 applies to resource R2 and R3; - # This will result in the following access control lists: - # - AccessControlList 1: [R1, R2], [P1, P2] - # - AccessControlList 2: [R2, R3], [P3] + # contains a set of resources and accesses. May include one item from each set + # to compose an access control entry. NOTICE that there could be multiple access + # control lists for one IAM policy binding. The access control lists are created + # based on resource and access combinations. For example, assume we have the + # following cases in one IAM policy binding: - Permission P1 and P2 apply to + # resource R1 and R2; - Permission P3 applies to resource R2 and R3; This will + # result in the following access control lists: - AccessControlList 1: [R1, R2], + # [P1, P2] - AccessControlList 2: [R2, R3], [P3] class GoogleCloudAssetV1p4beta1AccessControlList include Google::Apis::Core::Hashable - # The accesses that match one of the following conditions: - # - The access_selector, if it is specified in request; - # - Otherwise, access specifiers reachable from the policy binding's role. + # The accesses that match one of the following conditions: - The access_selector, + # if it is specified in request; - Otherwise, access specifiers reachable from + # the policy binding's role. # Corresponds to the JSON property `accesses` # @return [Array] attr_accessor :accesses - # Resource edges of the graph starting from the policy attached - # resource to any descendant resources. The Edge.source_node contains - # the full resource name of a parent resource and Edge.target_node - # contains the full resource name of a child resource. This field is - # present only if the output_resource_edges option is enabled in request. + # Resource edges of the graph starting from the policy attached resource to any + # descendant resources. The Edge.source_node contains the full resource name of + # a parent resource and Edge.target_node contains the full resource name of a + # child resource. This field is present only if the output_resource_edges option + # is enabled in request. # Corresponds to the JSON property `resourceEdges` # @return [Array] attr_accessor :resource_edges - # The resources that match one of the following conditions: - # - The resource_selector, if it is specified in request; - # - Otherwise, resources reachable from the policy attached resource. + # The resources that match one of the following conditions: - The + # resource_selector, if it is specified in request; - Otherwise, resources + # reachable from the policy attached resource. # Corresponds to the JSON property `resources` # @return [Array] attr_accessor :resources @@ -376,8 +349,8 @@ module Google end end - # Represents the detailed state of an entity under analysis, such as a - # resource, an identity or an access. + # Represents the detailed state of an entity under analysis, such as a resource, + # an identity or an access. class GoogleCloudAssetV1p4beta1AnalysisState include Google::Apis::Core::Hashable @@ -386,12 +359,11 @@ module Google # @return [String] attr_accessor :cause - # The Google standard error code that best describes the state. - # For example: - # - OK means the analysis on this entity has been successfully finished; - # - PERMISSION_DENIED means an access denied error is encountered; - # - DEADLINE_EXCEEDED means the analysis on this entity hasn't been started - # in time; + # The Google standard error code that best describes the state. For example: - + # OK means the analysis on this entity has been successfully finished; - + # PERMISSION_DENIED means an access denied error is encountered; - + # DEADLINE_EXCEEDED means the analysis on this entity hasn't been started in + # time; # Corresponds to the JSON property `code` # @return [String] attr_accessor :code @@ -436,23 +408,16 @@ module Google class GoogleCloudAssetV1p4beta1Identity include Google::Apis::Core::Hashable - # Represents the detailed state of an entity under analysis, such as a - # resource, an identity or an access. + # Represents the detailed state of an entity under analysis, such as a resource, + # an identity or an access. # Corresponds to the JSON property `analysisState` # @return [Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AnalysisState] attr_accessor :analysis_state - # The identity name in any form of members appear in - # [IAM policy - # binding](https://cloud.google.com/iam/reference/rest/v1/Binding), such - # as: - # - user:foo@google.com - # - group:group1@google.com - # - serviceAccount:s1@prj1.iam.gserviceaccount.com - # - projectOwner:some_project_id - # - domain:google.com - # - allUsers - # - etc. + # The identity name in any form of members appear in [IAM policy binding](https:/ + # /cloud.google.com/iam/reference/rest/v1/Binding), such as: - user:foo@google. + # com - group:group1@google.com - serviceAccount:s1@prj1.iam.gserviceaccount.com + # - projectOwner:some_project_id - domain:google.com - allUsers - etc. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -472,21 +437,18 @@ module Google class GoogleCloudAssetV1p4beta1IdentityList include Google::Apis::Core::Hashable - # Group identity edges of the graph starting from the binding's - # group members to any node of the identities. The Edge.source_node - # contains a group, such as "group:parent@google.com". The - # Edge.target_node contains a member of the group, - # such as "group:child@google.com" or "user:foo@google.com". - # This field is present only if the output_group_edges option is enabled in - # request. + # Group identity edges of the graph starting from the binding's group members to + # any node of the identities. The Edge.source_node contains a group, such as " + # group:parent@google.com". The Edge.target_node contains a member of the group, + # such as "group:child@google.com" or "user:foo@google.com". This field is + # present only if the output_group_edges option is enabled in request. # Corresponds to the JSON property `groupEdges` # @return [Array] attr_accessor :group_edges # Only the identities that match one of the following conditions will be - # presented: - # - The identity_selector, if it is specified in request; - # - Otherwise, identities reachable from the policy binding's members. + # presented: - The identity_selector, if it is specified in request; - Otherwise, + # identities reachable from the policy binding's members. # Corresponds to the JSON property `identities` # @return [Array] attr_accessor :identities @@ -506,14 +468,14 @@ module Google class GoogleCloudAssetV1p4beta1Resource include Google::Apis::Core::Hashable - # Represents the detailed state of an entity under analysis, such as a - # resource, an identity or an access. + # Represents the detailed state of an entity under analysis, such as a resource, + # an identity or an access. # Corresponds to the JSON property `analysisState` # @return [Google::Apis::CloudassetV1p4beta1::GoogleCloudAssetV1p4beta1AnalysisState] attr_accessor :analysis_state - # The [full resource - # name](https://cloud.google.com/asset-inventory/docs/resource-name-format) + # The [full resource name](https://cloud.google.com/asset-inventory/docs/ + # resource-name-format) # Corresponds to the JSON property `fullResourceName` # @return [String] attr_accessor :full_resource_name @@ -538,14 +500,14 @@ module Google # @return [Google::Apis::CloudassetV1p4beta1::IamPolicyAnalysisQuery] attr_accessor :analysis_query - # A list of IamPolicyAnalysisResult that matches the analysis query, or - # empty if no result is found. + # A list of IamPolicyAnalysisResult that matches the analysis query, or empty if + # no result is found. # Corresponds to the JSON property `analysisResults` # @return [Array] attr_accessor :analysis_results - # Represents whether all entries in the analysis_results have been - # fully explored to answer the query. + # Represents whether all entries in the analysis_results have been fully + # explored to answer the query. # Corresponds to the JSON property `fullyExplored` # @return [Boolean] attr_accessor :fully_explored @@ -587,29 +549,27 @@ module Google include Google::Apis::Core::Hashable # Specifies roles and/or permissions to analyze, to determine both the - # identities possessing them and the resources they control. If multiple - # values are specified, results will include identities and resources - # matching any of them. + # identities possessing them and the resources they control. If multiple values + # are specified, results will include identities and resources matching any of + # them. # Corresponds to the JSON property `accessSelector` # @return [Google::Apis::CloudassetV1p4beta1::AccessSelector] attr_accessor :access_selector - # Specifies an identity for which to determine resource access, based on - # roles assigned either directly to them or to the groups they belong to, - # directly or indirectly. + # Specifies an identity for which to determine resource access, based on roles + # assigned either directly to them or to the groups they belong to, directly or + # indirectly. # Corresponds to the JSON property `identitySelector` # @return [Google::Apis::CloudassetV1p4beta1::IdentitySelector] attr_accessor :identity_selector # Required. The relative name of the root asset. Only resources and IAM policies - # within - # the parent will be analyzed. This can only be an organization number (such - # as "organizations/123") or a folder number (such as "folders/123"). - # To know how to get organization id, visit [here - # ](https://cloud.google.com/resource-manager/docs/creating-managing- - # organization#retrieving_your_organization_id). - # To know how to get folder id, visit [here - # ](https://cloud.google.com/resource-manager/docs/creating-managing-folders# + # within the parent will be analyzed. This can only be an organization number ( + # such as "organizations/123") or a folder number (such as "folders/123"). To + # know how to get organization id, visit [here ](https://cloud.google.com/ + # resource-manager/docs/creating-managing-organization# + # retrieving_your_organization_id). To know how to get folder id, visit [here ]( + # https://cloud.google.com/resource-manager/docs/creating-managing-folders# # viewing_or_listing_folders_and_projects). # Corresponds to the JSON property `parent` # @return [String] @@ -646,15 +606,13 @@ module Google # @return [Array] attr_accessor :access_control_lists - # The [full resource - # name](https://cloud.google.com/asset-inventory/docs/resource-name-format) - # of the resource to which the iam_binding policy attaches. + # The [full resource name](https://cloud.google.com/asset-inventory/docs/ + # resource-name-format) of the resource to which the iam_binding policy attaches. # Corresponds to the JSON property `attachedResourceFullName` # @return [String] attr_accessor :attached_resource_full_name - # Represents whether all analyses on the iam_binding have successfully - # finished. + # Represents whether all analyses on the iam_binding have successfully finished. # Corresponds to the JSON property `fullyExplored` # @return [Boolean] attr_accessor :fully_explored @@ -685,22 +643,18 @@ module Google end end - # Specifies an identity for which to determine resource access, based on - # roles assigned either directly to them or to the groups they belong to, - # directly or indirectly. + # Specifies an identity for which to determine resource access, based on roles + # assigned either directly to them or to the groups they belong to, directly or + # indirectly. class IdentitySelector include Google::Apis::Core::Hashable - # Required. The identity appear in the form of members in - # [IAM policy - # binding](https://cloud.google.com/iam/reference/rest/v1/Binding). - # The examples of supported forms are: - # "user:mike@example.com", - # "group:admins@example.com", - # "domain:google.com", - # "serviceAccount:my-project-id@appspot.gserviceaccount.com". - # Notice that wildcard characters (such as * and ?) are not supported. - # You must give a specific identity. + # Required. The identity appear in the form of members in [IAM policy binding]( + # https://cloud.google.com/iam/reference/rest/v1/Binding). The examples of + # supported forms are: "user:mike@example.com", "group:admins@example.com", " + # domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com". + # Notice that wildcard characters (such as * and ?) are not supported. You must + # give a specific identity. # Corresponds to the JSON property `identity` # @return [String] attr_accessor :identity @@ -720,47 +674,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::CloudassetV1p4beta1::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] 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] attr_accessor :response @@ -784,75 +736,67 @@ module Google include Google::Apis::Core::Hashable # Optional. If true, the response will include access analysis from identities - # to - # resources via service account impersonation. This is a very expensive - # operation, because many derived queries will be executed. - # For example, if the request analyzes for which resources user A has - # permission P, and there's an IAM policy states user A has - # iam.serviceAccounts.getAccessToken permission to a service account SA, - # and there's another IAM policy states service account SA has permission P - # to a GCP folder F, then user A potentially has access to the GCP folder - # F. And those advanced analysis results will be included in - # AnalyzeIamPolicyResponse.service_account_impersonation_analysis. - # Another example, if the request analyzes for who has - # permission P to a GCP folder F, and there's an IAM policy states user A - # has iam.serviceAccounts.actAs permission to a service account SA, and - # there's another IAM policy states service account SA has permission P to - # the GCP folder F, then user A potentially has access to the GCP folder - # F. And those advanced analysis results will be included in - # AnalyzeIamPolicyResponse.service_account_impersonation_analysis. - # Default is false. + # to resources via service account impersonation. This is a very expensive + # operation, because many derived queries will be executed. For example, if the + # request analyzes for which resources user A has permission P, and there's an + # IAM policy states user A has iam.serviceAccounts.getAccessToken permission to + # a service account SA, and there's another IAM policy states service account SA + # has permission P to a GCP folder F, then user A potentially has access to the + # GCP folder F. And those advanced analysis results will be included in + # AnalyzeIamPolicyResponse.service_account_impersonation_analysis. Another + # example, if the request analyzes for who has permission P to a GCP folder F, + # and there's an IAM policy states user A has iam.serviceAccounts.actAs + # permission to a service account SA, and there's another IAM policy states + # service account SA has permission P to the GCP folder F, then user A + # potentially has access to the GCP folder F. And those advanced analysis + # results will be included in AnalyzeIamPolicyResponse. + # service_account_impersonation_analysis. Default is false. # Corresponds to the JSON property `analyzeServiceAccountImpersonation` # @return [Boolean] attr_accessor :analyze_service_account_impersonation alias_method :analyze_service_account_impersonation?, :analyze_service_account_impersonation - # Optional. If true, the identities section of the result will expand any - # Google groups appearing in an IAM policy binding. - # If identity_selector is specified, the identity in the result will - # be determined by the selector, and this flag will have no effect. - # Default is false. + # Optional. If true, the identities section of the result will expand any Google + # groups appearing in an IAM policy binding. If identity_selector is specified, + # the identity in the result will be determined by the selector, and this flag + # will have no effect. Default is false. # Corresponds to the JSON property `expandGroups` # @return [Boolean] attr_accessor :expand_groups alias_method :expand_groups?, :expand_groups - # Optional. If true, the resource section of the result will expand any - # resource attached to an IAM policy to include resources lower in the - # resource hierarchy. + # Optional. If true, the resource section of the result will expand any resource + # attached to an IAM policy to include resources lower in the resource hierarchy. # For example, if the request analyzes for which resources user A has - # permission P, and the results include an IAM policy with P on a GCP - # folder, the results will also include resources in that folder with - # permission P. - # If resource_selector is specified, the resource section of the result - # will be determined by the selector, and this flag will have no effect. - # Default is false. + # permission P, and the results include an IAM policy with P on a GCP folder, + # the results will also include resources in that folder with permission P. If + # resource_selector is specified, the resource section of the result will be + # determined by the selector, and this flag will have no effect. Default is + # false. # Corresponds to the JSON property `expandResources` # @return [Boolean] attr_accessor :expand_resources alias_method :expand_resources?, :expand_resources # Optional. If true, the access section of result will expand any roles - # appearing in IAM policy bindings to include their permissions. - # If access_selector is specified, the access section of the result - # will be determined by the selector, and this flag will have no effect. - # Default is false. + # appearing in IAM policy bindings to include their permissions. If + # access_selector is specified, the access section of the result will be + # determined by the selector, and this flag will have no effect. Default is + # false. # Corresponds to the JSON property `expandRoles` # @return [Boolean] attr_accessor :expand_roles alias_method :expand_roles?, :expand_roles - # Optional. If true, the result will output group identity edges, starting - # from the binding's group members, to any expanded identities. - # Default is false. + # Optional. If true, the result will output group identity edges, starting from + # the binding's group members, to any expanded identities. Default is false. # Corresponds to the JSON property `outputGroupEdges` # @return [Boolean] attr_accessor :output_group_edges alias_method :output_group_edges?, :output_group_edges - # Optional. If true, the result will output resource edges, starting - # from the policy attached resource, to any expanded resources. - # Default is false. + # Optional. If true, the result will output resource edges, starting from the + # policy attached resource, to any expanded resources. Default is false. # Corresponds to the JSON property `outputResourceEdges` # @return [Boolean] attr_accessor :output_resource_edges @@ -879,10 +823,9 @@ module Google class ResourceSelector include Google::Apis::Core::Hashable - # Required. The [full resource - # name](https://cloud.google.com/asset-inventory/docs/resource-name-format) - # of a resource of [supported resource - # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types# + # Required. The [full resource name](https://cloud.google.com/asset-inventory/ + # docs/resource-name-format) of a resource of [supported resource types](https:// + # cloud.google.com/asset-inventory/docs/supported-asset-types# # analyzable_asset_types). # Corresponds to the JSON property `fullResourceName` # @return [String] @@ -898,12 +841,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 @@ -912,15 +855,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>] 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 diff --git a/generated/google/apis/cloudasset_v1p4beta1/service.rb b/generated/google/apis/cloudasset_v1p4beta1/service.rb index 7746301ad..f2896b0a2 100644 --- a/generated/google/apis/cloudasset_v1p4beta1/service.rb +++ b/generated/google/apis/cloudasset_v1p4beta1/service.rb @@ -47,102 +47,85 @@ module Google @batch_path = 'batch' end - # Analyzes IAM policies to answer which identities have what accesses on - # which resources. + # Analyzes IAM policies to answer which identities have what accesses on which + # resources. # @param [String] parent # Required. The relative name of the root asset. Only resources and IAM policies - # within - # the parent will be analyzed. This can only be an organization number (such - # as "organizations/123") or a folder number (such as "folders/123"). - # To know how to get organization id, visit [here - # ](https://cloud.google.com/resource-manager/docs/creating-managing- - # organization#retrieving_your_organization_id). - # To know how to get folder id, visit [here - # ](https://cloud.google.com/resource-manager/docs/creating-managing-folders# + # within the parent will be analyzed. This can only be an organization number ( + # such as "organizations/123") or a folder number (such as "folders/123"). To + # know how to get organization id, visit [here ](https://cloud.google.com/ + # resource-manager/docs/creating-managing-organization# + # retrieving_your_organization_id). To know how to get folder id, visit [here ]( + # https://cloud.google.com/resource-manager/docs/creating-managing-folders# # viewing_or_listing_folders_and_projects). # @param [Array, String] analysis_query_access_selector_permissions # Optional. The permissions to appear in result. # @param [Array, String] analysis_query_access_selector_roles # Optional. The roles to appear in result. # @param [String] analysis_query_identity_selector_identity - # Required. The identity appear in the form of members in - # [IAM policy - # binding](https://cloud.google.com/iam/reference/rest/v1/Binding). - # The examples of supported forms are: - # "user:mike@example.com", - # "group:admins@example.com", - # "domain:google.com", - # "serviceAccount:my-project-id@appspot.gserviceaccount.com". - # Notice that wildcard characters (such as * and ?) are not supported. - # You must give a specific identity. + # Required. The identity appear in the form of members in [IAM policy binding]( + # https://cloud.google.com/iam/reference/rest/v1/Binding). The examples of + # supported forms are: "user:mike@example.com", "group:admins@example.com", " + # domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com". + # Notice that wildcard characters (such as * and ?) are not supported. You must + # give a specific identity. # @param [String] analysis_query_resource_selector_full_resource_name - # Required. The [full resource - # name](https://cloud.google.com/asset-inventory/docs/resource-name-format) - # of a resource of [supported resource - # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types# + # Required. The [full resource name](https://cloud.google.com/asset-inventory/ + # docs/resource-name-format) of a resource of [supported resource types](https:// + # cloud.google.com/asset-inventory/docs/supported-asset-types# # analyzable_asset_types). # @param [Boolean] options_analyze_service_account_impersonation # Optional. If true, the response will include access analysis from identities - # to - # resources via service account impersonation. This is a very expensive - # operation, because many derived queries will be executed. We highly - # recommend you use AssetService.ExportIamPolicyAnalysis rpc instead. - # For example, if the request analyzes for which resources user A has - # permission P, and there's an IAM policy states user A has - # iam.serviceAccounts.getAccessToken permission to a service account SA, - # and there's another IAM policy states service account SA has permission P - # to a GCP folder F, then user A potentially has access to the GCP folder - # F. And those advanced analysis results will be included in - # AnalyzeIamPolicyResponse.service_account_impersonation_analysis. - # Another example, if the request analyzes for who has - # permission P to a GCP folder F, and there's an IAM policy states user A - # has iam.serviceAccounts.actAs permission to a service account SA, and - # there's another IAM policy states service account SA has permission P to - # the GCP folder F, then user A potentially has access to the GCP folder - # F. And those advanced analysis results will be included in - # AnalyzeIamPolicyResponse.service_account_impersonation_analysis. - # Default is false. + # to resources via service account impersonation. This is a very expensive + # operation, because many derived queries will be executed. We highly recommend + # you use AssetService.ExportIamPolicyAnalysis rpc instead. For example, if the + # request analyzes for which resources user A has permission P, and there's an + # IAM policy states user A has iam.serviceAccounts.getAccessToken permission to + # a service account SA, and there's another IAM policy states service account SA + # has permission P to a GCP folder F, then user A potentially has access to the + # GCP folder F. And those advanced analysis results will be included in + # AnalyzeIamPolicyResponse.service_account_impersonation_analysis. Another + # example, if the request analyzes for who has permission P to a GCP folder F, + # and there's an IAM policy states user A has iam.serviceAccounts.actAs + # permission to a service account SA, and there's another IAM policy states + # service account SA has permission P to the GCP folder F, then user A + # potentially has access to the GCP folder F. And those advanced analysis + # results will be included in AnalyzeIamPolicyResponse. + # service_account_impersonation_analysis. Default is false. # @param [String] options_execution_timeout - # Optional. Amount of time executable has to complete. See JSON representation - # of - # [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json). + # Optional. Amount of time executable has to complete. See JSON representation + # of [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json). # If this field is set with a value less than the RPC deadline, and the - # execution of your query hasn't finished in the specified - # execution timeout, you will get a response with partial result. - # Otherwise, your query's execution will continue until the RPC deadline. - # If it's not finished until then, you will get a DEADLINE_EXCEEDED error. - # Default is empty. + # execution of your query hasn't finished in the specified execution timeout, + # you will get a response with partial result. Otherwise, your query's execution + # will continue until the RPC deadline. If it's not finished until then, you + # will get a DEADLINE_EXCEEDED error. Default is empty. # @param [Boolean] options_expand_groups - # Optional. If true, the identities section of the result will expand any - # Google groups appearing in an IAM policy binding. - # If identity_selector is specified, the identity in the result will - # be determined by the selector, and this flag will have no effect. - # Default is false. + # Optional. If true, the identities section of the result will expand any Google + # groups appearing in an IAM policy binding. If identity_selector is specified, + # the identity in the result will be determined by the selector, and this flag + # will have no effect. Default is false. # @param [Boolean] options_expand_resources - # Optional. If true, the resource section of the result will expand any - # resource attached to an IAM policy to include resources lower in the - # resource hierarchy. + # Optional. If true, the resource section of the result will expand any resource + # attached to an IAM policy to include resources lower in the resource hierarchy. # For example, if the request analyzes for which resources user A has - # permission P, and the results include an IAM policy with P on a GCP - # folder, the results will also include resources in that folder with - # permission P. - # If resource_selector is specified, the resource section of the result - # will be determined by the selector, and this flag will have no effect. - # Default is false. + # permission P, and the results include an IAM policy with P on a GCP folder, + # the results will also include resources in that folder with permission P. If + # resource_selector is specified, the resource section of the result will be + # determined by the selector, and this flag will have no effect. Default is + # false. # @param [Boolean] options_expand_roles # Optional. If true, the access section of result will expand any roles - # appearing in IAM policy bindings to include their permissions. - # If access_selector is specified, the access section of the result - # will be determined by the selector, and this flag will have no effect. - # Default is false. + # appearing in IAM policy bindings to include their permissions. If + # access_selector is specified, the access section of the result will be + # determined by the selector, and this flag will have no effect. Default is + # false. # @param [Boolean] options_output_group_edges - # Optional. If true, the result will output group identity edges, starting - # from the binding's group members, to any expanded identities. - # Default is false. + # Optional. If true, the result will output group identity edges, starting from + # the binding's group members, to any expanded identities. Default is false. # @param [Boolean] options_output_resource_edges - # Optional. If true, the result will output resource edges, starting - # from the policy attached resource, to any expanded resources. - # Default is false. + # Optional. If true, the result will output resource edges, starting from the + # policy attached resource, to any expanded resources. Default is false. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -181,24 +164,21 @@ module Google execute_or_queue_command(command, &block) end - # Exports the answers of which identities have what accesses on which - # resources to a Google Cloud Storage destination. The output format is - # the JSON format that represents a AnalyzeIamPolicyResponse - # in the JSON format. - # This method implements the google.longrunning.Operation, which allows - # you to keep track of the export. We recommend intervals of at least 2 - # seconds with exponential retry to poll the export operation result. The - # metadata contains the request to help callers to map responses to requests. + # Exports the answers of which identities have what accesses on which resources + # to a Google Cloud Storage destination. The output format is the JSON format + # that represents a AnalyzeIamPolicyResponse in the JSON format. This method + # implements the google.longrunning.Operation, which allows you to keep track of + # the export. We recommend intervals of at least 2 seconds with exponential + # retry to poll the export operation result. The metadata contains the request + # to help callers to map responses to requests. # @param [String] parent # Required. The relative name of the root asset. Only resources and IAM policies - # within - # the parent will be analyzed. This can only be an organization number (such - # as "organizations/123") or a folder number (such as "folders/123"). - # To know how to get organization id, visit [here - # ](https://cloud.google.com/resource-manager/docs/creating-managing- - # organization#retrieving_your_organization_id). - # To know how to get folder id, visit [here - # ](https://cloud.google.com/resource-manager/docs/creating-managing-folders# + # within the parent will be analyzed. This can only be an organization number ( + # such as "organizations/123") or a folder number (such as "folders/123"). To + # know how to get organization id, visit [here ](https://cloud.google.com/ + # resource-manager/docs/creating-managing-organization# + # retrieving_your_organization_id). To know how to get folder id, visit [here ]( + # https://cloud.google.com/resource-manager/docs/creating-managing-folders# # viewing_or_listing_folders_and_projects). # @param [Google::Apis::CloudassetV1p4beta1::ExportIamPolicyAnalysisRequest] export_iam_policy_analysis_request_object # @param [String] fields diff --git a/generated/google/apis/cloudasset_v1p5beta1.rb b/generated/google/apis/cloudasset_v1p5beta1.rb index e088c6803..1f75420b9 100644 --- a/generated/google/apis/cloudasset_v1p5beta1.rb +++ b/generated/google/apis/cloudasset_v1p5beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/asset-inventory/docs/quickstart module CloudassetV1p5beta1 VERSION = 'V1p5beta1' - REVISION = '20200731' + REVISION = '20200810' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudasset_v1p5beta1/classes.rb b/generated/google/apis/cloudasset_v1p5beta1/classes.rb index 398adff9f..56a8c5c39 100644 --- a/generated/google/apis/cloudasset_v1p5beta1/classes.rb +++ b/generated/google/apis/cloudasset_v1p5beta1/classes.rb @@ -22,15 +22,12 @@ module Google module Apis module CloudassetV1p5beta1 - # An asset in Google Cloud. An asset can be any resource in the Google Cloud - # [resource - # hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform- - # resource-hierarchy), - # a resource outside the Google Cloud resource hierarchy (such as Google - # Kubernetes Engine clusters and objects), or a policy (e.g. Cloud IAM policy). - # See [Supported asset - # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - # for more information. + # An asset in Google Cloud. An asset can be any resource in the Google Cloud [ + # resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud- + # platform-resource-hierarchy), a resource outside the Google Cloud resource + # hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy + # (e.g. Cloud IAM policy). See [Supported asset types](https://cloud.google.com/ + # asset-inventory/docs/supported-asset-types) for more information. class Asset include Google::Apis::Core::Hashable @@ -42,114 +39,74 @@ module Google attr_accessor :access_level # `AccessPolicy` is a container for `AccessLevels` (which define the necessary - # attributes to use Google Cloud services) and `ServicePerimeters` (which - # define regions of services able to freely pass data within a perimeter). An - # access policy is globally visible within an organization, and the - # restrictions it specifies apply to all projects within an organization. + # attributes to use Google Cloud services) and `ServicePerimeters` (which define + # regions of services able to freely pass data within a perimeter). An access + # policy is globally visible within an organization, and the restrictions it + # specifies apply to all projects within an organization. # Corresponds to the JSON property `accessPolicy` # @return [Google::Apis::CloudassetV1p5beta1::GoogleIdentityAccesscontextmanagerV1AccessPolicy] attr_accessor :access_policy - # The ancestry path of an asset in Google Cloud [resource - # hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform- - # resource-hierarchy), - # represented as a list of relative resource names. An ancestry path starts - # with the closest ancestor in the hierarchy and ends at root. If the asset - # is a project, folder, or organization, the ancestry path starts from the - # asset itself. - # Example: `["projects/123456789", "folders/5432", "organizations/1234"]` + # The ancestry path of an asset in Google Cloud [resource hierarchy](https:// + # cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), + # represented as a list of relative resource names. An ancestry path starts with + # the closest ancestor in the hierarchy and ends at root. If the asset is a + # project, folder, or organization, the ancestry path starts from the asset + # itself. Example: `["projects/123456789", "folders/5432", "organizations/1234"]` # Corresponds to the JSON property `ancestors` # @return [Array] attr_accessor :ancestors - # The type of the asset. Example: `compute.googleapis.com/Disk` - # See [Supported asset - # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) - # for more information. + # The type of the asset. Example: `compute.googleapis.com/Disk` See [Supported + # asset types](https://cloud.google.com/asset-inventory/docs/supported-asset- + # types) for more information. # Corresponds to the JSON property `assetType` # @return [String] attr_accessor :asset_type # 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 `iamPolicy` # @return [Google::Apis::CloudassetV1p5beta1::Policy] attr_accessor :iam_policy - # The full name of the asset. Example: - # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/ - # instance1` - # See [Resource - # names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - # for more information. + # The full name of the asset. Example: `//compute.googleapis.com/projects/ + # my_project_123/zones/zone1/instances/instance1` See [Resource names](https:// + # cloud.google.com/apis/design/resource_names#full_resource_name) for more + # information. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # A representation of an [organization - # policy](https://cloud.google.com/resource-manager/docs/organization-policy/ - # overview#organization_policy). - # There can be more than one organization policy with different constraints - # set on a given resource. + # A representation of an [organization policy](https://cloud.google.com/resource- + # manager/docs/organization-policy/overview#organization_policy). There can be + # more than one organization policy with different constraints set on a given + # resource. # Corresponds to the JSON property `orgPolicy` # @return [Array] attr_accessor :org_policy @@ -160,15 +117,14 @@ module Google attr_accessor :resource # `ServicePerimeter` describes a set of Google Cloud resources which can freely - # import and export data amongst themselves, but not export outside of the - # `ServicePerimeter`. If a request with a source within this `ServicePerimeter` + # import and export data amongst themselves, but not export outside of the ` + # ServicePerimeter`. If a request with a source within this `ServicePerimeter` # has a target outside of the `ServicePerimeter`, the request will be blocked. # Otherwise the request is allowed. There are two types of Service Perimeter - - # Regular and Bridge. Regular Service Perimeters cannot overlap, a single - # Google Cloud project can only belong to a single regular Service Perimeter. - # Service Perimeter Bridges can contain only Google Cloud projects as members, - # a single Google Cloud project may belong to multiple Service Perimeter - # Bridges. + # Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google + # Cloud project can only belong to a single regular Service Perimeter. Service + # Perimeter Bridges can contain only Google Cloud projects as members, a single + # Google Cloud project may belong to multiple Service Perimeter Bridges. # Corresponds to the JSON property `servicePerimeter` # @return [Google::Apis::CloudassetV1p5beta1::GoogleIdentityAccesscontextmanagerV1ServicePerimeter] attr_accessor :service_perimeter @@ -191,53 +147,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 @@ -246,9 +170,9 @@ module Google # @return [Array] 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 @@ -264,28 +188,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] @@ -311,69 +222,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::CloudassetV1p5beta1::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] 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 @@ -390,52 +289,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 @@ -458,45 +348,29 @@ module Google class GoogleCloudOrgpolicyV1BooleanPolicy include Google::Apis::Core::Hashable - # If `true`, then the `Policy` is enforced. If `false`, then any - # configuration is acceptable. - # Suppose you have a `Constraint` - # `constraints/compute.disableSerialPortAccess` with `constraint_default` - # set to `ALLOW`. A `Policy` for that `Constraint` exhibits the following - # behavior: - # - If the `Policy` at this resource has enforced set to `false`, serial - # port connection attempts will be allowed. - # - If the `Policy` at this resource has enforced set to `true`, serial - # port connection attempts will be refused. - # - If the `Policy` at this resource is `RestoreDefault`, serial port - # connection attempts will be allowed. - # - If no `Policy` is set at this resource or anywhere higher in the - # resource hierarchy, serial port connection attempts will be allowed. - # - If no `Policy` is set at this resource, but one exists higher in the - # resource hierarchy, the behavior is as if the`Policy` were set at - # this resource. - # The following examples demonstrate the different possible layerings: - # Example 1 (nearest `Constraint` wins): - # `organizations/foo` has a `Policy` with: - # `enforced: false` - # `projects/bar` has no `Policy` set. - # The constraint at `projects/bar` and `organizations/foo` will not be - # enforced. - # Example 2 (enforcement gets replaced): - # `organizations/foo` has a `Policy` with: - # `enforced: false` - # `projects/bar` has a `Policy` with: - # `enforced: true` - # The constraint at `organizations/foo` is not enforced. - # The constraint at `projects/bar` is enforced. - # Example 3 (RestoreDefault): - # `organizations/foo` has a `Policy` with: - # `enforced: true` - # `projects/bar` has a `Policy` with: - # `RestoreDefault: ``` - # The constraint at `organizations/foo` is enforced. - # The constraint at `projects/bar` is not enforced, because - # `constraint_default` for the `Constraint` is `ALLOW`. + # If `true`, then the `Policy` is enforced. If `false`, then any configuration + # is acceptable. Suppose you have a `Constraint` `constraints/compute. + # disableSerialPortAccess` with `constraint_default` set to `ALLOW`. A `Policy` + # for that `Constraint` exhibits the following behavior: - If the `Policy` at + # this resource has enforced set to `false`, serial port connection attempts + # will be allowed. - If the `Policy` at this resource has enforced set to `true`, + # serial port connection attempts will be refused. - If the `Policy` at this + # resource is `RestoreDefault`, serial port connection attempts will be allowed. + # - If no `Policy` is set at this resource or anywhere higher in the resource + # hierarchy, serial port connection attempts will be allowed. - If no `Policy` + # is set at this resource, but one exists higher in the resource hierarchy, the + # behavior is as if the`Policy` were set at this resource. The following + # examples demonstrate the different possible layerings: Example 1 (nearest ` + # Constraint` wins): `organizations/foo` has a `Policy` with: `enforced: false` ` + # projects/bar` has no `Policy` set. The constraint at `projects/bar` and ` + # organizations/foo` will not be enforced. Example 2 (enforcement gets replaced): + # `organizations/foo` has a `Policy` with: `enforced: false` `projects/bar` has + # a `Policy` with: `enforced: true` The constraint at `organizations/foo` is not + # enforced. The constraint at `projects/bar` is enforced. Example 3 ( + # RestoreDefault): `organizations/foo` has a `Policy` with: `enforced: true` ` + # projects/bar` has a `Policy` with: `RestoreDefault: ``` The constraint at ` + # organizations/foo` is enforced. The constraint at `projects/bar` is not + # enforced, because `constraint_default` for the `Constraint` is `ALLOW`. # Corresponds to the JSON property `enforced` # @return [Boolean] attr_accessor :enforced @@ -512,26 +386,22 @@ module Google end end - # Used in `policy_type` to specify how `list_policy` behaves at this - # resource. - # `ListPolicy` can define specific values and subtrees of Cloud Resource - # Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that - # are allowed or denied by setting the `allowed_values` and `denied_values` - # fields. This is achieved by using the `under:` and optional `is:` prefixes. - # The `under:` prefix is used to denote resource subtree values. - # The `is:` prefix is used to denote specific values, and is required only - # if the value contains a ":". Values prefixed with "is:" are treated the - # same as values with no prefix. - # Ancestry subtrees must be in one of the following formats: - # - "projects/", e.g. "projects/tokyo-rain-123" - # - "folders/", e.g. "folders/1234" - # - "organizations/", e.g. "organizations/1234" - # The `supports_under` field of the associated `Constraint` defines whether - # ancestry prefixes can be used. You can set `allowed_values` and - # `denied_values` in the same `Policy` if `all_values` is - # `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all - # values. If `all_values` is set to either `ALLOW` or `DENY`, - # `allowed_values` and `denied_values` must be unset. + # Used in `policy_type` to specify how `list_policy` behaves at this resource. ` + # ListPolicy` can define specific values and subtrees of Cloud Resource Manager + # resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed + # or denied by setting the `allowed_values` and `denied_values` fields. This is + # achieved by using the `under:` and optional `is:` prefixes. The `under:` + # prefix is used to denote resource subtree values. The `is:` prefix is used to + # denote specific values, and is required only if the value contains a ":". + # Values prefixed with "is:" are treated the same as values with no prefix. + # Ancestry subtrees must be in one of the following formats: - "projects/", e.g. + # "projects/tokyo-rain-123" - "folders/", e.g. "folders/1234" - "organizations/", + # e.g. "organizations/1234" The `supports_under` field of the associated ` + # Constraint` defines whether ancestry prefixes can be used. You can set ` + # allowed_values` and `denied_values` in the same `Policy` if `all_values` is ` + # ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all + # values. If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values` + # and `denied_values` must be unset. class GoogleCloudOrgpolicyV1ListPolicy include Google::Apis::Core::Hashable @@ -540,112 +410,83 @@ module Google # @return [String] attr_accessor :all_values - # List of values allowed at this resource. Can only be set if `all_values` - # is set to `ALL_VALUES_UNSPECIFIED`. + # List of values allowed at this resource. Can only be set if `all_values` is + # set to `ALL_VALUES_UNSPECIFIED`. # Corresponds to the JSON property `allowedValues` # @return [Array] attr_accessor :allowed_values - # List of values denied at this resource. Can only be set if `all_values` - # is set to `ALL_VALUES_UNSPECIFIED`. + # List of values denied at this resource. Can only be set if `all_values` is set + # to `ALL_VALUES_UNSPECIFIED`. # Corresponds to the JSON property `deniedValues` # @return [Array] attr_accessor :denied_values - # Determines the inheritance behavior for this `Policy`. - # By default, a `ListPolicy` set at a resource supersedes any `Policy` set - # anywhere up the resource hierarchy. However, if `inherit_from_parent` is - # set to `true`, then the values from the effective `Policy` of the parent - # resource are inherited, meaning the values set in this `Policy` are - # added to the values inherited up the hierarchy. - # Setting `Policy` hierarchies that inherit both allowed values and denied - # values isn't recommended in most circumstances to keep the configuration - # simple and understandable. However, it is possible to set a `Policy` with - # `allowed_values` set that inherits a `Policy` with `denied_values` set. - # In this case, the values that are allowed must be in `allowed_values` and - # not present in `denied_values`. - # For example, suppose you have a `Constraint` - # `constraints/serviceuser.services`, which has a `constraint_type` of - # `list_constraint`, and with `constraint_default` set to `ALLOW`. - # Suppose that at the Organization level, a `Policy` is applied that - # restricts the allowed API activations to ``E1`, `E2``. Then, if a - # `Policy` is applied to a project below the Organization that has - # `inherit_from_parent` set to `false` and field all_values set to DENY, - # then an attempt to activate any API will be denied. - # The following examples demonstrate different possible layerings for - # `projects/bar` parented by `organizations/foo`: - # Example 1 (no inherited values): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values:"E2"` - # `projects/bar` has `inherit_from_parent` `false` and values: - # `allowed_values: "E3" allowed_values: "E4"` - # The accepted values at `organizations/foo` are `E1`, `E2`. - # The accepted values at `projects/bar` are `E3`, and `E4`. - # Example 2 (inherited values): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values:"E2"` - # `projects/bar` has a `Policy` with values: - # `value: "E3" value: "E4" inherit_from_parent: true` - # The accepted values at `organizations/foo` are `E1`, `E2`. - # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`. - # Example 3 (inheriting both allowed and denied values): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values: "E2"` - # `projects/bar` has a `Policy` with: - # `denied_values: "E1"` - # The accepted values at `organizations/foo` are `E1`, `E2`. - # The value accepted at `projects/bar` is `E2`. - # Example 4 (RestoreDefault): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values:"E2"` - # `projects/bar` has a `Policy` with values: - # `RestoreDefault: ``` - # The accepted values at `organizations/foo` are `E1`, `E2`. - # The accepted values at `projects/bar` are either all or none depending on - # the value of `constraint_default` (if `ALLOW`, all; if - # `DENY`, none). - # Example 5 (no policy inherits parent policy): - # `organizations/foo` has no `Policy` set. - # `projects/bar` has no `Policy` set. - # The accepted values at both levels are either all or none depending on - # the value of `constraint_default` (if `ALLOW`, all; if - # `DENY`, none). - # Example 6 (ListConstraint allowing all): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values: "E2"` - # `projects/bar` has a `Policy` with: - # `all: ALLOW` - # The accepted values at `organizations/foo` are `E1`, E2`. - # Any value is accepted at `projects/bar`. - # Example 7 (ListConstraint allowing none): - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "E1" allowed_values: "E2"` - # `projects/bar` has a `Policy` with: - # `all: DENY` - # The accepted values at `organizations/foo` are `E1`, E2`. - # No value is accepted at `projects/bar`. - # Example 10 (allowed and denied subtrees of Resource Manager hierarchy): - # Given the following resource hierarchy - # O1->`F1, F2`; F1->`P1`; F2->`P2, P3`, - # `organizations/foo` has a `Policy` with values: - # `allowed_values: "under:organizations/O1"` - # `projects/bar` has a `Policy` with: - # `allowed_values: "under:projects/P3"` - # `denied_values: "under:folders/F2"` - # The accepted values at `organizations/foo` are `organizations/O1`, - # `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`, - # `projects/P3`. - # The accepted values at `projects/bar` are `organizations/O1`, - # `folders/F1`, `projects/P1`. + # Determines the inheritance behavior for this `Policy`. By default, a ` + # ListPolicy` set at a resource supersedes any `Policy` set anywhere up the + # resource hierarchy. However, if `inherit_from_parent` is set to `true`, then + # the values from the effective `Policy` of the parent resource are inherited, + # meaning the values set in this `Policy` are added to the values inherited up + # the hierarchy. Setting `Policy` hierarchies that inherit both allowed values + # and denied values isn't recommended in most circumstances to keep the + # configuration simple and understandable. However, it is possible to set a ` + # Policy` with `allowed_values` set that inherits a `Policy` with `denied_values` + # set. In this case, the values that are allowed must be in `allowed_values` + # and not present in `denied_values`. For example, suppose you have a ` + # Constraint` `constraints/serviceuser.services`, which has a `constraint_type` + # of `list_constraint`, and with `constraint_default` set to `ALLOW`. Suppose + # that at the Organization level, a `Policy` is applied that restricts the + # allowed API activations to ``E1`, `E2``. Then, if a `Policy` is applied to a + # project below the Organization that has `inherit_from_parent` set to `false` + # and field all_values set to DENY, then an attempt to activate any API will be + # denied. The following examples demonstrate different possible layerings for ` + # projects/bar` parented by `organizations/foo`: Example 1 (no inherited values): + # `organizations/foo` has a `Policy` with values: `allowed_values: "E1" + # allowed_values:"E2"` `projects/bar` has `inherit_from_parent` `false` and + # values: `allowed_values: "E3" allowed_values: "E4"` The accepted values at ` + # organizations/foo` are `E1`, `E2`. The accepted values at `projects/bar` are ` + # E3`, and `E4`. Example 2 (inherited values): `organizations/foo` has a `Policy` + # with values: `allowed_values: "E1" allowed_values:"E2"` `projects/bar` has a ` + # Policy` with values: `value: "E3" value: "E4" inherit_from_parent: true` The + # accepted values at `organizations/foo` are `E1`, `E2`. The accepted values at ` + # projects/bar` are `E1`, `E2`, `E3`, and `E4`. Example 3 (inheriting both + # allowed and denied values): `organizations/foo` has a `Policy` with values: ` + # allowed_values: "E1" allowed_values: "E2"` `projects/bar` has a `Policy` with: + # `denied_values: "E1"` The accepted values at `organizations/foo` are `E1`, `E2` + # . The value accepted at `projects/bar` is `E2`. Example 4 (RestoreDefault): ` + # organizations/foo` has a `Policy` with values: `allowed_values: "E1" + # allowed_values:"E2"` `projects/bar` has a `Policy` with values: ` + # RestoreDefault: ``` The accepted values at `organizations/foo` are `E1`, `E2`. + # The accepted values at `projects/bar` are either all or none depending on the + # value of `constraint_default` (if `ALLOW`, all; if `DENY`, none). Example 5 ( + # no policy inherits parent policy): `organizations/foo` has no `Policy` set. ` + # projects/bar` has no `Policy` set. The accepted values at both levels are + # either all or none depending on the value of `constraint_default` (if `ALLOW`, + # all; if `DENY`, none). Example 6 (ListConstraint allowing all): `organizations/ + # foo` has a `Policy` with values: `allowed_values: "E1" allowed_values: "E2"` ` + # projects/bar` has a `Policy` with: `all: ALLOW` The accepted values at ` + # organizations/foo` are `E1`, E2`. Any value is accepted at `projects/bar`. + # Example 7 (ListConstraint allowing none): `organizations/foo` has a `Policy` + # with values: `allowed_values: "E1" allowed_values: "E2"` `projects/bar` has a ` + # Policy` with: `all: DENY` The accepted values at `organizations/foo` are `E1`, + # E2`. No value is accepted at `projects/bar`. Example 10 (allowed and denied + # subtrees of Resource Manager hierarchy): Given the following resource + # hierarchy O1->`F1, F2`; F1->`P1`; F2->`P2, P3`, `organizations/foo` has a ` + # Policy` with values: `allowed_values: "under:organizations/O1"` `projects/bar` + # has a `Policy` with: `allowed_values: "under:projects/P3"` `denied_values: " + # under:folders/F2"` The accepted values at `organizations/foo` are ` + # organizations/O1`, `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`, ` + # projects/P3`. The accepted values at `projects/bar` are `organizations/O1`, ` + # folders/F1`, `projects/P1`. # Corresponds to the JSON property `inheritFromParent` # @return [Boolean] attr_accessor :inherit_from_parent alias_method :inherit_from_parent?, :inherit_from_parent - # Optional. The Google Cloud Console will try to default to a configuration - # that matches the value specified in this `Policy`. If `suggested_value` - # is not set, it will inherit the value specified higher in the hierarchy, - # unless `inherit_from_parent` is `false`. + # Optional. The Google Cloud Console will try to default to a configuration that + # matches the value specified in this `Policy`. If `suggested_value` is not set, + # it will inherit the value specified higher in the hierarchy, unless ` + # inherit_from_parent` is `false`. # Corresponds to the JSON property `suggestedValue` # @return [String] attr_accessor :suggested_value @@ -675,76 +516,65 @@ module Google # @return [Google::Apis::CloudassetV1p5beta1::GoogleCloudOrgpolicyV1BooleanPolicy] attr_accessor :boolean_policy - # The name of the `Constraint` the `Policy` is configuring, for example, - # `constraints/serviceuser.services`. - # A [list of available - # constraints](/resource-manager/docs/organization-policy/org-policy-constraints) - # is available. + # The name of the `Constraint` the `Policy` is configuring, for example, ` + # constraints/serviceuser.services`. A [list of available constraints](/resource- + # manager/docs/organization-policy/org-policy-constraints) is available. # Immutable after creation. # Corresponds to the JSON property `constraint` # @return [String] attr_accessor :constraint # An opaque tag indicating the current version of the `Policy`, used for - # concurrency control. - # When the `Policy` is returned from either a `GetPolicy` or a - # `ListOrgPolicy` request, this `etag` indicates the version of the current - # `Policy` to use when executing a read-modify-write loop. - # When the `Policy` is returned from a `GetEffectivePolicy` request, the - # `etag` will be unset. - # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value - # that was returned from a `GetOrgPolicy` request as part of a - # read-modify-write loop for concurrency control. Not setting the `etag`in a - # `SetOrgPolicy` request will result in an unconditional write of the - # `Policy`. + # concurrency control. When the `Policy` is returned from either a `GetPolicy` + # or a `ListOrgPolicy` request, this `etag` indicates the version of the current + # `Policy` to use when executing a read-modify-write loop. When the `Policy` is + # returned from a `GetEffectivePolicy` request, the `etag` will be unset. When + # the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value that was + # returned from a `GetOrgPolicy` request as part of a read-modify-write loop for + # concurrency control. Not setting the `etag`in a `SetOrgPolicy` request will + # result in an unconditional write of the `Policy`. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag - # Used in `policy_type` to specify how `list_policy` behaves at this - # resource. - # `ListPolicy` can define specific values and subtrees of Cloud Resource - # Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that - # are allowed or denied by setting the `allowed_values` and `denied_values` - # fields. This is achieved by using the `under:` and optional `is:` prefixes. - # The `under:` prefix is used to denote resource subtree values. - # The `is:` prefix is used to denote specific values, and is required only - # if the value contains a ":". Values prefixed with "is:" are treated the - # same as values with no prefix. - # Ancestry subtrees must be in one of the following formats: - # - "projects/", e.g. "projects/tokyo-rain-123" - # - "folders/", e.g. "folders/1234" - # - "organizations/", e.g. "organizations/1234" - # The `supports_under` field of the associated `Constraint` defines whether - # ancestry prefixes can be used. You can set `allowed_values` and - # `denied_values` in the same `Policy` if `all_values` is - # `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all - # values. If `all_values` is set to either `ALLOW` or `DENY`, - # `allowed_values` and `denied_values` must be unset. + # Used in `policy_type` to specify how `list_policy` behaves at this resource. ` + # ListPolicy` can define specific values and subtrees of Cloud Resource Manager + # resource hierarchy (`Organizations`, `Folders`, `Projects`) that are allowed + # or denied by setting the `allowed_values` and `denied_values` fields. This is + # achieved by using the `under:` and optional `is:` prefixes. The `under:` + # prefix is used to denote resource subtree values. The `is:` prefix is used to + # denote specific values, and is required only if the value contains a ":". + # Values prefixed with "is:" are treated the same as values with no prefix. + # Ancestry subtrees must be in one of the following formats: - "projects/", e.g. + # "projects/tokyo-rain-123" - "folders/", e.g. "folders/1234" - "organizations/", + # e.g. "organizations/1234" The `supports_under` field of the associated ` + # Constraint` defines whether ancestry prefixes can be used. You can set ` + # allowed_values` and `denied_values` in the same `Policy` if `all_values` is ` + # ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all + # values. If `all_values` is set to either `ALLOW` or `DENY`, `allowed_values` + # and `denied_values` must be unset. # Corresponds to the JSON property `listPolicy` # @return [Google::Apis::CloudassetV1p5beta1::GoogleCloudOrgpolicyV1ListPolicy] attr_accessor :list_policy - # Ignores policies set above this resource and restores the - # `constraint_default` enforcement behavior of the specific `Constraint` at - # this resource. - # Suppose that `constraint_default` is set to `ALLOW` for the - # `Constraint` `constraints/serviceuser.services`. Suppose that organization - # foo.com sets a `Policy` at their Organization resource node that restricts - # the allowed service activations to deny all service activations. They - # could then set a `Policy` with the `policy_type` `restore_default` on - # several experimental projects, restoring the `constraint_default` - # enforcement of the `Constraint` for only those projects, allowing those - # projects to have all services activated. + # Ignores policies set above this resource and restores the `constraint_default` + # enforcement behavior of the specific `Constraint` at this resource. Suppose + # that `constraint_default` is set to `ALLOW` for the `Constraint` `constraints/ + # serviceuser.services`. Suppose that organization foo.com sets a `Policy` at + # their Organization resource node that restricts the allowed service + # activations to deny all service activations. They could then set a `Policy` + # with the `policy_type` `restore_default` on several experimental projects, + # restoring the `constraint_default` enforcement of the `Constraint` for only + # those projects, allowing those projects to have all services activated. # Corresponds to the JSON property `restoreDefault` # @return [Google::Apis::CloudassetV1p5beta1::GoogleCloudOrgpolicyV1RestoreDefault] attr_accessor :restore_default - # The time stamp the `Policy` was previously updated. This is set by the - # server, not specified by the caller, and represents the last time a call to - # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will - # be ignored. + # The time stamp the `Policy` was previously updated. This is set by the server, + # not specified by the caller, and represents the last time a call to ` + # SetOrgPolicy` was made for that `Policy`. Any value set by the client will be + # ignored. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -770,17 +600,15 @@ module Google end end - # Ignores policies set above this resource and restores the - # `constraint_default` enforcement behavior of the specific `Constraint` at - # this resource. - # Suppose that `constraint_default` is set to `ALLOW` for the - # `Constraint` `constraints/serviceuser.services`. Suppose that organization - # foo.com sets a `Policy` at their Organization resource node that restricts - # the allowed service activations to deny all service activations. They - # could then set a `Policy` with the `policy_type` `restore_default` on - # several experimental projects, restoring the `constraint_default` - # enforcement of the `Constraint` for only those projects, allowing those - # projects to have all services activated. + # Ignores policies set above this resource and restores the `constraint_default` + # enforcement behavior of the specific `Constraint` at this resource. Suppose + # that `constraint_default` is set to `ALLOW` for the `Constraint` `constraints/ + # serviceuser.services`. Suppose that organization foo.com sets a `Policy` at + # their Organization resource node that restricts the allowed service + # activations to deny all service activations. They could then set a `Policy` + # with the `policy_type` `restore_default` on several experimental projects, + # restoring the `constraint_default` enforcement of the `Constraint` for only + # those projects, allowing those projects to have all services activated. class GoogleCloudOrgpolicyV1RestoreDefault include Google::Apis::Core::Hashable @@ -805,8 +633,8 @@ module Google attr_accessor :basic # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language - # to represent the necessary conditions for the level to apply to a request. - # See CEL spec at: https://github.com/google/cel-spec + # to represent the necessary conditions for the level to apply to a request. See + # CEL spec at: https://github.com/google/cel-spec # Corresponds to the JSON property `custom` # @return [Google::Apis::CloudassetV1p5beta1::GoogleIdentityAccesscontextmanagerV1CustomLevel] attr_accessor :custom @@ -816,10 +644,10 @@ module Google # @return [String] attr_accessor :description - # Required. Resource name for the Access Level. The `short_name` component - # must begin with a letter and only include alphanumeric and '_'. Format: - # `accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length - # of the `short_name` component is 50 characters. + # Required. Resource name for the Access Level. The `short_name` component must + # begin with a letter and only include alphanumeric and '_'. Format: ` + # accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length of + # the `short_name` component is 50 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -844,30 +672,29 @@ module Google end # `AccessPolicy` is a container for `AccessLevels` (which define the necessary - # attributes to use Google Cloud services) and `ServicePerimeters` (which - # define regions of services able to freely pass data within a perimeter). An - # access policy is globally visible within an organization, and the - # restrictions it specifies apply to all projects within an organization. + # attributes to use Google Cloud services) and `ServicePerimeters` (which define + # regions of services able to freely pass data within a perimeter). An access + # policy is globally visible within an organization, and the restrictions it + # specifies apply to all projects within an organization. class GoogleIdentityAccesscontextmanagerV1AccessPolicy include Google::Apis::Core::Hashable - # Output only. An opaque identifier for the current version of the - # `AccessPolicy`. This will always be a strongly validated etag, meaning that - # two Access Polices will be identical if and only if their etags are - # identical. Clients should not expect this to be in any specific format. + # Output only. An opaque identifier for the current version of the `AccessPolicy` + # . This will always be a strongly validated etag, meaning that two Access + # Polices will be identical if and only if their etags are identical. Clients + # should not expect this to be in any specific format. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # Output only. Resource name of the `AccessPolicy`. Format: - # `accessPolicies/`policy_id`` + # Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/` + # policy_id`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The parent of this `AccessPolicy` in the Cloud Resource - # Hierarchy. Currently immutable once created. Format: - # `organizations/`organization_id`` + # Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. + # Currently immutable once created. Format: `organizations/`organization_id`` # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -895,10 +722,10 @@ module Google include Google::Apis::Core::Hashable # How the `conditions` list should be combined to determine if a request is - # granted this `AccessLevel`. If AND is used, each `Condition` in - # `conditions` must be satisfied for the `AccessLevel` to be applied. If OR - # is used, at least one `Condition` in `conditions` must be satisfied for the - # `AccessLevel` to be applied. Default behavior is AND. + # granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` + # must be satisfied for the `AccessLevel` to be applied. If OR is used, at least + # one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be + # applied. Default behavior is AND. # Corresponds to the JSON property `combiningFunction` # @return [String] attr_accessor :combining_function @@ -932,54 +759,48 @@ module Google # devices to be granted access levels, it does not do any enforcement on the # device. `DevicePolicy` acts as an AND over all specified fields, and each # repeated field is an OR over its elements. Any unset fields are ignored. For - # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : - # DESKTOP_LINUX, encryption_status: ENCRYPTED`, then the DevicePolicy will be - # true for requests originating from encrypted Linux desktops and encrypted - # Windows desktops. + # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, + # encryption_status: ENCRYPTED`, then the DevicePolicy will be true for requests + # originating from encrypted Linux desktops and encrypted Windows desktops. # Corresponds to the JSON property `devicePolicy` # @return [Google::Apis::CloudassetV1p5beta1::GoogleIdentityAccesscontextmanagerV1DevicePolicy] attr_accessor :device_policy - # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for - # a CIDR IP address block, the specified IP address portion must be properly + # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a + # CIDR IP address block, the specified IP address portion must be properly # truncated (i.e. all the host bits must be zero) or the input is considered - # malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is - # not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas - # "2001:db8::1/32" is not. The originating IP of a request must be in one of - # the listed subnets in order for this Condition to be true. If empty, all IP - # addresses are allowed. + # malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. + # Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is + # not. The originating IP of a request must be in one of the listed subnets in + # order for this Condition to be true. If empty, all IP addresses are allowed. # Corresponds to the JSON property `ipSubnetworks` # @return [Array] attr_accessor :ip_subnetworks - # The request must be made by one of the provided user or service - # accounts. Groups are not supported. - # Syntax: - # `user:`emailid`` - # `serviceAccount:`emailid`` + # The request must be made by one of the provided user or service accounts. + # Groups are not supported. Syntax: `user:`emailid`` `serviceAccount:`emailid`` # If not specified, a request may come from any user. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members # Whether to negate the Condition. If true, the Condition becomes a NAND over - # its non-empty fields, each field must be false for the Condition overall to - # be satisfied. Defaults to false. + # its non-empty fields, each field must be false for the Condition overall to be + # satisfied. Defaults to false. # Corresponds to the JSON property `negate` # @return [Boolean] attr_accessor :negate alias_method :negate?, :negate - # The request must originate from one of the provided countries/regions. - # Must be valid ISO 3166-1 alpha-2 codes. + # The request must originate from one of the provided countries/regions. Must be + # valid ISO 3166-1 alpha-2 codes. # Corresponds to the JSON property `regions` # @return [Array] attr_accessor :regions # A list of other access levels defined in the same `Policy`, referenced by - # resource name. Referencing an `AccessLevel` which does not exist is an - # error. All access levels listed must be granted for the Condition - # to be true. Example: + # resource name. Referencing an `AccessLevel` which does not exist is an error. + # All access levels listed must be granted for the Condition to be true. Example: # "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` # Corresponds to the JSON property `requiredAccessLevels` # @return [Array] @@ -1001,33 +822,26 @@ module Google end # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language - # to represent the necessary conditions for the level to apply to a request. - # See CEL spec at: https://github.com/google/cel-spec + # to represent the necessary conditions for the level to apply to a request. See + # CEL spec at: https://github.com/google/cel-spec class GoogleIdentityAccesscontextmanagerV1CustomLevel 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 `expr` # @return [Google::Apis::CloudassetV1p5beta1::Expr] attr_accessor :expr @@ -1047,15 +861,13 @@ module Google # devices to be granted access levels, it does not do any enforcement on the # device. `DevicePolicy` acts as an AND over all specified fields, and each # repeated field is an OR over its elements. Any unset fields are ignored. For - # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : - # DESKTOP_LINUX, encryption_status: ENCRYPTED`, then the DevicePolicy will be - # true for requests originating from encrypted Linux desktops and encrypted - # Windows desktops. + # example, if the proto is ` os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, + # encryption_status: ENCRYPTED`, then the DevicePolicy will be true for requests + # originating from encrypted Linux desktops and encrypted Windows desktops. class GoogleIdentityAccesscontextmanagerV1DevicePolicy include Google::Apis::Core::Hashable - # Allowed device management levels, an empty list allows all management - # levels. + # Allowed device management levels, an empty list allows all management levels. # Corresponds to the JSON property `allowedDeviceManagementLevels` # @return [Array] attr_accessor :allowed_device_management_levels @@ -1108,9 +920,9 @@ module Google class GoogleIdentityAccesscontextmanagerV1OsConstraint include Google::Apis::Core::Hashable - # The minimum allowed OS version. If not set, any version of this OS - # satisfies the constraint. Format: `"major.minor.patch"`. - # Examples: `"10.5.301"`, `"9.2.1"`. + # The minimum allowed OS version. If not set, any version of this OS satisfies + # the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1" + # `. # Corresponds to the JSON property `minimumVersion` # @return [String] attr_accessor :minimum_version @@ -1120,10 +932,10 @@ module Google # @return [String] attr_accessor :os_type - # Only allows requests from devices with a verified Chrome OS. - # Verifications includes requirements that the device is enterprise-managed, - # conformant to domain policies, and the caller has permission to call - # the API targeted by the request. + # Only allows requests from devices with a verified Chrome OS. Verifications + # includes requirements that the device is enterprise-managed, conformant to + # domain policies, and the caller has permission to call the API targeted by the + # request. # Corresponds to the JSON property `requireVerifiedChromeOs` # @return [Boolean] attr_accessor :require_verified_chrome_os @@ -1142,37 +954,34 @@ module Google end # `ServicePerimeter` describes a set of Google Cloud resources which can freely - # import and export data amongst themselves, but not export outside of the - # `ServicePerimeter`. If a request with a source within this `ServicePerimeter` + # import and export data amongst themselves, but not export outside of the ` + # ServicePerimeter`. If a request with a source within this `ServicePerimeter` # has a target outside of the `ServicePerimeter`, the request will be blocked. # Otherwise the request is allowed. There are two types of Service Perimeter - - # Regular and Bridge. Regular Service Perimeters cannot overlap, a single - # Google Cloud project can only belong to a single regular Service Perimeter. - # Service Perimeter Bridges can contain only Google Cloud projects as members, - # a single Google Cloud project may belong to multiple Service Perimeter - # Bridges. + # Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google + # Cloud project can only belong to a single regular Service Perimeter. Service + # Perimeter Bridges can contain only Google Cloud projects as members, a single + # Google Cloud project may belong to multiple Service Perimeter Bridges. class GoogleIdentityAccesscontextmanagerV1ServicePerimeter include Google::Apis::Core::Hashable - # Description of the `ServicePerimeter` and its use. Does not affect - # behavior. + # Description of the `ServicePerimeter` and its use. Does not affect behavior. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Required. Resource name for the ServicePerimeter. The `short_name` - # component must begin with a letter and only include alphanumeric and '_'. - # Format: `accessPolicies/`policy_id`/servicePerimeters/`short_name`` + # Required. Resource name for the ServicePerimeter. The `short_name` component + # must begin with a letter and only include alphanumeric and '_'. Format: ` + # accessPolicies/`policy_id`/servicePerimeters/`short_name`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Perimeter type indicator. A single project is - # allowed to be a member of single regular perimeter, but multiple service - # perimeter bridges. A project cannot be a included in a perimeter bridge - # without being included in regular perimeter. For perimeter bridges, - # the restricted service list as well as access level lists must be - # empty. + # Perimeter type indicator. A single project is allowed to be a member of single + # regular perimeter, but multiple service perimeter bridges. A project cannot be + # a included in a perimeter bridge without being included in regular perimeter. + # For perimeter bridges, the restricted service list as well as access level + # lists must be empty. # Corresponds to the JSON property `perimeterType` # @return [String] attr_accessor :perimeter_type @@ -1194,16 +1003,15 @@ module Google # @return [String] attr_accessor :title - # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly - # exists for all Service Perimeters, and that spec is identical to the - # status for those Service Perimeters. When this flag is set, it inhibits the - # generation of the implicit spec, thereby allowing the user to explicitly - # provide a configuration ("spec") to use in a dry-run version of the Service - # Perimeter. This allows the user to test changes to the enforced config - # ("status") without actually enforcing them. This testing is done through - # analyzing the differences between currently enforced and suggested - # restrictions. use_explicit_dry_run_spec must bet set to True if any of the - # fields in the spec are set to non-default values. + # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists + # for all Service Perimeters, and that spec is identical to the status for those + # Service Perimeters. When this flag is set, it inhibits the generation of the + # implicit spec, thereby allowing the user to explicitly provide a configuration + # ("spec") to use in a dry-run version of the Service Perimeter. This allows the + # user to test changes to the enforced config ("status") without actually + # enforcing them. This testing is done through analyzing the differences between + # currently enforced and suggested restrictions. use_explicit_dry_run_spec must + # bet set to True if any of the fields in the spec are set to non-default values. # Corresponds to the JSON property `useExplicitDryRunSpec` # @return [Boolean] attr_accessor :use_explicit_dry_run_spec @@ -1230,14 +1038,13 @@ module Google class GoogleIdentityAccesscontextmanagerV1ServicePerimeterConfig include Google::Apis::Core::Hashable - # A list of `AccessLevel` resource names that allow resources within the - # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed - # must be in the same policy as this `ServicePerimeter`. Referencing a - # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are - # listed, resources within the perimeter can only be accessed via Google - # Cloud calls with request origins within the perimeter. Example: - # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. - # For Service Perimeter Bridge, must be empty. + # A list of `AccessLevel` resource names that allow resources within the ` + # ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must + # be in the same policy as this `ServicePerimeter`. Referencing a nonexistent ` + # AccessLevel` is a syntax error. If no `AccessLevel` names are listed, + # resources within the perimeter can only be accessed via Google Cloud calls + # with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/ + # accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. # Corresponds to the JSON property `accessLevels` # @return [Array] attr_accessor :access_levels @@ -1248,16 +1055,14 @@ module Google # @return [Array] attr_accessor :resources - # Google Cloud services that are subject to the Service Perimeter - # restrictions. For example, if `storage.googleapis.com` is specified, access - # to the storage buckets inside the perimeter must meet the perimeter's - # access restrictions. + # Google Cloud services that are subject to the Service Perimeter restrictions. + # For example, if `storage.googleapis.com` is specified, access to the storage + # buckets inside the perimeter must meet the perimeter's access restrictions. # Corresponds to the JSON property `restrictedServices` # @return [Array] attr_accessor :restricted_services - # Specifies how APIs are allowed to communicate within the Service - # Perimeter. + # Specifies how APIs are allowed to communicate within the Service Perimeter. # Corresponds to the JSON property `vpcAccessibleServices` # @return [Google::Apis::CloudassetV1p5beta1::GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices] attr_accessor :vpc_accessible_services @@ -1275,21 +1080,20 @@ module Google end end - # Specifies how APIs are allowed to communicate within the Service - # Perimeter. + # Specifies how APIs are allowed to communicate within the Service Perimeter. class GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices include Google::Apis::Core::Hashable - # The list of APIs usable within the Service Perimeter. Must be empty - # unless 'enable_restriction' is True. You can specify a list of individual - # services, as well as include the 'RESTRICTED-SERVICES' value, which - # automatically includes all of the services protected by the perimeter. + # The list of APIs usable within the Service Perimeter. Must be empty unless ' + # enable_restriction' is True. You can specify a list of individual services, as + # well as include the 'RESTRICTED-SERVICES' value, which automatically includes + # all of the services protected by the perimeter. # Corresponds to the JSON property `allowedServices` # @return [Array] attr_accessor :allowed_services - # Whether to restrict API calls within the Service Perimeter to the list of - # APIs specified in 'allowed_services'. + # Whether to restrict API calls within the Service Perimeter to the list of APIs + # specified in 'allowed_services'. # Corresponds to the JSON property `enableRestriction` # @return [Boolean] attr_accessor :enable_restriction @@ -1339,66 +1143,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 @@ -1407,48 +1177,44 @@ module Google # @return [Array] 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] 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 @@ -1470,47 +1236,42 @@ module Google class Resource include Google::Apis::Core::Hashable - # The content of the resource, in which some sensitive fields are removed - # and may not be present. + # The content of the resource, in which some sensitive fields are removed and + # may not be present. # Corresponds to the JSON property `data` # @return [Hash] attr_accessor :data # The URL of the discovery document containing the resource's JSON schema. - # Example: - # `https://www.googleapis.com/discovery/v1/apis/compute/v1/rest` - # This value is unspecified for resources that do not have an API based on a + # Example: `https://www.googleapis.com/discovery/v1/apis/compute/v1/rest` This + # value is unspecified for resources that do not have an API based on a # discovery document, such as Cloud Bigtable. # Corresponds to the JSON property `discoveryDocumentUri` # @return [String] attr_accessor :discovery_document_uri - # The JSON schema name listed in the discovery document. Example: - # `Project` - # This value is unspecified for resources that do not have an API based on a + # The JSON schema name listed in the discovery document. Example: `Project` This + # value is unspecified for resources that do not have an API based on a # discovery document, such as Cloud Bigtable. # Corresponds to the JSON property `discoveryName` # @return [String] attr_accessor :discovery_name - # The full name of the immediate parent of this resource. See - # [Resource - # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) - # for more information. - # For Google Cloud assets, this value is the parent resource defined in the - # [Cloud IAM policy - # hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy). - # Example: - # `//cloudresourcemanager.googleapis.com/projects/my_project_123` - # For third-party assets, this field may be set differently. + # The full name of the immediate parent of this resource. See [Resource Names]( + # https://cloud.google.com/apis/design/resource_names#full_resource_name) for + # more information. For Google Cloud assets, this value is the parent resource + # defined in the [Cloud IAM policy hierarchy](https://cloud.google.com/iam/docs/ + # overview#policy_hierarchy). Example: `//cloudresourcemanager.googleapis.com/ + # projects/my_project_123` For third-party assets, this field may be set + # differently. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # The REST URL for accessing the resource. An HTTP `GET` request using this - # URL returns the resource itself. Example: - # `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123` - # This value is unspecified for resources without a REST API. + # The REST URL for accessing the resource. An HTTP `GET` request using this URL + # returns the resource itself. Example: `https://cloudresourcemanager.googleapis. + # com/v1/projects/my-project-123` This value is unspecified for resources + # without a REST API. # Corresponds to the JSON property `resourceUrl` # @return [String] attr_accessor :resource_url diff --git a/generated/google/apis/cloudasset_v1p5beta1/service.rb b/generated/google/apis/cloudasset_v1p5beta1/service.rb index 35af8860b..ca1ed6dc7 100644 --- a/generated/google/apis/cloudasset_v1p5beta1/service.rb +++ b/generated/google/apis/cloudasset_v1p5beta1/service.rb @@ -50,41 +50,38 @@ module Google # Lists assets with time and resource types and returns paged results in # response. # @param [String] parent - # Required. Name of the organization or project the assets belong to. Format: - # "organizations/[organization-number]" (such as "organizations/123"), - # "projects/[project-number]" (such as "projects/my-project-id"), or - # "projects/[project-id]" (such as "projects/12345"). + # Required. Name of the organization or project the assets belong to. Format: " + # organizations/[organization-number]" (such as "organizations/123"), "projects/[ + # project-number]" (such as "projects/my-project-id"), or "projects/[project-id]" + # (such as "projects/12345"). # @param [Array, String] asset_types - # A list of asset types to take a snapshot for. For example: - # "compute.googleapis.com/Disk". - # Regular expression is also supported. For example: - # * "compute.googleapis.com.*" snapshots resources whose asset type starts - # with "compute.googleapis.com". - # * ".*Instance" snapshots resources whose asset type ends with "Instance". - # * ".*Instance.*" snapshots resources whose asset type contains "Instance". - # See [RE2](https://github.com/google/re2/wiki/Syntax) for all supported - # regular expression syntax. If the regular expression does not match any - # supported asset type, an INVALID_ARGUMENT error will be returned. - # If specified, only matching assets will be returned, otherwise, it will - # snapshot all asset types. See [Introduction to Cloud Asset - # Inventory](https://cloud.google.com/asset-inventory/docs/overview) - # for all supported asset types. + # A list of asset types to take a snapshot for. For example: "compute.googleapis. + # com/Disk". Regular expression is also supported. For example: * "compute. + # googleapis.com.*" snapshots resources whose asset type starts with "compute. + # googleapis.com". * ".*Instance" snapshots resources whose asset type ends with + # "Instance". * ".*Instance.*" snapshots resources whose asset type contains " + # Instance". See [RE2](https://github.com/google/re2/wiki/Syntax) for all + # supported regular expression syntax. If the regular expression does not match + # any supported asset type, an INVALID_ARGUMENT error will be returned. If + # specified, only matching assets will be returned, otherwise, it will snapshot + # all asset types. See [Introduction to Cloud Asset Inventory](https://cloud. + # google.com/asset-inventory/docs/overview) for all supported asset types. # @param [String] content_type - # Asset content type. If not specified, no content but the asset name will - # be returned. + # Asset content type. If not specified, no content but the asset name will be + # returned. # @param [Fixnum] page_size - # The maximum number of assets to be returned in a single response. Default - # is 100, minimum is 1, and maximum is 1000. + # The maximum number of assets to be returned in a single response. Default is + # 100, minimum is 1, and maximum is 1000. # @param [String] page_token # The `next_page_token` returned from the previous `ListAssetsResponse`, or - # unspecified for the first `ListAssetsRequest`. It is a continuation of a - # prior `ListAssets` call, and the API should return the next page of assets. + # unspecified for the first `ListAssetsRequest`. It is a continuation of a prior + # `ListAssets` call, and the API should return the next page of assets. # @param [String] read_time # Timestamp to take an asset snapshot. This can only be set to a timestamp - # between the current time and the current time minus 35 days (inclusive). - # If not specified, the current time will be used. Due to delays in resource - # data collection and indexing, there is a volatile window during which - # running the same query may get different results. + # between the current time and the current time minus 35 days (inclusive). If + # not specified, the current time will be used. Due to delays in resource data + # collection and indexing, there is a volatile window during which running the + # same query may get different results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/cloudidentity_v1.rb b/generated/google/apis/cloudidentity_v1.rb index a651157c4..68221e470 100644 --- a/generated/google/apis/cloudidentity_v1.rb +++ b/generated/google/apis/cloudidentity_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/identity/ module CloudidentityV1 VERSION = 'V1' - REVISION = '20200622' + REVISION = '20200809' # See, change, create, and delete any of the Cloud Identity Groups that you can access, including the members of each group AUTH_CLOUD_IDENTITY_GROUPS = 'https://www.googleapis.com/auth/cloud-identity.groups' diff --git a/generated/google/apis/cloudidentity_v1/classes.rb b/generated/google/apis/cloudidentity_v1/classes.rb index dce6ef14b..cc3f5ccd9 100644 --- a/generated/google/apis/cloudidentity_v1/classes.rb +++ b/generated/google/apis/cloudidentity_v1/classes.rb @@ -22,23 +22,541 @@ module Google module Apis module CloudidentityV1 + # Resource representing the Android specific attributes of a Device. + class AndroidAttributes + include Google::Apis::Core::Hashable + + # Whether applications from unknown sources can be installed on device. + # Corresponds to the JSON property `enabledUnknownSources` + # @return [Boolean] + attr_accessor :enabled_unknown_sources + alias_method :enabled_unknown_sources?, :enabled_unknown_sources + + # Whether this account is on an owner/primary profile. For phones, only true for + # owner profiles. Android 4+ devices can have secondary or restricted user + # profiles. + # Corresponds to the JSON property `ownerProfileAccount` + # @return [Boolean] + attr_accessor :owner_profile_account + alias_method :owner_profile_account?, :owner_profile_account + + # Ownership privileges on device. + # Corresponds to the JSON property `ownershipPrivilege` + # @return [String] + attr_accessor :ownership_privilege + + # Whether device supports Android work profiles. If false, this service will not + # block access to corp data even if an administrator turns on the "Enforce Work + # Profile" policy. + # Corresponds to the JSON property `supportsWorkProfile` + # @return [Boolean] + attr_accessor :supports_work_profile + alias_method :supports_work_profile?, :supports_work_profile + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enabled_unknown_sources = args[:enabled_unknown_sources] if args.key?(:enabled_unknown_sources) + @owner_profile_account = args[:owner_profile_account] if args.key?(:owner_profile_account) + @ownership_privilege = args[:ownership_privilege] if args.key?(:ownership_privilege) + @supports_work_profile = args[:supports_work_profile] if args.key?(:supports_work_profile) + end + end + + # Response message for approving the device to access user data. + class ApproveDeviceUserResponse + include Google::Apis::Core::Hashable + + # Represents a user's use of a Device in the Cloud Identity Devices API. A + # DeviceUser is a resource representing a user's use of a Device + # Corresponds to the JSON property `deviceUser` + # @return [Google::Apis::CloudidentityV1::DeviceUser] + attr_accessor :device_user + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device_user = args[:device_user] if args.key?(:device_user) + end + end + + # Response message for blocking the device from accessing user data. + class BlockDeviceUserResponse + include Google::Apis::Core::Hashable + + # Represents a user's use of a Device in the Cloud Identity Devices API. A + # DeviceUser is a resource representing a user's use of a Device + # Corresponds to the JSON property `deviceUser` + # @return [Google::Apis::CloudidentityV1::DeviceUser] + attr_accessor :device_user + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device_user = args[:device_user] if args.key?(:device_user) + end + end + + # Response message for cancelling an unfinished device wipe. + class CancelWipeDeviceResponse + include Google::Apis::Core::Hashable + + # A Device within the Cloud Identity Devices API. Represents a Device known to + # Google Cloud, independent of the device ownership, type, and whether it is + # assigned or in use by a user. + # Corresponds to the JSON property `device` + # @return [Google::Apis::CloudidentityV1::Device] + attr_accessor :device + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device = args[:device] if args.key?(:device) + end + end + + # Response message for cancelling an unfinished user account wipe. + class CancelWipeDeviceUserResponse + include Google::Apis::Core::Hashable + + # Represents a user's use of a Device in the Cloud Identity Devices API. A + # DeviceUser is a resource representing a user's use of a Device + # Corresponds to the JSON property `deviceUser` + # @return [Google::Apis::CloudidentityV1::DeviceUser] + attr_accessor :device_user + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device_user = args[:device_user] if args.key?(:device_user) + end + end + + # Represents the state associated with an API client calling the Devices API. + # Resource representing ClientState and supports updates from API users + class ClientState + include Google::Apis::Core::Hashable + + # The caller can specify asset tags for this resource + # Corresponds to the JSON property `assetTags` + # @return [Array] + attr_accessor :asset_tags + + # The compliance state of the resource as specified by the API client. + # Corresponds to the JSON property `complianceState` + # @return [String] + attr_accessor :compliance_state + + # Output only. The time the client state data was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # This field may be used to store a unique identifier for the API resource + # within which these CustomAttributes are a field. + # Corresponds to the JSON property `customId` + # @return [String] + attr_accessor :custom_id + + # The token that needs to be passed back for concurrency control in updates. + # Token needs to be passed back in UpdateRequest + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The Health score of the resource + # Corresponds to the JSON property `healthScore` + # @return [String] + attr_accessor :health_score + + # The map of key-value attributes stored by callers specific to a device. The + # total serialized length of this map may not exceed 10KB. No limit is placed on + # the number of attributes in a map. + # Corresponds to the JSON property `keyValuePairs` + # @return [Hash] + attr_accessor :key_value_pairs + + # Output only. The time the client state data was last updated. + # Corresponds to the JSON property `lastUpdateTime` + # @return [String] + attr_accessor :last_update_time + + # The management state of the resource as specified by the API client. + # Corresponds to the JSON property `managed` + # @return [String] + attr_accessor :managed + + # Output only. [Resource name](https://cloud.google.com/apis/design/ + # resource_names) of the ClientState in format: `devices/`device_id`/deviceUsers/ + # `device_user_id`/clientState/`partner_id``, where partner_id corresponds to + # the partner storing the data. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The owner of the ClientState + # Corresponds to the JSON property `ownerType` + # @return [String] + attr_accessor :owner_type + + # A descriptive cause of the health score. + # Corresponds to the JSON property `scoreReason` + # @return [String] + attr_accessor :score_reason + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @asset_tags = args[:asset_tags] if args.key?(:asset_tags) + @compliance_state = args[:compliance_state] if args.key?(:compliance_state) + @create_time = args[:create_time] if args.key?(:create_time) + @custom_id = args[:custom_id] if args.key?(:custom_id) + @etag = args[:etag] if args.key?(:etag) + @health_score = args[:health_score] if args.key?(:health_score) + @key_value_pairs = args[:key_value_pairs] if args.key?(:key_value_pairs) + @last_update_time = args[:last_update_time] if args.key?(:last_update_time) + @managed = args[:managed] if args.key?(:managed) + @name = args[:name] if args.key?(:name) + @owner_type = args[:owner_type] if args.key?(:owner_type) + @score_reason = args[:score_reason] if args.key?(:score_reason) + end + end + + # Additional custom attribute values may be one of these types + class CustomAttributeValue + include Google::Apis::Core::Hashable + + # Represents a boolean value. + # Corresponds to the JSON property `boolValue` + # @return [Boolean] + attr_accessor :bool_value + alias_method :bool_value?, :bool_value + + # Represents a double value. + # Corresponds to the JSON property `numberValue` + # @return [Float] + attr_accessor :number_value + + # Represents a string value. + # Corresponds to the JSON property `stringValue` + # @return [String] + attr_accessor :string_value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bool_value = args[:bool_value] if args.key?(:bool_value) + @number_value = args[:number_value] if args.key?(:number_value) + @string_value = args[:string_value] if args.key?(:string_value) + end + end + + # A Device within the Cloud Identity Devices API. Represents a Device known to + # Google Cloud, independent of the device ownership, type, and whether it is + # assigned or in use by a user. + class Device + include Google::Apis::Core::Hashable + + # Resource representing the Android specific attributes of a Device. + # Corresponds to the JSON property `androidSpecificAttributes` + # @return [Google::Apis::CloudidentityV1::AndroidAttributes] + attr_accessor :android_specific_attributes + + # Asset tag of the device. + # Corresponds to the JSON property `assetTag` + # @return [String] + attr_accessor :asset_tag + + # Output only. Baseband version of the device. + # Corresponds to the JSON property `basebandVersion` + # @return [String] + attr_accessor :baseband_version + + # Output only. Device bootloader version. Example: 0.6.7. + # Corresponds to the JSON property `bootloaderVersion` + # @return [String] + attr_accessor :bootloader_version + + # Output only. Device brand. Example: Samsung. + # Corresponds to the JSON property `brand` + # @return [String] + attr_accessor :brand + + # Output only. Build number of the device. + # Corresponds to the JSON property `buildNumber` + # @return [String] + attr_accessor :build_number + + # Output only. Represents whether the Device is compromised. + # Corresponds to the JSON property `compromisedState` + # @return [String] + attr_accessor :compromised_state + + # Output only. When the Company-Owned device was imported. This field is empty + # for BYOD devices. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Output only. Type of device. + # Corresponds to the JSON property `deviceType` + # @return [String] + attr_accessor :device_type + + # Output only. Whether developer options is enabled on device. + # Corresponds to the JSON property `enabledDeveloperOptions` + # @return [Boolean] + attr_accessor :enabled_developer_options + alias_method :enabled_developer_options?, :enabled_developer_options + + # Output only. Whether USB debugging is enabled on device. + # Corresponds to the JSON property `enabledUsbDebugging` + # @return [Boolean] + attr_accessor :enabled_usb_debugging + alias_method :enabled_usb_debugging?, :enabled_usb_debugging + + # Output only. Device encryption state. + # Corresponds to the JSON property `encryptionState` + # @return [String] + attr_accessor :encryption_state + + # Output only. IMEI number of device if GSM device; empty otherwise. + # Corresponds to the JSON property `imei` + # @return [String] + attr_accessor :imei + + # Output only. Kernel version of the device. + # Corresponds to the JSON property `kernelVersion` + # @return [String] + attr_accessor :kernel_version + + # Most recent time when device synced with this service. + # Corresponds to the JSON property `lastSyncTime` + # @return [String] + attr_accessor :last_sync_time + + # Output only. Management state of the device + # Corresponds to the JSON property `managementState` + # @return [String] + attr_accessor :management_state + + # Output only. Device manufacturer. Example: Motorola. + # Corresponds to the JSON property `manufacturer` + # @return [String] + attr_accessor :manufacturer + + # Output only. MEID number of device if CDMA device; empty otherwise. + # Corresponds to the JSON property `meid` + # @return [String] + attr_accessor :meid + + # Output only. Model name of device. Example: Pixel 3. + # Corresponds to the JSON property `model` + # @return [String] + attr_accessor :model + + # Output only. [Resource name](https://cloud.google.com/apis/design/ + # resource_names) of the Device in format: `devices/`device_id``, where + # device_id is the unique id assigned to the Device. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. Mobile or network operator of device, if available. + # Corresponds to the JSON property `networkOperator` + # @return [String] + attr_accessor :network_operator + + # Output only. OS version of the device. Example: Android 8.1.0. + # Corresponds to the JSON property `osVersion` + # @return [String] + attr_accessor :os_version + + # Output only. Domain name for Google accounts on device. Type for other + # accounts on device. On Android, will only be populated if |ownership_privilege| + # is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in + # to the device policy app if that account's domain has only one account. + # Examples: "com.example", "xyz.com". + # Corresponds to the JSON property `otherAccounts` + # @return [Array] + attr_accessor :other_accounts + + # Output only. Whether the device is owned by the company or an individual + # Corresponds to the JSON property `ownerType` + # @return [String] + attr_accessor :owner_type + + # Output only. OS release version. Example: 6.0. + # Corresponds to the JSON property `releaseVersion` + # @return [String] + attr_accessor :release_version + + # Output only. OS security patch update time on device. + # Corresponds to the JSON property `securityPatchTime` + # @return [String] + attr_accessor :security_patch_time + + # Serial Number of device. Example: HT82V1A01076. + # Corresponds to the JSON property `serialNumber` + # @return [String] + attr_accessor :serial_number + + # WiFi MAC addresses of device. + # Corresponds to the JSON property `wifiMacAddresses` + # @return [Array] + attr_accessor :wifi_mac_addresses + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @android_specific_attributes = args[:android_specific_attributes] if args.key?(:android_specific_attributes) + @asset_tag = args[:asset_tag] if args.key?(:asset_tag) + @baseband_version = args[:baseband_version] if args.key?(:baseband_version) + @bootloader_version = args[:bootloader_version] if args.key?(:bootloader_version) + @brand = args[:brand] if args.key?(:brand) + @build_number = args[:build_number] if args.key?(:build_number) + @compromised_state = args[:compromised_state] if args.key?(:compromised_state) + @create_time = args[:create_time] if args.key?(:create_time) + @device_type = args[:device_type] if args.key?(:device_type) + @enabled_developer_options = args[:enabled_developer_options] if args.key?(:enabled_developer_options) + @enabled_usb_debugging = args[:enabled_usb_debugging] if args.key?(:enabled_usb_debugging) + @encryption_state = args[:encryption_state] if args.key?(:encryption_state) + @imei = args[:imei] if args.key?(:imei) + @kernel_version = args[:kernel_version] if args.key?(:kernel_version) + @last_sync_time = args[:last_sync_time] if args.key?(:last_sync_time) + @management_state = args[:management_state] if args.key?(:management_state) + @manufacturer = args[:manufacturer] if args.key?(:manufacturer) + @meid = args[:meid] if args.key?(:meid) + @model = args[:model] if args.key?(:model) + @name = args[:name] if args.key?(:name) + @network_operator = args[:network_operator] if args.key?(:network_operator) + @os_version = args[:os_version] if args.key?(:os_version) + @other_accounts = args[:other_accounts] if args.key?(:other_accounts) + @owner_type = args[:owner_type] if args.key?(:owner_type) + @release_version = args[:release_version] if args.key?(:release_version) + @security_patch_time = args[:security_patch_time] if args.key?(:security_patch_time) + @serial_number = args[:serial_number] if args.key?(:serial_number) + @wifi_mac_addresses = args[:wifi_mac_addresses] if args.key?(:wifi_mac_addresses) + end + end + + # Represents a user's use of a Device in the Cloud Identity Devices API. A + # DeviceUser is a resource representing a user's use of a Device + class DeviceUser + include Google::Apis::Core::Hashable + + # Compromised State of the DeviceUser object + # Corresponds to the JSON property `compromisedState` + # @return [String] + attr_accessor :compromised_state + + # When the user first signed in to the device + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Output only. Most recent time when user registered with this service. + # Corresponds to the JSON property `firstSyncTime` + # @return [String] + attr_accessor :first_sync_time + + # Output only. Default locale used on device, in IETF BCP-47 format. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # Output only. Last time when user synced with policies. + # Corresponds to the JSON property `lastSyncTime` + # @return [String] + attr_accessor :last_sync_time + + # Output only. Management state of the user on the device. + # Corresponds to the JSON property `managementState` + # @return [String] + attr_accessor :management_state + + # Output only. [Resource name](https://cloud.google.com/apis/design/ + # resource_names) of the DeviceUser in format: `devices/`device_id`/deviceUsers/` + # user_id``, where user_id is the ID of the user associated with the user + # session. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Password state of the DeviceUser object + # Corresponds to the JSON property `passwordState` + # @return [String] + attr_accessor :password_state + + # Output only. User agent on the device for this specific user + # Corresponds to the JSON property `userAgent` + # @return [String] + attr_accessor :user_agent + + # Email address of the user registered on the device. + # Corresponds to the JSON property `userEmail` + # @return [String] + attr_accessor :user_email + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @compromised_state = args[:compromised_state] if args.key?(:compromised_state) + @create_time = args[:create_time] if args.key?(:create_time) + @first_sync_time = args[:first_sync_time] if args.key?(:first_sync_time) + @language_code = args[:language_code] if args.key?(:language_code) + @last_sync_time = args[:last_sync_time] if args.key?(:last_sync_time) + @management_state = args[:management_state] if args.key?(:management_state) + @name = args[:name] if args.key?(:name) + @password_state = args[:password_state] if args.key?(:password_state) + @user_agent = args[:user_agent] if args.key?(:user_agent) + @user_email = args[:user_email] if args.key?(:user_email) + end + end + # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # isolation for IDs. A single ID can be reused across namespaces but the # combination of a namespace and an ID must be unique. class EntityKey include Google::Apis::Core::Hashable - # The ID of the entity within the given namespace. The ID must be unique - # within its namespace. + # The ID of the entity within the given namespace. The ID must be unique within + # its namespace. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Namespaces provide isolation for IDs, so an ID only needs to be unique - # within its namespace. - # Namespaces are currently only created as part of IdentitySource creation - # from Admin Console. A namespace `"identitysources/`identity_source_id`"` is - # created corresponding to every Identity Source `identity_source_id`. + # Namespaces provide isolation for IDs, so an ID only needs to be unique within + # its namespace. Namespaces are currently only created as part of IdentitySource + # creation from Admin Console. A namespace `"identitysources/`identity_source_id` + # "` is created corresponding to every Identity Source `identity_source_id`. # Corresponds to the JSON property `namespace` # @return [String] attr_accessor :namespace @@ -58,8 +576,7 @@ module Google class Group include Google::Apis::Core::Hashable - # Output only. The time when the Group was created. - # Output only. + # Output only. The time when the Group was created. Output only. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -84,32 +601,29 @@ module Google # @return [Google::Apis::CloudidentityV1::EntityKey] attr_accessor :group_key - # Required. `Required`. Labels for Group resource. - # For creating Groups under a namespace, set label key to - # 'labels/system/groups/external' and label value as empty. + # Required. `Required`. Labels for Group resource. For creating Groups under a + # namespace, set label key to 'labels/system/groups/external' and label value as + # empty. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Output only. [Resource name](https://cloud.google.com/apis/design/ - # resource_names) of the - # Group in the format: `groups/`group_id``, where group_id is the unique ID - # assigned to the Group. - # Must be left blank while creating a Group. + # resource_names) of the Group in the format: `groups/`group_id``, where + # group_id is the unique ID assigned to the Group. Must be left blank while + # creating a Group. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. Immutable. The entity under which this Group resides in Cloud - # Identity resource - # hierarchy. Must be set when creating a Group, read-only afterwards. - # Currently allowed types: `identitysources`. + # Identity resource hierarchy. Must be set when creating a Group, read-only + # afterwards. Currently allowed types: `identitysources`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # Output only. The time when the Group was last updated. - # Output only. + # Output only. The time when the Group was last updated. Output only. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -135,14 +649,13 @@ module Google class ListGroupsResponse include Google::Apis::Core::Hashable - # Groups returned in response to list request. - # The results are not sorted. + # Groups returned in response to list request. The results are not sorted. # Corresponds to the JSON property `groups` # @return [Array] attr_accessor :groups - # Token to retrieve the next page of results, or empty if there are no - # more results available for listing. + # Token to retrieve the next page of results, or empty if there are no more + # results available for listing. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -167,8 +680,8 @@ module Google # @return [Array] attr_accessor :memberships - # Token to retrieve the next page of results, or empty if there are no - # more results available for listing. + # Token to retrieve the next page of results, or empty if there are no more + # results available for listing. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -210,10 +723,9 @@ module Google include Google::Apis::Core::Hashable # [Resource name](https://cloud.google.com/apis/design/resource_names) of the - # Membership being looked up. - # Format: `groups/`group_id`/memberships/`member_id``, where `group_id` is - # the unique ID assigned to the Group to which Membership belongs to, and - # `member_id` is the unique ID assigned to the member. + # Membership being looked up. Format: `groups/`group_id`/memberships/`member_id`` + # , where `group_id` is the unique ID assigned to the Group to which Membership + # belongs to, and `member_id` is the unique ID assigned to the member. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -238,11 +750,10 @@ module Google attr_accessor :create_time # Output only. [Resource name](https://cloud.google.com/apis/design/ - # resource_names) of the - # Membership in the format: `groups/`group_id`/memberships/`member_id``, - # where group_id is the unique ID assigned to the Group to which Membership - # belongs to, and member_id is the unique ID assigned to the member - # Must be left blank while creating a Membership. + # resource_names) of the Membership in the format: `groups/`group_id`/ + # memberships/`member_id``, where group_id is the unique ID assigned to the + # Group to which Membership belongs to, and member_id is the unique ID assigned + # to the member Must be left blank while creating a Membership. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -254,8 +765,8 @@ module Google # @return [Google::Apis::CloudidentityV1::EntityKey] attr_accessor :preferred_member_key - # Roles for a member within the Group. - # Currently supported MembershipRoles: `"MEMBER"`. + # Roles for a member within the Group. Currently supported MembershipRoles: `" + # MEMBER"`. # Corresponds to the JSON property `roles` # @return [Array] attr_accessor :roles @@ -283,8 +794,8 @@ module Google class MembershipRole include Google::Apis::Core::Hashable - # MembershipRole in string format. - # Currently supported MembershipRoles: `"MEMBER"`. + # MembershipRole in string format. Currently supported MembershipRoles: `"MEMBER" + # `. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -304,47 +815,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::CloudidentityV1::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] 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] attr_accessor :response @@ -372,8 +881,8 @@ module Google # @return [Array] attr_accessor :groups - # Token to retrieve the next page of results, or empty if there are no - # more results available for specified query. + # Token to retrieve the next page of results, or empty if there are no more + # results available for specified query. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -389,12 +898,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 @@ -403,15 +912,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>] 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 @@ -427,6 +936,47 @@ module Google @message = args[:message] if args.key?(:message) end end + + # Response message for wiping all data on the device. + class WipeDeviceResponse + include Google::Apis::Core::Hashable + + # A Device within the Cloud Identity Devices API. Represents a Device known to + # Google Cloud, independent of the device ownership, type, and whether it is + # assigned or in use by a user. + # Corresponds to the JSON property `device` + # @return [Google::Apis::CloudidentityV1::Device] + attr_accessor :device + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device = args[:device] if args.key?(:device) + end + end + + # Response message for wiping the user's account from the device. + class WipeDeviceUserResponse + include Google::Apis::Core::Hashable + + # Represents a user's use of a Device in the Cloud Identity Devices API. A + # DeviceUser is a resource representing a user's use of a Device + # Corresponds to the JSON property `deviceUser` + # @return [Google::Apis::CloudidentityV1::DeviceUser] + attr_accessor :device_user + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device_user = args[:device_user] if args.key?(:device_user) + end + end end end end diff --git a/generated/google/apis/cloudidentity_v1/representations.rb b/generated/google/apis/cloudidentity_v1/representations.rb index 6a972091f..41c8e0f1f 100644 --- a/generated/google/apis/cloudidentity_v1/representations.rb +++ b/generated/google/apis/cloudidentity_v1/representations.rb @@ -22,6 +22,60 @@ module Google module Apis module CloudidentityV1 + class AndroidAttributes + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApproveDeviceUserResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BlockDeviceUserResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CancelWipeDeviceResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CancelWipeDeviceUserResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ClientState + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomAttributeValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Device + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeviceUser + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class EntityKey class Representation < Google::Apis::Core::JsonRepresentation; end @@ -88,6 +142,139 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class WipeDeviceResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class WipeDeviceUserResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AndroidAttributes + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :enabled_unknown_sources, as: 'enabledUnknownSources' + property :owner_profile_account, as: 'ownerProfileAccount' + property :ownership_privilege, as: 'ownershipPrivilege' + property :supports_work_profile, as: 'supportsWorkProfile' + end + end + + class ApproveDeviceUserResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :device_user, as: 'deviceUser', class: Google::Apis::CloudidentityV1::DeviceUser, decorator: Google::Apis::CloudidentityV1::DeviceUser::Representation + + end + end + + class BlockDeviceUserResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :device_user, as: 'deviceUser', class: Google::Apis::CloudidentityV1::DeviceUser, decorator: Google::Apis::CloudidentityV1::DeviceUser::Representation + + end + end + + class CancelWipeDeviceResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :device, as: 'device', class: Google::Apis::CloudidentityV1::Device, decorator: Google::Apis::CloudidentityV1::Device::Representation + + end + end + + class CancelWipeDeviceUserResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :device_user, as: 'deviceUser', class: Google::Apis::CloudidentityV1::DeviceUser, decorator: Google::Apis::CloudidentityV1::DeviceUser::Representation + + end + end + + class ClientState + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :asset_tags, as: 'assetTags' + property :compliance_state, as: 'complianceState' + property :create_time, as: 'createTime' + property :custom_id, as: 'customId' + property :etag, as: 'etag' + property :health_score, as: 'healthScore' + hash :key_value_pairs, as: 'keyValuePairs', class: Google::Apis::CloudidentityV1::CustomAttributeValue, decorator: Google::Apis::CloudidentityV1::CustomAttributeValue::Representation + + property :last_update_time, as: 'lastUpdateTime' + property :managed, as: 'managed' + property :name, as: 'name' + property :owner_type, as: 'ownerType' + property :score_reason, as: 'scoreReason' + end + end + + class CustomAttributeValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bool_value, as: 'boolValue' + property :number_value, as: 'numberValue' + property :string_value, as: 'stringValue' + end + end + + class Device + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :android_specific_attributes, as: 'androidSpecificAttributes', class: Google::Apis::CloudidentityV1::AndroidAttributes, decorator: Google::Apis::CloudidentityV1::AndroidAttributes::Representation + + property :asset_tag, as: 'assetTag' + property :baseband_version, as: 'basebandVersion' + property :bootloader_version, as: 'bootloaderVersion' + property :brand, as: 'brand' + property :build_number, as: 'buildNumber' + property :compromised_state, as: 'compromisedState' + property :create_time, as: 'createTime' + property :device_type, as: 'deviceType' + property :enabled_developer_options, as: 'enabledDeveloperOptions' + property :enabled_usb_debugging, as: 'enabledUsbDebugging' + property :encryption_state, as: 'encryptionState' + property :imei, as: 'imei' + property :kernel_version, as: 'kernelVersion' + property :last_sync_time, as: 'lastSyncTime' + property :management_state, as: 'managementState' + property :manufacturer, as: 'manufacturer' + property :meid, as: 'meid' + property :model, as: 'model' + property :name, as: 'name' + property :network_operator, as: 'networkOperator' + property :os_version, as: 'osVersion' + collection :other_accounts, as: 'otherAccounts' + property :owner_type, as: 'ownerType' + property :release_version, as: 'releaseVersion' + property :security_patch_time, as: 'securityPatchTime' + property :serial_number, as: 'serialNumber' + collection :wifi_mac_addresses, as: 'wifiMacAddresses' + end + end + + class DeviceUser + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :compromised_state, as: 'compromisedState' + property :create_time, as: 'createTime' + property :first_sync_time, as: 'firstSyncTime' + property :language_code, as: 'languageCode' + property :last_sync_time, as: 'lastSyncTime' + property :management_state, as: 'managementState' + property :name, as: 'name' + property :password_state, as: 'passwordState' + property :user_agent, as: 'userAgent' + property :user_email, as: 'userEmail' + end + end + class EntityKey # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -192,6 +379,22 @@ module Google property :message, as: 'message' end end + + class WipeDeviceResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :device, as: 'device', class: Google::Apis::CloudidentityV1::Device, decorator: Google::Apis::CloudidentityV1::Device::Representation + + end + end + + class WipeDeviceUserResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :device_user, as: 'deviceUser', class: Google::Apis::CloudidentityV1::DeviceUser, decorator: Google::Apis::CloudidentityV1::DeviceUser::Representation + + end + end end end end diff --git a/generated/google/apis/cloudidentity_v1/service.rb b/generated/google/apis/cloudidentity_v1/service.rb index 4c1e9558b..892712e60 100644 --- a/generated/google/apis/cloudidentity_v1/service.rb +++ b/generated/google/apis/cloudidentity_v1/service.rb @@ -80,9 +80,8 @@ module Google # Deletes a Group. # @param [String] name # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) - # of the - # Group in the format: `groups/`group_id``, where `group_id` is the unique ID - # assigned to the Group. + # of the Group in the format: `groups/`group_id``, where `group_id` is the + # unique ID assigned to the Group. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -113,9 +112,8 @@ module Google # Retrieves a Group. # @param [String] name # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) - # of the - # Group in the format: `groups/`group_id``, where `group_id` is the unique ID - # assigned to the Group. + # of the Group in the format: `groups/`group_id``, where `group_id` is the + # unique ID assigned to the Group. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -145,8 +143,8 @@ module Google # Lists groups within a customer or a domain. # @param [Fixnum] page_size - # The default page size is 200 (max 1000) for the BASIC view, and 50 - # (max 500) for the FULL view. + # The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) + # for the FULL view. # @param [String] page_token # The next_page_token value returned from a previous list request, if any. # @param [String] parent @@ -183,18 +181,16 @@ module Google execute_or_queue_command(command, &block) end - # Looks up [resource - # name](https://cloud.google.com/apis/design/resource_names) of a Group by - # its EntityKey. + # Looks up [resource name](https://cloud.google.com/apis/design/resource_names) + # of a Group by its EntityKey. # @param [String] group_key_id - # The ID of the entity within the given namespace. The ID must be unique - # within its namespace. + # The ID of the entity within the given namespace. The ID must be unique within + # its namespace. # @param [String] group_key_namespace - # Namespaces provide isolation for IDs, so an ID only needs to be unique - # within its namespace. - # Namespaces are currently only created as part of IdentitySource creation - # from Admin Console. A namespace `"identitysources/`identity_source_id`"` is - # created corresponding to every Identity Source `identity_source_id`. + # Namespaces provide isolation for IDs, so an ID only needs to be unique within + # its namespace. Namespaces are currently only created as part of IdentitySource + # creation from Admin Console. A namespace `"identitysources/`identity_source_id` + # "` is created corresponding to every Identity Source `identity_source_id`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -226,10 +222,9 @@ module Google # Updates a Group. # @param [String] name # Output only. [Resource name](https://cloud.google.com/apis/design/ - # resource_names) of the - # Group in the format: `groups/`group_id``, where group_id is the unique ID - # assigned to the Group. - # Must be left blank while creating a Group. + # resource_names) of the Group in the format: `groups/`group_id``, where + # group_id is the unique ID assigned to the Group. Must be left blank while + # creating a Group. # @param [Google::Apis::CloudidentityV1::Group] group_object # @param [String] update_mask # Required. Editable fields: `display_name`, `description` @@ -265,16 +260,14 @@ module Google # Searches for Groups. # @param [Fixnum] page_size - # The default page size is 200 (max 1000) for the BASIC view, and 50 - # (max 500) for the FULL view. + # The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) + # for the FULL view. # @param [String] page_token # The next_page_token value returned from a previous search request, if any. # @param [String] query # Required. `Required`. Query string for performing search on groups. Users can - # search - # on parent and label attributes of groups. - # EXACT match ('==') is supported on parent, and CONTAINS match ('in') is - # supported on labels. + # search on parent and label attributes of groups. EXACT match ('==') is + # supported on parent, and CONTAINS match ('in') is supported on labels. # @param [String] view # Group resource view to be returned. Defaults to [View.BASIC](). # @param [String] fields @@ -310,9 +303,8 @@ module Google # Creates a Membership. # @param [String] parent # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) - # of the - # Group to create Membership within. Format: `groups/`group_id``, where - # `group_id` is the unique ID assigned to the Group. + # of the Group to create Membership within. Format: `groups/`group_id``, where ` + # group_id` is the unique ID assigned to the Group. # @param [Google::Apis::CloudidentityV1::Membership] membership_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -346,11 +338,9 @@ module Google # Deletes a Membership. # @param [String] name # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) - # of the - # Membership to be deleted. - # Format: `groups/`group_id`/memberships/`member_id``, where `group_id` is - # the unique ID assigned to the Group to which Membership belongs to, and - # member_id is the unique ID assigned to the member. + # of the Membership to be deleted. Format: `groups/`group_id`/memberships/` + # member_id``, where `group_id` is the unique ID assigned to the Group to which + # Membership belongs to, and member_id is the unique ID assigned to the member. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -381,11 +371,9 @@ module Google # Retrieves a Membership. # @param [String] name # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) - # of the - # Membership to be retrieved. - # Format: `groups/`group_id`/memberships/`member_id``, where `group_id` is - # the unique id assigned to the Group to which Membership belongs to, and - # `member_id` is the unique ID assigned to the member. + # of the Membership to be retrieved. Format: `groups/`group_id`/memberships/` + # member_id``, where `group_id` is the unique id assigned to the Group to which + # Membership belongs to, and `member_id` is the unique ID assigned to the member. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -416,13 +404,11 @@ module Google # Lists Memberships within a Group. # @param [String] parent # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) - # of the - # Group to list Memberships within. - # Format: `groups/`group_id``, where `group_id` is the unique ID assigned to - # the Group. + # of the Group to list Memberships within. Format: `groups/`group_id``, where ` + # group_id` is the unique ID assigned to the Group. # @param [Fixnum] page_size - # The default page size is 200 (max 1000) for the BASIC view, and 50 - # (max 500) for the FULL view. + # The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) + # for the FULL view. # @param [String] page_token # The next_page_token value returned from a previous list request, if any. # @param [String] view @@ -457,24 +443,20 @@ module Google execute_or_queue_command(command, &block) end - # Looks up [resource - # name](https://cloud.google.com/apis/design/resource_names) of a Membership - # within a Group by member's EntityKey. + # Looks up [resource name](https://cloud.google.com/apis/design/resource_names) + # of a Membership within a Group by member's EntityKey. # @param [String] parent # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) - # of the - # Group to lookup Membership within. - # Format: `groups/`group_id``, where `group_id` is the unique ID assigned to - # the Group. + # of the Group to lookup Membership within. Format: `groups/`group_id``, where ` + # group_id` is the unique ID assigned to the Group. # @param [String] member_key_id - # The ID of the entity within the given namespace. The ID must be unique - # within its namespace. + # The ID of the entity within the given namespace. The ID must be unique within + # its namespace. # @param [String] member_key_namespace - # Namespaces provide isolation for IDs, so an ID only needs to be unique - # within its namespace. - # Namespaces are currently only created as part of IdentitySource creation - # from Admin Console. A namespace `"identitysources/`identity_source_id`"` is - # created corresponding to every Identity Source `identity_source_id`. + # Namespaces provide isolation for IDs, so an ID only needs to be unique within + # its namespace. Namespaces are currently only created as part of IdentitySource + # creation from Admin Console. A namespace `"identitysources/`identity_source_id` + # "` is created corresponding to every Identity Source `identity_source_id`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/cloudidentity_v1beta1.rb b/generated/google/apis/cloudidentity_v1beta1.rb index 374c56cb6..7522d9518 100644 --- a/generated/google/apis/cloudidentity_v1beta1.rb +++ b/generated/google/apis/cloudidentity_v1beta1.rb @@ -25,7 +25,10 @@ module Google # @see https://cloud.google.com/identity/ module CloudidentityV1beta1 VERSION = 'V1beta1' - REVISION = '20200711' + REVISION = '20200809' + + # See your device details + AUTH_CLOUD_IDENTITY_DEVICES_LOOKUP = 'https://www.googleapis.com/auth/cloud-identity.devices.lookup' # See, change, create, and delete any of the Cloud Identity Groups that you can access, including the members of each group AUTH_CLOUD_IDENTITY_GROUPS = 'https://www.googleapis.com/auth/cloud-identity.groups' diff --git a/generated/google/apis/cloudidentity_v1beta1/classes.rb b/generated/google/apis/cloudidentity_v1beta1/classes.rb index 94673a533..326c26a3f 100644 --- a/generated/google/apis/cloudidentity_v1beta1/classes.rb +++ b/generated/google/apis/cloudidentity_v1beta1/classes.rb @@ -32,9 +32,9 @@ module Google attr_accessor :enabled_unknown_sources alias_method :enabled_unknown_sources?, :enabled_unknown_sources - # Whether this account is on an owner/primary profile. - # For phones, only true for owner profiles. Android 4+ devices - # can have secondary or restricted user profiles. + # Whether this account is on an owner/primary profile. For phones, only true for + # owner profiles. Android 4+ devices can have secondary or restricted user + # profiles. # Corresponds to the JSON property `ownerProfileAccount` # @return [Boolean] attr_accessor :owner_profile_account @@ -45,9 +45,9 @@ module Google # @return [String] attr_accessor :ownership_privilege - # Whether device supports Android work profiles. If false, this service - # will not block access to corp data even if an administrator turns on the - # "Enforce Work Profile" policy. + # Whether device supports Android work profiles. If false, this service will not + # block access to corp data even if an administrator turns on the "Enforce Work + # Profile" policy. # Corresponds to the JSON property `supportsWorkProfile` # @return [Boolean] attr_accessor :supports_work_profile @@ -66,11 +66,35 @@ module Google end end + # Request message for approving the device to access user data. + class ApproveDeviceUserRequest + include Google::Apis::Core::Hashable + + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # Corresponds to the JSON property `customer` + # @return [String] + attr_accessor :customer + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer = args[:customer] if args.key?(:customer) + end + end + # Response message for approving the device to access user data. class ApproveDeviceUserResponse include Google::Apis::Core::Hashable - # A DeviceUser is a resource representing a user's use of a Device + # Represents a user's use of a Device in the Cloud Identity Devices API. A + # DeviceUser is a resource representing a user's use of a Device # Corresponds to the JSON property `deviceUser` # @return [Google::Apis::CloudidentityV1beta1::DeviceUser] attr_accessor :device_user @@ -85,11 +109,35 @@ module Google end end + # Request message for blocking account on device. + class BlockDeviceUserRequest + include Google::Apis::Core::Hashable + + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # Corresponds to the JSON property `customer` + # @return [String] + attr_accessor :customer + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer = args[:customer] if args.key?(:customer) + end + end + # Response message for blocking the device from accessing user data. class BlockDeviceUserResponse include Google::Apis::Core::Hashable - # A DeviceUser is a resource representing a user's use of a Device + # Represents a user's use of a Device in the Cloud Identity Devices API. A + # DeviceUser is a resource representing a user's use of a Device # Corresponds to the JSON property `deviceUser` # @return [Google::Apis::CloudidentityV1beta1::DeviceUser] attr_accessor :device_user @@ -104,12 +152,36 @@ module Google end end + # Request message for cancelling an unfinished device wipe. + class CancelWipeDeviceRequest + include Google::Apis::Core::Hashable + + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # Corresponds to the JSON property `customer` + # @return [String] + attr_accessor :customer + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer = args[:customer] if args.key?(:customer) + end + end + # Response message for cancelling an unfinished device wipe. class CancelWipeDeviceResponse include Google::Apis::Core::Hashable - # Represents a Device known to Google Cloud, independent of the device - # ownership, type, and whether it is assigned or in use by a user. + # A Device within the Cloud Identity Devices API. Represents a Device known to + # Google Cloud, independent of the device ownership, type, and whether it is + # assigned or in use by a user. # Corresponds to the JSON property `device` # @return [Google::Apis::CloudidentityV1beta1::Device] attr_accessor :device @@ -124,11 +196,35 @@ module Google end end + # Request message for cancelling an unfinished user account wipe. + class CancelWipeDeviceUserRequest + include Google::Apis::Core::Hashable + + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # Corresponds to the JSON property `customer` + # @return [String] + attr_accessor :customer + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer = args[:customer] if args.key?(:customer) + end + end + # Response message for cancelling an unfinished user account wipe. class CancelWipeDeviceUserResponse include Google::Apis::Core::Hashable - # A DeviceUser is a resource representing a user's use of a Device + # Represents a user's use of a Device in the Cloud Identity Devices API. A + # DeviceUser is a resource representing a user's use of a Device # Corresponds to the JSON property `deviceUser` # @return [Google::Apis::CloudidentityV1beta1::DeviceUser] attr_accessor :device_user @@ -143,6 +239,7 @@ module Google end end + # Represents the state associated with an API client calling the Devices API. # Resource representing ClientState and supports updates from API users class ClientState include Google::Apis::Core::Hashable @@ -168,9 +265,8 @@ module Google # @return [String] attr_accessor :custom_id - # The token that needs to be passed back for - # concurrency control in updates. Token needs to be passed back - # in UpdateRequest + # The token that needs to be passed back for concurrency control in updates. + # Token needs to be passed back in UpdateRequest # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -180,9 +276,9 @@ module Google # @return [String] attr_accessor :health_score - # The map of key-value attributes stored by callers specific to a - # device. The total serialized length of this map may not exceed 10KB. No - # limit is placed on the number of attributes in a map. + # The map of key-value attributes stored by callers specific to a device. The + # total serialized length of this map may not exceed 10KB. No limit is placed on + # the number of attributes in a map. # Corresponds to the JSON property `keyValuePairs` # @return [Hash] attr_accessor :key_value_pairs @@ -198,10 +294,9 @@ module Google attr_accessor :managed # Output only. [Resource name](https://cloud.google.com/apis/design/ - # resource_names) of - # the ClientState in format: - # `devices/`device_id`/deviceUsers/`device_user_id`/clientState/`partner_id``, - # where partner_id corresponds to the partner storing the data. + # resource_names) of the ClientState in format: `devices/`device_id`/deviceUsers/ + # `device_user_id`/clientState/`partner_id``, where partner_id corresponds to + # the partner storing the data. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -237,6 +332,37 @@ module Google end end + # Request message for creating a Company Owned device. + class CreateDeviceRequest + include Google::Apis::Core::Hashable + + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # Corresponds to the JSON property `customer` + # @return [String] + attr_accessor :customer + + # A Device within the Cloud Identity Devices API. Represents a Device known to + # Google Cloud, independent of the device ownership, type, and whether it is + # assigned or in use by a user. + # Corresponds to the JSON property `device` + # @return [Google::Apis::CloudidentityV1beta1::Device] + attr_accessor :device + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer = args[:customer] if args.key?(:customer) + @device = args[:device] if args.key?(:device) + end + end + # Additional custom attribute values may be one of these types class CustomAttributeValue include Google::Apis::Core::Hashable @@ -269,8 +395,9 @@ module Google end end - # Represents a Device known to Google Cloud, independent of the device - # ownership, type, and whether it is assigned or in use by a user. + # A Device within the Cloud Identity Devices API. Represents a Device known to + # Google Cloud, independent of the device ownership, type, and whether it is + # assigned or in use by a user. class Device include Google::Apis::Core::Hashable @@ -310,8 +437,7 @@ module Google attr_accessor :compromised_state # Output only. When the Company-Owned device was imported. This field is empty - # for BYOD - # devices. + # for BYOD devices. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -374,9 +500,8 @@ module Google attr_accessor :model # Output only. [Resource name](https://cloud.google.com/apis/design/ - # resource_names) - # of the Device in format: `devices/`device_id``, where device_id is - # the unique id assigned to the Device. + # resource_names) of the Device in format: `devices/`device_id``, where + # device_id is the unique id assigned to the Device. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -392,9 +517,8 @@ module Google attr_accessor :os_version # Output only. Domain name for Google accounts on device. Type for other - # accounts on - # device. On Android, will only be populated if |ownership_privilege| is - # |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in + # accounts on device. On Android, will only be populated if |ownership_privilege| + # is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in # to the device policy app if that account's domain has only one account. # Examples: "com.example", "xyz.com". # Corresponds to the JSON property `otherAccounts` @@ -463,7 +587,8 @@ module Google end end - # A DeviceUser is a resource representing a user's use of a Device + # Represents a user's use of a Device in the Cloud Identity Devices API. A + # DeviceUser is a resource representing a user's use of a Device class DeviceUser include Google::Apis::Core::Hashable @@ -498,9 +623,9 @@ module Google attr_accessor :management_state # Output only. [Resource name](https://cloud.google.com/apis/design/ - # resource_names) of - # the DeviceUser in format: `devices/`device_id`/deviceUsers/`user_id``, - # where user_id is the ID of the user associated with the user session. + # resource_names) of the DeviceUser in format: `devices/`device_id`/deviceUsers/` + # user_id``, where user_id is the ID of the user associated with the user + # session. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -539,82 +664,26 @@ module Google end end - # An EndpointApp represents an app that is installed on a device - class EndpointApp - include Google::Apis::Core::Hashable - - # Output only. Name of the app displayed to the user - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # Output only. [Resource name](https://cloud.google.com/apis/design/ - # resource_names) of - # the EndpointApp in format: - # `devices/`device`/deviceUsers/`device_user`/endpointApps/`endpoint_app``, - # where client_app_id is the ID of the app associated with the Device. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Output only. Full package name of the installed app - # Corresponds to the JSON property `packageName` - # @return [String] - attr_accessor :package_name - - # Output only. Names of all permissions granted to the installed app - # Corresponds to the JSON property `permissions` - # @return [Array] - attr_accessor :permissions - - # Output only. Version code of the installed app - # Corresponds to the JSON property `versionCode` - # @return [Fixnum] - attr_accessor :version_code - - # Output only. Version name of the installed app - # Corresponds to the JSON property `versionName` - # @return [String] - attr_accessor :version_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @display_name = args[:display_name] if args.key?(:display_name) - @name = args[:name] if args.key?(:name) - @package_name = args[:package_name] if args.key?(:package_name) - @permissions = args[:permissions] if args.key?(:permissions) - @version_code = args[:version_code] if args.key?(:version_code) - @version_name = args[:version_name] if args.key?(:version_name) - end - end - - # A unique identifier for an entity in the Cloud Identity Groups API. - # An entity can represent either a group with an optional `namespace` or a user - # without a `namespace`. The combination of `id` and `namespace` must be - # unique; however, the same `id` can be used with different `namespace`s. + # A unique identifier for an entity in the Cloud Identity Groups API. An entity + # can represent either a group with an optional `namespace` or a user without a ` + # namespace`. The combination of `id` and `namespace` must be unique; however, + # the same `id` can be used with different `namespace`s. class EntityKey include Google::Apis::Core::Hashable - # The ID of the entity. - # For Google-managed entities, the `id` must be the email address of an - # existing group or user. - # For external-identity-mapped entities, the `id` must be a string conforming - # to the Identity Source's requirements. + # The ID of the entity. For Google-managed entities, the `id` must be the email + # address of an existing group or user. For external-identity-mapped entities, + # the `id` must be a string conforming to the Identity Source's requirements. # Must be unique within a `namespace`. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # The namespace in which the entity exists. - # If not specified, the `EntityKey` represents a Google-managed entity such - # as a Google user or a Google Group. - # If specified, the `EntityKey` represents an external-identity-mapped group. - # The namespace must correspond to an identity source created in Admin - # Console and must be in the form of `identitysources/`identity_source_id`. + # The namespace in which the entity exists. If not specified, the `EntityKey` + # represents a Google-managed entity such as a Google user or a Google Group. If + # specified, the `EntityKey` represents an external-identity-mapped group. The + # namespace must correspond to an identity source created in Admin Console and + # must be in the form of `identitysources/`identity_source_id`. # Corresponds to the JSON property `namespace` # @return [String] attr_accessor :namespace @@ -658,9 +727,9 @@ module Google # @return [Array] attr_accessor :adjacency_list - # The resources representing each group in the adjacency list. Each - # group in this list can be correlated to a 'group' of the - # MembershipAdjacencyList using the 'name' of the Group resource. + # The resources representing each group in the adjacency list. Each group in + # this list can be correlated to a 'group' of the MembershipAdjacencyList using + # the 'name' of the Group resource. # Corresponds to the JSON property `groups` # @return [Array] attr_accessor :groups @@ -676,9 +745,9 @@ module Google end end - # A group within the Cloud Identity Groups API. - # A `Group` is a collection of entities, where each entity is either a user, - # another group or a service account. + # A group within the Cloud Identity Groups API. A `Group` is a collection of + # entities, where each entity is either a user, another group, or a service + # account. class Group include Google::Apis::Core::Hashable @@ -692,8 +761,8 @@ module Google # @return [String] attr_accessor :create_time - # An extended description to help users determine the purpose of a `Group`. - # Must not be longer than 4,096 characters. + # An extended description to help users determine the purpose of a `Group`. Must + # not be longer than 4,096 characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -703,36 +772,39 @@ module Google # @return [String] attr_accessor :display_name - # A unique identifier for an entity in the Cloud Identity Groups API. - # An entity can represent either a group with an optional `namespace` or a user - # without a `namespace`. The combination of `id` and `namespace` must be - # unique; however, the same `id` can be used with different `namespace`s. + # A unique identifier for an entity in the Cloud Identity Groups API. An entity + # can represent either a group with an optional `namespace` or a user without a ` + # namespace`. The combination of `id` and `namespace` must be unique; however, + # the same `id` can be used with different `namespace`s. # Corresponds to the JSON property `groupKey` # @return [Google::Apis::CloudidentityV1beta1::EntityKey] attr_accessor :group_key - # Required. The labels that apply to the `Group`. - # Must not contain more than one entry. Must contain the entry - # `'cloudidentity.googleapis.com/groups.discussion_forum': ''` if the `Group` - # is a Google Group or `'system/groups/external': ''` if the `Group` is an - # external-identity-mapped group. + # Required. One or more label entries that apply to the Group. Currently + # supported labels contain a key with an empty value. Google Groups are the + # default type of group and have a label with a key of 'cloudidentity.googleapis. + # com/groups.discussion_forum' and an empty value. Existing Google Groups can + # have an additional label with a key of 'cloudidentity.googleapis.com/groups. + # security' and an empty value added to them. **This is an immutable change and + # the security label cannot be removed once added.** Dynamic groups have a label + # with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped + # groups for Cloud Search have a label with a key of 'system/groups/external' + # and an empty value. Examples: `"cloudidentity.googleapis.com/groups. + # discussion_forum": ""` or `"system/groups/external": ""`. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Output only. The [resource name](https://cloud.google.com/apis/design/ - # resource_names) of - # the `Group`. - # Shall be of the form `groups/`group_id``. + # resource_names) of the `Group`. Shall be of the form `groups/`group_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. Immutable. The resource name of the entity under which this `Group` - # resides in the - # Cloud Identity resource hierarchy. - # Must be of the form `identitysources/`identity_source_id`` for external- - # identity-mapped groups or `customers/`customer_id`` for Google Groups. + # resides in the Cloud Identity resource hierarchy. Must be of the form ` + # identitysources/`identity_source_id`` for external- identity-mapped groups or ` + # customers/`customer_id`` for Google Groups. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -760,8 +832,7 @@ module Google end end - # Response message that is returned in LRO result of ListClientStates - # Operation. + # Response message that is returned in LRO result of ListClientStates Operation. class ListClientStatesResponse include Google::Apis::Core::Hashable @@ -770,8 +841,7 @@ module Google # @return [Array] attr_accessor :client_states - # Token to retrieve the next page of results. Empty if there are no more - # results. + # Token to retrieve the next page of results. Empty if there are no more results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -787,7 +857,7 @@ module Google end end - # Response message that is returned in LRO result of ListDeviceUsers Operation. + # Response message that is returned from the ListDeviceUsers method. class ListDeviceUsersResponse include Google::Apis::Core::Hashable @@ -796,8 +866,7 @@ module Google # @return [Array] attr_accessor :device_users - # Token to retrieve the next page of results. Empty if there are no more - # results. + # Token to retrieve the next page of results. Empty if there are no more results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -813,7 +882,7 @@ module Google end end - # Response message that is returned in LRO result of ListDevices Operation. + # Response message that is returned from the ListDevices method. class ListDevicesResponse include Google::Apis::Core::Hashable @@ -822,8 +891,7 @@ module Google # @return [Array] attr_accessor :devices - # Token to retrieve the next page of results. Empty if there are no more - # results. + # Token to retrieve the next page of results. Empty if there are no more results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -839,32 +907,6 @@ module Google end end - # Response message for listing all apps on the device. - class ListEndpointAppsResponse - include Google::Apis::Core::Hashable - - # The list of matching EndpointApps found as a result of the request. - # Corresponds to the JSON property `endpointApps` - # @return [Array] - attr_accessor :endpoint_apps - - # Token to retrieve the next page of results. Empty if there are no more - # results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @endpoint_apps = args[:endpoint_apps] if args.key?(:endpoint_apps) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - # The response message for GroupsService.ListGroups. class ListGroupsResponse include Google::Apis::Core::Hashable @@ -874,8 +916,8 @@ module Google # @return [Array] attr_accessor :groups - # A continuation token to retrieve the next page of results, or empty if - # there are no more results available. + # A continuation token to retrieve the next page of results, or empty if there + # are no more results available. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -900,8 +942,8 @@ module Google # @return [Array] attr_accessor :memberships - # A continuation token to retrieve the next page of results, or empty if - # there are no more results available. + # A continuation token to retrieve the next page of results, or empty if there + # are no more results available. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -922,8 +964,7 @@ module Google include Google::Apis::Core::Hashable # Output only. The [resource name](https://cloud.google.com/apis/design/ - # resource_names) of - # the looked-up `Group`. + # resource_names) of the looked-up `Group`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -943,8 +984,8 @@ module Google include Google::Apis::Core::Hashable # The [resource name](https://cloud.google.com/apis/design/resource_names) of - # the looked-up `Membership`. - # Must be of the form `groups/`group_id`/memberships/`membership_id``. + # the looked-up `Membership`. Must be of the form `groups/`group_id`/memberships/ + # `membership_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -964,23 +1005,21 @@ module Google class LookupSelfDeviceUsersResponse include Google::Apis::Core::Hashable - # The obfuscated customer Id that may be passed back to other - # Devices API methods such as List, Get, etc. + # The obfuscated customer Id that may be passed back to other Devices API + # methods such as List, Get, etc. # Corresponds to the JSON property `customer` # @return [String] attr_accessor :customer - # [Resource names](https://cloud.google.com/apis/design/resource_names) of - # the DeviceUsers in the format: - # `devices/`device_id`/deviceUsers/`user_resource_id``, where - # device_id is the unique ID assigned to a Device and - # user_resource_id is the unique user ID + # [Resource names](https://cloud.google.com/apis/design/resource_names) of the + # DeviceUsers in the format: `devices/`device_id`/deviceUsers/`user_resource_id`` + # , where device_id is the unique ID assigned to a Device and user_resource_id + # is the unique user ID # Corresponds to the JSON property `names` # @return [Array] attr_accessor :names - # Token to retrieve the next page of results. Empty if there are no more - # results. + # Token to retrieve the next page of results. Empty if there are no more results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -997,9 +1036,9 @@ module Google end end - # A membership within the Cloud Identity Groups API. - # A `Membership` defines a relationship between a `Group` and an entity - # belonging to that `Group`, referred to as a "member". + # A membership within the Cloud Identity Groups API. A `Membership` defines a + # relationship between a `Group` and an entity belonging to that `Group`, + # referred to as a "member". class Membership include Google::Apis::Core::Hashable @@ -1008,33 +1047,32 @@ module Google # @return [String] attr_accessor :create_time - # A unique identifier for an entity in the Cloud Identity Groups API. - # An entity can represent either a group with an optional `namespace` or a user - # without a `namespace`. The combination of `id` and `namespace` must be - # unique; however, the same `id` can be used with different `namespace`s. + # A unique identifier for an entity in the Cloud Identity Groups API. An entity + # can represent either a group with an optional `namespace` or a user without a ` + # namespace`. The combination of `id` and `namespace` must be unique; however, + # the same `id` can be used with different `namespace`s. # Corresponds to the JSON property `memberKey` # @return [Google::Apis::CloudidentityV1beta1::EntityKey] attr_accessor :member_key # Output only. The [resource name](https://cloud.google.com/apis/design/ - # resource_names) of - # the `Membership`. - # Shall be of the form `groups/`group_id`/memberships/`membership_id``. + # resource_names) of the `Membership`. Shall be of the form `groups/`group_id`/ + # memberships/`membership_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # A unique identifier for an entity in the Cloud Identity Groups API. - # An entity can represent either a group with an optional `namespace` or a user - # without a `namespace`. The combination of `id` and `namespace` must be - # unique; however, the same `id` can be used with different `namespace`s. + # A unique identifier for an entity in the Cloud Identity Groups API. An entity + # can represent either a group with an optional `namespace` or a user without a ` + # namespace`. The combination of `id` and `namespace` must be unique; however, + # the same `id` can be used with different `namespace`s. # Corresponds to the JSON property `preferredMemberKey` # @return [Google::Apis::CloudidentityV1beta1::EntityKey] attr_accessor :preferred_member_key - # The `MembershipRole`s that apply to the `Membership`. - # If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. - # Must not contain duplicate `MembershipRole`s with the same `name`. + # The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults + # to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate ` + # MembershipRole`s with the same `name`. # Corresponds to the JSON property `roles` # @return [Array] attr_accessor :roles @@ -1090,8 +1128,8 @@ module Google end end - # A membership role within the Cloud Identity Groups API. - # A `MembershipRole` defines the privileges granted to a `Membership`. + # A membership role within the Cloud Identity Groups API. A `MembershipRole` + # defines the privileges granted to a `Membership`. class MembershipRole include Google::Apis::Core::Hashable @@ -1100,8 +1138,7 @@ module Google # @return [Google::Apis::CloudidentityV1beta1::ExpiryDetail] attr_accessor :expiry_detail - # The name of the `MembershipRole`. - # Must be one of `OWNER`, `MANAGER`, `MEMBER`. + # The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1121,29 +1158,25 @@ module Google class ModifyMembershipRolesRequest include Google::Apis::Core::Hashable - # The `MembershipRole`s to be added. - # Adding or removing roles in the same request as updating roles is not - # supported. - # Must not be set if `update_roles_params` is set. + # The `MembershipRole`s to be added. Adding or removing roles in the same + # request as updating roles is not supported. Must not be set if ` + # update_roles_params` is set. # Corresponds to the JSON property `addRoles` # @return [Array] attr_accessor :add_roles - # The `name`s of the `MembershipRole`s to be removed. - # Adding or removing roles in the same request as updating roles is not - # supported. - # It is not possible to remove the `MEMBER` `MembershipRole`. If you wish to - # delete a `Membership`, call MembershipsService.DeleteMembership - # instead. - # Must not contain `MEMBER`. Must not be set if `update_roles_params` is set. + # The `name`s of the `MembershipRole`s to be removed. Adding or removing roles + # in the same request as updating roles is not supported. It is not possible to + # remove the `MEMBER` `MembershipRole`. If you wish to delete a `Membership`, + # call MembershipsService.DeleteMembership instead. Must not contain `MEMBER`. + # Must not be set if `update_roles_params` is set. # Corresponds to the JSON property `removeRoles` # @return [Array] attr_accessor :remove_roles - # The `MembershipRole`s to be updated. - # Updating roles in the same request as adding or removing roles is not - # supported. - # Must not be set if either `add_roles` or `remove_roles` is set. + # The `MembershipRole`s to be updated. Updating roles in the same request as + # adding or removing roles is not supported. Must not be set if either ` + # add_roles` or `remove_roles` is set. # Corresponds to the JSON property `updateRolesParams` # @return [Array] attr_accessor :update_roles_params @@ -1164,9 +1197,9 @@ module Google class ModifyMembershipRolesResponse include Google::Apis::Core::Hashable - # A membership within the Cloud Identity Groups API. - # A `Membership` defines a relationship between a `Group` and an entity - # belonging to that `Group`, referred to as a "member". + # A membership within the Cloud Identity Groups API. A `Membership` defines a + # relationship between a `Group` and an entity belonging to that `Group`, + # referred to as a "member". # Corresponds to the JSON property `membership` # @return [Google::Apis::CloudidentityV1beta1::Membership] attr_accessor :membership @@ -1186,47 +1219,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::CloudidentityV1beta1::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] 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] attr_accessor :response @@ -1254,8 +1285,8 @@ module Google # @return [Array] attr_accessor :groups - # A continuation token to retrieve the next page of results, or empty if - # there are no more results available. + # A continuation token to retrieve the next page of results, or empty if there + # are no more results available. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1271,12 +1302,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 @@ -1285,15 +1316,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>] 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 @@ -1314,14 +1345,14 @@ module Google class UpdateMembershipRolesParams include Google::Apis::Core::Hashable - # The fully-qualified names of fields to update. - # May only contain the field `expiry_detail`. + # The fully-qualified names of fields to update. May only contain the field ` + # expiry_detail`. # Corresponds to the JSON property `fieldMask` # @return [String] attr_accessor :field_mask - # A membership role within the Cloud Identity Groups API. - # A `MembershipRole` defines the privileges granted to a `Membership`. + # A membership role within the Cloud Identity Groups API. A `MembershipRole` + # defines the privileges granted to a `Membership`. # Corresponds to the JSON property `membershipRole` # @return [Google::Apis::CloudidentityV1beta1::MembershipRole] attr_accessor :membership_role @@ -1337,12 +1368,36 @@ module Google end end + # Request message for wiping all data on the device. + class WipeDeviceRequest + include Google::Apis::Core::Hashable + + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # Corresponds to the JSON property `customer` + # @return [String] + attr_accessor :customer + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer = args[:customer] if args.key?(:customer) + end + end + # Response message for wiping all data on the device. class WipeDeviceResponse include Google::Apis::Core::Hashable - # Represents a Device known to Google Cloud, independent of the device - # ownership, type, and whether it is assigned or in use by a user. + # A Device within the Cloud Identity Devices API. Represents a Device known to + # Google Cloud, independent of the device ownership, type, and whether it is + # assigned or in use by a user. # Corresponds to the JSON property `device` # @return [Google::Apis::CloudidentityV1beta1::Device] attr_accessor :device @@ -1357,11 +1412,35 @@ module Google end end + # Request message for starting an account wipe on device. + class WipeDeviceUserRequest + include Google::Apis::Core::Hashable + + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # Corresponds to the JSON property `customer` + # @return [String] + attr_accessor :customer + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer = args[:customer] if args.key?(:customer) + end + end + # Response message for wiping the user's account from the device. class WipeDeviceUserResponse include Google::Apis::Core::Hashable - # A DeviceUser is a resource representing a user's use of a Device + # Represents a user's use of a Device in the Cloud Identity Devices API. A + # DeviceUser is a resource representing a user's use of a Device # Corresponds to the JSON property `deviceUser` # @return [Google::Apis::CloudidentityV1beta1::DeviceUser] attr_accessor :device_user diff --git a/generated/google/apis/cloudidentity_v1beta1/representations.rb b/generated/google/apis/cloudidentity_v1beta1/representations.rb index f281a1e17..b98544e63 100644 --- a/generated/google/apis/cloudidentity_v1beta1/representations.rb +++ b/generated/google/apis/cloudidentity_v1beta1/representations.rb @@ -28,24 +28,48 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ApproveDeviceUserRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ApproveDeviceUserResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class BlockDeviceUserRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class BlockDeviceUserResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class CancelWipeDeviceRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CancelWipeDeviceResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class CancelWipeDeviceUserRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CancelWipeDeviceUserResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -58,6 +82,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class CreateDeviceRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CustomAttributeValue class Representation < Google::Apis::Core::JsonRepresentation; end @@ -76,12 +106,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class EndpointApp - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class EntityKey class Representation < Google::Apis::Core::JsonRepresentation; end @@ -124,12 +148,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class ListEndpointAppsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class ListGroupsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -214,12 +232,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class WipeDeviceRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class WipeDeviceResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class WipeDeviceUserRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class WipeDeviceUserResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -236,6 +266,13 @@ module Google end end + class ApproveDeviceUserRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer, as: 'customer' + end + end + class ApproveDeviceUserResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -244,6 +281,13 @@ module Google end end + class BlockDeviceUserRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer, as: 'customer' + end + end + class BlockDeviceUserResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -252,6 +296,13 @@ module Google end end + class CancelWipeDeviceRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer, as: 'customer' + end + end + class CancelWipeDeviceResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -260,6 +311,13 @@ module Google end end + class CancelWipeDeviceUserRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer, as: 'customer' + end + end + class CancelWipeDeviceUserResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -287,6 +345,15 @@ module Google end end + class CreateDeviceRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer, as: 'customer' + property :device, as: 'device', class: Google::Apis::CloudidentityV1beta1::Device, decorator: Google::Apis::CloudidentityV1beta1::Device::Representation + + end + end + class CustomAttributeValue # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -347,18 +414,6 @@ module Google end end - class EndpointApp - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :display_name, as: 'displayName' - property :name, as: 'name' - property :package_name, as: 'packageName' - collection :permissions, as: 'permissions' - property :version_code, as: 'versionCode' - property :version_name, as: 'versionName' - end - end - class EntityKey # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -428,15 +483,6 @@ module Google end end - class ListEndpointAppsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :endpoint_apps, as: 'endpointApps', class: Google::Apis::CloudidentityV1beta1::EndpointApp, decorator: Google::Apis::CloudidentityV1beta1::EndpointApp::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - class ListGroupsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -570,6 +616,13 @@ module Google end end + class WipeDeviceRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer, as: 'customer' + end + end + class WipeDeviceResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -578,6 +631,13 @@ module Google end end + class WipeDeviceUserRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer, as: 'customer' + end + end + class WipeDeviceUserResponse # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/cloudidentity_v1beta1/service.rb b/generated/google/apis/cloudidentity_v1beta1/service.rb index ccf3f4392..e1d3abf9c 100644 --- a/generated/google/apis/cloudidentity_v1beta1/service.rb +++ b/generated/google/apis/cloudidentity_v1beta1/service.rb @@ -47,6 +47,681 @@ module Google @batch_path = 'batch' end + # Cancels an unfinished device wipe. This operation can be used to cancel device + # wipe in the gap between the wipe operation returning success and the device + # being wiped. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id``, where device_id is the unique + # ID assigned to the Device, and device_user_id is the unique ID assigned to the + # User. + # @param [Google::Apis::CloudidentityV1beta1::CancelWipeDeviceRequest] cancel_wipe_device_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::Operation] + # + # @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 cancel_wipe_device(name, cancel_wipe_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:cancelWipe', options) + command.request_representation = Google::Apis::CloudidentityV1beta1::CancelWipeDeviceRequest::Representation + command.request_object = cancel_wipe_device_request_object + command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a device. Only company-owned device may be created. + # @param [Google::Apis::CloudidentityV1beta1::CreateDeviceRequest] create_device_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::Operation] + # + # @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_device(create_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/devices', options) + command.request_representation = Google::Apis::CloudidentityV1beta1::CreateDeviceRequest::Representation + command.request_object = create_device_request_object + command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::Operation + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified device. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id``, where device_id is the unique + # ID assigned to the Device. + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::Operation] + # + # @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 delete_device(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['customer'] = customer unless customer.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the specified device. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id``, where device_id is the unique + # ID assigned to the Device. + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Customer in format: `customers/`customer_id``, where customer_id is the + # customer to whom the device belongs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::Device] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::Device] + # + # @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_device(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::CloudidentityV1beta1::Device::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::Device + command.params['name'] = name unless name.nil? + command.query['customer'] = customer unless customer.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists/Searches devices. + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. + # @param [String] filter + # Optional. Additional restrictions when fetching list of devices. [HC article + # link](https://support.google.com/a/answer/7549103) + # @param [String] order_by + # Optional. Order specification for devices in the response. Only one of the + # following field names may be used to specify the order: `create_time`, ` + # last_sync_time`, `model`, `os_version`, `device_type` and `serial_number`. ` + # desc` may be specified optionally to specify results to be sorted in + # descending order. Default order is ascending. + # @param [Fixnum] page_size + # Optional. The maximum number of Devices to return. If unspecified, at most 20 + # Devices will be returned. The maximum value is 100; values above 100 will be + # coerced to 100. + # @param [String] page_token + # Optional. A page token, received from a previous `ListDevices` call. Provide + # this to retrieve the subsequent page. When paginating, all other parameters + # provided to `ListDevices` must match the call that provided the page token. + # @param [String] view + # Optional. The view to use for the List request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::ListDevicesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::ListDevicesResponse] + # + # @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_devices(customer: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/devices', options) + command.response_representation = Google::Apis::CloudidentityV1beta1::ListDevicesResponse::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::ListDevicesResponse + command.query['customer'] = customer unless customer.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['view'] = view unless view.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Wipes all data on the specified device. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``, + # where device_id is the unique ID assigned to the Device, and device_user_id is + # the unique ID assigned to the User. + # @param [Google::Apis::CloudidentityV1beta1::WipeDeviceRequest] wipe_device_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::Operation] + # + # @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 wipe_device(name, wipe_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:wipe', options) + command.request_representation = Google::Apis::CloudidentityV1beta1::WipeDeviceRequest::Representation + command.request_object = wipe_device_request_object + command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Approves device to access user data. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``, + # where device_id is the unique ID assigned to the Device, and device_user_id is + # the unique ID assigned to the User. + # @param [Google::Apis::CloudidentityV1beta1::ApproveDeviceUserRequest] approve_device_user_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::Operation] + # + # @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 approve_device_user(name, approve_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:approve', options) + command.request_representation = Google::Apis::CloudidentityV1beta1::ApproveDeviceUserRequest::Representation + command.request_object = approve_device_user_request_object + command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Blocks device from accessing user data + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``, + # where device_id is the unique ID assigned to the Device, and device_user_id is + # the unique ID assigned to the User. + # @param [Google::Apis::CloudidentityV1beta1::BlockDeviceUserRequest] block_device_user_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::Operation] + # + # @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 block_device_user(name, block_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:block', options) + command.request_representation = Google::Apis::CloudidentityV1beta1::BlockDeviceUserRequest::Representation + command.request_object = block_device_user_request_object + command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Cancels an unfinished user account wipe. This operation can be used to cancel + # device wipe in the gap between the wipe operation returning success and the + # device being wiped. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``, + # where device_id is the unique ID assigned to the Device, and device_user_id is + # the unique ID assigned to the User. + # @param [Google::Apis::CloudidentityV1beta1::CancelWipeDeviceUserRequest] cancel_wipe_device_user_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::Operation] + # + # @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 cancel_wipe_device_user(name, cancel_wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:cancelWipe', options) + command.request_representation = Google::Apis::CloudidentityV1beta1::CancelWipeDeviceUserRequest::Representation + command.request_object = cancel_wipe_device_user_request_object + command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified DeviceUser. This also revokes the user's access to + # device data. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``, + # where device_id is the unique ID assigned to the Device, and device_user_id is + # the unique ID assigned to the User. + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::Operation] + # + # @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 delete_device_device_user(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['customer'] = customer unless customer.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the specified DeviceUser + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``, + # where device_id is the unique ID assigned to the Device, and device_user_id is + # the unique ID assigned to the User. + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::DeviceUser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::DeviceUser] + # + # @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_device_device_user(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::CloudidentityV1beta1::DeviceUser::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::DeviceUser + command.params['name'] = name unless name.nil? + command.query['customer'] = customer unless customer.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists/Searches DeviceUsers. + # @param [String] parent + # Required. To list all DeviceUsers, set this to "devices/-". To list all + # DeviceUsers owned by a device, set this to the resource name of the device. + # Format: devices/`device` + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # @param [String] filter + # Optional. Additional restrictions when fetching list of devices. [HC article]( + # https://support.google.com/a/answer/7549103) + # @param [String] order_by + # Optional. Order specification for devices in the response. + # @param [Fixnum] page_size + # Optional. The maximum number of DeviceUsers to return. If unspecified, at most + # 5 DeviceUsers will be returned. The maximum value is 20; values above 20 will + # be coerced to 20. + # @param [String] page_token + # Optional. A page token, received from a previous `ListDeviceUsers` call. + # Provide this to retrieve the subsequent page. When paginating, all other + # parameters provided to `ListBooks` must match the call that provided the page + # token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse] + # + # @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_device_device_users(parent, customer: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/deviceUsers', options) + command.response_representation = Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::ListDeviceUsersResponse + command.params['parent'] = parent unless parent.nil? + command.query['customer'] = customer unless customer.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + 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? + execute_or_queue_command(command, &block) + end + + # Looks up resource names of the DeviceUsers associated with the caller's + # credentials, as well as the properties provided in the request. This method + # must be called with end-user credentials with the scope: https://www. + # googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are + # provided, only DeviceUsers having all of these properties are considered as + # matches - i.e. the query behaves like an AND. Different platforms require + # different amounts of information from the caller to ensure that the DeviceUser + # is uniquely identified. - iOS: No properties need to be passed, the caller's + # credentials are sufficient to identify the corresponding DeviceUser. - Android: + # Specifying the 'android_id' field is required. - Desktop: Specifying the ' + # raw_resource_id' field is required. + # @param [String] parent + # Must be set to "devices/-/deviceUsers" to search across all DeviceUser + # belonging to the user. + # @param [String] android_id + # Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android. + # com/reference/android/provider/Settings.Secure.html#ANDROID_ID). + # @param [Fixnum] page_size + # The maximum number of DeviceUsers to return. If unspecified, at most 20 + # DeviceUsers will be returned. The maximum value is 20; values above 20 will be + # coerced to 20. + # @param [String] page_token + # A page token, received from a previous `LookupDeviceUsers` call. Provide this + # to retrieve the subsequent page. When paginating, all other parameters + # provided to `LookupDeviceUsers` must match the call that provided the page + # token. + # @param [String] raw_resource_id + # Raw Resource Id used by Google Endpoint Verification. If the user is enrolled + # into Google Endpoint Verification, this id will be saved as the ' + # device_resource_id' field in the following platform dependent files. Mac: ~/. + # secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%\. + # secureConnect\context_aware_config.json Linux: ~/.secureConnect/ + # context_aware_config.json + # @param [String] user_id + # The user whose DeviceUser's resource name will be fetched. Must be set to 'me' + # to fetch the DeviceUser's resource name for the calling user. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::LookupSelfDeviceUsersResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::LookupSelfDeviceUsersResponse] + # + # @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 lookup_device_device_user(parent, android_id: nil, page_size: nil, page_token: nil, raw_resource_id: nil, user_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}:lookup', options) + command.response_representation = Google::Apis::CloudidentityV1beta1::LookupSelfDeviceUsersResponse::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::LookupSelfDeviceUsersResponse + command.params['parent'] = parent unless parent.nil? + command.query['androidId'] = android_id unless android_id.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['rawResourceId'] = raw_resource_id unless raw_resource_id.nil? + command.query['userId'] = user_id unless user_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Wipes the user's account on a device. + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the Device in format: `devices/`device_id`/deviceUsers/`device_user_id``, + # where device_id is the unique ID assigned to the Device, and device_user_id is + # the unique ID assigned to the User. + # @param [Google::Apis::CloudidentityV1beta1::WipeDeviceUserRequest] wipe_device_user_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::Operation] + # + # @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 wipe_device_user(name, wipe_device_user_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:wipe', options) + command.request_representation = Google::Apis::CloudidentityV1beta1::WipeDeviceUserRequest::Representation + command.request_object = wipe_device_user_request_object + command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the client state for the device user + # @param [String] name + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the ClientState in format: `devices/`device_id`/deviceUsers/`device_user_id` + # /clientStates/`partner_id``, where device_id is the unique ID assigned to the + # Device, device_user_id is the unique ID assigned to the User and partner_id + # identifies the partner storing the data. + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::ClientState] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::ClientState] + # + # @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_device_device_user_client_state(name, customer: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::CloudidentityV1beta1::ClientState::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::ClientState + command.params['name'] = name unless name.nil? + command.query['customer'] = customer unless customer.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the client state for the device user + # @param [String] name + # Output only. [Resource name](https://cloud.google.com/apis/design/ + # resource_names) of the ClientState in format: `devices/`device_id`/deviceUsers/ + # `device_user_id`/clientState/`partner_id``, where partner_id corresponds to + # the partner storing the data. + # @param [Google::Apis::CloudidentityV1beta1::ClientState] client_state_object + # @param [String] customer + # Required. [Resource name](https://cloud.google.com/apis/design/resource_names) + # of the customer. If you're using this API for your own organization, use ` + # customers/my_customer` If you're using this API to manage another organization, + # use `customers/`customer_id``, where customer_id is the customer to whom the + # device belongs. + # @param [String] update_mask + # Optional. Comma-separated list of fully qualified names of fields to be + # updated. If not specified, all updatable fields in ClientState are updated. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudidentityV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudidentityV1beta1::Operation] + # + # @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_device_device_user_client_state(name, client_state_object = nil, customer: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta1/{+name}', options) + command.request_representation = Google::Apis::CloudidentityV1beta1::ClientState::Representation + command.request_object = client_state_object + command.response_representation = Google::Apis::CloudidentityV1beta1::Operation::Representation + command.response_class = Google::Apis::CloudidentityV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['customer'] = customer unless customer.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a `Group`. # @param [Google::Apis::CloudidentityV1beta1::Group] group_object # @param [String] initial_group_config @@ -83,9 +758,8 @@ module Google # Deletes a `Group`. # @param [String] name # Required. The [resource name](https://cloud.google.com/apis/design/ - # resource_names) of - # the `Group` to retrieve. - # Must be of the form `groups/`group_id``. + # resource_names) of the `Group` to retrieve. Must be of the form `groups/` + # group_id``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -116,9 +790,8 @@ module Google # Retrieves a `Group`. # @param [String] name # Required. The [resource name](https://cloud.google.com/apis/design/ - # resource_names) of - # the `Group` to retrieve. - # Must be of the form `groups/`group_id``. + # resource_names) of the `Group` to retrieve. Must be of the form `groups/` + # group_id``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -148,22 +821,20 @@ module Google # Lists the `Group`s under a customer or namespace. # @param [Fixnum] page_size - # The maximum number of results to return. - # Note that the number of results returned may be less than this value even - # if there are more available results. To fetch all results, clients must - # continue calling this method repeatedly until the response no longer - # contains a `next_page_token`. - # If unspecified, defaults to 200 for `View.BASIC` and to 50 for `View.FULL`. - # Must not be greater than 1000 for `View.BASIC` or 500 for `View.FULL`. + # The maximum number of results to return. Note that the number of results + # returned may be less than this value even if there are more available results. + # To fetch all results, clients must continue calling this method repeatedly + # until the response no longer contains a `next_page_token`. If unspecified, + # defaults to 200 for `View.BASIC` and to 50 for `View.FULL`. Must not be + # greater than 1000 for `View.BASIC` or 500 for `View.FULL`. # @param [String] page_token # The `next_page_token` value returned from a previous list request, if any. # @param [String] parent - # Required. The parent resource under which to list all `Group`s. - # Must be of the form `identitysources/`identity_source_id`` for external- - # identity-mapped groups or `customers/`customer_id`` for Google Groups. + # Required. The parent resource under which to list all `Group`s. Must be of the + # form `identitysources/`identity_source_id`` for external- identity-mapped + # groups or `customers/`customer_id`` for Google Groups. # @param [String] view - # The level of detail to be returned. - # If unspecified, defaults to `View.BASIC`. + # The level of detail to be returned. If unspecified, defaults to `View.BASIC`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -194,23 +865,19 @@ module Google execute_or_queue_command(command, &block) end - # Looks up the [resource - # name](https://cloud.google.com/apis/design/resource_names) of a `Group` by - # its `EntityKey`. + # Looks up the [resource name](https://cloud.google.com/apis/design/ + # resource_names) of a `Group` by its `EntityKey`. # @param [String] group_key_id - # The ID of the entity. - # For Google-managed entities, the `id` must be the email address of an - # existing group or user. - # For external-identity-mapped entities, the `id` must be a string conforming - # to the Identity Source's requirements. + # The ID of the entity. For Google-managed entities, the `id` must be the email + # address of an existing group or user. For external-identity-mapped entities, + # the `id` must be a string conforming to the Identity Source's requirements. # Must be unique within a `namespace`. # @param [String] group_key_namespace - # The namespace in which the entity exists. - # If not specified, the `EntityKey` represents a Google-managed entity such - # as a Google user or a Google Group. - # If specified, the `EntityKey` represents an external-identity-mapped group. - # The namespace must correspond to an identity source created in Admin - # Console and must be in the form of `identitysources/`identity_source_id`. + # The namespace in which the entity exists. If not specified, the `EntityKey` + # represents a Google-managed entity such as a Google user or a Google Group. If + # specified, the `EntityKey` represents an external-identity-mapped group. The + # namespace must correspond to an identity source created in Admin Console and + # must be in the form of `identitysources/`identity_source_id`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -242,13 +909,11 @@ module Google # Updates a `Group`. # @param [String] name # Output only. The [resource name](https://cloud.google.com/apis/design/ - # resource_names) of - # the `Group`. - # Shall be of the form `groups/`group_id``. + # resource_names) of the `Group`. Shall be of the form `groups/`group_id``. # @param [Google::Apis::CloudidentityV1beta1::Group] group_object # @param [String] update_mask - # Required. The fully-qualified names of fields to update. - # May only contain the following fields: `display_name`, `description`. + # Required. The fully-qualified names of fields to update. May only contain the + # following fields: `display_name`, `description`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -281,28 +946,22 @@ module Google # Searches for `Group`s matching a specified query. # @param [Fixnum] page_size - # The maximum number of results to return. - # Note that the number of results returned may be less than this value even - # if there are more available results. To fetch all results, clients must - # continue calling this method repeatedly until the response no longer - # contains a `next_page_token`. - # If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for - # `GroupView.FULL`. - # Must not be greater than 1000 for `GroupView.BASIC` or 500 for - # `GroupView.FULL`. + # The maximum number of results to return. Note that the number of results + # returned may be less than this value even if there are more available results. + # To fetch all results, clients must continue calling this method repeatedly + # until the response no longer contains a `next_page_token`. If unspecified, + # defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not + # be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`. # @param [String] page_token - # The `next_page_token` value returned from a previous search request, if - # any. + # The `next_page_token` value returned from a previous search request, if any. # @param [String] query - # Required. The search query. - # Must be specified in [Common Expression - # Language](https://opensource.google/projects/cel). May only contain - # equality operators on the parent and inclusion operators on labels (e.g., - # `parent == 'customers/`customer_id`' && - # 'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). + # Required. The search query. Must be specified in [Common Expression Language]( + # https://opensource.google/projects/cel). May only contain equality operators + # on the parent and inclusion operators on labels (e.g., `parent == 'customers/` + # customer_id`' && 'cloudidentity.googleapis.com/groups.discussion_forum' in + # labels`). # @param [String] view - # The level of detail to be returned. - # If unspecified, defaults to `View.BASIC`. + # The level of detail to be returned. If unspecified, defaults to `View.BASIC`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -370,9 +1029,8 @@ module Google # Deletes a `Membership`. # @param [String] name # Required. The [resource name](https://cloud.google.com/apis/design/ - # resource_names) of - # the `Membership` to delete. - # Must be of the form `groups/`group_id`/memberships/`membership_id``. + # resource_names) of the `Membership` to delete. Must be of the form `groups/` + # group_id`/memberships/`membership_id``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -403,9 +1061,8 @@ module Google # Retrieves a `Membership`. # @param [String] name # Required. The [resource name](https://cloud.google.com/apis/design/ - # resource_names) of - # the `Membership` to retrieve. - # Must be of the form `groups/`group_id`/memberships/`membership_id``. + # resource_names) of the `Membership` to retrieve. Must be of the form `groups/` + # group_id`/memberships/`membership_id``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -436,24 +1093,19 @@ module Google # Lists the `Membership`s within a `Group`. # @param [String] parent # Required. The parent `Group` resource under which to lookup the `Membership` - # name. - # Must be of the form `groups/`group_id``. + # name. Must be of the form `groups/`group_id``. # @param [Fixnum] page_size - # The maximum number of results to return. - # Note that the number of results returned may be less than this value even - # if there are more available results. To fetch all results, clients must - # continue calling this method repeatedly until the response no longer - # contains a `next_page_token`. - # If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for - # `GroupView.FULL`. - # Must not be greater than 1000 for `GroupView.BASIC` or 500 for - # `GroupView.FULL`. + # The maximum number of results to return. Note that the number of results + # returned may be less than this value even if there are more available results. + # To fetch all results, clients must continue calling this method repeatedly + # until the response no longer contains a `next_page_token`. If unspecified, + # defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not + # be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`. # @param [String] page_token - # The `next_page_token` value returned from a previous search request, if - # any. + # The `next_page_token` value returned from a previous search request, if any. # @param [String] view - # The level of detail to be returned. - # If unspecified, defaults to `MembershipView.BASIC`. + # The level of detail to be returned. If unspecified, defaults to ` + # MembershipView.BASIC`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -484,27 +1136,22 @@ module Google execute_or_queue_command(command, &block) end - # Looks up the [resource - # name](https://cloud.google.com/apis/design/resource_names) of a - # `Membership` by its `EntityKey`. + # Looks up the [resource name](https://cloud.google.com/apis/design/ + # resource_names) of a `Membership` by its `EntityKey`. # @param [String] parent # Required. The parent `Group` resource under which to lookup the `Membership` - # name. - # Must be of the form `groups/`group_id``. + # name. Must be of the form `groups/`group_id``. # @param [String] member_key_id - # The ID of the entity. - # For Google-managed entities, the `id` must be the email address of an - # existing group or user. - # For external-identity-mapped entities, the `id` must be a string conforming - # to the Identity Source's requirements. + # The ID of the entity. For Google-managed entities, the `id` must be the email + # address of an existing group or user. For external-identity-mapped entities, + # the `id` must be a string conforming to the Identity Source's requirements. # Must be unique within a `namespace`. # @param [String] member_key_namespace - # The namespace in which the entity exists. - # If not specified, the `EntityKey` represents a Google-managed entity such - # as a Google user or a Google Group. - # If specified, the `EntityKey` represents an external-identity-mapped group. - # The namespace must correspond to an identity source created in Admin - # Console and must be in the form of `identitysources/`identity_source_id`. + # The namespace in which the entity exists. If not specified, the `EntityKey` + # represents a Google-managed entity such as a Google user or a Google Group. If + # specified, the `EntityKey` represents an external-identity-mapped group. The + # namespace must correspond to an identity source created in Admin Console and + # must be in the form of `identitysources/`identity_source_id`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -537,9 +1184,8 @@ module Google # Modifies the `MembershipRole`s of a `Membership`. # @param [String] name # Required. The [resource name](https://cloud.google.com/apis/design/ - # resource_names) of - # the `Membership` whose roles are to be modified. - # Must be of the form `groups/`group_id`/memberships/`membership_id``. + # resource_names) of the `Membership` whose roles are to be modified. Must be of + # the form `groups/`group_id`/memberships/`membership_id``. # @param [Google::Apis::CloudidentityV1beta1::ModifyMembershipRolesRequest] modify_membership_roles_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/cloudsearch_v1.rb b/generated/google/apis/cloudsearch_v1.rb index 65a63c406..ff9f5c358 100644 --- a/generated/google/apis/cloudsearch_v1.rb +++ b/generated/google/apis/cloudsearch_v1.rb @@ -20,13 +20,13 @@ module Google module Apis # Cloud Search API # - # Cloud Search provides cloud-based search capabilities over G Suite data. The + # Cloud Search provides cloud-based search capabilities over G Suite data. The # Cloud Search API allows indexing of non-G Suite data into Cloud Search. # # @see https://developers.google.com/cloud-search/docs/guides/ module CloudsearchV1 VERSION = 'V1' - REVISION = '20200721' + REVISION = '20200803' # Index and serve your organization's data with Cloud Search AUTH_CLOUD_SEARCH = 'https://www.googleapis.com/auth/cloud_search' diff --git a/generated/google/apis/cloudsearch_v1/classes.rb b/generated/google/apis/cloudsearch_v1/classes.rb index 9c68dfcc3..4b3d418f4 100644 --- a/generated/google/apis/cloudsearch_v1/classes.rb +++ b/generated/google/apis/cloudsearch_v1/classes.rb @@ -22,22 +22,20 @@ module Google module Apis module CloudsearchV1 - # Used to provide a search operator for boolean properties. This is - # optional. Search operators let users restrict the query to specific fields - # relevant to the type of item being searched. + # Used to provide a search operator for boolean properties. This is optional. + # Search operators let users restrict the query to specific fields relevant to + # the type of item being searched. class BooleanOperatorOptions include Google::Apis::Core::Hashable # Indicates the operator name required in the query in order to isolate the - # boolean property. For example, if operatorName is *closed* and the - # property's name is *isClosed*, then queries like - # *closed:<value>* show results only where the value of the - # property named *isClosed* matches *<value>*. By contrast, a - # search that uses the same *<value>* without an operator returns - # all items where *<value>* matches the value of any - # String properties or text within the content field for the item. - # The operator name can only contain lowercase letters (a-z). - # The maximum length is 32 characters. + # boolean property. For example, if operatorName is *closed* and the property's + # name is *isClosed*, then queries like *closed:* show results only where + # the value of the property named *isClosed* matches **. By contrast, a + # search that uses the same ** without an operator returns all items + # where ** matches the value of any String properties or text within the + # content field for the item. The operator name can only contain lowercase + # letters (a-z). The maximum length is 32 characters. # Corresponds to the JSON property `operatorName` # @return [String] attr_accessor :operator_name @@ -56,9 +54,9 @@ module Google class BooleanPropertyOptions include Google::Apis::Core::Hashable - # Used to provide a search operator for boolean properties. This is - # optional. Search operators let users restrict the query to specific fields - # relevant to the type of item being searched. + # Used to provide a search operator for boolean properties. This is optional. + # Search operators let users restrict the query to specific fields relevant to + # the type of item being searched. # Corresponds to the JSON property `operatorOptions` # @return [Google::Apis::CloudsearchV1::BooleanOperatorOptions] attr_accessor :operator_options @@ -77,7 +75,7 @@ module Google class CheckAccessResponse include Google::Apis::Core::Hashable - # Returns true if principal has access. Returns false otherwise. + # Returns true if principal has access. Returns false otherwise. # Corresponds to the JSON property `hasAccess` # @return [Boolean] attr_accessor :has_access @@ -246,16 +244,15 @@ module Google end end - # Datasource is a logical namespace for items to be indexed. - # All items must belong to a datasource. This is the prerequisite before - # items can be indexed into Cloud Search. + # Datasource is a logical namespace for items to be indexed. All items must + # belong to a datasource. This is the prerequisite before items can be indexed + # into Cloud Search. class DataSource include Google::Apis::Core::Hashable - # If true, Indexing API rejects any modification calls to this datasource - # such as create, update, and delete. - # Disabling this does not imply halting process of previously - # accepted data. + # If true, Indexing API rejects any modification calls to this datasource such + # as create, update, and delete. Disabling this does not imply halting process + # of previously accepted data. # Corresponds to the JSON property `disableModifications` # @return [Boolean] attr_accessor :disable_modifications @@ -267,8 +264,7 @@ module Google attr_accessor :disable_serving alias_method :disable_serving?, :disable_serving - # Required. Display name of the datasource - # The maximum length is 300 characters. + # Required. Display name of the datasource The maximum length is 300 characters. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -278,37 +274,34 @@ module Google # @return [Array] attr_accessor :indexing_service_accounts - # This field restricts visibility to items at the datasource level. Items - # within the datasource are restricted to the union of users and groups - # included in this field. Note that, this does not ensure access to a - # specific item, as users need to have ACL permissions on the contained - # items. This ensures a high level access on the entire datasource, and - # that the individual items are not shared outside this visibility. + # This field restricts visibility to items at the datasource level. Items within + # the datasource are restricted to the union of users and groups included in + # this field. Note that, this does not ensure access to a specific item, as + # users need to have ACL permissions on the contained items. This ensures a high + # level access on the entire datasource, and that the individual items are not + # shared outside this visibility. # Corresponds to the JSON property `itemsVisibility` # @return [Array] attr_accessor :items_visibility - # Name of the datasource resource. - # Format: datasources/`source_id`. - #
The name is ignored when creating a datasource. + # Name of the datasource resource. Format: datasources/`source_id`. The name is + # ignored when creating a datasource. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # IDs of the Long Running Operations (LROs) currently running for this - # schema. + # IDs of the Long Running Operations (LROs) currently running for this schema. # Corresponds to the JSON property `operationIds` # @return [Array] attr_accessor :operation_ids - # A short name or alias for the source. This value will be used to match the - # 'source' operator. For example, if the short name is *<value>* then - # queries like *source:<value>* will only return results for this - # source. The value must be unique across all datasources. The value must - # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start - # with 'google' and cannot be one of the following: mail, gmail, docs, drive, - # groups, sites, calendar, hangouts, gplus, keep, people, teams. - # Its maximum length is 32 characters. + # A short name or alias for the source. This value will be used to match the ' + # source' operator. For example, if the short name is ** then queries + # like *source:* will only return results for this source. The value must + # be unique across all datasources. The value must only contain alphanumeric + # characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one + # of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, + # gplus, keep, people, teams. Its maximum length is 32 characters. # Corresponds to the JSON property `shortName` # @return [String] attr_accessor :short_name @@ -363,13 +356,11 @@ module Google class DataSourceRestriction include Google::Apis::Core::Hashable - # Filter options restricting the results. If multiple filters - # are present, they are grouped by object type before joining. - # Filters with the same object type are joined conjunctively, then - # the resulting expressions are joined disjunctively. - # The maximum number of elements is 20. - # NOTE: Suggest API supports only few filters at the moment: - # "objecttype", "type" and "mimetype". + # Filter options restricting the results. If multiple filters are present, they + # are grouped by object type before joining. Filters with the same object type + # are joined conjunctively, then the resulting expressions are joined + # disjunctively. The maximum number of elements is 20. NOTE: Suggest API + # supports only few filters at the moment: "objecttype", "type" and "mimetype". # For now, schema specific filters cannot be used to filter suggestions. # Corresponds to the JSON property `filterOptions` # @return [Array] @@ -426,47 +417,41 @@ module Google end end - # Optional. Provides a search operator for date properties. - # Search operators let users restrict the query to specific fields relevant - # to the type of item being searched. + # Optional. Provides a search operator for date properties. Search operators let + # users restrict the query to specific fields relevant to the type of item being + # searched. class DateOperatorOptions include Google::Apis::Core::Hashable - # Indicates the operator name required in the query in order to isolate the - # date property using the greater-than operator. For example, if - # greaterThanOperatorName is *closedafter* and the property's name is - # *closeDate*, then queries like *closedafter:<value>* - # show results only where the value of the property named *closeDate* is - # later than *<value>*. - # The operator name can only contain lowercase letters (a-z). - # The maximum length is 32 characters. + # Indicates the operator name required in the query in order to isolate the date + # property using the greater-than operator. For example, if + # greaterThanOperatorName is *closedafter* and the property's name is *closeDate* + # , then queries like *closedafter:* show results only where the value of + # the property named *closeDate* is later than **. The operator name can + # only contain lowercase letters (a-z). The maximum length is 32 characters. # Corresponds to the JSON property `greaterThanOperatorName` # @return [String] attr_accessor :greater_than_operator_name - # Indicates the operator name required in the query in order to isolate the - # date property using the less-than operator. For example, if - # lessThanOperatorName is *closedbefore* and the property's name is - # *closeDate*, then queries like *closedbefore:<value>* - # show results only where the value of the property named *closeDate* is - # earlier than *<value>*. - # The operator name can only contain lowercase letters (a-z). - # The maximum length is 32 characters. + # Indicates the operator name required in the query in order to isolate the date + # property using the less-than operator. For example, if lessThanOperatorName is + # *closedbefore* and the property's name is *closeDate*, then queries like * + # closedbefore:* show results only where the value of the property named * + # closeDate* is earlier than **. The operator name can only contain + # lowercase letters (a-z). The maximum length is 32 characters. # Corresponds to the JSON property `lessThanOperatorName` # @return [String] attr_accessor :less_than_operator_name - # Indicates the actual string required in the query in order to isolate the - # date property. For example, suppose an issue tracking schema object - # has a property named *closeDate* that specifies an operator with an - # operatorName of *closedon*. For searches on that data, queries like - # *closedon:<value>* show results only where the value of the - # *closeDate* property matches *<value>*. By contrast, a - # search that uses the same *<value>* without an operator returns - # all items where *<value>* matches the value of any String - # properties or text within the content field for the indexed datasource. - # The operator name can only contain lowercase letters (a-z). - # The maximum length is 32 characters. + # Indicates the actual string required in the query in order to isolate the date + # property. For example, suppose an issue tracking schema object has a property + # named *closeDate* that specifies an operator with an operatorName of *closedon* + # . For searches on that data, queries like *closedon:* show results only + # where the value of the *closeDate* property matches **. By contrast, a + # search that uses the same ** without an operator returns all items + # where ** matches the value of any String properties or text within the + # content field for the indexed datasource. The operator name can only contain + # lowercase letters (a-z). The maximum length is 32 characters. # Corresponds to the JSON property `operatorName` # @return [String] attr_accessor :operator_name @@ -487,9 +472,9 @@ module Google class DatePropertyOptions include Google::Apis::Core::Hashable - # Optional. Provides a search operator for date properties. - # Search operators let users restrict the query to specific fields relevant - # to the type of item being searched. + # Optional. Provides a search operator for date properties. Search operators let + # users restrict the query to specific fields relevant to the type of item being + # searched. # Corresponds to the JSON property `operatorOptions` # @return [Google::Apis::CloudsearchV1::DateOperatorOptions] attr_accessor :operator_options @@ -527,8 +512,8 @@ module Google class DebugOptions include Google::Apis::Core::Hashable - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # Corresponds to the JSON property `enableDebugging` # @return [Boolean] attr_accessor :enable_debugging @@ -548,8 +533,8 @@ module Google class DeleteQueueItemsRequest include Google::Apis::Core::Hashable - # Name of connector making this call. - #
Format: datasources/`source_id`/connectors/`ID` + # Name of connector making this call. Format: datasources/`source_id`/connectors/ + # `ID` # Corresponds to the JSON property `connectorName` # @return [String] attr_accessor :connector_name @@ -576,18 +561,16 @@ module Google end end - # A reference to a top-level property within the object that should be - # displayed in search results. The values of the chosen properties is - # displayed in the search results along with the - # display label - # for that property if one is specified. If a display label is not specified, - # only the values is shown. + # A reference to a top-level property within the object that should be displayed + # in search results. The values of the chosen properties is displayed in the + # search results along with the display label for that property if one is + # specified. If a display label is not specified, only the values is shown. class DisplayedProperty include Google::Apis::Core::Hashable - # The name of the top-level property as defined in a property definition - # for the object. If the name is not a defined property in the schema, an - # error is given when attempting to update the schema. + # The name of the top-level property as defined in a property definition for the + # object. If the name is not a defined property in the schema, an error is given + # when attempting to update the schema. # Corresponds to the JSON property `propertyName` # @return [String] attr_accessor :property_name @@ -602,16 +585,15 @@ module Google end end - # Used to provide a search operator for double properties. This is - # optional. Search operators let users restrict the query to specific fields - # relevant to the type of item being searched. + # Used to provide a search operator for double properties. This is optional. + # Search operators let users restrict the query to specific fields relevant to + # the type of item being searched. class DoubleOperatorOptions include Google::Apis::Core::Hashable - # Indicates the operator name required in the query in order to use the - # double property in sorting or as a facet. - # The operator name can only contain lowercase letters (a-z). - # The maximum length is 32 characters. + # Indicates the operator name required in the query in order to use the double + # property in sorting or as a facet. The operator name can only contain + # lowercase letters (a-z). The maximum length is 32 characters. # Corresponds to the JSON property `operatorName` # @return [String] attr_accessor :operator_name @@ -630,9 +612,9 @@ module Google class DoublePropertyOptions include Google::Apis::Core::Hashable - # Used to provide a search operator for double properties. This is - # optional. Search operators let users restrict the query to specific fields - # relevant to the type of item being searched. + # Used to provide a search operator for double properties. This is optional. + # Search operators let users restrict the query to specific fields relevant to + # the type of item being searched. # Corresponds to the JSON property `operatorOptions` # @return [Google::Apis::CloudsearchV1::DoubleOperatorOptions] attr_accessor :operator_options @@ -761,29 +743,26 @@ module Google end end - # Used to provide a search operator for enum properties. This is - # optional. Search operators let users restrict the query to specific fields - # relevant to the type of item being searched. For example, if you provide no - # operator for a *priority* enum property with possible values *p0* and *p1*, - # a query that contains the term *p0* returns items that have *p0* as the - # value of the *priority* property, as well as any items that contain the - # string *p0* in other fields. If you provide an operator name for the enum, - # such as *priority*, then search users can use that operator to refine - # results to only items that have *p0* as this property's value, with the - # query *priority:p0*. + # Used to provide a search operator for enum properties. This is optional. + # Search operators let users restrict the query to specific fields relevant to + # the type of item being searched. For example, if you provide no operator for a + # *priority* enum property with possible values *p0* and *p1*, a query that + # contains the term *p0* returns items that have *p0* as the value of the * + # priority* property, as well as any items that contain the string *p0* in other + # fields. If you provide an operator name for the enum, such as *priority*, then + # search users can use that operator to refine results to only items that have * + # p0* as this property's value, with the query *priority:p0*. class EnumOperatorOptions include Google::Apis::Core::Hashable - # Indicates the operator name required in the query in order to isolate the - # enum property. For example, if operatorName is *priority* and the - # property's name is *priorityVal*, then queries like - # *priority:<value>* show results only where the value of the - # property named *priorityVal* matches *<value>*. By contrast, a - # search that uses the same *<value>* without an operator returns - # all items where *<value>* matches the value of any String - # properties or text within the content field for the item. - # The operator name can only contain lowercase letters (a-z). - # The maximum length is 32 characters. + # Indicates the operator name required in the query in order to isolate the enum + # property. For example, if operatorName is *priority* and the property's name + # is *priorityVal*, then queries like *priority:* show results only where + # the value of the property named *priorityVal* matches **. By contrast, + # a search that uses the same ** without an operator returns all items + # where ** matches the value of any String properties or text within the + # content field for the item. The operator name can only contain lowercase + # letters (a-z). The maximum length is 32 characters. # Corresponds to the JSON property `operatorName` # @return [String] attr_accessor :operator_name @@ -809,16 +788,15 @@ module Google class EnumPropertyOptions include Google::Apis::Core::Hashable - # Used to provide a search operator for enum properties. This is - # optional. Search operators let users restrict the query to specific fields - # relevant to the type of item being searched. For example, if you provide no - # operator for a *priority* enum property with possible values *p0* and *p1*, - # a query that contains the term *p0* returns items that have *p0* as the - # value of the *priority* property, as well as any items that contain the - # string *p0* in other fields. If you provide an operator name for the enum, - # such as *priority*, then search users can use that operator to refine - # results to only items that have *p0* as this property's value, with the - # query *priority:p0*. + # Used to provide a search operator for enum properties. This is optional. + # Search operators let users restrict the query to specific fields relevant to + # the type of item being searched. For example, if you provide no operator for a + # *priority* enum property with possible values *p0* and *p1*, a query that + # contains the term *p0* returns items that have *p0* as the value of the * + # priority* property, as well as any items that contain the string *p0* in other + # fields. If you provide an operator name for the enum, such as *priority*, then + # search users can use that operator to refine results to only items that have * + # p0* as this property's value, with the query *priority:p0*. # Corresponds to the JSON property `operatorOptions` # @return [Google::Apis::CloudsearchV1::EnumOperatorOptions] attr_accessor :operator_options @@ -826,22 +804,20 @@ module Google # Used to specify the ordered ranking for the enumeration that determines how # the integer values provided in the possible EnumValuePairs are used to rank # results. If specified, integer values must be provided for all possible - # EnumValuePair values given for this property. Can only be used if - # isRepeatable + # EnumValuePair values given for this property. Can only be used if isRepeatable # is false. # Corresponds to the JSON property `orderedRanking` # @return [String] attr_accessor :ordered_ranking - # The list of possible values for the enumeration property. All - # EnumValuePairs must provide a string value. If you specify an integer value - # for one EnumValuePair, then all possible EnumValuePairs must provide an - # integer value. Both the string value and integer value must be unique over - # all possible values. Once set, possible values cannot be removed or - # modified. If you supply an ordered ranking and think you might insert - # additional enum values in the future, leave gaps in the initial integer - # values to allow adding a value in between previously registered values. - # The maximum number of elements is 100. + # The list of possible values for the enumeration property. All EnumValuePairs + # must provide a string value. If you specify an integer value for one + # EnumValuePair, then all possible EnumValuePairs must provide an integer value. + # Both the string value and integer value must be unique over all possible + # values. Once set, possible values cannot be removed or modified. If you supply + # an ordered ranking and think you might insert additional enum values in the + # future, leave gaps in the initial integer values to allow adding a value in + # between previously registered values. The maximum number of elements is 100. # Corresponds to the JSON property `possibleValues` # @return [Array] attr_accessor :possible_values @@ -858,31 +834,27 @@ module Google end end - # The enumeration value pair defines two things: a required string value and - # an optional integer value. The string value defines the necessary query - # term required to retrieve that item, such as *p0* for a priority item. - # The integer value determines the ranking of that string value relative - # to other enumerated values for the same property. For example, you might - # associate *p0* with *0* and define another enum pair such as *p1* and *1*. - # You must use the integer value in combination with - # ordered - # ranking to - # set the ranking of a given value relative to other enumerated values for - # the same property name. Here, a ranking order of DESCENDING for *priority* - # properties results in a ranking boost for items indexed with a value of - # *p0* compared to items indexed with a value of *p1*. Without a specified - # ranking order, the integer value has no effect on item ranking. + # The enumeration value pair defines two things: a required string value and an + # optional integer value. The string value defines the necessary query term + # required to retrieve that item, such as *p0* for a priority item. The integer + # value determines the ranking of that string value relative to other enumerated + # values for the same property. For example, you might associate *p0* with *0* + # and define another enum pair such as *p1* and *1*. You must use the integer + # value in combination with ordered ranking to set the ranking of a given value + # relative to other enumerated values for the same property name. Here, a + # ranking order of DESCENDING for *priority* properties results in a ranking + # boost for items indexed with a value of *p0* compared to items indexed with a + # value of *p1*. Without a specified ranking order, the integer value has no + # effect on item ranking. class EnumValuePair include Google::Apis::Core::Hashable - # The integer value of the EnumValuePair which must be non-negative. - # Optional. + # The integer value of the EnumValuePair which must be non-negative. Optional. # Corresponds to the JSON property `integerValue` # @return [Fixnum] attr_accessor :integer_value - # The string value of the EnumValuePair. - # The maximum length is 32 characters. + # The string value of the EnumValuePair. The maximum length is 32 characters. # Corresponds to the JSON property `stringValue` # @return [String] attr_accessor :string_value @@ -962,24 +934,24 @@ module Google end # A bucket in a facet is the basic unit of operation. A bucket can comprise - # either a single value OR a contiguous range of values, depending on the - # type of the field bucketed. - # FacetBucket is currently used only for returning the response object. + # either a single value OR a contiguous range of values, depending on the type + # of the field bucketed. FacetBucket is currently used only for returning the + # response object. class FacetBucket include Google::Apis::Core::Hashable - # Number of results that match the bucket value. Counts are only returned - # for searches when count accuracy is ensured. Can be empty. + # Number of results that match the bucket value. Counts are only returned for + # searches when count accuracy is ensured. Can be empty. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count - # Percent of results that match the bucket value. The returned value is - # between (0-100], and is rounded down to an integer if fractional. If the - # value is not explicitly returned, it represents a percentage value that - # rounds to 0. Percentages are returned for all searches, but are an - # estimate. Because percentages are always returned, you should render - # percentages instead of counts. + # Percent of results that match the bucket value. The returned value is between ( + # 0-100], and is rounded down to an integer if fractional. If the value is not + # explicitly returned, it represents a percentage value that rounds to 0. + # Percentages are returned for all searches, but are an estimate. Because + # percentages are always returned, you should render percentages instead of + # counts. # Corresponds to the JSON property `percentage` # @return [Fixnum] attr_accessor :percentage @@ -1001,32 +973,31 @@ module Google end end - # Specifies operators to return facet results for. There will be one - # FacetResult for every source_name/object_type/operator_name combination. + # Specifies operators to return facet results for. There will be one FacetResult + # for every source_name/object_type/operator_name combination. class FacetOptions include Google::Apis::Core::Hashable # Maximum number of facet buckets that should be returned for this facet. - # Defaults to 10. - # Maximum value is 100. + # Defaults to 10. Maximum value is 100. # Corresponds to the JSON property `numFacetBuckets` # @return [Fixnum] attr_accessor :num_facet_buckets - # If object_type is set, only those objects of that type will be used to - # compute facets. If empty, then all objects will be used to compute facets. + # If object_type is set, only those objects of that type will be used to compute + # facets. If empty, then all objects will be used to compute facets. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type - # Name of the operator chosen for faceting. @see - # cloudsearch.SchemaPropertyOptions + # Name of the operator chosen for faceting. @see cloudsearch. + # SchemaPropertyOptions # Corresponds to the JSON property `operatorName` # @return [String] attr_accessor :operator_name - # Source name to facet on. Format: datasources/`source_id` - # If empty, all data sources will be used. + # Source name to facet on. Format: datasources/`source_id` If empty, all data + # sources will be used. # Corresponds to the JSON property `sourceName` # @return [String] attr_accessor :source_name @@ -1058,8 +1029,8 @@ module Google # @return [String] attr_accessor :object_type - # Name of the operator chosen for faceting. @see - # cloudsearch.SchemaPropertyOptions + # Name of the operator chosen for faceting. @see cloudsearch. + # SchemaPropertyOptions # Corresponds to the JSON property `operatorName` # @return [String] attr_accessor :operator_name @@ -1107,15 +1078,12 @@ module Google end end - # A generic way of expressing filters in a query, which supports two - # approaches:

+ # A generic way of expressing filters in a query, which supports two approaches: # **1. Setting a ValueFilter.** The name must match an operator_name defined in - # the schema for your data source. - #
- # **2. Setting a CompositeFilter.** The filters are evaluated - # using the logical operator. The top-level operators can only be either an AND - # or a NOT. AND can appear only at the top-most level. OR can appear only under - # a top-level AND. + # the schema for your data source. **2. Setting a CompositeFilter.** The filters + # are evaluated using the logical operator. The top-level operators can only be + # either an AND or a NOT. AND can appear only at the top-most level. OR can + # appear only under a top-level AND. class Filter include Google::Apis::Core::Hashable @@ -1144,22 +1112,19 @@ module Google class FilterOptions include Google::Apis::Core::Hashable - # A generic way of expressing filters in a query, which supports two - # approaches:

+ # A generic way of expressing filters in a query, which supports two approaches: # **1. Setting a ValueFilter.** The name must match an operator_name defined in - # the schema for your data source. - #
- # **2. Setting a CompositeFilter.** The filters are evaluated - # using the logical operator. The top-level operators can only be either an AND - # or a NOT. AND can appear only at the top-most level. OR can appear only under - # a top-level AND. + # the schema for your data source. **2. Setting a CompositeFilter.** The filters + # are evaluated using the logical operator. The top-level operators can only be + # either an AND or a NOT. AND can appear only at the top-most level. OR can + # appear only under a top-level AND. # Corresponds to the JSON property `filter` # @return [Google::Apis::CloudsearchV1::Filter] attr_accessor :filter # If object_type is set, only objects of that type are returned. This should - # correspond to the name of the object that was registered within the - # definition of schema. The maximum length is 256 characters. + # correspond to the name of the object that was registered within the definition + # of schema. The maximum length is 256 characters. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type @@ -1175,35 +1140,28 @@ module Google end end - # Indicates which freshness property to use when adjusting search ranking for - # an item. Fresher, more recent dates indicate higher quality. Use the - # freshness option property that best works with your data. For fileshare - # documents, last modified time is most relevant. For calendar event data, - # the time when the event occurs is a more relevant freshness indicator. In - # this way, calendar events that occur closer to the time of the search query - # are considered higher quality and ranked accordingly. + # Indicates which freshness property to use when adjusting search ranking for an + # item. Fresher, more recent dates indicate higher quality. Use the freshness + # option property that best works with your data. For fileshare documents, last + # modified time is most relevant. For calendar event data, the time when the + # event occurs is a more relevant freshness indicator. In this way, calendar + # events that occur closer to the time of the search query are considered higher + # quality and ranked accordingly. class FreshnessOptions include Google::Apis::Core::Hashable - # The duration after which an object should be considered - # stale. The default value is 180 days (in seconds). + # The duration after which an object should be considered stale. The default + # value is 180 days (in seconds). # Corresponds to the JSON property `freshnessDuration` # @return [String] attr_accessor :freshness_duration - # This property indicates the freshness level of the object in the index. - # If set, this property must be a top-level property within the - # property definitions - # and it must be a - # timestamp type - # or - # date type. - # Otherwise, the Indexing API uses - # updateTime - # as the freshness indicator. - # The maximum length is 256 characters. - # When a property is used to calculate freshness, the value defaults - # to 2 years from the current time. + # This property indicates the freshness level of the object in the index. If set, + # this property must be a top-level property within the property definitions + # and it must be a timestamp type or date type. Otherwise, the Indexing API uses + # updateTime as the freshness indicator. The maximum length is 256 characters. + # When a property is used to calculate freshness, the value defaults to 2 years + # from the current time. # Corresponds to the JSON property `freshnessProperty` # @return [String] attr_accessor :freshness_property @@ -1223,8 +1181,7 @@ module Google class GSuitePrincipal include Google::Apis::Core::Hashable - # This principal represents all users of the G Suite domain of the - # customer. + # This principal represents all users of the G Suite domain of the customer. # Corresponds to the JSON property `gsuiteDomain` # @return [Boolean] attr_accessor :gsuite_domain @@ -1405,20 +1362,18 @@ module Google end # Used to provide a search operator for html properties. This is optional. - # Search operators let users restrict the query to specific fields relevant - # to the type of item being searched. + # Search operators let users restrict the query to specific fields relevant to + # the type of item being searched. class HtmlOperatorOptions include Google::Apis::Core::Hashable - # Indicates the operator name required in the query in order to isolate the - # html property. For example, if operatorName is *subject* and the - # property's name is *subjectLine*, then queries like - # *subject:<value>* show results only where the value of the - # property named *subjectLine* matches *<value>*. By contrast, a - # search that uses the same *<value>* without an operator return - # all items where *<value>* matches the value of any - # html properties or text within the content field for the item. - # The operator name can only contain lowercase letters (a-z). + # Indicates the operator name required in the query in order to isolate the html + # property. For example, if operatorName is *subject* and the property's name is + # *subjectLine*, then queries like *subject:* show results only where the + # value of the property named *subjectLine* matches **. By contrast, a + # search that uses the same ** without an operator return all items where + # ** matches the value of any html properties or text within the content + # field for the item. The operator name can only contain lowercase letters (a-z). # The maximum length is 32 characters. # Corresponds to the JSON property `operatorName` # @return [String] @@ -1439,14 +1394,14 @@ module Google include Google::Apis::Core::Hashable # Used to provide a search operator for html properties. This is optional. - # Search operators let users restrict the query to specific fields relevant - # to the type of item being searched. + # Search operators let users restrict the query to specific fields relevant to + # the type of item being searched. # Corresponds to the JSON property `operatorOptions` # @return [Google::Apis::CloudsearchV1::HtmlOperatorOptions] attr_accessor :operator_options - # Indicates the search quality importance of the tokens within the - # field when used for retrieval. Can only be set to DEFAULT or NONE. + # Indicates the search quality importance of the tokens within the field when + # used for retrieval. Can only be set to DEFAULT or NONE. # Corresponds to the JSON property `retrievalImportance` # @return [Google::Apis::CloudsearchV1::RetrievalImportance] attr_accessor :retrieval_importance @@ -1506,8 +1461,8 @@ module Google class IndexItemRequest include Google::Apis::Core::Hashable - # Name of connector making this call. - #
Format: datasources/`source_id`/connectors/`ID` + # Name of connector making this call. Format: datasources/`source_id`/connectors/ + # `ID` # Corresponds to the JSON property `connectorName` # @return [String] attr_accessor :connector_name @@ -1522,8 +1477,8 @@ module Google # @return [Google::Apis::CloudsearchV1::IndexItemOptions] attr_accessor :index_item_options - # Represents a single object that is an item in the search index, such as a - # file, folder, or a database record. + # Represents a single object that is an item in the search index, such as a file, + # folder, or a database record. # Corresponds to the JSON property `item` # @return [Google::Apis::CloudsearchV1::Item] attr_accessor :item @@ -1547,46 +1502,42 @@ module Google end end - # Used to provide a search operator for integer properties. This is - # optional. Search operators let users restrict the query to specific fields - # relevant to the type of item being searched. + # Used to provide a search operator for integer properties. This is optional. + # Search operators let users restrict the query to specific fields relevant to + # the type of item being searched. class IntegerOperatorOptions include Google::Apis::Core::Hashable # Indicates the operator name required in the query in order to isolate the # integer property using the greater-than operator. For example, if - # greaterThanOperatorName is *priorityabove* and the property's name is - # *priorityVal*, then queries like *priorityabove:<value>* - # show results only where the value of the property named *priorityVal* is - # greater than *<value>*. - # The operator name can only contain lowercase letters (a-z). - # The maximum length is 32 characters. + # greaterThanOperatorName is *priorityabove* and the property's name is * + # priorityVal*, then queries like *priorityabove:* show results only + # where the value of the property named *priorityVal* is greater than **. + # The operator name can only contain lowercase letters (a-z). The maximum length + # is 32 characters. # Corresponds to the JSON property `greaterThanOperatorName` # @return [String] attr_accessor :greater_than_operator_name # Indicates the operator name required in the query in order to isolate the # integer property using the less-than operator. For example, if - # lessThanOperatorName is *prioritybelow* and the property's name is - # *priorityVal*, then queries like *prioritybelow:<value>* - # show results only where the value of the property named *priorityVal* is - # less than *<value>*. - # The operator name can only contain lowercase letters (a-z). - # The maximum length is 32 characters. + # lessThanOperatorName is *prioritybelow* and the property's name is * + # priorityVal*, then queries like *prioritybelow:* show results only + # where the value of the property named *priorityVal* is less than **. + # The operator name can only contain lowercase letters (a-z). The maximum length + # is 32 characters. # Corresponds to the JSON property `lessThanOperatorName` # @return [String] attr_accessor :less_than_operator_name # Indicates the operator name required in the query in order to isolate the - # integer property. For example, if operatorName is *priority* and the - # property's name is *priorityVal*, then queries like - # *priority:<value>* show results only where the value of the - # property named *priorityVal* matches *<value>*. By contrast, a - # search that uses the same *<value>* without an operator returns - # all items where *<value>* matches the value of any String - # properties or text within the content field for the item. - # The operator name can only contain lowercase letters (a-z). - # The maximum length is 32 characters. + # integer property. For example, if operatorName is *priority* and the property' + # s name is *priorityVal*, then queries like *priority:* show results + # only where the value of the property named *priorityVal* matches **. By + # contrast, a search that uses the same ** without an operator returns + # all items where ** matches the value of any String properties or text + # within the content field for the item. The operator name can only contain + # lowercase letters (a-z). The maximum length is 32 characters. # Corresponds to the JSON property `operatorName` # @return [String] attr_accessor :operator_name @@ -1608,33 +1559,30 @@ module Google include Google::Apis::Core::Hashable # The maximum value of the property. The minimum and maximum values for the - # property are used to rank results according to the - # ordered ranking. - # Indexing requests with values greater than the maximum are accepted and - # ranked with the same weight as items indexed with the maximum value. + # property are used to rank results according to the ordered ranking. Indexing + # requests with values greater than the maximum are accepted and ranked with the + # same weight as items indexed with the maximum value. # Corresponds to the JSON property `maximumValue` # @return [Fixnum] attr_accessor :maximum_value # The minimum value of the property. The minimum and maximum values for the - # property are used to rank results according to the - # ordered ranking. - # Indexing requests with values less than the minimum are accepted and - # ranked with the same weight as items indexed with the minimum value. + # property are used to rank results according to the ordered ranking. Indexing + # requests with values less than the minimum are accepted and ranked with the + # same weight as items indexed with the minimum value. # Corresponds to the JSON property `minimumValue` # @return [Fixnum] attr_accessor :minimum_value - # Used to provide a search operator for integer properties. This is - # optional. Search operators let users restrict the query to specific fields - # relevant to the type of item being searched. + # Used to provide a search operator for integer properties. This is optional. + # Search operators let users restrict the query to specific fields relevant to + # the type of item being searched. # Corresponds to the JSON property `operatorOptions` # @return [Google::Apis::CloudsearchV1::IntegerOperatorOptions] attr_accessor :operator_options # Used to specify the ordered ranking for the integer. Can only be used if - # isRepeatable - # is false. + # isRepeatable is false. # Corresponds to the JSON property `orderedRanking` # @return [String] attr_accessor :ordered_ranking @@ -1675,8 +1623,8 @@ module Google class Interaction include Google::Apis::Core::Hashable - # The time when the user acted on the item. If multiple actions of the same - # type exist for a single user, only the most recent action is recorded. + # The time when the user acted on the item. If multiple actions of the same type + # exist for a single user, only the most recent action is recorded. # Corresponds to the JSON property `interactionTime` # @return [String] attr_accessor :interaction_time @@ -1703,13 +1651,13 @@ module Google end end - # Represents a single object that is an item in the search index, such as a - # file, folder, or a database record. + # Represents a single object that is an item in the search index, such as a file, + # folder, or a database record. class Item include Google::Apis::Core::Hashable - # Access control list information for the item. For more information see - # [Map ACLs](/cloud-search/docs/guides/acls). + # Access control list information for the item. For more information see [Map + # ACLs](/cloud-search/docs/guides/acls). # Corresponds to the JSON property `acl` # @return [Google::Apis::CloudsearchV1::ItemAcl] attr_accessor :acl @@ -1729,23 +1677,20 @@ module Google # @return [Google::Apis::CloudsearchV1::ItemMetadata] attr_accessor :metadata - # Name of the Item. Format: - # datasources/`source_id`/items/`item_id` - #
This is a required field. - # The maximum length is 1536 characters. + # Name of the Item. Format: datasources/`source_id`/items/`item_id` This is a + # required field. The maximum length is 1536 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Additional state connector can store for this item. - # The maximum length is 10000 bytes. + # Additional state connector can store for this item. The maximum length is + # 10000 bytes. # Corresponds to the JSON property `payload` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :payload - # Queue this item belongs to. - # The maximum length is 100 characters. + # Queue this item belongs to. The maximum length is 100 characters. # Corresponds to the JSON property `queue` # @return [String] attr_accessor :queue @@ -1760,14 +1705,11 @@ module Google # @return [Google::Apis::CloudsearchV1::ItemStructuredData] attr_accessor :structured_data - # Required. The indexing system stores the version from the datasource as a - # byte string and compares the Item version in the index - # to the version of the queued Item using lexical ordering. - #

- # Cloud Search Indexing won't index or delete any queued item with - # a version value that is less than or equal to the version of the - # currently indexed item. - # The maximum length for this field is 1024 bytes. + # Required. The indexing system stores the version from the datasource as a byte + # string and compares the Item version in the index to the version of the queued + # Item using lexical ordering. Cloud Search Indexing won't index or delete any + # queued item with a version value that is less than or equal to the version of + # the currently indexed item. The maximum length for this field is 1024 bytes. # Corresponds to the JSON property `version` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1792,60 +1734,50 @@ module Google end end - # Access control list information for the item. For more information see - # [Map ACLs](/cloud-search/docs/guides/acls). + # Access control list information for the item. For more information see [Map + # ACLs](/cloud-search/docs/guides/acls). class ItemAcl include Google::Apis::Core::Hashable # Sets the type of access rules to apply when an item inherits its ACL from a - # parent. This should always be set in tandem with the - # inheritAclFrom - # field. Also, when the - # inheritAclFrom field - # is set, this field should be set to a valid AclInheritanceType. + # parent. This should always be set in tandem with the inheritAclFrom field. + # Also, when the inheritAclFrom field is set, this field should be set to a + # valid AclInheritanceType. # Corresponds to the JSON property `aclInheritanceType` # @return [String] attr_accessor :acl_inheritance_type # List of principals who are explicitly denied access to the item in search - # results. While principals are denied access by default, use denied readers - # to handle exceptions and override the list allowed readers. - # The maximum number of elements is 100. + # results. While principals are denied access by default, use denied readers to + # handle exceptions and override the list allowed readers. The maximum number of + # elements is 100. # Corresponds to the JSON property `deniedReaders` # @return [Array] attr_accessor :denied_readers - # Name of the item to inherit the Access Permission List (ACL) from. - # Note: ACL inheritance *only* provides access permissions - # to child items and does not define structural relationships, nor does it - # provide convenient ways to delete large groups of items. - # Deleting an ACL parent from the index only alters the access permissions of - # child items that reference the parent in the - # inheritAclFrom - # field. The item is still in the index, but may not - # visible in search results. By contrast, deletion of a container item - # also deletes all items that reference the container via the - # containerName - # field. - # The maximum length for this field is 1536 characters. + # Name of the item to inherit the Access Permission List (ACL) from. Note: ACL + # inheritance *only* provides access permissions to child items and does not + # define structural relationships, nor does it provide convenient ways to delete + # large groups of items. Deleting an ACL parent from the index only alters the + # access permissions of child items that reference the parent in the + # inheritAclFrom field. The item is still in the index, but may not visible in + # search results. By contrast, deletion of a container item also deletes all + # items that reference the container via the containerName field. The maximum + # length for this field is 1536 characters. # Corresponds to the JSON property `inheritAclFrom` # @return [String] attr_accessor :inherit_acl_from - # Optional. List of owners for the item. This field has no bearing on - # document access permissions. It does, however, offer - # a slight ranking boosts items where the querying user is an owner. - # The maximum number of elements is 5. + # Optional. List of owners for the item. This field has no bearing on document + # access permissions. It does, however, offer a slight ranking boosts items + # where the querying user is an owner. The maximum number of elements is 5. # Corresponds to the JSON property `owners` # @return [Array] attr_accessor :owners - # List of principals who are allowed to see the item in search results. - # Optional if inheriting permissions from another item or if the item - # is not intended to be visible, such as - # virtual - # containers. - # The maximum number of elements is 1000. + # List of principals who are allowed to see the item in search results. Optional + # if inheriting permissions from another item or if the item is not intended to + # be visible, such as virtual containers. The maximum number of elements is 1000. # Corresponds to the JSON property `readers` # @return [Array] attr_accessor :readers @@ -1868,10 +1800,8 @@ module Google class ItemContent include Google::Apis::Core::Hashable - # Represents an upload session reference. - # This reference is created via upload - # method. - # Updating of item content may refer to this uploaded content via + # Represents an upload session reference. This reference is created via upload + # method. Updating of item content may refer to this uploaded content via # contentDataRef. # Corresponds to the JSON property `contentDataRef` # @return [Google::Apis::CloudsearchV1::UploadItemRef] @@ -1882,15 +1812,15 @@ module Google # @return [String] attr_accessor :content_format - # Hashing info calculated and provided by the API client for content. - # Can be used with the items.push method to calculate modified state. - # The maximum length is 2048 characters. + # Hashing info calculated and provided by the API client for content. Can be + # used with the items.push method to calculate modified state. The maximum + # length is 2048 characters. # Corresponds to the JSON property `hash` # @return [String] attr_accessor :hash_prop - # Content that is supplied inlined within the update method. - # The maximum length is 102400 bytes (100 KiB). + # Content that is supplied inlined within the update method. The maximum length + # is 102400 bytes (100 KiB). # Corresponds to the JSON property `inlineContent` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1938,20 +1868,17 @@ module Google class ItemMetadata include Google::Apis::Core::Hashable - # The name of the container for this item. - # Deletion of the container item leads to automatic deletion of this - # item. Note: ACLs are not inherited from a container item. - # To provide ACL inheritance for an item, use the - # inheritAclFrom + # The name of the container for this item. Deletion of the container item leads + # to automatic deletion of this item. Note: ACLs are not inherited from a + # container item. To provide ACL inheritance for an item, use the inheritAclFrom # field. The maximum length is 1536 characters. # Corresponds to the JSON property `containerName` # @return [String] attr_accessor :container_name - # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For - # more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - # The maximum length is 32 characters. + # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. The maximum length is 32 characters. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -1961,44 +1888,37 @@ module Google # @return [String] attr_accessor :create_time - # Hashing value provided by the API caller. - # This can be used with the - # items.push - # method to calculate modified state. - # The maximum length is 2048 characters. + # Hashing value provided by the API caller. This can be used with the items.push + # method to calculate modified state. The maximum length is 2048 characters. # Corresponds to the JSON property `hash` # @return [String] attr_accessor :hash_prop - # A list of interactions for the item. Interactions are used to improve - # Search quality, but are not exposed to end users. - # The maximum number of elements is 1000. + # A list of interactions for the item. Interactions are used to improve Search + # quality, but are not exposed to end users. The maximum number of elements is + # 1000. # Corresponds to the JSON property `interactions` # @return [Array] attr_accessor :interactions - # Additional keywords or phrases that should match the item. - # Used internally for user generated content. - # The maximum number of elements is 100. - # The maximum length is 8192 characters. + # Additional keywords or phrases that should match the item. Used internally for + # user generated content. The maximum number of elements is 100. The maximum + # length is 8192 characters. # Corresponds to the JSON property `keywords` # @return [Array] attr_accessor :keywords - # The original mime-type of - # ItemContent.content - # in the source repository. - # The maximum length is 256 characters. + # The original mime-type of ItemContent.content in the source repository. The + # maximum length is 256 characters. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type - # The type of the item. This should correspond to the name of an object - # definition in the schema registered for the data source. For example, if - # the schema for the data source contains an object definition with name - # 'document', then item indexing requests for objects of that type should set - # objectType to 'document'. - # The maximum length is 256 characters. + # The type of the item. This should correspond to the name of an object + # definition in the schema registered for the data source. For example, if the + # schema for the data source contains an object definition with name 'document', + # then item indexing requests for objects of that type should set objectType to ' + # document'. The maximum length is 256 characters. # Corresponds to the JSON property `objectType` # @return [String] attr_accessor :object_type @@ -2008,18 +1928,16 @@ module Google # @return [Google::Apis::CloudsearchV1::SearchQualityMetadata] attr_accessor :search_quality_metadata - # Link to the source repository serving the data. Search results apply - # this link to the title. - # Whitespace or special characters may cause Cloud Search result links to - # trigger a redirect notice; to avoid this, encode the URL. - # The maximum length is 2048 characters. + # Link to the source repository serving the data. Search results apply this link + # to the title. Whitespace or special characters may cause Cloud Search result + # links to trigger a redirect notice; to avoid this, encode the URL. The maximum + # length is 2048 characters. # Corresponds to the JSON property `sourceRepositoryUrl` # @return [String] attr_accessor :source_repository_url - # The title of the item. If given, this will be the displayed title of the - # Search result. - # The maximum length is 2048 characters. + # The title of the item. If given, this will be the displayed title of the + # Search result. The maximum length is 2048 characters. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -2085,11 +2003,8 @@ module Google class ItemStructuredData include Google::Apis::Core::Hashable - # Hashing value provided by the API caller. - # This can be used with the - # items.push - # method to calculate modified state. - # The maximum length is 2048 characters. + # Hashing value provided by the API caller. This can be used with the items.push + # method to calculate modified state. The maximum length is 2048 characters. # Corresponds to the JSON property `hash` # @return [String] attr_accessor :hash_prop @@ -2114,8 +2029,8 @@ module Google class ListDataSourceResponse 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 @@ -2145,8 +2060,8 @@ module Google # @return [Array] attr_accessor :item_names - # 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 @@ -2171,8 +2086,8 @@ module Google # @return [Array] attr_accessor :items - # 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 @@ -2217,8 +2132,8 @@ module Google class ListSearchApplicationsResponse 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 @@ -2243,8 +2158,8 @@ module Google class ListUnmappedIdentitiesResponse 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 @@ -2348,10 +2263,10 @@ module Google # @return [Google::Apis::CloudsearchV1::Source] attr_accessor :source - # The last modified date for the object in the search result. If not - # set in the item, the value returned here is empty. When - # `updateTime` is used for calculating freshness and is not set, this - # value defaults to 2 years from the current time. + # The last modified date for the object in the search result. If not set in the + # item, the value returned here is empty. When `updateTime` is used for + # calculating freshness and is not set, this value defaults to 2 years from the + # current time. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -2398,8 +2313,8 @@ module Google class Name include Google::Apis::Core::Hashable - # The read-only display name formatted according to the locale specified by - # the viewer's account or the Accept-Language HTTP header. + # The read-only display name formatted according to the locale specified by the + # viewer's account or the Accept-Language HTTP header. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -2414,8 +2329,8 @@ module Google end end - # A typed name-value pair for structured data. The type of the value should - # be the same as the registered type for the `name` property in the object + # A typed name-value pair for structured data. The type of the value should be + # the same as the registered type for the `name` property in the object # definition of `objectType`. class NamedProperty include Google::Apis::Core::Hashable @@ -2451,9 +2366,9 @@ module Google # @return [Google::Apis::CloudsearchV1::IntegerValues] attr_accessor :integer_values - # The name of the property. This name should correspond to the name of the - # property that was registered for object definition in the schema. - # The maximum allowable length for this property is 256 characters. + # The name of the property. This name should correspond to the name of the + # property that was registered for object definition in the schema. The maximum + # allowable length for this property is 256 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2497,15 +2412,11 @@ module Google include Google::Apis::Core::Hashable # Name for the object, which then defines its type. Item indexing requests - # should set the - # objectType field - # equal to this value. For example, if *name* is *Document*, then indexing - # requests for items of type Document should set - # objectType equal to - # *Document*. Each object definition must be uniquely named within a schema. - # The name must start with a letter and can only contain letters (A-Z, a-z) - # or numbers (0-9). - # The maximum length is 256 characters. + # should set the objectType field equal to this value. For example, if *name* is + # *Document*, then indexing requests for items of type Document should set + # objectType equal to *Document*. Each object definition must be uniquely named + # within a schema. The name must start with a letter and can only contain + # letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2515,8 +2426,8 @@ module Google # @return [Google::Apis::CloudsearchV1::ObjectOptions] attr_accessor :options - # The property definitions for the object. - # The maximum number of elements is 1000. + # The property definitions for the object. The maximum number of elements is + # 1000. # Corresponds to the JSON property `propertyDefinitions` # @return [Array] attr_accessor :property_definitions @@ -2537,22 +2448,20 @@ module Google class ObjectDisplayOptions include Google::Apis::Core::Hashable - # Defines the properties that are displayed in the metalines of the - # search results. The property values are displayed in the order given - # here. If a property holds multiple values, all of the values are - # displayed before the next properties. For this reason, it is a good - # practice to specify singular properties before repeated properties in this - # list. All of the properties must set - # is_returnable - # to true. The maximum number of metalines is 3. + # Defines the properties that are displayed in the metalines of the search + # results. The property values are displayed in the order given here. If a + # property holds multiple values, all of the values are displayed before the + # next properties. For this reason, it is a good practice to specify singular + # properties before repeated properties in this list. All of the properties must + # set is_returnable to true. The maximum number of metalines is 3. # Corresponds to the JSON property `metalines` # @return [Array] attr_accessor :metalines - # The user friendly label to display in the search result to indicate the - # type of the item. This is OPTIONAL; if not provided, an object label isn't - # displayed on the context line of the search results. The maximum length - # is 64 characters. + # The user friendly label to display in the search result to indicate the type + # of the item. This is OPTIONAL; if not provided, an object label isn't + # displayed on the context line of the search results. The maximum length is 64 + # characters. # Corresponds to the JSON property `objectDisplayLabel` # @return [String] attr_accessor :object_display_label @@ -2577,13 +2486,13 @@ module Google # @return [Google::Apis::CloudsearchV1::ObjectDisplayOptions] attr_accessor :display_options - # Indicates which freshness property to use when adjusting search ranking for - # an item. Fresher, more recent dates indicate higher quality. Use the - # freshness option property that best works with your data. For fileshare - # documents, last modified time is most relevant. For calendar event data, - # the time when the event occurs is a more relevant freshness indicator. In - # this way, calendar events that occur closer to the time of the search query - # are considered higher quality and ranked accordingly. + # Indicates which freshness property to use when adjusting search ranking for an + # item. Fresher, more recent dates indicate higher quality. Use the freshness + # option property that best works with your data. For fileshare documents, last + # modified time is most relevant. For calendar event data, the time when the + # event occurs is a more relevant freshness indicator. In this way, calendar + # events that occur closer to the time of the search query are considered higher + # quality and ranked accordingly. # Corresponds to the JSON property `freshnessOptions` # @return [Google::Apis::CloudsearchV1::FreshnessOptions] attr_accessor :freshness_options @@ -2603,10 +2512,10 @@ module Google class ObjectPropertyOptions include Google::Apis::Core::Hashable - # The properties of the sub-object. These properties represent a nested - # object. For example, if this property represents a postal address, the - # subobjectProperties might be named *street*, *city*, and *state*. - # The maximum number of elements is 1000. + # The properties of the sub-object. These properties represent a nested object. + # For example, if this property represents a postal address, the + # subobjectProperties might be named *street*, *city*, and *state*. The maximum + # number of elements is 1000. # Corresponds to the JSON property `subobjectProperties` # @return [Array] attr_accessor :subobject_properties @@ -2645,47 +2554,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::CloudsearchV1::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] 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] attr_accessor :response @@ -2732,9 +2639,8 @@ module Google # @return [Array] attr_accessor :email_addresses - # The resource name of the person to provide information about. - # See - # People.get from Google People API. + # The resource name of the person to provide information about. See People.get + # from Google People API. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2749,8 +2655,8 @@ module Google # @return [Array] attr_accessor :person_names - # A person's read-only photo. A picture shown next to the person's name to - # help others recognize the person in search results. + # A person's read-only photo. A picture shown next to the person's name to help + # others recognize the person in search results. # Corresponds to the JSON property `photos` # @return [Array] attr_accessor :photos @@ -2792,8 +2698,8 @@ module Google class PollItemsRequest include Google::Apis::Core::Hashable - # Name of connector making this call. - #
Format: datasources/`source_id`/connectors/`ID` + # Name of connector making this call. Format: datasources/`source_id`/connectors/ + # `ID` # Corresponds to the JSON property `connectorName` # @return [String] attr_accessor :connector_name @@ -2803,15 +2709,14 @@ module Google # @return [Google::Apis::CloudsearchV1::DebugOptions] attr_accessor :debug_options - # Maximum number of items to return. - #
The maximum value is 100 and the default value is 20. + # Maximum number of items to return. The maximum value is 100 and the default + # value is 20. # Corresponds to the JSON property `limit` # @return [Fixnum] attr_accessor :limit - # Queue name to fetch items from. If unspecified, PollItems will - # fetch from 'default' queue. - # The maximum length is 100 characters. + # Queue name to fetch items from. If unspecified, PollItems will fetch from ' + # default' queue. The maximum length is 100 characters. # Corresponds to the JSON property `queue` # @return [String] attr_accessor :queue @@ -2839,15 +2744,9 @@ module Google class PollItemsResponse include Google::Apis::Core::Hashable - # Set of items from the queue available for connector to process. - #
These items have the following subset of fields populated:
- #
version - #
metadata.hash - #
structured_data.hash - #
content.hash - #
payload - #
status - #
queue + # Set of items from the queue available for connector to process. These items + # have the following subset of fields populated: version metadata.hash + # structured_data.hash content.hash payload status queue # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items @@ -2866,9 +2765,9 @@ module Google class Principal include Google::Apis::Core::Hashable - # This principal is a group identified using an external identity. - # The name field must specify the group resource name with this format: - # identitysources/`source_id`/groups/`ID` + # This principal is a group identified using an external identity. The name + # field must specify the group resource name with this format: identitysources/` + # source_id`/groups/`ID` # Corresponds to the JSON property `groupResourceName` # @return [String] attr_accessor :group_resource_name @@ -2878,9 +2777,9 @@ module Google # @return [Google::Apis::CloudsearchV1::GSuitePrincipal] attr_accessor :gsuite_principal - # This principal is a user identified using an external identity. - # The name field must specify the user resource name with this format: - # identitysources/`source_id`/users/`ID` + # This principal is a user identified using an external identity. The name field + # must specify the user resource name with this format: identitysources/` + # source_id`/users/`ID` # Corresponds to the JSON property `userResourceName` # @return [String] attr_accessor :user_resource_name @@ -2911,8 +2810,8 @@ module Google # @return [String] attr_accessor :error_message - # In case the item fields are invalid, this field contains the details - # about the validation errors. + # In case the item fields are invalid, this field contains the details about the + # validation errors. # Corresponds to the JSON property `fieldViolations` # @return [Array] attr_accessor :field_violations @@ -2975,10 +2874,9 @@ module Google # @return [Google::Apis::CloudsearchV1::IntegerPropertyOptions] attr_accessor :integer_property_options - # Indicates that the property can be used for generating facets. Cannot be - # true for properties whose type is object. IsReturnable must be true to set - # this option. - # Only supported for Boolean, Enum, and Text properties. + # Indicates that the property can be used for generating facets. Cannot be true + # for properties whose type is object. IsReturnable must be true to set this + # option. Only supported for Boolean, Enum, and Text properties. # Corresponds to the JSON property `isFacetable` # @return [Boolean] attr_accessor :is_facetable @@ -2986,31 +2884,30 @@ module Google # Indicates that multiple values are allowed for the property. For example, a # document only has one description but can have multiple comments. Cannot be - # true for properties whose type is a boolean. - # If set to false, properties that contain more than one value cause the - # indexing request for that item to be rejected. + # true for properties whose type is a boolean. If set to false, properties that + # contain more than one value cause the indexing request for that item to be + # rejected. # Corresponds to the JSON property `isRepeatable` # @return [Boolean] attr_accessor :is_repeatable alias_method :is_repeatable?, :is_repeatable - # Indicates that the property identifies data that should be returned in - # search results via the Query API. If set to *true*, indicates that Query - # API users can use matching property fields in results. However, storing - # fields requires more space allocation and uses more bandwidth for search - # queries, which impacts performance over large datasets. Set to *true* here - # only if the field is needed for search results. Cannot be true for - # properties whose type is an object. + # Indicates that the property identifies data that should be returned in search + # results via the Query API. If set to *true*, indicates that Query API users + # can use matching property fields in results. However, storing fields requires + # more space allocation and uses more bandwidth for search queries, which + # impacts performance over large datasets. Set to *true* here only if the field + # is needed for search results. Cannot be true for properties whose type is an + # object. # Corresponds to the JSON property `isReturnable` # @return [Boolean] attr_accessor :is_returnable alias_method :is_returnable?, :is_returnable # Indicates that the property can be used for sorting. Cannot be true for - # properties that are repeatable. Cannot be true for properties whose type - # is object or user identifier. IsReturnable must be true to set this option. - # Only supported for Boolean, Date, Double, Integer, and Timestamp - # properties. + # properties that are repeatable. Cannot be true for properties whose type is + # object or user identifier. IsReturnable must be true to set this option. Only + # supported for Boolean, Date, Double, Integer, and Timestamp properties. # Corresponds to the JSON property `isSortable` # @return [Boolean] attr_accessor :is_sortable @@ -3022,26 +2919,23 @@ module Google attr_accessor :is_suggestable alias_method :is_suggestable?, :is_suggestable - # Indicates that users can perform wildcard search for this - # property. Only supported for Text properties. IsReturnable must be true to - # set this option. In a given datasource maximum of 5 properties can be - # marked as is_wildcard_searchable. + # Indicates that users can perform wildcard search for this property. Only + # supported for Text properties. IsReturnable must be true to set this option. + # In a given datasource maximum of 5 properties can be marked as + # is_wildcard_searchable. # Corresponds to the JSON property `isWildcardSearchable` # @return [Boolean] attr_accessor :is_wildcard_searchable alias_method :is_wildcard_searchable?, :is_wildcard_searchable # The name of the property. Item indexing requests sent to the Indexing API - # should set the property name - # equal to this value. For example, if name is *subject_line*, then indexing - # requests for document items with subject fields should set the - # name for that field equal to - # *subject_line*. Use the name as the identifier for the object property. - # Once registered as a property for an object, you cannot re-use this name - # for another property within that object. - # The name must start with a letter and can only contain letters (A-Z, a-z) - # or numbers (0-9). - # The maximum length is 256 characters. + # should set the property name equal to this value. For example, if name is * + # subject_line*, then indexing requests for document items with subject fields + # should set the name for that field equal to *subject_line*. Use the name as + # the identifier for the object property. Once registered as a property for an + # object, you cannot re-use this name for another property within that object. + # The name must start with a letter and can only contain letters (A-Z, a-z) or + # numbers (0-9). The maximum length is 256 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3091,15 +2985,14 @@ module Google class PropertyDisplayOptions include Google::Apis::Core::Hashable - # The user friendly label for the property that is used if the property - # is specified to be displayed in ObjectDisplayOptions. If provided, the - # display label is shown in front of the property values when the property is - # part of the object display options. For example, if the property value is - # '1', the value by itself may not be useful context for the user. If the - # display name given was 'priority', then the user sees 'priority : 1' in - # the search results which provides clear context to search users. This is - # OPTIONAL; if not given, only the property values are displayed. - # The maximum length is 64 characters. + # The user friendly label for the property that is used if the property is + # specified to be displayed in ObjectDisplayOptions. If provided, the display + # label is shown in front of the property values when the property is part of + # the object display options. For example, if the property value is '1', the + # value by itself may not be useful context for the user. If the display name + # given was 'priority', then the user sees 'priority : 1' in the search results + # which provides clear context to search users. This is OPTIONAL; if not given, + # only the property values are displayed. The maximum length is 64 characters. # Corresponds to the JSON property `displayLabel` # @return [String] attr_accessor :display_label @@ -3119,36 +3012,28 @@ module Google include Google::Apis::Core::Hashable # Content hash of the item according to the repository. If specified, this is - # used to determine how to modify this - # item's status. Setting this field and the - # type field results in argument - # error. - # The maximum length is 2048 characters. + # used to determine how to modify this item's status. Setting this field and the + # type field results in argument error. The maximum length is 2048 characters. # Corresponds to the JSON property `contentHash` # @return [String] attr_accessor :content_hash - # Metadata hash of the item according to the repository. If specified, this - # is used to determine how to modify this - # item's status. Setting this field and the - # type field results in argument - # error. - # The maximum length is 2048 characters. + # Metadata hash of the item according to the repository. If specified, this is + # used to determine how to modify this item's status. Setting this field and the + # type field results in argument error. The maximum length is 2048 characters. # Corresponds to the JSON property `metadataHash` # @return [String] attr_accessor :metadata_hash - # Provides additional document state information for the connector, - # such as an alternate repository ID and other metadata. - # The maximum length is 8192 bytes. + # Provides additional document state information for the connector, such as an + # alternate repository ID and other metadata. The maximum length is 8192 bytes. # Corresponds to the JSON property `payload` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :payload - # Queue to which this item belongs to. The default queue is - # chosen if this field is not specified. The maximum length is - # 512 characters. + # Queue to which this item belongs to. The default queue is chosen if this field + # is not specified. The maximum length is 512 characters. # Corresponds to the JSON property `queue` # @return [String] attr_accessor :queue @@ -3159,10 +3044,9 @@ module Google attr_accessor :repository_error # Structured data hash of the item according to the repository. If specified, - # this is used to determine how to modify this item's status. Setting this - # field and the type field - # results in argument error. - # The maximum length is 2048 characters. + # this is used to determine how to modify this item's status. Setting this field + # and the type field results in argument error. The maximum length is 2048 + # characters. # Corresponds to the JSON property `structuredDataHash` # @return [String] attr_accessor :structured_data_hash @@ -3192,8 +3076,8 @@ module Google class PushItemRequest include Google::Apis::Core::Hashable - # Name of connector making this call. - #
Format: datasources/`source_id`/connectors/`ID` + # Name of connector making this call. Format: datasources/`source_id`/connectors/ + # `ID` # Corresponds to the JSON property `connectorName` # @return [String] attr_accessor :connector_name @@ -3255,15 +3139,15 @@ module Google attr_accessor :interpretation_type # The interpretation of the query used in search. For example, queries with - # natural language intent like "email from john" will be interpreted as - # "from:john source:mail". This field will not be filled when the reason is + # natural language intent like "email from john" will be interpreted as "from: + # john source:mail". This field will not be filled when the reason is # NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY. # Corresponds to the JSON property `interpretedQuery` # @return [String] attr_accessor :interpreted_query - # The reason for interpretation of the query. This field will not be - # UNSPECIFIED if the interpretation type is not NONE. + # The reason for interpretation of the query. This field will not be UNSPECIFIED + # if the interpretation type is not NONE. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -3292,10 +3176,10 @@ module Google attr_accessor :disable_nl_interpretation alias_method :disable_nl_interpretation?, :disable_nl_interpretation - # Enable this flag to turn off all internal optimizations like natural - # language (NL) interpretation of queries, supplemental result retrieval, - # and usage of synonyms including custom ones. - # Nl interpretation will be disabled if either one of the two flags is true. + # Enable this flag to turn off all internal optimizations like natural language ( + # NL) interpretation of queries, supplemental result retrieval, and usage of + # synonyms including custom ones. Nl interpretation will be disabled if either + # one of the two flags is true. # Corresponds to the JSON property `enableVerbatimMode` # @return [Boolean] attr_accessor :enable_verbatim_mode @@ -3347,8 +3231,8 @@ module Google # @return [Array] attr_accessor :enum_values - # Indicates the operator name that can be used to isolate the property using - # the greater-than operator. + # Indicates the operator name that can be used to isolate the property using the + # greater-than operator. # Corresponds to the JSON property `greaterThanOperatorName` # @return [String] attr_accessor :greater_than_operator_name @@ -3384,8 +3268,8 @@ module Google attr_accessor :is_suggestable alias_method :is_suggestable?, :is_suggestable - # Indicates the operator name that can be used to isolate the property using - # the less-than operator. + # Indicates the operator name that can be used to isolate the property using the + # less-than operator. # Corresponds to the JSON property `lessThanOperatorName` # @return [String] attr_accessor :less_than_operator_name @@ -3441,8 +3325,8 @@ module Google # @return [Array] attr_accessor :operators - # A short name or alias for the source. This value can be used with the - # 'source' operator. + # A short name or alias for the source. This value can be used with the 'source' + # operator. # Corresponds to the JSON property `shortName` # @return [String] attr_accessor :short_name @@ -3483,13 +3367,13 @@ module Google class RepositoryError include Google::Apis::Core::Hashable - # Message that describes the error. The maximum allowable length - # of the message is 8192 characters. + # Message that describes the error. The maximum allowable length of the message + # is 8192 characters. # Corresponds to the JSON property `errorMessage` # @return [String] attr_accessor :error_message - # Error codes. Matches the definition of HTTP status codes. + # Error codes. Matches the definition of HTTP status codes. # Corresponds to the JSON property `httpStatusCode` # @return [Fixnum] attr_accessor :http_status_code @@ -3520,34 +3404,30 @@ module Google # @return [Google::Apis::CloudsearchV1::DebugOptions] attr_accessor :debug_options - # The BCP-47 language code, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - # For translations. - # Set this field using the language set in browser or for the page. In the - # event that the user's language preference is known, set this field to the - # known user language. - # When specified, the documents in search results are biased towards the - # specified language. - # The suggest API does not use this parameter. Instead, suggest autocompletes - # only based on characters in the query. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For + # translations. Set this field using the language set in browser or for the page. + # In the event that the user's language preference is known, set this field to + # the known user language. When specified, the documents in search results are + # biased towards the specified language. The suggest API does not use this + # parameter. Instead, suggest autocompletes only based on characters in the + # query. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # The ID generated when you create a search application using the - # [admin console](https://support.google.com/a/answer/9043922). + # The ID generated when you create a search application using the [admin console] + # (https://support.google.com/a/answer/9043922). # Corresponds to the JSON property `searchApplicationId` # @return [String] attr_accessor :search_application_id - # Current user's time zone id, such as "America/Los_Angeles" or - # "Australia/Sydney". These IDs are defined by - # [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) - # project, and currently available in the file - # [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). - # This field is used to correctly interpret date and time queries. - # If this field is not specified, the default time zone (UTC) is used. + # Current user's time zone id, such as "America/Los_Angeles" or "Australia/ + # Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR) + # ](http://cldr.unicode.org/) project, and currently available in the file [ + # timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). + # This field is used to correctly interpret date and time queries. If this field + # is not specified, the default time zone (UTC) is used. # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone @@ -3603,8 +3483,7 @@ module Google end end - # Information relevant only to a restrict entry. - # NextId: 12 + # Information relevant only to a restrict entry. NextId: 12 class RestrictItem include Google::Apis::Core::Hashable @@ -3699,8 +3578,8 @@ module Google # @return [String] attr_accessor :operator_name - # A typed name-value pair for structured data. The type of the value should - # be the same as the registered type for the `name` property in the object + # A typed name-value pair for structured data. The type of the value should be + # the same as the registered type for the `name` property in the object # definition of `objectType`. # Corresponds to the JSON property `property` # @return [Google::Apis::CloudsearchV1::NamedProperty] @@ -3766,9 +3645,8 @@ module Google class RetrievalImportance include Google::Apis::Core::Hashable - # Indicates the ranking importance given to property when it is matched - # during retrieval. Once set, the token importance of a property cannot be - # changed. + # Indicates the ranking importance given to property when it is matched during + # retrieval. Once set, the token importance of a property cannot be changed. # Corresponds to the JSON property `importance` # @return [String] attr_accessor :importance @@ -3787,15 +3665,15 @@ module Google class Schema include Google::Apis::Core::Hashable - # The list of top-level objects for the data source. - # The maximum number of elements is 10. + # The list of top-level objects for the data source. The maximum number of + # elements is 10. # Corresponds to the JSON property `objectDefinitions` # @return [Array] attr_accessor :object_definitions - # IDs of the Long Running Operations (LROs) currently running for this - # schema. After modifying the schema, wait for operations to complete - # before indexing additional content. + # IDs of the Long Running Operations (LROs) currently running for this schema. + # After modifying the schema, wait for operations to complete before indexing + # additional content. # Corresponds to the JSON property `operationIds` # @return [Array] attr_accessor :operation_ids @@ -3811,22 +3689,20 @@ module Google end end - # Scoring configurations for a source while processing a - # Search or - # Suggest request. + # Scoring configurations for a source while processing a Search or Suggest + # request. class ScoringConfig include Google::Apis::Core::Hashable - # Whether to use freshness as a ranking signal. By default, freshness is used - # as a ranking signal. Note that this setting is not available in the Admin - # UI. + # Whether to use freshness as a ranking signal. By default, freshness is used as + # a ranking signal. Note that this setting is not available in the Admin UI. # Corresponds to the JSON property `disableFreshness` # @return [Boolean] attr_accessor :disable_freshness alias_method :disable_freshness?, :disable_freshness - # Whether to personalize the results. By default, personal signals will - # be used to boost results. + # Whether to personalize the results. By default, personal signals will be used + # to boost results. # Corresponds to the JSON property `disablePersonalization` # @return [Boolean] attr_accessor :disable_personalization @@ -3847,16 +3723,14 @@ module Google class SearchApplication include Google::Apis::Core::Hashable - # Retrictions applied to the configurations. - # The maximum number of elements is 10. + # Retrictions applied to the configurations. The maximum number of elements is + # 10. # Corresponds to the JSON property `dataSourceRestrictions` # @return [Array] attr_accessor :data_source_restrictions - # The default fields for returning facet results. - # The sources specified here also have been included in - # data_source_restrictions - # above. + # The default fields for returning facet results. The sources specified here + # also have been included in data_source_restrictions above. # Corresponds to the JSON property `defaultFacetOptions` # @return [Array] attr_accessor :default_facet_options @@ -3866,28 +3740,24 @@ module Google # @return [Google::Apis::CloudsearchV1::SortOptions] attr_accessor :default_sort_options - # Display name of the Search Application. - # The maximum length is 300 characters. + # Display name of the Search Application. The maximum length is 300 characters. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Name of the Search Application. - #
Format: searchapplications/`application_id`. + # Name of the Search Application. Format: searchapplications/`application_id`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. IDs of the Long Running Operations (LROs) currently running for - # this - # schema. Output only field. + # this schema. Output only field. # Corresponds to the JSON property `operationIds` # @return [Array] attr_accessor :operation_ids - # Scoring configurations for a source while processing a - # Search or - # Suggest request. + # Scoring configurations for a source while processing a Search or Suggest + # request. # Corresponds to the JSON property `scoringConfig` # @return [Google::Apis::CloudsearchV1::ScoringConfig] attr_accessor :scoring_config @@ -4027,8 +3897,8 @@ module Google # @return [String] attr_accessor :page_token - # Specify the full view URL to find the corresponding item. - # The maximum length is 2048 characters. + # Specify the full view URL to find the corresponding item. The maximum length + # is 2048 characters. # Corresponds to the JSON property `viewUrl` # @return [String] attr_accessor :view_url @@ -4054,8 +3924,8 @@ module Google # @return [Array] attr_accessor :items - # 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 @@ -4096,8 +3966,8 @@ module Google class SearchRequest include Google::Apis::Core::Hashable - # The sources to use for querying. If not specified, all data sources - # from the current search application are used. + # The sources to use for querying. If not specified, all data sources from the + # current search application are used. # Corresponds to the JSON property `dataSourceRestrictions` # @return [Array] attr_accessor :data_source_restrictions @@ -4107,17 +3977,14 @@ module Google # @return [Array] attr_accessor :facet_options - # Maximum number of search results to return in one page. - # Valid values are between 1 and 100, inclusive. - # Default value is 10. + # Maximum number of search results to return in one page. Valid values are + # between 1 and 100, inclusive. Default value is 10. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size - # The raw query string. - # See supported search operators in the [Cloud search - # Cheat - # Sheet](https://support.google.com/a/users/answer/9299929) + # The raw query string. See supported search operators in the [Cloud search + # Cheat Sheet](https://support.google.com/a/users/answer/9299929) # Corresponds to the JSON property `query` # @return [String] attr_accessor :query @@ -4184,8 +4051,8 @@ module Google attr_accessor :has_more_results alias_method :has_more_results?, :has_more_results - # Query interpretation result for user query. Empty if query interpretation - # is disabled. + # Query interpretation result for user query. Empty if query interpretation is + # disabled. # Corresponds to the JSON property `queryInterpretation` # @return [Google::Apis::CloudsearchV1::QueryInterpretation] attr_accessor :query_interpretation @@ -4215,8 +4082,8 @@ module Google # @return [Array] attr_accessor :spell_results - # Structured results for the user query. These results are not counted - # against the page_size. + # Structured results for the user query. These results are not counted against + # the page_size. # Corresponds to the JSON property `structuredResults` # @return [Array] attr_accessor :structured_results @@ -4245,8 +4112,8 @@ module Google class SearchResult include Google::Apis::Core::Hashable - # If source is clustered, provide list of clustered results. There will only - # be one level of clustered results. If current source is not enabled for + # If source is clustered, provide list of clustered results. There will only be + # one level of clustered results. If current source is not enabled for # clustering, this field will be empty. # Corresponds to the JSON property `clusteredResults` # @return [Array] @@ -4273,8 +4140,8 @@ module Google # @return [String] attr_accessor :title - # The URL of the search result. The URL contains a Google redirect to the - # actual item. This URL is signed and shouldn't be changed. + # The URL of the search result. The URL contains a Google redirect to the actual + # item. This URL is signed and shouldn't be changed. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -4304,9 +4171,8 @@ module Google # @return [Array] attr_accessor :match_ranges - # The snippet of the document. - # The snippet of the document. May contain escaped HTML character that - # should be unescaped prior to rendering. + # The snippet of the document. The snippet of the document. May contain escaped + # HTML character that should be unescaped prior to rendering. # Corresponds to the JSON property `snippet` # @return [String] attr_accessor :snippet @@ -4326,9 +4192,8 @@ module Google class SortOptions include Google::Apis::Core::Hashable - # Name of the operator corresponding to the field to sort on. - # The corresponding property must be marked as - # sortable. + # Name of the operator corresponding to the field to sort on. The corresponding + # property must be marked as sortable. # Corresponds to the JSON property `operatorName` # @return [String] attr_accessor :operator_name @@ -4353,8 +4218,7 @@ module Google class Source include Google::Apis::Core::Hashable - # Source name for content indexed by the - # Indexing API. + # Source name for content indexed by the Indexing API. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4375,17 +4239,15 @@ module Google end end - # Configurations for a source while processing a - # Search or - # Suggest request. + # Configurations for a source while processing a Search or Suggest request. class SourceConfig include Google::Apis::Core::Hashable - # Set search results crowding limits. Crowding is a situation in which - # multiple results from the same source or host "crowd out" other results, - # diminishing the quality of search for users. To foster better search quality - # and source diversity in search results, you can set a condition to reduce - # repetitive results by source. + # Set search results crowding limits. Crowding is a situation in which multiple + # results from the same source or host "crowd out" other results, diminishing + # the quality of search for users. To foster better search quality and source + # diversity in search results, you can set a condition to reduce repetitive + # results by source. # Corresponds to the JSON property `crowdingConfig` # @return [Google::Apis::CloudsearchV1::SourceCrowdingConfig] attr_accessor :crowding_config @@ -4413,22 +4275,22 @@ module Google end end - # Set search results crowding limits. Crowding is a situation in which - # multiple results from the same source or host "crowd out" other results, - # diminishing the quality of search for users. To foster better search quality - # and source diversity in search results, you can set a condition to reduce - # repetitive results by source. + # Set search results crowding limits. Crowding is a situation in which multiple + # results from the same source or host "crowd out" other results, diminishing + # the quality of search for users. To foster better search quality and source + # diversity in search results, you can set a condition to reduce repetitive + # results by source. class SourceCrowdingConfig include Google::Apis::Core::Hashable - # Maximum number of results allowed from a source. - # No limits will be set on results if this value is less than or equal to 0. + # Maximum number of results allowed from a source. No limits will be set on + # results if this value is less than or equal to 0. # Corresponds to the JSON property `numResults` # @return [Fixnum] attr_accessor :num_results - # Maximum number of suggestions allowed from a source. - # No limits will be set on results if this value is less than or equal to 0. + # Maximum number of suggestions allowed from a source. No limits will be set on + # results if this value is less than or equal to 0. # Corresponds to the JSON property `numSuggestions` # @return [Fixnum] attr_accessor :num_suggestions @@ -4525,8 +4387,8 @@ module Google class StartUploadItemRequest include Google::Apis::Core::Hashable - # Name of connector making this call. - #
Format: datasources/`source_id`/connectors/`ID` + # Name of connector making this call. Format: datasources/`source_id`/connectors/ + # `ID` # Corresponds to the JSON property `connectorName` # @return [String] attr_accessor :connector_name @@ -4547,12 +4409,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 @@ -4561,15 +4423,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>] 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 @@ -4590,8 +4452,7 @@ module Google class StructuredDataObject include Google::Apis::Core::Hashable - # The properties for the object. - # The maximum number of elements is 1000. + # The properties for the object. The maximum number of elements is 1000. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -4629,17 +4490,16 @@ module Google class SuggestRequest include Google::Apis::Core::Hashable - # The sources to use for suggestions. If not specified, the data sources - # are taken from the current search application. - # NOTE: Suggestions are supported only for third party data sources and - # people (i.e. PredefinedSource.PERSON). + # The sources to use for suggestions. If not specified, the data sources are + # taken from the current search application. NOTE: Suggestions are supported + # only for third party data sources and people (i.e. PredefinedSource.PERSON). # Corresponds to the JSON property `dataSourceRestrictions` # @return [Array] attr_accessor :data_source_restrictions - # Partial query for which autocomplete suggestions will be shown. - # For example, if the query is "sea", then the server might return - # "season", "search", "seagull" and so on. + # Partial query for which autocomplete suggestions will be shown. For example, + # if the query is "sea", then the server might return "season", "search", " + # seagull" and so on. # Corresponds to the JSON property `query` # @return [String] attr_accessor :query @@ -4700,8 +4560,8 @@ module Google # @return [Google::Apis::CloudsearchV1::Source] attr_accessor :source - # The suggested query that will be used for search, when the user - # clicks on the suggestion + # The suggested query that will be used for search, when the user clicks on the + # suggestion # Corresponds to the JSON property `suggestedQuery` # @return [String] attr_accessor :suggested_query @@ -4720,35 +4580,31 @@ module Google end # Used to provide a search operator for text properties. This is optional. - # Search operators let users restrict the query to specific fields relevant - # to the type of item being searched. + # Search operators let users restrict the query to specific fields relevant to + # the type of item being searched. class TextOperatorOptions include Google::Apis::Core::Hashable - # If true, the text value is tokenized as one atomic value in - # operator searches and facet matches. For example, if the operator name is - # "genre" and the value is "science-fiction" the query restrictions - # "genre:science" and "genre:fiction" doesn't match the item; - # "genre:science-fiction" does. Value matching is case-sensitive - # and does not remove special characters. - # If false, the text is tokenized. For example, if the value is - # "science-fiction" the queries "genre:science" and "genre:fiction" - # matches the item. + # If true, the text value is tokenized as one atomic value in operator searches + # and facet matches. For example, if the operator name is "genre" and the value + # is "science-fiction" the query restrictions "genre:science" and "genre:fiction" + # doesn't match the item; "genre:science-fiction" does. Value matching is case- + # sensitive and does not remove special characters. If false, the text is + # tokenized. For example, if the value is "science-fiction" the queries "genre: + # science" and "genre:fiction" matches the item. # Corresponds to the JSON property `exactMatchWithOperator` # @return [Boolean] attr_accessor :exact_match_with_operator alias_method :exact_match_with_operator?, :exact_match_with_operator - # Indicates the operator name required in the query in order to isolate the - # text property. For example, if operatorName is *subject* and the - # property's name is *subjectLine*, then queries like - # *subject:<value>* show results only where the value of the - # property named *subjectLine* matches *<value>*. By contrast, a - # search that uses the same *<value>* without an operator returns - # all items where *<value>* matches the value of any - # text properties or text within the content field for the item. - # The operator name can only contain lowercase letters (a-z). - # The maximum length is 32 characters. + # Indicates the operator name required in the query in order to isolate the text + # property. For example, if operatorName is *subject* and the property's name is + # *subjectLine*, then queries like *subject:* show results only where the + # value of the property named *subjectLine* matches **. By contrast, a + # search that uses the same ** without an operator returns all items + # where ** matches the value of any text properties or text within the + # content field for the item. The operator name can only contain lowercase + # letters (a-z). The maximum length is 32 characters. # Corresponds to the JSON property `operatorName` # @return [String] attr_accessor :operator_name @@ -4769,14 +4625,14 @@ module Google include Google::Apis::Core::Hashable # Used to provide a search operator for text properties. This is optional. - # Search operators let users restrict the query to specific fields relevant - # to the type of item being searched. + # Search operators let users restrict the query to specific fields relevant to + # the type of item being searched. # Corresponds to the JSON property `operatorOptions` # @return [Google::Apis::CloudsearchV1::TextOperatorOptions] attr_accessor :operator_options - # Indicates the search quality importance of the tokens within the - # field when used for retrieval. + # Indicates the search quality importance of the tokens within the field when + # used for retrieval. # Corresponds to the JSON property `retrievalImportance` # @return [Google::Apis::CloudsearchV1::RetrievalImportance] attr_accessor :retrieval_importance @@ -4811,46 +4667,40 @@ module Google end end - # Used to provide a search operator for timestamp properties. This is - # optional. Search operators let users restrict the query to specific fields - # relevant to the type of item being searched. + # Used to provide a search operator for timestamp properties. This is optional. + # Search operators let users restrict the query to specific fields relevant to + # the type of item being searched. class TimestampOperatorOptions include Google::Apis::Core::Hashable # Indicates the operator name required in the query in order to isolate the # timestamp property using the greater-than operator. For example, if - # greaterThanOperatorName is *closedafter* and the property's name is - # *closeDate*, then queries like *closedafter:<value>* - # show results only where the value of the property named *closeDate* is - # later than *<value>*. - # The operator name can only contain lowercase letters (a-z). - # The maximum length is 32 characters. + # greaterThanOperatorName is *closedafter* and the property's name is *closeDate* + # , then queries like *closedafter:* show results only where the value of + # the property named *closeDate* is later than **. The operator name can + # only contain lowercase letters (a-z). The maximum length is 32 characters. # Corresponds to the JSON property `greaterThanOperatorName` # @return [String] attr_accessor :greater_than_operator_name # Indicates the operator name required in the query in order to isolate the # timestamp property using the less-than operator. For example, if - # lessThanOperatorName is *closedbefore* and the property's name is - # *closeDate*, then queries like *closedbefore:<value>* - # show results only where the value of the property named *closeDate* is - # earlier than *<value>*. - # The operator name can only contain lowercase letters (a-z). - # The maximum length is 32 characters. + # lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, + # then queries like *closedbefore:* show results only where the value of + # the property named *closeDate* is earlier than **. The operator name + # can only contain lowercase letters (a-z). The maximum length is 32 characters. # Corresponds to the JSON property `lessThanOperatorName` # @return [String] attr_accessor :less_than_operator_name # Indicates the operator name required in the query in order to isolate the # timestamp property. For example, if operatorName is *closedon* and the - # property's name is *closeDate*, then queries like - # *closedon:<value>* show results only where the value of the - # property named *closeDate* matches *<value>*. By contrast, a - # search that uses the same *<value>* without an operator returns - # all items where *<value>* matches the value of any String - # properties or text within the content field for the item. The operator - # name can only contain lowercase letters (a-z). The maximum length is 32 - # characters. + # property's name is *closeDate*, then queries like *closedon:* show + # results only where the value of the property named *closeDate* matches * + # *. By contrast, a search that uses the same ** without an operator + # returns all items where ** matches the value of any String properties + # or text within the content field for the item. The operator name can only + # contain lowercase letters (a-z). The maximum length is 32 characters. # Corresponds to the JSON property `operatorName` # @return [String] attr_accessor :operator_name @@ -4871,9 +4721,9 @@ module Google class TimestampPropertyOptions include Google::Apis::Core::Hashable - # Used to provide a search operator for timestamp properties. This is - # optional. Search operators let users restrict the query to specific fields - # relevant to the type of item being searched. + # Used to provide a search operator for timestamp properties. This is optional. + # Search operators let users restrict the query to specific fields relevant to + # the type of item being searched. # Corresponds to the JSON property `operatorOptions` # @return [Google::Apis::CloudsearchV1::TimestampOperatorOptions] attr_accessor :operator_options @@ -4936,8 +4786,8 @@ module Google class UnreserveItemsRequest include Google::Apis::Core::Hashable - # Name of connector making this call. - #
Format: datasources/`source_id`/connectors/`ID` + # Name of connector making this call. Format: datasources/`source_id`/connectors/ + # `ID` # Corresponds to the JSON property `connectorName` # @return [String] attr_accessor :connector_name @@ -4973,9 +4823,9 @@ module Google # @return [Google::Apis::CloudsearchV1::DebugOptions] attr_accessor :debug_options - # Datasource is a logical namespace for items to be indexed. - # All items must belong to a datasource. This is the prerequisite before - # items can be indexed into Cloud Search. + # Datasource is a logical namespace for items to be indexed. All items must + # belong to a datasource. This is the prerequisite before items can be indexed + # into Cloud Search. # Corresponds to the JSON property `source` # @return [Google::Apis::CloudsearchV1::DataSource] attr_accessor :source @@ -5005,8 +4855,8 @@ module Google # @return [Google::Apis::CloudsearchV1::Schema] attr_accessor :schema - # If true, the schema will be checked for validity, - # but will not be registered with the data source, even if valid. + # If true, the schema will be checked for validity, but will not be registered + # with the data source, even if valid. # Corresponds to the JSON property `validateOnly` # @return [Boolean] attr_accessor :validate_only @@ -5024,16 +4874,13 @@ module Google end end - # Represents an upload session reference. - # This reference is created via upload - # method. - # Updating of item content may refer to this uploaded content via + # Represents an upload session reference. This reference is created via upload + # method. Updating of item content may refer to this uploaded content via # contentDataRef. class UploadItemRef include Google::Apis::Core::Hashable - # Name of the content reference. - # The maximum length is 2048 characters. + # Name of the content reference. The maximum length is 2048 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -5106,16 +4953,13 @@ module Google class ValueFilter include Google::Apis::Core::Hashable - # The `operator_name` applied to the query, such as *price_greater_than*. - # The filter can work against both types of filters defined in the schema - # for your data source: - #

- # 1. `operator_name`, where the query filters results by the property - # that matches the value. - #
- # 2. `greater_than_operator_name` or `less_than_operator_name` in your - # schema. The query filters the results for the property values that are - # greater than or less than the supplied value in the query. + # The `operator_name` applied to the query, such as *price_greater_than*. The + # filter can work against both types of filters defined in the schema for your + # data source: 1. `operator_name`, where the query filters results by the + # property that matches the value. 2. `greater_than_operator_name` or ` + # less_than_operator_name` in your schema. The query filters the results for the + # property values that are greater than or less than the supplied value in the + # query. # Corresponds to the JSON property `operatorName` # @return [String] attr_accessor :operator_name diff --git a/generated/google/apis/cloudsearch_v1/service.rb b/generated/google/apis/cloudsearch_v1/service.rb index 0304ac3be..a9ba25216 100644 --- a/generated/google/apis/cloudsearch_v1/service.rb +++ b/generated/google/apis/cloudsearch_v1/service.rb @@ -22,7 +22,7 @@ module Google module CloudsearchV1 # Cloud Search API # - # Cloud Search provides cloud-based search capabilities over G Suite data. The + # Cloud Search provides cloud-based search capabilities over G Suite data. The # Cloud Search API allows indexing of non-G Suite data into Cloud Search. # # @example @@ -48,15 +48,14 @@ module Google @batch_path = 'batch' end - # Checks whether an item is accessible by specified principal. - # **Note:** This API requires an admin account to execute. + # Checks whether an item is accessible by specified principal. **Note:** This + # API requires an admin account to execute. # @param [String] name - # Item name, format: - # datasources/`source_id`/items/`item_id` + # Item name, format: datasources/`source_id`/items/`item_id` # @param [Google::Apis::CloudsearchV1::Principal] principal_object # @param [Boolean] debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -87,12 +86,10 @@ module Google execute_or_queue_command(command, &block) end - # Fetches the item whose viewUrl exactly matches that of the URL provided - # in the request. - # **Note:** This API requires an admin account to execute. + # Fetches the item whose viewUrl exactly matches that of the URL provided in the + # request. **Note:** This API requires an admin account to execute. # @param [String] name - # Source name, format: - # datasources/`source_id` + # Source name, format: datasources/`source_id` # @param [Google::Apis::CloudsearchV1::SearchItemsByViewUrlRequest] search_items_by_view_url_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -123,17 +120,16 @@ module Google execute_or_queue_command(command, &block) end - # List all unmapped identities for a specific item. - # **Note:** This API requires an admin account to execute. + # List all unmapped identities for a specific item. **Note:** This API requires + # an admin account to execute. # @param [String] parent - # The name of the item, in the following format: - # datasources/`source_id`/items/`ID` + # The name of the item, in the following format: datasources/`source_id`/items/` + # ID` # @param [Boolean] debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @param [Fixnum] page_size - # Maximum number of items to fetch in a request. - # Defaults to 100. + # Maximum number of items to fetch in a request. Defaults to 100. # @param [String] page_token # The next_page_token value returned from a previous List request, if any. # @param [String] fields @@ -166,18 +162,17 @@ module Google execute_or_queue_command(command, &block) end - # Lists names of items associated with an unmapped identity. - # **Note:** This API requires an admin account to execute. + # Lists names of items associated with an unmapped identity. **Note:** This API + # requires an admin account to execute. # @param [String] parent - # The name of the identity source, in the following format: - # identitysources/`source_id`` + # The name of the identity source, in the following format: identitysources/` + # source_id`` # @param [Boolean] debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @param [String] group_resource_name # @param [Fixnum] page_size - # Maximum number of items to fetch in a request. - # Defaults to 100. + # Maximum number of items to fetch in a request. Defaults to 100. # @param [String] page_token # The next_page_token value returned from a previous List request, if any. # @param [String] user_resource_name @@ -213,17 +208,16 @@ module Google execute_or_queue_command(command, &block) end - # Lists unmapped user identities for an identity source. - # **Note:** This API requires an admin account to execute. + # Lists unmapped user identities for an identity source. **Note:** This API + # requires an admin account to execute. # @param [String] parent - # The name of the identity source, in the following format: - # identitysources/`source_id` + # The name of the identity source, in the following format: identitysources/` + # source_id` # @param [Boolean] debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @param [Fixnum] page_size - # Maximum number of items to fetch in a request. - # Defaults to 100. + # Maximum number of items to fetch in a request. Defaults to 100. # @param [String] page_token # The next_page_token value returned from a previous List request, if any. # @param [String] resolution_status_code @@ -259,14 +253,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the schema of a data source. - # **Note:** This API requires an admin or service account to execute. + # Deletes the schema of a data source. **Note:** This API requires an admin or + # service account to execute. # @param [String] name - # Name of the data source to delete Schema. Format: - # datasources/`source_id` + # Name of the data source to delete Schema. Format: datasources/`source_id` # @param [Boolean] debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -295,14 +288,13 @@ module Google execute_or_queue_command(command, &block) end - # Gets the schema of a data source. - # **Note:** This API requires an admin or service account to execute. + # Gets the schema of a data source. **Note:** This API requires an admin or + # service account to execute. # @param [String] name - # Name of the data source to get Schema. Format: - # datasources/`source_id` + # Name of the data source to get Schema. Format: datasources/`source_id` # @param [Boolean] debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -331,13 +323,12 @@ module Google execute_or_queue_command(command, &block) end - # Updates the schema of a data source. This method does not perform - # incremental updates to the schema. Instead, this method updates the schema - # by overwriting the entire schema. - # **Note:** This API requires an admin or service account to execute. + # Updates the schema of a data source. This method does not perform incremental + # updates to the schema. Instead, this method updates the schema by overwriting + # the entire schema. **Note:** This API requires an admin or service account to + # execute. # @param [String] name - # Name of the data source to update Schema. Format: - # datasources/`source_id` + # Name of the data source to update Schema. Format: datasources/`source_id` # @param [Google::Apis::CloudsearchV1::UpdateSchemaRequest] update_schema_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -368,31 +359,27 @@ module Google execute_or_queue_command(command, &block) end - # Deletes Item resource for the - # specified resource name. This API requires an admin or service account - # to execute. The service account used is the one whitelisted in the - # corresponding data source. + # Deletes Item resource for the specified resource name. This API requires an + # admin or service account to execute. The service account used is the one + # whitelisted in the corresponding data source. # @param [String] name - # Required. Name of the item to delete. - # Format: datasources/`source_id`/items/`item_id` + # Required. Name of the item to delete. Format: datasources/`source_id`/items/` + # item_id` # @param [String] connector_name - # Name of connector making this call. - #
Format: datasources/`source_id`/connectors/`ID` + # Name of connector making this call. Format: datasources/`source_id`/connectors/ + # `ID` # @param [Boolean] debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @param [String] mode # Required. The RequestMode for this request. # @param [String] version - # Required. The incremented version of the item to delete from the index. - # The indexing system stores the version from the datasource as a - # byte string and compares the Item version in the index - # to the version of the queued Item using lexical ordering. - #

- # Cloud Search Indexing won't delete any queued item with - # a version value that is less than or equal to - # the version of the currently indexed item. - # The maximum length for this field is 1024 bytes. + # Required. The incremented version of the item to delete from the index. The + # indexing system stores the version from the datasource as a byte string and + # compares the Item version in the index to the version of the queued Item using + # lexical ordering. Cloud Search Indexing won't delete any queued item with a + # version value that is less than or equal to the version of the currently + # indexed item. The maximum length for this field is 1024 bytes. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -424,13 +411,12 @@ module Google execute_or_queue_command(command, &block) end - # Deletes all items in a queue. This method is useful for deleting stale - # items. - # This API requires an admin or service account to execute. The service - # account used is the one whitelisted in the corresponding data source. + # Deletes all items in a queue. This method is useful for deleting stale items. + # This API requires an admin or service account to execute. The service account + # used is the one whitelisted in the corresponding data source. # @param [String] name - # Name of the Data Source to delete items in a queue. - # Format: datasources/`source_id` + # Name of the Data Source to delete items in a queue. Format: datasources/` + # source_id` # @param [Google::Apis::CloudsearchV1::DeleteQueueItemsRequest] delete_queue_items_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -461,18 +447,17 @@ module Google execute_or_queue_command(command, &block) end - # Gets Item resource by item name. - # This API requires an admin or service account to execute. The service - # account used is the one whitelisted in the corresponding data source. + # Gets Item resource by item name. This API requires an admin or service account + # to execute. The service account used is the one whitelisted in the + # corresponding data source. # @param [String] name - # Name of the item to get info. - # Format: datasources/`source_id`/items/`item_id` + # Name of the item to get info. Format: datasources/`source_id`/items/`item_id` # @param [String] connector_name - # Name of connector making this call. - #
Format: datasources/`source_id`/connectors/`ID` + # Name of connector making this call. Format: datasources/`source_id`/connectors/ + # `ID` # @param [Boolean] debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -502,18 +487,14 @@ module Google execute_or_queue_command(command, &block) end - # Updates Item ACL, metadata, and - # content. It will insert the Item if it - # does not exist. - # This method does not support partial updates. Fields with no provided - # values are cleared out in the Cloud Search index. - # This API requires an admin or service account to execute. The service - # account used is the one whitelisted in the corresponding data source. + # Updates Item ACL, metadata, and content. It will insert the Item if it does + # not exist. This method does not support partial updates. Fields with no + # provided values are cleared out in the Cloud Search index. This API requires + # an admin or service account to execute. The service account used is the one + # whitelisted in the corresponding data source. # @param [String] name - # Name of the Item. Format: - # datasources/`source_id`/items/`item_id` - #
This is a required field. - # The maximum length is 1536 characters. + # Name of the Item. Format: datasources/`source_id`/items/`item_id` This is a + # required field. The maximum length is 1536 characters. # @param [Google::Apis::CloudsearchV1::IndexItemRequest] index_item_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -544,43 +525,28 @@ module Google execute_or_queue_command(command, &block) end - # Lists all or a subset of Item resources. - # This API requires an admin or service account to execute. The service - # account used is the one whitelisted in the corresponding data source. + # Lists all or a subset of Item resources. This API requires an admin or service + # account to execute. The service account used is the one whitelisted in the + # corresponding data source. # @param [String] name - # Name of the Data Source to list Items. Format: - # datasources/`source_id` + # Name of the Data Source to list Items. Format: datasources/`source_id` # @param [Boolean] brief # When set to true, the indexing system only populates the following fields: - # name, - # version, - # queue. - # metadata.hash, - # metadata.title, - # metadata.sourceRepositoryURL, - # metadata.objectType, - # metadata.createTime, - # metadata.updateTime, - # metadata.contentLanguage, - # metadata.mimeType, - # structured_data.hash, - # content.hash, - # itemType, - # itemStatus.code, - # itemStatus.processingError.code, - # itemStatus.repositoryError.type, - #
If this value is false, then all the fields are populated in Item. + # name, version, queue. metadata.hash, metadata.title, metadata. + # sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata. + # updateTime, metadata.contentLanguage, metadata.mimeType, structured_data.hash, + # content.hash, itemType, itemStatus.code, itemStatus.processingError.code, + # itemStatus.repositoryError.type, If this value is false, then all the fields + # are populated in Item. # @param [String] connector_name - # Name of connector making this call. - #
Format: datasources/`source_id`/connectors/`ID` + # Name of connector making this call. Format: datasources/`source_id`/connectors/ + # `ID` # @param [Boolean] debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @param [Fixnum] page_size - # Maximum number of items to fetch in a request. - # The max value is 1000 when brief is true. The max value is 10 if brief - # is false. - #
The default value is 10 + # Maximum number of items to fetch in a request. The max value is 1000 when + # brief is true. The max value is 10 if brief is false. The default value is 10 # @param [String] page_token # The next_page_token value returned from a previous List request, if any. # @param [String] fields @@ -615,34 +581,18 @@ module Google execute_or_queue_command(command, &block) end - # Polls for unreserved items from the indexing queue and marks a - # set as reserved, starting with items that have - # the oldest timestamp from the highest priority - # ItemStatus. - # The priority order is as follows:
- # ERROR - #
- # MODIFIED - #
- # NEW_ITEM - #
- # ACCEPTED - #
- # Reserving items ensures that polling from other threads - # cannot create overlapping sets. - # After handling the reserved items, the client should put items back - # into the unreserved state, either by calling - # index, - # or by calling - # push with - # the type REQUEUE. - # Items automatically become available (unreserved) after 4 hours even if no - # update or push method is called. - # This API requires an admin or service account to execute. The service - # account used is the one whitelisted in the corresponding data source. + # Polls for unreserved items from the indexing queue and marks a set as reserved, + # starting with items that have the oldest timestamp from the highest priority + # ItemStatus. The priority order is as follows: ERROR MODIFIED NEW_ITEM ACCEPTED + # Reserving items ensures that polling from other threads cannot create + # overlapping sets. After handling the reserved items, the client should put + # items back into the unreserved state, either by calling index, or by calling + # push with the type REQUEUE. Items automatically become available (unreserved) + # after 4 hours even if no update or push method is called. This API requires an + # admin or service account to execute. The service account used is the one + # whitelisted in the corresponding data source. # @param [String] name - # Name of the Data Source to poll items. - # Format: datasources/`source_id` + # Name of the Data Source to poll items. Format: datasources/`source_id` # @param [Google::Apis::CloudsearchV1::PollItemsRequest] poll_items_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -673,15 +623,13 @@ module Google execute_or_queue_command(command, &block) end - # Pushes an item onto a queue for later polling and updating. - # This API requires an admin or service account to execute. The service - # account used is the one whitelisted in the corresponding data source. + # Pushes an item onto a queue for later polling and updating. This API requires + # an admin or service account to execute. The service account used is the one + # whitelisted in the corresponding data source. # @param [String] name - # Name of the item to - # push into the indexing queue.
- # Format: datasources/`source_id`/items/`ID` - #
This is a required field. - # The maximum length is 1536 characters. + # Name of the item to push into the indexing queue. Format: datasources/` + # source_id`/items/`ID` This is a required field. The maximum length is 1536 + # characters. # @param [Google::Apis::CloudsearchV1::PushItemRequest] push_item_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -712,14 +660,12 @@ module Google execute_or_queue_command(command, &block) end - # Unreserves all items from a queue, making them all eligible to be - # polled. This method is useful for resetting the indexing queue - # after a connector has been restarted. - # This API requires an admin or service account to execute. The service - # account used is the one whitelisted in the corresponding data source. + # Unreserves all items from a queue, making them all eligible to be polled. This + # method is useful for resetting the indexing queue after a connector has been + # restarted. This API requires an admin or service account to execute. The + # service account used is the one whitelisted in the corresponding data source. # @param [String] name - # Name of the Data Source to unreserve all items. - # Format: datasources/`source_id` + # Name of the Data Source to unreserve all items. Format: datasources/`source_id` # @param [Google::Apis::CloudsearchV1::UnreserveItemsRequest] unreserve_items_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -750,16 +696,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates an upload session for uploading item content. For items smaller - # than 100 KB, it's easier to embed the content - # inline within - # an index request. - # This API requires an admin or service account to execute. The service - # account used is the one whitelisted in the corresponding data source. + # Creates an upload session for uploading item content. For items smaller than + # 100 KB, it's easier to embed the content inline within an index request. This + # API requires an admin or service account to execute. The service account used + # is the one whitelisted in the corresponding data source. # @param [String] name - # Name of the Item to start a resumable upload. - # Format: datasources/`source_id`/items/`item_id`. - # The maximum length is 1536 bytes. + # Name of the Item to start a resumable upload. Format: datasources/`source_id`/ + # items/`item_id`. The maximum length is 1536 bytes. # @param [Google::Apis::CloudsearchV1::StartUploadItemRequest] start_upload_item_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -790,30 +733,21 @@ module Google execute_or_queue_command(command, &block) end - # Uploads media for indexing. - # The upload endpoint supports direct and resumable upload protocols and - # is intended for large items that can not be - # [inlined during index requests](https://developers.google.com/cloud-search/ - # docs/reference/rest/v1/indexing.datasources.items#itemcontent). - # To index large content: - # 1. Call - # indexing.datasources.items.upload - # with the resource name to begin an upload session and retrieve the - # UploadItemRef. - # 1. Call media.upload to upload the content using the same resource name from - # step 1. - # 1. Call indexing.datasources.items.index - # to index the item. Populate the - # [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources. - # items#ItemContent) - # with the UploadItemRef from step 1. - # For additional information, see - # [Create a content connector using the REST API](https://developers.google.com/ - # cloud-search/docs/guides/content-connector#rest). - # **Note:** This API requires a service account to execute. + # Uploads media for indexing. The upload endpoint supports direct and resumable + # upload protocols and is intended for large items that can not be [inlined + # during index requests](https://developers.google.com/cloud-search/docs/ + # reference/rest/v1/indexing.datasources.items#itemcontent). To index large + # content: 1. Call indexing.datasources.items.upload with the resource name to + # begin an upload session and retrieve the UploadItemRef. 1. Call media.upload + # to upload the content using the same resource name from step 1. 1. Call + # indexing.datasources.items.index to index the item. Populate the [ItemContent]( + # /cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) + # with the UploadItemRef from step 1. For additional information, see [Create a + # content connector using the REST API](https://developers.google.com/cloud- + # search/docs/guides/content-connector#rest). **Note:** This API requires a + # service account to execute. # @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 [Google::Apis::CloudsearchV1::Media] media_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -854,9 +788,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 @@ -886,15 +819,14 @@ module Google execute_or_queue_command(command, &block) end - # The Cloud Search Query API provides the search method, which returns - # the most relevant results from a user query. The results can come from - # G Suite Apps, such as Gmail or Google Drive, or they can come from data - # that you have indexed from a third party. - # **Note:** This API requires a standard end user account to execute. - # A service account can't perform Query API requests directly; to use a - # service account to perform queries, set up [G Suite domain-wide delegation - # of - # authority](https://developers.google.com/cloud-search/docs/guides/delegation/). + # The Cloud Search Query API provides the search method, which returns the most + # relevant results from a user query. The results can come from G Suite Apps, + # such as Gmail or Google Drive, or they can come from data that you have + # indexed from a third party. **Note:** This API requires a standard end user + # account to execute. A service account can't perform Query API requests + # directly; to use a service account to perform queries, set up [G Suite domain- + # wide delegation of authority](https://developers.google.com/cloud-search/docs/ + # guides/delegation/). # @param [Google::Apis::CloudsearchV1::SearchRequest] search_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -924,12 +856,11 @@ module Google execute_or_queue_command(command, &block) end - # Provides suggestions for autocompleting the query. - # **Note:** This API requires a standard end user account to execute. - # A service account can't perform Query API requests directly; to use a - # service account to perform queries, set up [G Suite domain-wide delegation - # of - # authority](https://developers.google.com/cloud-search/docs/guides/delegation/). + # Provides suggestions for autocompleting the query. **Note:** This API requires + # a standard end user account to execute. A service account can't perform Query + # API requests directly; to use a service account to perform queries, set up [G + # Suite domain-wide delegation of authority](https://developers.google.com/cloud- + # search/docs/guides/delegation/). # @param [Google::Apis::CloudsearchV1::SuggestRequest] suggest_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -959,40 +890,35 @@ module Google execute_or_queue_command(command, &block) end - # Returns list of sources that user can use for Search and Suggest APIs. - # **Note:** This API requires a standard end user account to execute. - # A service account can't perform Query API requests directly; to use a - # service account to perform queries, set up [G Suite domain-wide delegation - # of - # authority](https://developers.google.com/cloud-search/docs/guides/delegation/). + # Returns list of sources that user can use for Search and Suggest APIs. **Note:* + # * This API requires a standard end user account to execute. A service account + # can't perform Query API requests directly; to use a service account to perform + # queries, set up [G Suite domain-wide delegation of authority](https:// + # developers.google.com/cloud-search/docs/guides/delegation/). # @param [String] page_token # Number of sources to return in the response. # @param [Boolean] request_options_debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @param [String] request_options_language_code - # The BCP-47 language code, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. - # For translations. - # Set this field using the language set in browser or for the page. In the - # event that the user's language preference is known, set this field to the - # known user language. - # When specified, the documents in search results are biased towards the - # specified language. - # The suggest API does not use this parameter. Instead, suggest autocompletes - # only based on characters in the query. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For + # translations. Set this field using the language set in browser or for the page. + # In the event that the user's language preference is known, set this field to + # the known user language. When specified, the documents in search results are + # biased towards the specified language. The suggest API does not use this + # parameter. Instead, suggest autocompletes only based on characters in the + # query. # @param [String] request_options_search_application_id - # The ID generated when you create a search application using the - # [admin console](https://support.google.com/a/answer/9043922). + # The ID generated when you create a search application using the [admin console] + # (https://support.google.com/a/answer/9043922). # @param [String] request_options_time_zone - # Current user's time zone id, such as "America/Los_Angeles" or - # "Australia/Sydney". These IDs are defined by - # [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) - # project, and currently available in the file - # [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). - # This field is used to correctly interpret date and time queries. - # If this field is not specified, the default time zone (UTC) is used. + # Current user's time zone id, such as "America/Los_Angeles" or "Australia/ + # Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR) + # ](http://cldr.unicode.org/) project, and currently available in the file [ + # timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). + # This field is used to correctly interpret date and time queries. If this field + # is not specified, the default time zone (UTC) is used. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1024,8 +950,7 @@ module Google execute_or_queue_command(command, &block) end - # Creates a datasource. - # **Note:** This API requires an admin account to execute. + # Creates a datasource. **Note:** This API requires an admin account to execute. # @param [Google::Apis::CloudsearchV1::DataSource] data_source_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1055,14 +980,12 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a datasource. - # **Note:** This API requires an admin account to execute. + # Deletes a datasource. **Note:** This API requires an admin account to execute. # @param [String] name - # Name of the datasource. - # Format: datasources/`source_id`. + # Name of the datasource. Format: datasources/`source_id`. # @param [Boolean] debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1091,14 +1014,12 @@ module Google execute_or_queue_command(command, &block) end - # Gets a datasource. - # **Note:** This API requires an admin account to execute. + # Gets a datasource. **Note:** This API requires an admin account to execute. # @param [String] name - # Name of the datasource resource. - # Format: datasources/`source_id`. + # Name of the datasource resource. Format: datasources/`source_id`. # @param [Boolean] debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1127,15 +1048,13 @@ module Google execute_or_queue_command(command, &block) end - # Lists datasources. - # **Note:** This API requires an admin account to execute. + # Lists datasources. **Note:** This API requires an admin account to execute. # @param [Boolean] debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @param [Fixnum] page_size - # Maximum number of datasources to fetch in a request. - # The max value is 100. - #
The default value is 10 + # Maximum number of datasources to fetch in a request. The max value is 100. The + # default value is 10 # @param [String] page_token # Starting index of the results. # @param [String] fields @@ -1167,12 +1086,10 @@ module Google execute_or_queue_command(command, &block) end - # Updates a datasource. - # **Note:** This API requires an admin account to execute. + # Updates a datasource. **Note:** This API requires an admin account to execute. # @param [String] name - # Name of the datasource resource. - # Format: datasources/`source_id`. - #
The name is ignored when creating a datasource. + # Name of the datasource resource. Format: datasources/`source_id`. The name is + # ignored when creating a datasource. # @param [Google::Apis::CloudsearchV1::UpdateDataSourceRequest] update_data_source_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1203,8 +1120,8 @@ module Google execute_or_queue_command(command, &block) end - # Creates a search application. - # **Note:** This API requires an admin account to execute. + # Creates a search application. **Note:** This API requires an admin account to + # execute. # @param [Google::Apis::CloudsearchV1::SearchApplication] search_application_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1234,14 +1151,14 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a search application. - # **Note:** This API requires an admin account to execute. + # Deletes a search application. **Note:** This API requires an admin account to + # execute. # @param [String] name - # The name of the search application to be deleted. - #
Format: applications/`application_id`. + # The name of the search application to be deleted. Format: applications/` + # application_id`. # @param [Boolean] debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1270,14 +1187,13 @@ module Google execute_or_queue_command(command, &block) end - # Gets the specified search application. - # **Note:** This API requires an admin account to execute. + # Gets the specified search application. **Note:** This API requires an admin + # account to execute. # @param [String] name - # Name of the search application. - #
Format: searchapplications/`application_id`. + # Name of the search application. Format: searchapplications/`application_id`. # @param [Boolean] debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1306,16 +1222,16 @@ module Google execute_or_queue_command(command, &block) end - # Lists all search applications. - # **Note:** This API requires an admin account to execute. + # Lists all search applications. **Note:** This API requires an admin account to + # execute. # @param [Boolean] debug_options_enable_debugging - # If you are asked by Google to help with debugging, set this field. - # Otherwise, ignore this field. + # If you are asked by Google to help with debugging, set this field. Otherwise, + # ignore this field. # @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. - #
The default value is 10 + # The next_page_token value returned from a previous List request, if any. The + # default value is 10 # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1346,11 +1262,10 @@ module Google end # Resets a search application to default settings. This will return an empty - # response. - # **Note:** This API requires an admin account to execute. + # response. **Note:** This API requires an admin account to execute. # @param [String] name - # The name of the search application to be reset. - #
Format: applications/`application_id`. + # The name of the search application to be reset. Format: applications/` + # application_id`. # @param [Google::Apis::CloudsearchV1::ResetSearchApplicationRequest] reset_search_application_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1381,11 +1296,10 @@ module Google execute_or_queue_command(command, &block) end - # Updates a search application. - # **Note:** This API requires an admin account to execute. + # Updates a search application. **Note:** This API requires an admin account to + # execute. # @param [String] name - # Name of the Search Application. - #
Format: searchapplications/`application_id`. + # Name of the Search Application. Format: searchapplications/`application_id`. # @param [Google::Apis::CloudsearchV1::SearchApplication] search_application_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1416,10 +1330,10 @@ module Google execute_or_queue_command(command, &block) end - # Gets indexed item statistics aggreggated across all data sources. This - # API only returns statistics for previous dates; it doesn't return - # statistics for the current day. - # **Note:** This API requires a standard end user account to execute. + # Gets indexed item statistics aggreggated across all data sources. This API + # only returns statistics for previous dates; it doesn't return statistics for + # the current day. **Note:** This API requires a standard end user account to + # execute. # @param [Fixnum] from_date_day # Day of month. Must be from 1 to 31 and valid for the year and month. # @param [Fixnum] from_date_month @@ -1464,8 +1378,8 @@ module Google execute_or_queue_command(command, &block) end - # Get the query statistics for customer. - # **Note:** This API requires a standard end user account to execute. + # Get the query statistics for customer. **Note:** This API requires a standard + # end user account to execute. # @param [Fixnum] from_date_day # Day of month. Must be from 1 to 31 and valid for the year and month. # @param [Fixnum] from_date_month @@ -1511,8 +1425,8 @@ module Google end # Get the # of search sessions, % of successful sessions with a click query - # statistics for customer. - # **Note:** This API requires a standard end user account to execute. + # statistics for customer. **Note:** This API requires a standard end user + # account to execute. # @param [Fixnum] from_date_day # Day of month. Must be from 1 to 31 and valid for the year and month. # @param [Fixnum] from_date_month @@ -1557,8 +1471,8 @@ module Google execute_or_queue_command(command, &block) end - # Get the users statistics for customer. - # **Note:** This API requires a standard end user account to execute. + # Get the users statistics for customer. **Note:** This API requires a standard + # end user account to execute. # @param [Fixnum] from_date_day # Day of month. Must be from 1 to 31 and valid for the year and month. # @param [Fixnum] from_date_month @@ -1603,11 +1517,11 @@ module Google execute_or_queue_command(command, &block) end - # Gets indexed item statistics for a single data source. - # **Note:** This API requires a standard end user account to execute. + # Gets indexed item statistics for a single data source. **Note:** This API + # requires a standard end user account to execute. # @param [String] name - # The resource id of the data source to retrieve statistics for, - # in the following format: "datasources/`source_id`" + # The resource id of the data source to retrieve statistics for, in the + # following format: "datasources/`source_id`" # @param [Fixnum] from_date_day # Day of month. Must be from 1 to 31 and valid for the year and month. # @param [Fixnum] from_date_month @@ -1653,11 +1567,11 @@ module Google execute_or_queue_command(command, &block) end - # Get the query statistics for search application. - # **Note:** This API requires a standard end user account to execute. + # Get the query statistics for search application. **Note:** This API requires a + # standard end user account to execute. # @param [String] name - # The resource id of the search application query stats, in the following - # format: searchapplications/`application_id` + # The resource id of the search application query stats, in the following format: + # searchapplications/`application_id` # @param [Fixnum] from_date_day # Day of month. Must be from 1 to 31 and valid for the year and month. # @param [Fixnum] from_date_month @@ -1704,8 +1618,8 @@ module Google end # Get the # of search sessions, % of successful sessions with a click query - # statistics for search application. - # **Note:** This API requires a standard end user account to execute. + # statistics for search application. **Note:** This API requires a standard end + # user account to execute. # @param [String] name # The resource id of the search application session stats, in the following # format: searchapplications/`application_id` @@ -1754,8 +1668,8 @@ module Google execute_or_queue_command(command, &block) end - # Get the users statistics for search application. - # **Note:** This API requires a standard end user account to execute. + # Get the users statistics for search application. **Note:** This API requires a + # standard end user account to execute. # @param [String] name # The resource id of the search application session stats, in the following # format: searchapplications/`application_id` diff --git a/generated/google/apis/dialogflow_v2.rb b/generated/google/apis/dialogflow_v2.rb index c95a3dea8..8db6e352f 100644 --- a/generated/google/apis/dialogflow_v2.rb +++ b/generated/google/apis/dialogflow_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow/ module DialogflowV2 VERSION = 'V2' - REVISION = '20200801' + REVISION = '20200810' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dialogflow_v2/classes.rb b/generated/google/apis/dialogflow_v2/classes.rb index 1f5f19b97..0c4786741 100644 --- a/generated/google/apis/dialogflow_v2/classes.rb +++ b/generated/google/apis/dialogflow_v2/classes.rb @@ -22,6 +22,26 @@ module Google module Apis module DialogflowV2 + # Metadata associated with the long running operation for Versions.CreateVersion. + class GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata + include Google::Apis::Core::Hashable + + # Name of the created version. Format: `projects//locations//agents//flows// + # versions/`. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @version = args[:version] if args.key?(:version) + end + end + # The response message for Agents.ExportAgent. class GoogleCloudDialogflowCxV3beta1ExportAgentResponse include Google::Apis::Core::Hashable @@ -372,8 +392,8 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment include Google::Apis::Core::Hashable - # Whether the playback of this segment can be interrupted by the end user's - # speech and the client should then start the next Dialogflow request. + # Output only. Whether the playback of this segment can be interrupted by the + # end user's speech and the client should then start the next Dialogflow request. # Corresponds to the JSON property `allowPlaybackInterruption` # @return [Boolean] attr_accessor :allow_playback_interruption @@ -435,8 +455,8 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio include Google::Apis::Core::Hashable - # Whether the playback of this message can be interrupted by the end user's - # speech and the client can then starts the next Dialogflow request. + # Output only. Whether the playback of this message can be interrupted by the + # end user's speech and the client can then starts the next Dialogflow request. # Corresponds to the JSON property `allowPlaybackInterruption` # @return [Boolean] attr_accessor :allow_playback_interruption @@ -463,8 +483,8 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageText include Google::Apis::Core::Hashable - # Whether the playback of this message can be interrupted by the end user's - # speech and the client can then starts the next Dialogflow request. + # Output only. Whether the playback of this message can be interrupted by the + # end user's speech and the client can then starts the next Dialogflow request. # Corresponds to the JSON property `allowPlaybackInterruption` # @return [Boolean] attr_accessor :allow_playback_interruption @@ -6807,6 +6827,26 @@ module Google end end + # Metadata associated with the long running operation for Versions.CreateVersion. + class GoogleCloudDialogflowV3alpha1CreateVersionOperationMetadata + include Google::Apis::Core::Hashable + + # Name of the created version. Format: `projects//locations//agents//flows// + # versions/`. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @version = args[:version] if args.key?(:version) + end + end + # The response message for Agents.ExportAgent. class GoogleCloudDialogflowV3alpha1ExportAgentResponse include Google::Apis::Core::Hashable diff --git a/generated/google/apis/dialogflow_v2/representations.rb b/generated/google/apis/dialogflow_v2/representations.rb index 8391565de..79e2d5318 100644 --- a/generated/google/apis/dialogflow_v2/representations.rb +++ b/generated/google/apis/dialogflow_v2/representations.rb @@ -22,6 +22,12 @@ module Google module Apis module DialogflowV2 + class GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDialogflowCxV3beta1ExportAgentResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1078,6 +1084,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDialogflowV3alpha1CreateVersionOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDialogflowV3alpha1ExportAgentResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1114,6 +1126,13 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :version, as: 'version' + end + end + class GoogleCloudDialogflowCxV3beta1ExportAgentResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2946,6 +2965,13 @@ module Google end end + class GoogleCloudDialogflowV3alpha1CreateVersionOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :version, as: 'version' + end + end + class GoogleCloudDialogflowV3alpha1ExportAgentResponse # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/dialogflow_v2beta1.rb b/generated/google/apis/dialogflow_v2beta1.rb index 59283abef..f90fbd775 100644 --- a/generated/google/apis/dialogflow_v2beta1.rb +++ b/generated/google/apis/dialogflow_v2beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow/ module DialogflowV2beta1 VERSION = 'V2beta1' - REVISION = '20200801' + REVISION = '20200810' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dialogflow_v2beta1/classes.rb b/generated/google/apis/dialogflow_v2beta1/classes.rb index 706e3b1ba..51d5ccd19 100644 --- a/generated/google/apis/dialogflow_v2beta1/classes.rb +++ b/generated/google/apis/dialogflow_v2beta1/classes.rb @@ -22,6 +22,26 @@ module Google module Apis module DialogflowV2beta1 + # Metadata associated with the long running operation for Versions.CreateVersion. + class GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata + include Google::Apis::Core::Hashable + + # Name of the created version. Format: `projects//locations//agents//flows// + # versions/`. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @version = args[:version] if args.key?(:version) + end + end + # The response message for Agents.ExportAgent. class GoogleCloudDialogflowCxV3beta1ExportAgentResponse include Google::Apis::Core::Hashable @@ -372,8 +392,8 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment include Google::Apis::Core::Hashable - # Whether the playback of this segment can be interrupted by the end user's - # speech and the client should then start the next Dialogflow request. + # Output only. Whether the playback of this segment can be interrupted by the + # end user's speech and the client should then start the next Dialogflow request. # Corresponds to the JSON property `allowPlaybackInterruption` # @return [Boolean] attr_accessor :allow_playback_interruption @@ -435,8 +455,8 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio include Google::Apis::Core::Hashable - # Whether the playback of this message can be interrupted by the end user's - # speech and the client can then starts the next Dialogflow request. + # Output only. Whether the playback of this message can be interrupted by the + # end user's speech and the client can then starts the next Dialogflow request. # Corresponds to the JSON property `allowPlaybackInterruption` # @return [Boolean] attr_accessor :allow_playback_interruption @@ -463,8 +483,8 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageText include Google::Apis::Core::Hashable - # Whether the playback of this message can be interrupted by the end user's - # speech and the client can then starts the next Dialogflow request. + # Output only. Whether the playback of this message can be interrupted by the + # end user's speech and the client can then starts the next Dialogflow request. # Corresponds to the JSON property `allowPlaybackInterruption` # @return [Boolean] attr_accessor :allow_playback_interruption @@ -7131,6 +7151,26 @@ module Google end end + # Metadata associated with the long running operation for Versions.CreateVersion. + class GoogleCloudDialogflowV3alpha1CreateVersionOperationMetadata + include Google::Apis::Core::Hashable + + # Name of the created version. Format: `projects//locations//agents//flows// + # versions/`. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @version = args[:version] if args.key?(:version) + end + end + # The response message for Agents.ExportAgent. class GoogleCloudDialogflowV3alpha1ExportAgentResponse include Google::Apis::Core::Hashable diff --git a/generated/google/apis/dialogflow_v2beta1/representations.rb b/generated/google/apis/dialogflow_v2beta1/representations.rb index e5d8ccddb..1a5dd8268 100644 --- a/generated/google/apis/dialogflow_v2beta1/representations.rb +++ b/generated/google/apis/dialogflow_v2beta1/representations.rb @@ -22,6 +22,12 @@ module Google module Apis module DialogflowV2beta1 + class GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDialogflowCxV3beta1ExportAgentResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1126,6 +1132,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDialogflowV3alpha1CreateVersionOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudDialogflowV3alpha1ExportAgentResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1162,6 +1174,13 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :version, as: 'version' + end + end + class GoogleCloudDialogflowCxV3beta1ExportAgentResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -3075,6 +3094,13 @@ module Google end end + class GoogleCloudDialogflowV3alpha1CreateVersionOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :version, as: 'version' + end + end + class GoogleCloudDialogflowV3alpha1ExportAgentResponse # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/dlp_v2.rb b/generated/google/apis/dlp_v2.rb index da28e3a46..0e3668b5f 100644 --- a/generated/google/apis/dlp_v2.rb +++ b/generated/google/apis/dlp_v2.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/dlp/docs/ module DlpV2 VERSION = 'V2' - REVISION = '20200805' + REVISION = '20200809' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dlp_v2/service.rb b/generated/google/apis/dlp_v2/service.rb index 27a4333de..0ff03a1f1 100644 --- a/generated/google/apis/dlp_v2/service.rb +++ b/generated/google/apis/dlp_v2/service.rb @@ -60,7 +60,8 @@ module Google # @param [String] location_id # Deprecated. This field has no effect. # @param [String] parent - # The parent resource name. - Format:locations/[LOCATION-ID] + # The parent resource name. The format of this value is as follows: locations/ + # LOCATION_ID # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -94,7 +95,8 @@ module Google # Returns a list of the sensitive information types that the DLP API supports. # See https://cloud.google.com/dlp/docs/infotypes-reference to learn more. # @param [String] parent - # The parent resource name. - Format:locations/[LOCATION-ID] + # The parent resource name. The format of this value is as follows: locations/ + # LOCATION_ID # @param [String] filter # filter to only return infoTypes supported by certain parts of the API. # Defaults to supported_by=INSPECT. @@ -137,9 +139,17 @@ module Google # identifying content, images, and storage. See https://cloud.google.com/dlp/ # docs/creating-templates-deid to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateDeidentifyTemplateRequest] google_privacy_dlp_v2_create_deidentify_template_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -239,9 +249,17 @@ module Google # Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating- # templates-deid to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [String] location_id # Deprecated. This field has no effect. # @param [String] order_by @@ -329,9 +347,17 @@ module Google # inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/ # creating-templates to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateInspectTemplateRequest] google_privacy_dlp_v2_create_inspect_template_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -431,9 +457,17 @@ module Google # Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating- # templates to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [String] location_id # Deprecated. This field has no effect. # @param [String] order_by @@ -521,9 +555,17 @@ module Google # identifying content, images, and storage. See https://cloud.google.com/dlp/ # docs/creating-templates-deid to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateDeidentifyTemplateRequest] google_privacy_dlp_v2_create_deidentify_template_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -623,9 +665,17 @@ module Google # Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating- # templates-deid to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [String] location_id # Deprecated. This field has no effect. # @param [String] order_by @@ -713,9 +763,17 @@ module Google # inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/ # creating-templates to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateInspectTemplateRequest] google_privacy_dlp_v2_create_inspect_template_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -815,9 +873,17 @@ module Google # Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating- # templates to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [String] location_id # Deprecated. This field has no effect. # @param [String] order_by @@ -904,9 +970,17 @@ module Google # Creates a pre-built stored infoType to be used for inspection. See https:// # cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateStoredInfoTypeRequest] google_privacy_dlp_v2_create_stored_info_type_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1006,9 +1080,17 @@ module Google # Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored- # infotypes to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [String] location_id # Deprecated. This field has no effect. # @param [String] order_by @@ -1096,9 +1178,17 @@ module Google # Creates a pre-built stored infoType to be used for inspection. See https:// # cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateStoredInfoTypeRequest] google_privacy_dlp_v2_create_stored_info_type_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1198,9 +1288,17 @@ module Google # Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored- # infotypes to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [String] location_id # Deprecated. This field has no effect. # @param [String] order_by @@ -1292,8 +1390,14 @@ module Google # detectors to run. By default this may be all types, but may change over time # as detectors are updated. # @param [String] parent - # Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[ - # PROJECT-ID]/locations/[LOCATION-ID] + # Parent resource name. The format of this value varies depending on whether you + # have [specified a processing location](/dlp/docs/specifying-location): + + # Projects scope, location specified: `projects/`PROJECT_ID`/locations/` + # LOCATION_ID + Projects scope, no location specified (defaults to global): ` + # projects/`PROJECT_ID The following example `parent` string specifies a parent + # project with the identifier `example-project`, and specifies the `europe-west3` + # location for processing data: parent=projects/example-project/locations/ + # europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyContentRequest] google_privacy_dlp_v2_deidentify_content_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1331,8 +1435,14 @@ module Google # as detectors are updated. For how to guides, see https://cloud.google.com/dlp/ # docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text, # @param [String] parent - # Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[ - # PROJECT-ID]/locations/[LOCATION-ID] + # Parent resource name. The format of this value varies depending on whether you + # have [specified a processing location](/dlp/docs/specifying-location): + + # Projects scope, location specified: `projects/`PROJECT_ID`/locations/` + # LOCATION_ID + Projects scope, no location specified (defaults to global): ` + # projects/`PROJECT_ID The following example `parent` string specifies a parent + # project with the identifier `example-project`, and specifies the `europe-west3` + # location for processing data: parent=projects/example-project/locations/ + # europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2InspectContentRequest] google_privacy_dlp_v2_inspect_content_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1367,8 +1477,14 @@ module Google # com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example to # learn more. # @param [String] parent - # Required. The parent resource name. - Format:projects/[PROJECT-ID] - Format: - # projects/[PROJECT-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # whether you have [specified a processing location](/dlp/docs/specifying- + # location): + Projects scope, location specified: `projects/`PROJECT_ID`/ + # locations/`LOCATION_ID + Projects scope, no location specified (defaults to + # global): `projects/`PROJECT_ID The following example `parent` string specifies + # a parent project with the identifier `example-project`, and specifies the ` + # europe-west3` location for processing data: parent=projects/example-project/ + # locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2ReidentifyContentRequest] google_privacy_dlp_v2_reidentify_content_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1403,9 +1519,17 @@ module Google # identifying content, images, and storage. See https://cloud.google.com/dlp/ # docs/creating-templates-deid to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateDeidentifyTemplateRequest] google_privacy_dlp_v2_create_deidentify_template_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1505,9 +1629,17 @@ module Google # Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating- # templates-deid to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [String] location_id # Deprecated. This field has no effect. # @param [String] order_by @@ -1634,8 +1766,14 @@ module Google # detectors to run. By default this may be all types, but may change over time # as detectors are updated. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # projects/[PROJECT-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # whether you have [specified a processing location](/dlp/docs/specifying- + # location): + Projects scope, location specified: `projects/`PROJECT_ID`/ + # locations/`LOCATION_ID + Projects scope, no location specified (defaults to + # global): `projects/`PROJECT_ID The following example `parent` string specifies + # a parent project with the identifier `example-project`, and specifies the ` + # europe-west3` location for processing data: parent=projects/example-project/ + # locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateDlpJobRequest] google_privacy_dlp_v2_create_dlp_job_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1735,8 +1873,14 @@ module Google # cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/ # docs/compute-risk-analysis to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # projects/[PROJECT-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # whether you have [specified a processing location](/dlp/docs/specifying- + # location): + Projects scope, location specified: `projects/`PROJECT_ID`/ + # locations/`LOCATION_ID + Projects scope, no location specified (defaults to + # global): `projects/`PROJECT_ID The following example `parent` string specifies + # a parent project with the identifier `example-project`, and specifies the ` + # europe-west3` location for processing data: parent=projects/example-project/ + # locations/europe-west3 # @param [String] filter # Allows filtering. Supported syntax: * Filter expressions are made up of one or # more restrictions. * Restrictions can be combined by `AND` or `OR` logical @@ -1809,8 +1953,14 @@ module Google # choose what detectors to run. By default this may be all types, but may change # over time as detectors are updated. # @param [String] parent - # The parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[ - # PROJECT-ID]/locations/[LOCATION-ID] + # Parent resource name. The format of this value varies depending on whether you + # have [specified a processing location](/dlp/docs/specifying-location): + + # Projects scope, location specified: `projects/`PROJECT_ID`/locations/` + # LOCATION_ID + Projects scope, no location specified (defaults to global): ` + # projects/`PROJECT_ID The following example `parent` string specifies a parent + # project with the identifier `example-project`, and specifies the `europe-west3` + # location for processing data: parent=projects/example-project/locations/ + # europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2RedactImageRequest] google_privacy_dlp_v2_redact_image_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1845,9 +1995,17 @@ module Google # inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/ # creating-templates to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateInspectTemplateRequest] google_privacy_dlp_v2_create_inspect_template_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1947,9 +2105,17 @@ module Google # Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating- # templates to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [String] location_id # Deprecated. This field has no effect. # @param [String] order_by @@ -2072,8 +2238,14 @@ module Google # sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/ # creating-job-triggers to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # projects/[PROJECT-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # whether you have [specified a processing location](/dlp/docs/specifying- + # location): + Projects scope, location specified: `projects/`PROJECT_ID`/ + # locations/`LOCATION_ID + Projects scope, no location specified (defaults to + # global): `projects/`PROJECT_ID The following example `parent` string specifies + # a parent project with the identifier `example-project`, and specifies the ` + # europe-west3` location for processing data: parent=projects/example-project/ + # locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateJobTriggerRequest] google_privacy_dlp_v2_create_job_trigger_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2171,8 +2343,14 @@ module Google # Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job- # triggers to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # projects/[PROJECT-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # whether you have [specified a processing location](/dlp/docs/specifying- + # location): + Projects scope, location specified: `projects/`PROJECT_ID`/ + # locations/`LOCATION_ID + Projects scope, no location specified (defaults to + # global): `projects/`PROJECT_ID The following example `parent` string specifies + # a parent project with the identifier `example-project`, and specifies the ` + # europe-west3` location for processing data: parent=projects/example-project/ + # locations/europe-west3 # @param [String] filter # Allows filtering. Supported syntax: * Filter expressions are made up of one or # more restrictions. * Restrictions can be combined by `AND` or `OR` logical @@ -2279,8 +2457,14 @@ module Google # detectors to run. By default this may be all types, but may change over time # as detectors are updated. # @param [String] parent - # Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[ - # PROJECT-ID]/locations/[LOCATION-ID] + # Parent resource name. The format of this value varies depending on whether you + # have [specified a processing location](/dlp/docs/specifying-location): + + # Projects scope, location specified: `projects/`PROJECT_ID`/locations/` + # LOCATION_ID + Projects scope, no location specified (defaults to global): ` + # projects/`PROJECT_ID The following example `parent` string specifies a parent + # project with the identifier `example-project`, and specifies the `europe-west3` + # location for processing data: parent=projects/example-project/locations/ + # europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyContentRequest] google_privacy_dlp_v2_deidentify_content_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2318,8 +2502,14 @@ module Google # as detectors are updated. For how to guides, see https://cloud.google.com/dlp/ # docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text, # @param [String] parent - # Parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[ - # PROJECT-ID]/locations/[LOCATION-ID] + # Parent resource name. The format of this value varies depending on whether you + # have [specified a processing location](/dlp/docs/specifying-location): + + # Projects scope, location specified: `projects/`PROJECT_ID`/locations/` + # LOCATION_ID + Projects scope, no location specified (defaults to global): ` + # projects/`PROJECT_ID The following example `parent` string specifies a parent + # project with the identifier `example-project`, and specifies the `europe-west3` + # location for processing data: parent=projects/example-project/locations/ + # europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2InspectContentRequest] google_privacy_dlp_v2_inspect_content_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2354,8 +2544,14 @@ module Google # com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example to # learn more. # @param [String] parent - # Required. The parent resource name. - Format:projects/[PROJECT-ID] - Format: - # projects/[PROJECT-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # whether you have [specified a processing location](/dlp/docs/specifying- + # location): + Projects scope, location specified: `projects/`PROJECT_ID`/ + # locations/`LOCATION_ID + Projects scope, no location specified (defaults to + # global): `projects/`PROJECT_ID The following example `parent` string specifies + # a parent project with the identifier `example-project`, and specifies the ` + # europe-west3` location for processing data: parent=projects/example-project/ + # locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2ReidentifyContentRequest] google_privacy_dlp_v2_reidentify_content_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2390,9 +2586,17 @@ module Google # identifying content, images, and storage. See https://cloud.google.com/dlp/ # docs/creating-templates-deid to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateDeidentifyTemplateRequest] google_privacy_dlp_v2_create_deidentify_template_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2492,9 +2696,17 @@ module Google # Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating- # templates-deid to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [String] location_id # Deprecated. This field has no effect. # @param [String] order_by @@ -2621,8 +2833,14 @@ module Google # detectors to run. By default this may be all types, but may change over time # as detectors are updated. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # projects/[PROJECT-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # whether you have [specified a processing location](/dlp/docs/specifying- + # location): + Projects scope, location specified: `projects/`PROJECT_ID`/ + # locations/`LOCATION_ID + Projects scope, no location specified (defaults to + # global): `projects/`PROJECT_ID The following example `parent` string specifies + # a parent project with the identifier `example-project`, and specifies the ` + # europe-west3` location for processing data: parent=projects/example-project/ + # locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateDlpJobRequest] google_privacy_dlp_v2_create_dlp_job_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2795,8 +3013,14 @@ module Google # cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/ # docs/compute-risk-analysis to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # projects/[PROJECT-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # whether you have [specified a processing location](/dlp/docs/specifying- + # location): + Projects scope, location specified: `projects/`PROJECT_ID`/ + # locations/`LOCATION_ID + Projects scope, no location specified (defaults to + # global): `projects/`PROJECT_ID The following example `parent` string specifies + # a parent project with the identifier `example-project`, and specifies the ` + # europe-west3` location for processing data: parent=projects/example-project/ + # locations/europe-west3 # @param [String] filter # Allows filtering. Supported syntax: * Filter expressions are made up of one or # more restrictions. * Restrictions can be combined by `AND` or `OR` logical @@ -2869,8 +3093,14 @@ module Google # choose what detectors to run. By default this may be all types, but may change # over time as detectors are updated. # @param [String] parent - # The parent resource name. - Format:projects/[PROJECT-ID] - Format:projects/[ - # PROJECT-ID]/locations/[LOCATION-ID] + # Parent resource name. The format of this value varies depending on whether you + # have [specified a processing location](/dlp/docs/specifying-location): + + # Projects scope, location specified: `projects/`PROJECT_ID`/locations/` + # LOCATION_ID + Projects scope, no location specified (defaults to global): ` + # projects/`PROJECT_ID The following example `parent` string specifies a parent + # project with the identifier `example-project`, and specifies the `europe-west3` + # location for processing data: parent=projects/example-project/locations/ + # europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2RedactImageRequest] google_privacy_dlp_v2_redact_image_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2905,9 +3135,17 @@ module Google # inspecting content, images, and storage. See https://cloud.google.com/dlp/docs/ # creating-templates to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateInspectTemplateRequest] google_privacy_dlp_v2_create_inspect_template_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3007,9 +3245,17 @@ module Google # Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating- # templates to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [String] location_id # Deprecated. This field has no effect. # @param [String] order_by @@ -3132,8 +3378,14 @@ module Google # sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/ # creating-job-triggers to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # projects/[PROJECT-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # whether you have [specified a processing location](/dlp/docs/specifying- + # location): + Projects scope, location specified: `projects/`PROJECT_ID`/ + # locations/`LOCATION_ID + Projects scope, no location specified (defaults to + # global): `projects/`PROJECT_ID The following example `parent` string specifies + # a parent project with the identifier `example-project`, and specifies the ` + # europe-west3` location for processing data: parent=projects/example-project/ + # locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateJobTriggerRequest] google_privacy_dlp_v2_create_job_trigger_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3269,8 +3521,14 @@ module Google # Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job- # triggers to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # projects/[PROJECT-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # whether you have [specified a processing location](/dlp/docs/specifying- + # location): + Projects scope, location specified: `projects/`PROJECT_ID`/ + # locations/`LOCATION_ID + Projects scope, no location specified (defaults to + # global): `projects/`PROJECT_ID The following example `parent` string specifies + # a parent project with the identifier `example-project`, and specifies the ` + # europe-west3` location for processing data: parent=projects/example-project/ + # locations/europe-west3 # @param [String] filter # Allows filtering. Supported syntax: * Filter expressions are made up of one or # more restrictions. * Restrictions can be combined by `AND` or `OR` logical @@ -3373,9 +3631,17 @@ module Google # Creates a pre-built stored infoType to be used for inspection. See https:// # cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateStoredInfoTypeRequest] google_privacy_dlp_v2_create_stored_info_type_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3475,9 +3741,17 @@ module Google # Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored- # infotypes to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [String] location_id # Deprecated. This field has no effect. # @param [String] order_by @@ -3565,9 +3839,17 @@ module Google # Creates a pre-built stored infoType to be used for inspection. See https:// # cloud.google.com/dlp/docs/creating-stored-infotypes to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2CreateStoredInfoTypeRequest] google_privacy_dlp_v2_create_stored_info_type_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3667,9 +3949,17 @@ module Google # Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored- # infotypes to learn more. # @param [String] parent - # Required. Parent resource name. - Format:projects/[PROJECT-ID] - Format: - # organizations/[ORGANIZATION-ID] - Format:projects/[PROJECT-ID]/locations/[ - # LOCATION-ID] - Format:organizations/[ORGANIZATION-ID]/locations/[LOCATION-ID] + # Required. Parent resource name. The format of this value varies depending on + # the scope of the request (project or organization) and whether you have [ + # specified a processing location](/dlp/docs/specifying-location): + Projects + # scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + + # Projects scope, no location specified (defaults to global): `projects/` + # PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/ + # locations/`LOCATION_ID + Organizations scope, no location specified (defaults + # to global): `organizations/`ORG_ID The following example `parent` string + # specifies a parent project with the identifier `example-project`, and + # specifies the `europe-west3` location for processing data: parent=projects/ + # example-project/locations/europe-west3 # @param [String] location_id # Deprecated. This field has no effect. # @param [String] order_by diff --git a/generated/google/apis/dns_v1.rb b/generated/google/apis/dns_v1.rb index bb41102e9..a8bc29f81 100644 --- a/generated/google/apis/dns_v1.rb +++ b/generated/google/apis/dns_v1.rb @@ -25,7 +25,7 @@ module Google # @see http://developers.google.com/cloud-dns module DnsV1 VERSION = 'V1' - REVISION = '20200731' + REVISION = '20200806' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dns_v1/classes.rb b/generated/google/apis/dns_v1/classes.rb index dd044a6b3..c23c2eade 100644 --- a/generated/google/apis/dns_v1/classes.rb +++ b/generated/google/apis/dns_v1/classes.rb @@ -22,13 +22,13 @@ module Google module Apis module DnsV1 - # A Change represents a set of ResourceRecordSet additions and deletions - # applied atomically to a ManagedZone. ResourceRecordSets within a - # ManagedZone are modified by creating a new Change element in the Changes - # collection. In turn the Changes collection also records the past - # modifications to the ResourceRecordSets in a ManagedZone. The current - # state of the ManagedZone is the sum effect of applying all Change - # elements in the Changes collection in sequence. + # A Change represents a set of ResourceRecordSet additions and deletions applied + # atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are + # modified by creating a new Change element in the Changes collection. In turn + # the Changes collection also records the past modifications to the + # ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is + # the sum effect of applying all Change elements in the Changes collection in + # sequence. class Change include Google::Apis::Core::Hashable @@ -58,15 +58,15 @@ module Google # @return [String] attr_accessor :kind - # The time that this operation was started by the server (output only). This - # is in RFC3339 text format. + # The time that this operation was started by the server (output only). This is + # in RFC3339 text format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # Status of the operation (output only). A status of "done" means that the - # request to update the authoritative servers has been sent but the - # servers might not be updated yet. + # request to update the authoritative servers has been sent but the servers + # might not be updated yet. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -107,15 +107,14 @@ module Google # @return [String] attr_accessor :kind - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your pagination token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a "snapshot" of collections larger than the maximum - # page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your pagination token. In this way you can + # retrieve the complete contents of even very large collections one page at a + # time. However, if the contents of the collection change between the first and + # last paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a "snapshot" + # of collections larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -137,8 +136,8 @@ module Google class DnsKey include Google::Apis::Core::Hashable - # String mnemonic specifying the DNSSEC algorithm of this key. Immutable - # after creation time. + # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after + # creation time. # Corresponds to the JSON property `algorithm` # @return [String] attr_accessor :algorithm @@ -149,15 +148,15 @@ module Google # @return [String] attr_accessor :creation_time - # A mutable string of at most 1024 characters associated with this resource - # for the user's convenience. Has no effect on the resource's function. + # A mutable string of at most 1024 characters associated with this resource for + # the user's convenience. Has no effect on the resource's function. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Cryptographic hashes of the DNSKEY resource record associated with this - # DnsKey. These digests are needed to construct a DS record that points at - # this DNS key. Output only. + # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. + # These digests are needed to construct a DS record that points at this DNS key. + # Output only. # Corresponds to the JSON property `digests` # @return [Array] attr_accessor :digests @@ -168,8 +167,8 @@ module Google attr_accessor :id # Active keys will be used to sign subsequent changes to the ManagedZone. - # Inactive keys will still be present as DNSKEY Resource Records for the use - # of resolvers validating existing signatures. + # Inactive keys will still be present as DNSKEY Resource Records for the use of + # resolvers validating existing signatures. # Corresponds to the JSON property `isActive` # @return [Boolean] attr_accessor :is_active @@ -181,11 +180,11 @@ module Google attr_accessor :key_length # The key tag is a non-cryptographic hash of the a DNSKEY resource record - # associated with this DnsKey. The key tag can be used to identify a DNSKEY - # more quickly (but it is not a unique identifier). In particular, the key - # tag is used in a parent zone's DS record to point at the DNSKEY in this - # child ManagedZone. The key tag is a number in the range [0, 65535] and the - # algorithm to calculate it is specified in RFC4034 Appendix B. Output only. + # associated with this DnsKey. The key tag can be used to identify a DNSKEY more + # quickly (but it is not a unique identifier). In particular, the key tag is + # used in a parent zone's DS record to point at the DNSKEY in this child + # ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm + # to calculate it is specified in RFC4034 Appendix B. Output only. # Corresponds to the JSON property `keyTag` # @return [Fixnum] attr_accessor :key_tag @@ -202,9 +201,9 @@ module Google # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the # Secure Entry Point flag set and, when active, will be used to sign only - # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point - # flag will be cleared and this key will be used to sign only resource - # record sets of other types. Immutable after creation time. + # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag + # will be cleared and this key will be used to sign only resource record sets of + # other types. Immutable after creation time. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -233,8 +232,8 @@ module Google class DnsKeyDigest include Google::Apis::Core::Hashable - # The base-16 encoded bytes of this digest. Suitable for use in a DS - # resource record. + # The base-16 encoded bytes of this digest. Suitable for use in a DS resource + # record. # Corresponds to the JSON property `digest` # @return [String] attr_accessor :digest @@ -255,8 +254,8 @@ module Google end end - # Parameters for DnsKey key generation. Used for generating initial keys - # for a new ManagedZone and as default when adding a new DnsKey. + # Parameters for DnsKey key generation. Used for generating initial keys for a + # new ManagedZone and as default when adding a new DnsKey. class DnsKeySpec include Google::Apis::Core::Hashable @@ -270,11 +269,11 @@ module Google # @return [Fixnum] attr_accessor :key_length - # Specifies whether this is a key signing key (KSK) or a zone signing key - # (ZSK). Key signing keys have the Secure Entry Point flag set and, when - # active, will only be used to sign resource record sets of type DNSKEY. - # Zone signing keys do not have the Secure Entry Point flag set and will be - # used to sign all other types of resource record sets. + # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). + # Key signing keys have the Secure Entry Point flag set and, when active, will + # only be used to sign resource record sets of type DNSKEY. Zone signing keys do + # not have the Secure Entry Point flag set and will be used to sign all other + # types of resource record sets. # Corresponds to the JSON property `keyType` # @return [String] attr_accessor :key_type @@ -316,15 +315,14 @@ module Google # @return [String] attr_accessor :kind - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your pagination token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a "snapshot" of collections larger than the maximum - # page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your pagination token. In this way you can + # retrieve the complete contents of even very large collections one page at a + # time. However, if the contents of the collection change between the first and + # last paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a "snapshot" + # of collections larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -343,19 +341,19 @@ module Google end # A zone is a subtree of the DNS namespace under one administrative - # responsibility. A ManagedZone is a resource that represents a DNS zone - # hosted by the Cloud DNS service. + # responsibility. A ManagedZone is a resource that represents a DNS zone hosted + # by the Cloud DNS service. class ManagedZone include Google::Apis::Core::Hashable - # The time that this resource was created on the server. This is in RFC3339 - # text format. Output only. + # The time that this resource was created on the server. This is in RFC3339 text + # format. Output only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time - # A mutable string of at most 1024 characters associated with this resource - # for the user's convenience. Has no effect on the managed zone's function. + # A mutable string of at most 1024 characters associated with this resource for + # the user's convenience. Has no effect on the managed zone's function. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -370,9 +368,9 @@ module Google # @return [Google::Apis::DnsV1::ManagedZoneDnsSecConfig] attr_accessor :dnssec_config - # The presence for this field indicates that outbound forwarding is enabled - # for this zone. The value of this field contains the set of destinations - # to forward to. + # The presence for this field indicates that outbound forwarding is enabled for + # this zone. The value of this field contains the set of destinations to forward + # to. # Corresponds to the JSON property `forwardingConfig` # @return [Google::Apis::DnsV1::ManagedZoneForwardingConfig] attr_accessor :forwarding_config @@ -392,16 +390,16 @@ module Google # @return [Hash] attr_accessor :labels - # User assigned name for this resource. Must be unique within the project. - # The name must be 1-63 characters long, must begin with a letter, end with - # a letter or digit, and only contain lowercase letters, digits or dashes. + # User assigned name for this resource. Must be unique within the project. The + # name must be 1-63 characters long, must begin with a letter, end with a letter + # or digit, and only contain lowercase letters, digits or dashes. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optionally specifies the NameServerSet for this ManagedZone. A - # NameServerSet is a set of DNS name servers that all host the same - # ManagedZones. Most users will leave this field unset. + # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet + # is a set of DNS name servers that all host the same ManagedZones. Most users + # will leave this field unset. # Corresponds to the JSON property `nameServerSet` # @return [String] attr_accessor :name_server_set @@ -412,28 +410,28 @@ module Google # @return [Array] attr_accessor :name_servers - # The presence of this field indicates that DNS Peering is enabled for this - # zone. The value of this field contains the network to peer with. + # The presence of this field indicates that DNS Peering is enabled for this zone. + # The value of this field contains the network to peer with. # Corresponds to the JSON property `peeringConfig` # @return [Google::Apis::DnsV1::ManagedZonePeeringConfig] attr_accessor :peering_config - # For privately visible zones, the set of Virtual Private Cloud resources - # that the zone is visible from. + # For privately visible zones, the set of Virtual Private Cloud resources that + # the zone is visible from. # Corresponds to the JSON property `privateVisibilityConfig` # @return [Google::Apis::DnsV1::ManagedZonePrivateVisibilityConfig] attr_accessor :private_visibility_config - # The presence of this field indicates that this is a managed reverse - # lookup zone and Cloud DNS will resolve reverse lookup queries using - # automatically configured records for VPC resources. This only applies - # to networks listed under private_visibility_config. + # The presence of this field indicates that this is a managed reverse lookup + # zone and Cloud DNS will resolve reverse lookup queries using automatically + # configured records for VPC resources. This only applies to networks listed + # under private_visibility_config. # Corresponds to the JSON property `reverseLookupConfig` # @return [Google::Apis::DnsV1::ManagedZoneReverseLookupConfig] attr_accessor :reverse_lookup_config - # The zone's visibility: public zones are exposed to the Internet, while - # private zones are visible only to Virtual Private Cloud resources. + # The zone's visibility: public zones are exposed to the Internet, while private + # zones are visible only to Virtual Private Cloud resources. # Corresponds to the JSON property `visibility` # @return [String] attr_accessor :visibility @@ -466,8 +464,8 @@ module Google class ManagedZoneDnsSecConfig include Google::Apis::Core::Hashable - # Specifies parameters for generating initial DnsKeys for this - # ManagedZone. Can only be changed while the state is OFF. + # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can + # only be changed while the state is OFF. # Corresponds to the JSON property `defaultKeySpecs` # @return [Array] attr_accessor :default_key_specs @@ -477,8 +475,8 @@ module Google # @return [String] attr_accessor :kind - # Specifies the mechanism for authenticated denial-of-existence responses. - # Can only be changed while the state is OFF. + # Specifies the mechanism for authenticated denial-of-existence responses. Can + # only be changed while the state is OFF. # Corresponds to the JSON property `nonExistence` # @return [String] attr_accessor :non_existence @@ -510,9 +508,8 @@ module Google # @return [String] attr_accessor :kind - # List of target name servers to forward to. - # Cloud DNS will select the best available name server if more than one - # target is given. + # List of target name servers to forward to. Cloud DNS will select the best + # available name server if more than one target is given. # Corresponds to the JSON property `targetNameServers` # @return [Array] attr_accessor :target_name_servers @@ -532,11 +529,10 @@ module Google class ManagedZoneForwardingConfigNameServerTarget include Google::Apis::Core::Hashable - # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, - # Cloud DNS will make forwarding decision based on address ranges, - # i.e. RFC1918 addresses go to the VPC, non-RFC1918 addresses go to the - # Internet. When set to PRIVATE, Cloud DNS will always send queries - # through VPC for this target. + # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud + # DNS will make forwarding decision based on address ranges, i.e. RFC1918 + # addresses go to the VPC, non-RFC1918 addresses go to the Internet. When set to + # PRIVATE, Cloud DNS will always send queries through VPC for this target. # Corresponds to the JSON property `forwardingPath` # @return [String] attr_accessor :forwarding_path @@ -577,15 +573,14 @@ module Google # @return [String] attr_accessor :kind - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your page token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a consistent snapshot of a collection larger than the - # maximum page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your page token. In this way you can retrieve + # the complete contents of even very large collections one page at a time. + # However, if the contents of the collection change between the first and last + # paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a consistent + # snapshot of a collection larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -637,11 +632,10 @@ module Google class ManagedZonePeeringConfigTargetNetwork include Google::Apis::Core::Hashable - # The time at which the zone was deactivated, in RFC 3339 date-time - # format. An empty string indicates that the peering connection is - # active. The producer network can deactivate a zone. The zone is - # automatically deactivated if the producer network that the zone - # targeted is deleted. Output only. + # The time at which the zone was deactivated, in RFC 3339 date-time format. An + # empty string indicates that the peering connection is active. The producer + # network can deactivate a zone. The zone is automatically deactivated if the + # producer network that the zone targeted is deleted. Output only. # Corresponds to the JSON property `deactivateTime` # @return [String] attr_accessor :deactivate_time @@ -651,10 +645,9 @@ module Google # @return [String] attr_accessor :kind - # The fully qualified URL of the VPC network to forward queries to. - # This should be formatted like - # https://www.googleapis.com/compute/v1/projects/`project`/global/networks/` - # network` + # The fully qualified URL of the VPC network to forward queries to. This should + # be formatted like https://www.googleapis.com/compute/v1/projects/`project`/ + # global/networks/`network` # Corresponds to the JSON property `networkUrl` # @return [String] attr_accessor :network_url @@ -705,10 +698,9 @@ module Google # @return [String] attr_accessor :kind - # The fully qualified URL of the VPC network to bind to. - # This should be formatted like - # https://www.googleapis.com/compute/v1/projects/`project`/global/networks/` - # network` + # The fully qualified URL of the VPC network to bind to. This should be + # formatted like https://www.googleapis.com/compute/v1/projects/`project`/global/ + # networks/`network` # Corresponds to the JSON property `networkUrl` # @return [String] attr_accessor :network_url @@ -762,15 +754,14 @@ module Google # @return [Array] attr_accessor :managed_zones - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your page token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a consistent snapshot of a collection larger than the - # maximum page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your page token. In this way you can retrieve + # the complete contents of even very large collections one page at a time. + # However, if the contents of the collection change between the first and last + # paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a consistent + # snapshot of a collection larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -789,10 +780,8 @@ module Google end # An operation represents a successful mutation performed on a Cloud DNS - # resource. - # Operations provide: - # - An audit log of server resource mutations. - # - A way to recover/retry API calls in the case where the response is never + # resource. Operations provide: - An audit log of server resource mutations. - A + # way to recover/retry API calls in the case where the response is never # received by the caller. Use the caller specified client_operation_id. class Operation include Google::Apis::Core::Hashable @@ -802,10 +791,10 @@ module Google # @return [Google::Apis::DnsV1::OperationDnsKeyContext] attr_accessor :dns_key_context - # Unique identifier for the resource. This is the client_operation_id if - # the client specified it when the mutation was initiated, otherwise, - # it is generated by the server. The name must be 1-63 characters long - # and match the regular expression [-a-z0-9]? (output only) + # Unique identifier for the resource. This is the client_operation_id if the + # client specified it when the mutation was initiated, otherwise, it is + # generated by the server. The name must be 1-63 characters long and match the + # regular expression [-a-z0-9]? (output only) # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -821,23 +810,21 @@ module Google # @return [String] attr_accessor :start_time - # Status of the operation. Can be one of the following: "PENDING" or "DONE" - # (output only). A status of "DONE" means that the - # request to update the authoritative servers has been sent, but the - # servers might not be updated yet. + # Status of the operation. Can be one of the following: "PENDING" or "DONE" ( + # output only). A status of "DONE" means that the request to update the + # authoritative servers has been sent, but the servers might not be updated yet. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status - # Type of the operation. Operations include insert, update, and delete - # (output only). + # Type of the operation. Operations include insert, update, and delete (output + # only). # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # User who requested the operation, for example: user@example.com. - # cloud-dns-system for operations automatically done by the system. - # (output only) + # User who requested the operation, for example: user@example.com. cloud-dns- + # system for operations automatically done by the system. (output only) # Corresponds to the JSON property `user` # @return [String] attr_accessor :user @@ -894,15 +881,15 @@ module Google include Google::Apis::Core::Hashable # A zone is a subtree of the DNS namespace under one administrative - # responsibility. A ManagedZone is a resource that represents a DNS zone - # hosted by the Cloud DNS service. + # responsibility. A ManagedZone is a resource that represents a DNS zone hosted + # by the Cloud DNS service. # Corresponds to the JSON property `newValue` # @return [Google::Apis::DnsV1::ManagedZone] attr_accessor :new_value # A zone is a subtree of the DNS namespace under one administrative - # responsibility. A ManagedZone is a resource that represents a DNS zone - # hosted by the Cloud DNS service. + # responsibility. A ManagedZone is a resource that represents a DNS zone hosted + # by the Cloud DNS service. # Corresponds to the JSON property `oldValue` # @return [Google::Apis::DnsV1::ManagedZone] attr_accessor :old_value @@ -932,15 +919,14 @@ module Google # @return [String] attr_accessor :kind - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your page token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a consistent snapshot of a collection larger than the - # maximum page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your page token. In this way you can retrieve + # the complete contents of even very large collections one page at a time. + # However, if the contents of the collection change between the first and last + # paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a consistent + # snapshot of a collection larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1020,23 +1006,22 @@ module Google class Policy include Google::Apis::Core::Hashable - # Sets an alternative name server for the associated networks. When - # specified, all DNS queries are forwarded to a name server that you - # choose. Names such as .internal are not available when an alternative - # name server is specified. + # Sets an alternative name server for the associated networks. When specified, + # all DNS queries are forwarded to a name server that you choose. Names such as . + # internal are not available when an alternative name server is specified. # Corresponds to the JSON property `alternativeNameServerConfig` # @return [Google::Apis::DnsV1::PolicyAlternativeNameServerConfig] attr_accessor :alternative_name_server_config - # A mutable string of at most 1024 characters associated with this resource - # for the user's convenience. Has no effect on the policy's function. + # A mutable string of at most 1024 characters associated with this resource for + # the user's convenience. Has no effect on the policy's function. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Allows networks bound to this policy to receive DNS queries sent by VMs or - # applications over VPN connections. When enabled, a virtual IP address will - # be allocated from each of the sub-networks that are bound to this policy. + # applications over VPN connections. When enabled, a virtual IP address will be + # allocated from each of the sub-networks that are bound to this policy. # Corresponds to the JSON property `enableInboundForwarding` # @return [Boolean] attr_accessor :enable_inbound_forwarding @@ -1095,10 +1080,9 @@ module Google # @return [String] attr_accessor :kind - # Sets an alternative name server for the associated networks. When - # specified, all DNS queries are forwarded to a name server that you - # choose. Names such as .internal are not available when an alternative - # name server is specified. + # Sets an alternative name server for the associated networks. When specified, + # all DNS queries are forwarded to a name server that you choose. Names such as . + # internal are not available when an alternative name server is specified. # Corresponds to the JSON property `targetNameServers` # @return [Array] attr_accessor :target_name_servers @@ -1118,11 +1102,10 @@ module Google class PolicyAlternativeNameServerConfigTargetNameServer include Google::Apis::Core::Hashable - # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, - # Cloud DNS will make forwarding decision based on address ranges, - # i.e. RFC1918 addresses go to the VPC, non-RFC1918 addresses go to the - # Internet. When set to PRIVATE, Cloud DNS will always send queries - # through VPC for this target. + # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud + # DNS will make forwarding decision based on address ranges, i.e. RFC1918 + # addresses go to the VPC, non-RFC1918 addresses go to the Internet. When set to + # PRIVATE, Cloud DNS will always send queries through VPC for this target. # Corresponds to the JSON property `forwardingPath` # @return [String] attr_accessor :forwarding_path @@ -1158,10 +1141,9 @@ module Google # @return [String] attr_accessor :kind - # The fully qualified URL of the VPC network to bind to. - # This should be formatted like - # https://www.googleapis.com/compute/v1/projects/`project`/global/networks/` - # network` + # The fully qualified URL of the VPC network to bind to. This should be + # formatted like https://www.googleapis.com/compute/v1/projects/`project`/global/ + # networks/`network` # Corresponds to the JSON property `networkUrl` # @return [String] attr_accessor :network_url @@ -1193,8 +1175,8 @@ module Google # @return [String] attr_accessor :kind - # Unique numeric identifier for the resource; defined by the server (output - # only). + # Unique numeric identifier for the resource; defined by the server (output only) + # . # Corresponds to the JSON property `number` # @return [Fixnum] attr_accessor :number @@ -1236,8 +1218,7 @@ module Google # @return [Fixnum] attr_accessor :managed_zones - # Maximum allowed number of managed zones which can be attached to a - # network. + # Maximum allowed number of managed zones which can be attached to a network. # Corresponds to the JSON property `managedZonesPerNetwork` # @return [Fixnum] attr_accessor :managed_zones_per_network @@ -1263,8 +1244,7 @@ module Google # @return [Fixnum] attr_accessor :resource_records_per_rrset - # Maximum allowed number of ResourceRecordSets to add per - # ChangesCreateRequest. + # Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest. # Corresponds to the JSON property `rrsetAdditionsPerChange` # @return [Fixnum] attr_accessor :rrset_additions_per_change @@ -1290,8 +1270,7 @@ module Google # @return [Fixnum] attr_accessor :target_name_servers_per_policy - # Maximum allowed size for total rrdata in one ChangesCreateRequest in - # bytes. + # Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes. # Corresponds to the JSON property `totalRrdataSizePerChange` # @return [Fixnum] attr_accessor :total_rrdata_size_per_change @@ -1340,7 +1319,7 @@ module Google attr_accessor :name # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see - # examples. + # examples. # Corresponds to the JSON property `rrdatas` # @return [Array] attr_accessor :rrdatas @@ -1355,9 +1334,8 @@ module Google # @return [Fixnum] attr_accessor :ttl - # The identifier of a supported record type. See the list of - # Supported - # DNS record types. + # The identifier of a supported record type. See the list of Supported DNS + # record types. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1391,15 +1369,14 @@ module Google # @return [String] attr_accessor :kind - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your pagination token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a consistent snapshot of a collection larger than the - # maximum page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your pagination token. In this way you can + # retrieve the complete contents of even very large collections one page at a + # time. However, if the contents of the collection change between the first and + # last paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a consistent + # snapshot of a collection larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1426,9 +1403,9 @@ module Google class ResponseHeader include Google::Apis::Core::Hashable - # For mutating operation requests that completed successfully. - # This is the client_operation_id if the client specified it, - # otherwise it is generated by the server (output only). + # For mutating operation requests that completed successfully. This is the + # client_operation_id if the client specified it, otherwise it is generated by + # the server (output only). # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id diff --git a/generated/google/apis/dns_v1/service.rb b/generated/google/apis/dns_v1/service.rb index e183cc23c..0fa2e8d8d 100644 --- a/generated/google/apis/dns_v1/service.rb +++ b/generated/google/apis/dns_v1/service.rb @@ -51,13 +51,12 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [Google::Apis::DnsV1::Change] change_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -93,15 +92,14 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [String] change_id # The identifier of the requested change, from a previous # ResourceRecordSetsChangeResponse. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -136,14 +134,14 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] sort_by # Sorting criterion. The only supported value is change sequence. # @param [String] sort_order @@ -184,18 +182,17 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [String] dns_key_id # The identifier of the requested DnsKey. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] digest_type - # An optional comma-separated list of digest types to compute and display - # for key signing keys. If omitted, the recommended digest type will be - # computed and displayed. + # An optional comma-separated list of digest types to compute and display for + # key signing keys. If omitted, the recommended digest type will be computed and + # displayed. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -231,18 +228,18 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [String] digest_type - # An optional comma-separated list of digest types to compute and display - # for key signing keys. If omitted, the recommended digest type will be - # computed and displayed. + # An optional comma-separated list of digest types to compute and display for + # key signing keys. If omitted, the recommended digest type will be computed and + # displayed. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -282,9 +279,8 @@ module Google # @param [String] operation # Identifies the operation addressed by this request. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -321,11 +317,11 @@ module Google # @param [String] managed_zone # Identifies the managed zone addressed by this request. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] sort_by # Sorting criterion. The only supported values are START_TIME and ID. # @param [String] fields @@ -364,9 +360,8 @@ module Google # Identifies the project addressed by this request. # @param [Google::Apis::DnsV1::ManagedZone] managed_zone_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -401,12 +396,11 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -438,12 +432,11 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -479,11 +472,11 @@ module Google # @param [String] dns_name # Restricts the list to return only zones with this domain name. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -518,13 +511,12 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [Google::Apis::DnsV1::ManagedZone] managed_zone_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -560,13 +552,12 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [Google::Apis::DnsV1::ManagedZone] managed_zone_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -603,9 +594,8 @@ module Google # Identifies the project addressed by this request. # @param [Google::Apis::DnsV1::Policy] policy_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -643,9 +633,8 @@ module Google # @param [String] policy # User given friendly name of the policy addressed by this request. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -679,9 +668,8 @@ module Google # @param [String] policy # User given friendly name of the policy addressed by this request. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -715,11 +703,11 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -756,9 +744,8 @@ module Google # User given friendly name of the policy addressed by this request. # @param [Google::Apis::DnsV1::Policy] policy_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -797,9 +784,8 @@ module Google # User given friendly name of the policy addressed by this request. # @param [Google::Apis::DnsV1::Policy] policy_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -835,9 +821,8 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -870,20 +855,20 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] name # Restricts the list to return only records with this fully qualified domain # name. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] type - # Restricts the list to return only records of this type. If present, the - # "name" parameter must also be present. + # Restricts the list to return only records of this type. If present, the "name" + # parameter must also be present. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/dns_v1beta2.rb b/generated/google/apis/dns_v1beta2.rb index db4fdc15e..c67120eb4 100644 --- a/generated/google/apis/dns_v1beta2.rb +++ b/generated/google/apis/dns_v1beta2.rb @@ -25,7 +25,7 @@ module Google # @see http://developers.google.com/cloud-dns module DnsV1beta2 VERSION = 'V1beta2' - REVISION = '20200731' + REVISION = '20200806' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dns_v1beta2/classes.rb b/generated/google/apis/dns_v1beta2/classes.rb index 906afce7b..5c9faa542 100644 --- a/generated/google/apis/dns_v1beta2/classes.rb +++ b/generated/google/apis/dns_v1beta2/classes.rb @@ -22,13 +22,13 @@ module Google module Apis module DnsV1beta2 - # A Change represents a set of ResourceRecordSet additions and deletions - # applied atomically to a ManagedZone. ResourceRecordSets within a - # ManagedZone are modified by creating a new Change element in the Changes - # collection. In turn the Changes collection also records the past - # modifications to the ResourceRecordSets in a ManagedZone. The current - # state of the ManagedZone is the sum effect of applying all Change - # elements in the Changes collection in sequence. + # A Change represents a set of ResourceRecordSet additions and deletions applied + # atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are + # modified by creating a new Change element in the Changes collection. In turn + # the Changes collection also records the past modifications to the + # ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is + # the sum effect of applying all Change elements in the Changes collection in + # sequence. class Change include Google::Apis::Core::Hashable @@ -58,15 +58,15 @@ module Google # @return [String] attr_accessor :kind - # The time that this operation was started by the server (output only). This - # is in RFC3339 text format. + # The time that this operation was started by the server (output only). This is + # in RFC3339 text format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # Status of the operation (output only). A status of "done" means that the - # request to update the authoritative servers has been sent but the - # servers might not be updated yet. + # request to update the authoritative servers has been sent but the servers + # might not be updated yet. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -107,15 +107,14 @@ module Google # @return [String] attr_accessor :kind - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your pagination token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a "snapshot" of collections larger than the maximum - # page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your pagination token. In this way you can + # retrieve the complete contents of even very large collections one page at a + # time. However, if the contents of the collection change between the first and + # last paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a "snapshot" + # of collections larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -137,8 +136,8 @@ module Google class DnsKey include Google::Apis::Core::Hashable - # String mnemonic specifying the DNSSEC algorithm of this key. Immutable - # after creation time. + # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after + # creation time. # Corresponds to the JSON property `algorithm` # @return [String] attr_accessor :algorithm @@ -149,15 +148,15 @@ module Google # @return [String] attr_accessor :creation_time - # A mutable string of at most 1024 characters associated with this resource - # for the user's convenience. Has no effect on the resource's function. + # A mutable string of at most 1024 characters associated with this resource for + # the user's convenience. Has no effect on the resource's function. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Cryptographic hashes of the DNSKEY resource record associated with this - # DnsKey. These digests are needed to construct a DS record that points at - # this DNS key. Output only. + # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. + # These digests are needed to construct a DS record that points at this DNS key. + # Output only. # Corresponds to the JSON property `digests` # @return [Array] attr_accessor :digests @@ -168,8 +167,8 @@ module Google attr_accessor :id # Active keys will be used to sign subsequent changes to the ManagedZone. - # Inactive keys will still be present as DNSKEY Resource Records for the use - # of resolvers validating existing signatures. + # Inactive keys will still be present as DNSKEY Resource Records for the use of + # resolvers validating existing signatures. # Corresponds to the JSON property `isActive` # @return [Boolean] attr_accessor :is_active @@ -181,11 +180,11 @@ module Google attr_accessor :key_length # The key tag is a non-cryptographic hash of the a DNSKEY resource record - # associated with this DnsKey. The key tag can be used to identify a DNSKEY - # more quickly (but it is not a unique identifier). In particular, the key - # tag is used in a parent zone's DS record to point at the DNSKEY in this - # child ManagedZone. The key tag is a number in the range [0, 65535] and the - # algorithm to calculate it is specified in RFC4034 Appendix B. Output only. + # associated with this DnsKey. The key tag can be used to identify a DNSKEY more + # quickly (but it is not a unique identifier). In particular, the key tag is + # used in a parent zone's DS record to point at the DNSKEY in this child + # ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm + # to calculate it is specified in RFC4034 Appendix B. Output only. # Corresponds to the JSON property `keyTag` # @return [Fixnum] attr_accessor :key_tag @@ -202,9 +201,9 @@ module Google # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the # Secure Entry Point flag set and, when active, will be used to sign only - # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point - # flag will be cleared and this key will be used to sign only resource - # record sets of other types. Immutable after creation time. + # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag + # will be cleared and this key will be used to sign only resource record sets of + # other types. Immutable after creation time. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -233,8 +232,8 @@ module Google class DnsKeyDigest include Google::Apis::Core::Hashable - # The base-16 encoded bytes of this digest. Suitable for use in a DS - # resource record. + # The base-16 encoded bytes of this digest. Suitable for use in a DS resource + # record. # Corresponds to the JSON property `digest` # @return [String] attr_accessor :digest @@ -255,8 +254,8 @@ module Google end end - # Parameters for DnsKey key generation. Used for generating initial keys - # for a new ManagedZone and as default when adding a new DnsKey. + # Parameters for DnsKey key generation. Used for generating initial keys for a + # new ManagedZone and as default when adding a new DnsKey. class DnsKeySpec include Google::Apis::Core::Hashable @@ -270,11 +269,11 @@ module Google # @return [Fixnum] attr_accessor :key_length - # Specifies whether this is a key signing key (KSK) or a zone signing key - # (ZSK). Key signing keys have the Secure Entry Point flag set and, when - # active, will only be used to sign resource record sets of type DNSKEY. - # Zone signing keys do not have the Secure Entry Point flag set and will be - # used to sign all other types of resource record sets. + # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). + # Key signing keys have the Secure Entry Point flag set and, when active, will + # only be used to sign resource record sets of type DNSKEY. Zone signing keys do + # not have the Secure Entry Point flag set and will be used to sign all other + # types of resource record sets. # Corresponds to the JSON property `keyType` # @return [String] attr_accessor :key_type @@ -316,15 +315,14 @@ module Google # @return [String] attr_accessor :kind - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your pagination token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a "snapshot" of collections larger than the maximum - # page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your pagination token. In this way you can + # retrieve the complete contents of even very large collections one page at a + # time. However, if the contents of the collection change between the first and + # last paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a "snapshot" + # of collections larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -343,19 +341,19 @@ module Google end # A zone is a subtree of the DNS namespace under one administrative - # responsibility. A ManagedZone is a resource that represents a DNS zone - # hosted by the Cloud DNS service. + # responsibility. A ManagedZone is a resource that represents a DNS zone hosted + # by the Cloud DNS service. class ManagedZone include Google::Apis::Core::Hashable - # The time that this resource was created on the server. This is in RFC3339 - # text format. Output only. + # The time that this resource was created on the server. This is in RFC3339 text + # format. Output only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time - # A mutable string of at most 1024 characters associated with this resource - # for the user's convenience. Has no effect on the managed zone's function. + # A mutable string of at most 1024 characters associated with this resource for + # the user's convenience. Has no effect on the managed zone's function. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -370,9 +368,9 @@ module Google # @return [Google::Apis::DnsV1beta2::ManagedZoneDnsSecConfig] attr_accessor :dnssec_config - # The presence for this field indicates that outbound forwarding is enabled - # for this zone. The value of this field contains the set of destinations - # to forward to. + # The presence for this field indicates that outbound forwarding is enabled for + # this zone. The value of this field contains the set of destinations to forward + # to. # Corresponds to the JSON property `forwardingConfig` # @return [Google::Apis::DnsV1beta2::ManagedZoneForwardingConfig] attr_accessor :forwarding_config @@ -392,16 +390,16 @@ module Google # @return [Hash] attr_accessor :labels - # User assigned name for this resource. Must be unique within the project. - # The name must be 1-63 characters long, must begin with a letter, end with - # a letter or digit, and only contain lowercase letters, digits or dashes. + # User assigned name for this resource. Must be unique within the project. The + # name must be 1-63 characters long, must begin with a letter, end with a letter + # or digit, and only contain lowercase letters, digits or dashes. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optionally specifies the NameServerSet for this ManagedZone. A - # NameServerSet is a set of DNS name servers that all host the same - # ManagedZones. Most users will leave this field unset. + # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet + # is a set of DNS name servers that all host the same ManagedZones. Most users + # will leave this field unset. # Corresponds to the JSON property `nameServerSet` # @return [String] attr_accessor :name_server_set @@ -412,22 +410,22 @@ module Google # @return [Array] attr_accessor :name_servers - # The presence of this field indicates that DNS Peering is enabled for this - # zone. The value of this field contains the network to peer with. + # The presence of this field indicates that DNS Peering is enabled for this zone. + # The value of this field contains the network to peer with. # Corresponds to the JSON property `peeringConfig` # @return [Google::Apis::DnsV1beta2::ManagedZonePeeringConfig] attr_accessor :peering_config - # For privately visible zones, the set of Virtual Private Cloud resources - # that the zone is visible from. + # For privately visible zones, the set of Virtual Private Cloud resources that + # the zone is visible from. # Corresponds to the JSON property `privateVisibilityConfig` # @return [Google::Apis::DnsV1beta2::ManagedZonePrivateVisibilityConfig] attr_accessor :private_visibility_config - # The presence of this field indicates that this is a managed reverse - # lookup zone and Cloud DNS will resolve reverse lookup queries using - # automatically configured records for VPC resources. This only applies - # to networks listed under private_visibility_config. + # The presence of this field indicates that this is a managed reverse lookup + # zone and Cloud DNS will resolve reverse lookup queries using automatically + # configured records for VPC resources. This only applies to networks listed + # under private_visibility_config. # Corresponds to the JSON property `reverseLookupConfig` # @return [Google::Apis::DnsV1beta2::ManagedZoneReverseLookupConfig] attr_accessor :reverse_lookup_config @@ -437,8 +435,8 @@ module Google # @return [Google::Apis::DnsV1beta2::ManagedZoneServiceDirectoryConfig] attr_accessor :service_directory_config - # The zone's visibility: public zones are exposed to the Internet, while - # private zones are visible only to Virtual Private Cloud resources. + # The zone's visibility: public zones are exposed to the Internet, while private + # zones are visible only to Virtual Private Cloud resources. # Corresponds to the JSON property `visibility` # @return [String] attr_accessor :visibility @@ -472,8 +470,8 @@ module Google class ManagedZoneDnsSecConfig include Google::Apis::Core::Hashable - # Specifies parameters for generating initial DnsKeys for this - # ManagedZone. Can only be changed while the state is OFF. + # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can + # only be changed while the state is OFF. # Corresponds to the JSON property `defaultKeySpecs` # @return [Array] attr_accessor :default_key_specs @@ -483,8 +481,8 @@ module Google # @return [String] attr_accessor :kind - # Specifies the mechanism for authenticated denial-of-existence responses. - # Can only be changed while the state is OFF. + # Specifies the mechanism for authenticated denial-of-existence responses. Can + # only be changed while the state is OFF. # Corresponds to the JSON property `nonExistence` # @return [String] attr_accessor :non_existence @@ -516,9 +514,8 @@ module Google # @return [String] attr_accessor :kind - # List of target name servers to forward to. - # Cloud DNS will select the best available name server if more than one - # target is given. + # List of target name servers to forward to. Cloud DNS will select the best + # available name server if more than one target is given. # Corresponds to the JSON property `targetNameServers` # @return [Array] attr_accessor :target_name_servers @@ -538,11 +535,10 @@ module Google class ManagedZoneForwardingConfigNameServerTarget include Google::Apis::Core::Hashable - # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, - # Cloud DNS will make forwarding decision based on address ranges, - # i.e. RFC1918 addresses go to the VPC, non-RFC1918 addresses go to the - # Internet. When set to PRIVATE, Cloud DNS will always send queries - # through VPC for this target. + # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud + # DNS will make forwarding decision based on address ranges, i.e. RFC1918 + # addresses go to the VPC, non-RFC1918 addresses go to the Internet. When set to + # PRIVATE, Cloud DNS will always send queries through VPC for this target. # Corresponds to the JSON property `forwardingPath` # @return [String] attr_accessor :forwarding_path @@ -583,15 +579,14 @@ module Google # @return [String] attr_accessor :kind - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your page token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a consistent snapshot of a collection larger than the - # maximum page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your page token. In this way you can retrieve + # the complete contents of even very large collections one page at a time. + # However, if the contents of the collection change between the first and last + # paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a consistent + # snapshot of a collection larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -643,11 +638,10 @@ module Google class ManagedZonePeeringConfigTargetNetwork include Google::Apis::Core::Hashable - # The time at which the zone was deactivated, in RFC 3339 date-time - # format. An empty string indicates that the peering connection is - # active. The producer network can deactivate a zone. The zone is - # automatically deactivated if the producer network that the zone - # targeted is deleted. Output only. + # The time at which the zone was deactivated, in RFC 3339 date-time format. An + # empty string indicates that the peering connection is active. The producer + # network can deactivate a zone. The zone is automatically deactivated if the + # producer network that the zone targeted is deleted. Output only. # Corresponds to the JSON property `deactivateTime` # @return [String] attr_accessor :deactivate_time @@ -657,10 +651,9 @@ module Google # @return [String] attr_accessor :kind - # The fully qualified URL of the VPC network to forward queries to. - # This should be formatted like - # https://www.googleapis.com/compute/v1/projects/`project`/global/networks/` - # network` + # The fully qualified URL of the VPC network to forward queries to. This should + # be formatted like https://www.googleapis.com/compute/v1/projects/`project`/ + # global/networks/`network` # Corresponds to the JSON property `networkUrl` # @return [String] attr_accessor :network_url @@ -711,10 +704,9 @@ module Google # @return [String] attr_accessor :kind - # The fully qualified URL of the VPC network to bind to. - # This should be formatted like - # https://www.googleapis.com/compute/v1/projects/`project`/global/networks/` - # network` + # The fully qualified URL of the VPC network to bind to. This should be + # formatted like https://www.googleapis.com/compute/v1/projects/`project`/global/ + # networks/`network` # Corresponds to the JSON property `networkUrl` # @return [String] attr_accessor :network_url @@ -778,9 +770,8 @@ module Google class ManagedZoneServiceDirectoryConfigNamespace include Google::Apis::Core::Hashable - # The time that the namespace backing this zone was deleted, empty - # string if it still exists. This is in RFC3339 text format. Output - # only. + # The time that the namespace backing this zone was deleted, empty string if it + # still exists. This is in RFC3339 text format. Output only. # Corresponds to the JSON property `deletionTime` # @return [String] attr_accessor :deletion_time @@ -790,10 +781,9 @@ module Google # @return [String] attr_accessor :kind - # The fully qualified URL of the namespace associated with the zone. - # This should be formatted like - # https://servicedirectory.googleapis.com/v1/projects/`project`/locations/` - # location`/namespaces/`namespace` + # The fully qualified URL of the namespace associated with the zone. This should + # be formatted like https://servicedirectory.googleapis.com/v1/projects/`project` + # /locations/`location`/namespaces/`namespace` # Corresponds to the JSON property `namespaceUrl` # @return [String] attr_accessor :namespace_url @@ -829,15 +819,14 @@ module Google # @return [Array] attr_accessor :managed_zones - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your page token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a consistent snapshot of a collection larger than the - # maximum page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your page token. In this way you can retrieve + # the complete contents of even very large collections one page at a time. + # However, if the contents of the collection change between the first and last + # paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a consistent + # snapshot of a collection larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -856,10 +845,8 @@ module Google end # An operation represents a successful mutation performed on a Cloud DNS - # resource. - # Operations provide: - # - An audit log of server resource mutations. - # - A way to recover/retry API calls in the case where the response is never + # resource. Operations provide: - An audit log of server resource mutations. - A + # way to recover/retry API calls in the case where the response is never # received by the caller. Use the caller specified client_operation_id. class Operation include Google::Apis::Core::Hashable @@ -869,10 +856,10 @@ module Google # @return [Google::Apis::DnsV1beta2::OperationDnsKeyContext] attr_accessor :dns_key_context - # Unique identifier for the resource. This is the client_operation_id if - # the client specified it when the mutation was initiated, otherwise, - # it is generated by the server. The name must be 1-63 characters long - # and match the regular expression [-a-z0-9]? (output only) + # Unique identifier for the resource. This is the client_operation_id if the + # client specified it when the mutation was initiated, otherwise, it is + # generated by the server. The name must be 1-63 characters long and match the + # regular expression [-a-z0-9]? (output only) # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -888,23 +875,21 @@ module Google # @return [String] attr_accessor :start_time - # Status of the operation. Can be one of the following: "PENDING" or "DONE" - # (output only). A status of "DONE" means that the - # request to update the authoritative servers has been sent, but the - # servers might not be updated yet. + # Status of the operation. Can be one of the following: "PENDING" or "DONE" ( + # output only). A status of "DONE" means that the request to update the + # authoritative servers has been sent, but the servers might not be updated yet. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status - # Type of the operation. Operations include insert, update, and delete - # (output only). + # Type of the operation. Operations include insert, update, and delete (output + # only). # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # User who requested the operation, for example: user@example.com. - # cloud-dns-system for operations automatically done by the system. - # (output only) + # User who requested the operation, for example: user@example.com. cloud-dns- + # system for operations automatically done by the system. (output only) # Corresponds to the JSON property `user` # @return [String] attr_accessor :user @@ -961,15 +946,15 @@ module Google include Google::Apis::Core::Hashable # A zone is a subtree of the DNS namespace under one administrative - # responsibility. A ManagedZone is a resource that represents a DNS zone - # hosted by the Cloud DNS service. + # responsibility. A ManagedZone is a resource that represents a DNS zone hosted + # by the Cloud DNS service. # Corresponds to the JSON property `newValue` # @return [Google::Apis::DnsV1beta2::ManagedZone] attr_accessor :new_value # A zone is a subtree of the DNS namespace under one administrative - # responsibility. A ManagedZone is a resource that represents a DNS zone - # hosted by the Cloud DNS service. + # responsibility. A ManagedZone is a resource that represents a DNS zone hosted + # by the Cloud DNS service. # Corresponds to the JSON property `oldValue` # @return [Google::Apis::DnsV1beta2::ManagedZone] attr_accessor :old_value @@ -999,15 +984,14 @@ module Google # @return [String] attr_accessor :kind - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your page token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a consistent snapshot of a collection larger than the - # maximum page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your page token. In this way you can retrieve + # the complete contents of even very large collections one page at a time. + # However, if the contents of the collection change between the first and last + # paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a consistent + # snapshot of a collection larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1087,23 +1071,22 @@ module Google class Policy include Google::Apis::Core::Hashable - # Sets an alternative name server for the associated networks. When - # specified, all DNS queries are forwarded to a name server that you - # choose. Names such as .internal are not available when an alternative - # name server is specified. + # Sets an alternative name server for the associated networks. When specified, + # all DNS queries are forwarded to a name server that you choose. Names such as . + # internal are not available when an alternative name server is specified. # Corresponds to the JSON property `alternativeNameServerConfig` # @return [Google::Apis::DnsV1beta2::PolicyAlternativeNameServerConfig] attr_accessor :alternative_name_server_config - # A mutable string of at most 1024 characters associated with this resource - # for the user's convenience. Has no effect on the policy's function. + # A mutable string of at most 1024 characters associated with this resource for + # the user's convenience. Has no effect on the policy's function. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Allows networks bound to this policy to receive DNS queries sent by VMs or - # applications over VPN connections. When enabled, a virtual IP address will - # be allocated from each of the sub-networks that are bound to this policy. + # applications over VPN connections. When enabled, a virtual IP address will be + # allocated from each of the sub-networks that are bound to this policy. # Corresponds to the JSON property `enableInboundForwarding` # @return [Boolean] attr_accessor :enable_inbound_forwarding @@ -1162,10 +1145,9 @@ module Google # @return [String] attr_accessor :kind - # Sets an alternative name server for the associated networks. When - # specified, all DNS queries are forwarded to a name server that you - # choose. Names such as .internal are not available when an alternative - # name server is specified. + # Sets an alternative name server for the associated networks. When specified, + # all DNS queries are forwarded to a name server that you choose. Names such as . + # internal are not available when an alternative name server is specified. # Corresponds to the JSON property `targetNameServers` # @return [Array] attr_accessor :target_name_servers @@ -1185,11 +1167,10 @@ module Google class PolicyAlternativeNameServerConfigTargetNameServer include Google::Apis::Core::Hashable - # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, - # Cloud DNS will make forwarding decision based on address ranges, - # i.e. RFC1918 addresses go to the VPC, non-RFC1918 addresses go to the - # Internet. When set to PRIVATE, Cloud DNS will always send queries - # through VPC for this target. + # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud + # DNS will make forwarding decision based on address ranges, i.e. RFC1918 + # addresses go to the VPC, non-RFC1918 addresses go to the Internet. When set to + # PRIVATE, Cloud DNS will always send queries through VPC for this target. # Corresponds to the JSON property `forwardingPath` # @return [String] attr_accessor :forwarding_path @@ -1225,10 +1206,9 @@ module Google # @return [String] attr_accessor :kind - # The fully qualified URL of the VPC network to bind to. - # This should be formatted like - # https://www.googleapis.com/compute/v1/projects/`project`/global/networks/` - # network` + # The fully qualified URL of the VPC network to bind to. This should be + # formatted like https://www.googleapis.com/compute/v1/projects/`project`/global/ + # networks/`network` # Corresponds to the JSON property `networkUrl` # @return [String] attr_accessor :network_url @@ -1260,8 +1240,8 @@ module Google # @return [String] attr_accessor :kind - # Unique numeric identifier for the resource; defined by the server (output - # only). + # Unique numeric identifier for the resource; defined by the server (output only) + # . # Corresponds to the JSON property `number` # @return [Fixnum] attr_accessor :number @@ -1303,8 +1283,7 @@ module Google # @return [Fixnum] attr_accessor :managed_zones - # Maximum allowed number of managed zones which can be attached to a - # network. + # Maximum allowed number of managed zones which can be attached to a network. # Corresponds to the JSON property `managedZonesPerNetwork` # @return [Fixnum] attr_accessor :managed_zones_per_network @@ -1330,8 +1309,7 @@ module Google # @return [Fixnum] attr_accessor :resource_records_per_rrset - # Maximum allowed number of ResourceRecordSets to add per - # ChangesCreateRequest. + # Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest. # Corresponds to the JSON property `rrsetAdditionsPerChange` # @return [Fixnum] attr_accessor :rrset_additions_per_change @@ -1357,8 +1335,7 @@ module Google # @return [Fixnum] attr_accessor :target_name_servers_per_policy - # Maximum allowed size for total rrdata in one ChangesCreateRequest in - # bytes. + # Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes. # Corresponds to the JSON property `totalRrdataSizePerChange` # @return [Fixnum] attr_accessor :total_rrdata_size_per_change @@ -1407,7 +1384,7 @@ module Google attr_accessor :name # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see - # examples. + # examples. # Corresponds to the JSON property `rrdatas` # @return [Array] attr_accessor :rrdatas @@ -1422,9 +1399,8 @@ module Google # @return [Fixnum] attr_accessor :ttl - # The identifier of a supported record type. See the list of - # Supported - # DNS record types. + # The identifier of a supported record type. See the list of Supported DNS + # record types. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1458,15 +1434,14 @@ module Google # @return [String] attr_accessor :kind - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your pagination token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a consistent snapshot of a collection larger than the - # maximum page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your pagination token. In this way you can + # retrieve the complete contents of even very large collections one page at a + # time. However, if the contents of the collection change between the first and + # last paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a consistent + # snapshot of a collection larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1493,9 +1468,9 @@ module Google class ResponseHeader include Google::Apis::Core::Hashable - # For mutating operation requests that completed successfully. - # This is the client_operation_id if the client specified it, - # otherwise it is generated by the server (output only). + # For mutating operation requests that completed successfully. This is the + # client_operation_id if the client specified it, otherwise it is generated by + # the server (output only). # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id diff --git a/generated/google/apis/dns_v1beta2/service.rb b/generated/google/apis/dns_v1beta2/service.rb index 5c5c9a675..5f3748748 100644 --- a/generated/google/apis/dns_v1beta2/service.rb +++ b/generated/google/apis/dns_v1beta2/service.rb @@ -51,13 +51,12 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [Google::Apis::DnsV1beta2::Change] change_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -93,15 +92,14 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [String] change_id # The identifier of the requested change, from a previous # ResourceRecordSetsChangeResponse. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -136,14 +134,14 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] sort_by # Sorting criterion. The only supported value is change sequence. # @param [String] sort_order @@ -184,18 +182,17 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [String] dns_key_id # The identifier of the requested DnsKey. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] digest_type - # An optional comma-separated list of digest types to compute and display - # for key signing keys. If omitted, the recommended digest type will be - # computed and displayed. + # An optional comma-separated list of digest types to compute and display for + # key signing keys. If omitted, the recommended digest type will be computed and + # displayed. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -231,18 +228,18 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [String] digest_type - # An optional comma-separated list of digest types to compute and display - # for key signing keys. If omitted, the recommended digest type will be - # computed and displayed. + # An optional comma-separated list of digest types to compute and display for + # key signing keys. If omitted, the recommended digest type will be computed and + # displayed. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -282,9 +279,8 @@ module Google # @param [String] operation # Identifies the operation addressed by this request. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -321,11 +317,11 @@ module Google # @param [String] managed_zone # Identifies the managed zone addressed by this request. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] sort_by # Sorting criterion. The only supported values are START_TIME and ID. # @param [String] fields @@ -364,9 +360,8 @@ module Google # Identifies the project addressed by this request. # @param [Google::Apis::DnsV1beta2::ManagedZone] managed_zone_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -401,12 +396,11 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -438,12 +432,11 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -479,11 +472,11 @@ module Google # @param [String] dns_name # Restricts the list to return only zones with this domain name. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -518,13 +511,12 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [Google::Apis::DnsV1beta2::ManagedZone] managed_zone_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -560,13 +552,12 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [Google::Apis::DnsV1beta2::ManagedZone] managed_zone_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -603,9 +594,8 @@ module Google # Identifies the project addressed by this request. # @param [Google::Apis::DnsV1beta2::Policy] policy_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -643,9 +633,8 @@ module Google # @param [String] policy # User given friendly name of the policy addressed by this request. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -679,9 +668,8 @@ module Google # @param [String] policy # User given friendly name of the policy addressed by this request. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -715,11 +703,11 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -756,9 +744,8 @@ module Google # User given friendly name of the policy addressed by this request. # @param [Google::Apis::DnsV1beta2::Policy] policy_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -797,9 +784,8 @@ module Google # User given friendly name of the policy addressed by this request. # @param [Google::Apis::DnsV1beta2::Policy] policy_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -835,9 +821,8 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -870,20 +855,20 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] name # Restricts the list to return only records with this fully qualified domain # name. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] type - # Restricts the list to return only records of this type. If present, the - # "name" parameter must also be present. + # Restricts the list to return only records of this type. If present, the "name" + # parameter must also be present. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/dns_v2beta1.rb b/generated/google/apis/dns_v2beta1.rb index 0db5f898d..b55fdb58a 100644 --- a/generated/google/apis/dns_v2beta1.rb +++ b/generated/google/apis/dns_v2beta1.rb @@ -25,7 +25,7 @@ module Google # @see http://developers.google.com/cloud-dns module DnsV2beta1 VERSION = 'V2beta1' - REVISION = '20200731' + REVISION = '20200806' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dns_v2beta1/classes.rb b/generated/google/apis/dns_v2beta1/classes.rb index ee0d02bbb..868304b28 100644 --- a/generated/google/apis/dns_v2beta1/classes.rb +++ b/generated/google/apis/dns_v2beta1/classes.rb @@ -22,13 +22,13 @@ module Google module Apis module DnsV2beta1 - # A Change represents a set of ResourceRecordSet additions and deletions - # applied atomically to a ManagedZone. ResourceRecordSets within a - # ManagedZone are modified by creating a new Change element in the Changes - # collection. In turn the Changes collection also records the past - # modifications to the ResourceRecordSets in a ManagedZone. The current - # state of the ManagedZone is the sum effect of applying all Change - # elements in the Changes collection in sequence. + # A Change represents a set of ResourceRecordSet additions and deletions applied + # atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are + # modified by creating a new Change element in the Changes collection. In turn + # the Changes collection also records the past modifications to the + # ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is + # the sum effect of applying all Change elements in the Changes collection in + # sequence. class Change include Google::Apis::Core::Hashable @@ -58,15 +58,15 @@ module Google # @return [String] attr_accessor :kind - # The time that this operation was started by the server (output only). This - # is in RFC3339 text format. + # The time that this operation was started by the server (output only). This is + # in RFC3339 text format. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # Status of the operation (output only). A status of "done" means that the - # request to update the authoritative servers has been sent but the - # servers might not be updated yet. + # request to update the authoritative servers has been sent but the servers + # might not be updated yet. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -107,15 +107,14 @@ module Google # @return [String] attr_accessor :kind - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your pagination token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a "snapshot" of collections larger than the maximum - # page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your pagination token. In this way you can + # retrieve the complete contents of even very large collections one page at a + # time. However, if the contents of the collection change between the first and + # last paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a "snapshot" + # of collections larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -137,8 +136,8 @@ module Google class DnsKey include Google::Apis::Core::Hashable - # String mnemonic specifying the DNSSEC algorithm of this key. Immutable - # after creation time. + # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after + # creation time. # Corresponds to the JSON property `algorithm` # @return [String] attr_accessor :algorithm @@ -149,15 +148,15 @@ module Google # @return [String] attr_accessor :creation_time - # A mutable string of at most 1024 characters associated with this resource - # for the user's convenience. Has no effect on the resource's function. + # A mutable string of at most 1024 characters associated with this resource for + # the user's convenience. Has no effect on the resource's function. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Cryptographic hashes of the DNSKEY resource record associated with this - # DnsKey. These digests are needed to construct a DS record that points at - # this DNS key. Output only. + # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. + # These digests are needed to construct a DS record that points at this DNS key. + # Output only. # Corresponds to the JSON property `digests` # @return [Array] attr_accessor :digests @@ -168,8 +167,8 @@ module Google attr_accessor :id # Active keys will be used to sign subsequent changes to the ManagedZone. - # Inactive keys will still be present as DNSKEY Resource Records for the use - # of resolvers validating existing signatures. + # Inactive keys will still be present as DNSKEY Resource Records for the use of + # resolvers validating existing signatures. # Corresponds to the JSON property `isActive` # @return [Boolean] attr_accessor :is_active @@ -181,11 +180,11 @@ module Google attr_accessor :key_length # The key tag is a non-cryptographic hash of the a DNSKEY resource record - # associated with this DnsKey. The key tag can be used to identify a DNSKEY - # more quickly (but it is not a unique identifier). In particular, the key - # tag is used in a parent zone's DS record to point at the DNSKEY in this - # child ManagedZone. The key tag is a number in the range [0, 65535] and the - # algorithm to calculate it is specified in RFC4034 Appendix B. Output only. + # associated with this DnsKey. The key tag can be used to identify a DNSKEY more + # quickly (but it is not a unique identifier). In particular, the key tag is + # used in a parent zone's DS record to point at the DNSKEY in this child + # ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm + # to calculate it is specified in RFC4034 Appendix B. Output only. # Corresponds to the JSON property `keyTag` # @return [Fixnum] attr_accessor :key_tag @@ -202,9 +201,9 @@ module Google # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the # Secure Entry Point flag set and, when active, will be used to sign only - # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point - # flag will be cleared and this key will be used to sign only resource - # record sets of other types. Immutable after creation time. + # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag + # will be cleared and this key will be used to sign only resource record sets of + # other types. Immutable after creation time. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -233,8 +232,8 @@ module Google class DnsKeyDigest include Google::Apis::Core::Hashable - # The base-16 encoded bytes of this digest. Suitable for use in a DS - # resource record. + # The base-16 encoded bytes of this digest. Suitable for use in a DS resource + # record. # Corresponds to the JSON property `digest` # @return [String] attr_accessor :digest @@ -255,8 +254,8 @@ module Google end end - # Parameters for DnsKey key generation. Used for generating initial keys - # for a new ManagedZone and as default when adding a new DnsKey. + # Parameters for DnsKey key generation. Used for generating initial keys for a + # new ManagedZone and as default when adding a new DnsKey. class DnsKeySpec include Google::Apis::Core::Hashable @@ -270,11 +269,11 @@ module Google # @return [Fixnum] attr_accessor :key_length - # Specifies whether this is a key signing key (KSK) or a zone signing key - # (ZSK). Key signing keys have the Secure Entry Point flag set and, when - # active, will only be used to sign resource record sets of type DNSKEY. - # Zone signing keys do not have the Secure Entry Point flag set and will be - # used to sign all other types of resource record sets. + # Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). + # Key signing keys have the Secure Entry Point flag set and, when active, will + # only be used to sign resource record sets of type DNSKEY. Zone signing keys do + # not have the Secure Entry Point flag set and will be used to sign all other + # types of resource record sets. # Corresponds to the JSON property `keyType` # @return [String] attr_accessor :key_type @@ -316,15 +315,14 @@ module Google # @return [String] attr_accessor :kind - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your pagination token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a "snapshot" of collections larger than the maximum - # page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your pagination token. In this way you can + # retrieve the complete contents of even very large collections one page at a + # time. However, if the contents of the collection change between the first and + # last paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a "snapshot" + # of collections larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -343,19 +341,19 @@ module Google end # A zone is a subtree of the DNS namespace under one administrative - # responsibility. A ManagedZone is a resource that represents a DNS zone - # hosted by the Cloud DNS service. + # responsibility. A ManagedZone is a resource that represents a DNS zone hosted + # by the Cloud DNS service. class ManagedZone include Google::Apis::Core::Hashable - # The time that this resource was created on the server. This is in RFC3339 - # text format. Output only. + # The time that this resource was created on the server. This is in RFC3339 text + # format. Output only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time - # A mutable string of at most 1024 characters associated with this resource - # for the user's convenience. Has no effect on the managed zone's function. + # A mutable string of at most 1024 characters associated with this resource for + # the user's convenience. Has no effect on the managed zone's function. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -370,9 +368,9 @@ module Google # @return [Google::Apis::DnsV2beta1::ManagedZoneDnsSecConfig] attr_accessor :dnssec_config - # The presence for this field indicates that outbound forwarding is enabled - # for this zone. The value of this field contains the set of destinations - # to forward to. + # The presence for this field indicates that outbound forwarding is enabled for + # this zone. The value of this field contains the set of destinations to forward + # to. # Corresponds to the JSON property `forwardingConfig` # @return [Google::Apis::DnsV2beta1::ManagedZoneForwardingConfig] attr_accessor :forwarding_config @@ -392,16 +390,16 @@ module Google # @return [Hash] attr_accessor :labels - # User assigned name for this resource. Must be unique within the project. - # The name must be 1-63 characters long, must begin with a letter, end with - # a letter or digit, and only contain lowercase letters, digits or dashes. + # User assigned name for this resource. Must be unique within the project. The + # name must be 1-63 characters long, must begin with a letter, end with a letter + # or digit, and only contain lowercase letters, digits or dashes. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optionally specifies the NameServerSet for this ManagedZone. A - # NameServerSet is a set of DNS name servers that all host the same - # ManagedZones. Most users will leave this field unset. + # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet + # is a set of DNS name servers that all host the same ManagedZones. Most users + # will leave this field unset. # Corresponds to the JSON property `nameServerSet` # @return [String] attr_accessor :name_server_set @@ -412,28 +410,28 @@ module Google # @return [Array] attr_accessor :name_servers - # The presence of this field indicates that DNS Peering is enabled for this - # zone. The value of this field contains the network to peer with. + # The presence of this field indicates that DNS Peering is enabled for this zone. + # The value of this field contains the network to peer with. # Corresponds to the JSON property `peeringConfig` # @return [Google::Apis::DnsV2beta1::ManagedZonePeeringConfig] attr_accessor :peering_config - # For privately visible zones, the set of Virtual Private Cloud resources - # that the zone is visible from. + # For privately visible zones, the set of Virtual Private Cloud resources that + # the zone is visible from. # Corresponds to the JSON property `privateVisibilityConfig` # @return [Google::Apis::DnsV2beta1::ManagedZonePrivateVisibilityConfig] attr_accessor :private_visibility_config - # The presence of this field indicates that this is a managed reverse - # lookup zone and Cloud DNS will resolve reverse lookup queries using - # automatically configured records for VPC resources. This only applies - # to networks listed under private_visibility_config. + # The presence of this field indicates that this is a managed reverse lookup + # zone and Cloud DNS will resolve reverse lookup queries using automatically + # configured records for VPC resources. This only applies to networks listed + # under private_visibility_config. # Corresponds to the JSON property `reverseLookupConfig` # @return [Google::Apis::DnsV2beta1::ManagedZoneReverseLookupConfig] attr_accessor :reverse_lookup_config - # The zone's visibility: public zones are exposed to the Internet, while - # private zones are visible only to Virtual Private Cloud resources. + # The zone's visibility: public zones are exposed to the Internet, while private + # zones are visible only to Virtual Private Cloud resources. # Corresponds to the JSON property `visibility` # @return [String] attr_accessor :visibility @@ -466,8 +464,8 @@ module Google class ManagedZoneDnsSecConfig include Google::Apis::Core::Hashable - # Specifies parameters for generating initial DnsKeys for this - # ManagedZone. Can only be changed while the state is OFF. + # Specifies parameters for generating initial DnsKeys for this ManagedZone. Can + # only be changed while the state is OFF. # Corresponds to the JSON property `defaultKeySpecs` # @return [Array] attr_accessor :default_key_specs @@ -477,8 +475,8 @@ module Google # @return [String] attr_accessor :kind - # Specifies the mechanism for authenticated denial-of-existence responses. - # Can only be changed while the state is OFF. + # Specifies the mechanism for authenticated denial-of-existence responses. Can + # only be changed while the state is OFF. # Corresponds to the JSON property `nonExistence` # @return [String] attr_accessor :non_existence @@ -510,9 +508,8 @@ module Google # @return [String] attr_accessor :kind - # List of target name servers to forward to. - # Cloud DNS will select the best available name server if more than one - # target is given. + # List of target name servers to forward to. Cloud DNS will select the best + # available name server if more than one target is given. # Corresponds to the JSON property `targetNameServers` # @return [Array] attr_accessor :target_name_servers @@ -532,11 +529,10 @@ module Google class ManagedZoneForwardingConfigNameServerTarget include Google::Apis::Core::Hashable - # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, - # Cloud DNS will make forwarding decision based on address ranges, - # i.e. RFC1918 addresses go to the VPC, non-RFC1918 addresses go to the - # Internet. When set to PRIVATE, Cloud DNS will always send queries - # through VPC for this target. + # Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud + # DNS will make forwarding decision based on address ranges, i.e. RFC1918 + # addresses go to the VPC, non-RFC1918 addresses go to the Internet. When set to + # PRIVATE, Cloud DNS will always send queries through VPC for this target. # Corresponds to the JSON property `forwardingPath` # @return [String] attr_accessor :forwarding_path @@ -577,15 +573,14 @@ module Google # @return [String] attr_accessor :kind - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your page token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a consistent snapshot of a collection larger than the - # maximum page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your page token. In this way you can retrieve + # the complete contents of even very large collections one page at a time. + # However, if the contents of the collection change between the first and last + # paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a consistent + # snapshot of a collection larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -637,11 +632,10 @@ module Google class ManagedZonePeeringConfigTargetNetwork include Google::Apis::Core::Hashable - # The time at which the zone was deactivated, in RFC 3339 date-time - # format. An empty string indicates that the peering connection is - # active. The producer network can deactivate a zone. The zone is - # automatically deactivated if the producer network that the zone - # targeted is deleted. Output only. + # The time at which the zone was deactivated, in RFC 3339 date-time format. An + # empty string indicates that the peering connection is active. The producer + # network can deactivate a zone. The zone is automatically deactivated if the + # producer network that the zone targeted is deleted. Output only. # Corresponds to the JSON property `deactivateTime` # @return [String] attr_accessor :deactivate_time @@ -651,10 +645,9 @@ module Google # @return [String] attr_accessor :kind - # The fully qualified URL of the VPC network to forward queries to. - # This should be formatted like - # https://www.googleapis.com/compute/v1/projects/`project`/global/networks/` - # network` + # The fully qualified URL of the VPC network to forward queries to. This should + # be formatted like https://www.googleapis.com/compute/v1/projects/`project`/ + # global/networks/`network` # Corresponds to the JSON property `networkUrl` # @return [String] attr_accessor :network_url @@ -705,10 +698,9 @@ module Google # @return [String] attr_accessor :kind - # The fully qualified URL of the VPC network to bind to. - # This should be formatted like - # https://www.googleapis.com/compute/v1/projects/`project`/global/networks/` - # network` + # The fully qualified URL of the VPC network to bind to. This should be + # formatted like https://www.googleapis.com/compute/v1/projects/`project`/global/ + # networks/`network` # Corresponds to the JSON property `networkUrl` # @return [String] attr_accessor :network_url @@ -762,15 +754,14 @@ module Google # @return [Array] attr_accessor :managed_zones - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your page token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a consistent snapshot of a collection larger than the - # maximum page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your page token. In this way you can retrieve + # the complete contents of even very large collections one page at a time. + # However, if the contents of the collection change between the first and last + # paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a consistent + # snapshot of a collection larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -789,10 +780,8 @@ module Google end # An operation represents a successful mutation performed on a Cloud DNS - # resource. - # Operations provide: - # - An audit log of server resource mutations. - # - A way to recover/retry API calls in the case where the response is never + # resource. Operations provide: - An audit log of server resource mutations. - A + # way to recover/retry API calls in the case where the response is never # received by the caller. Use the caller specified client_operation_id. class Operation include Google::Apis::Core::Hashable @@ -802,10 +791,10 @@ module Google # @return [Google::Apis::DnsV2beta1::OperationDnsKeyContext] attr_accessor :dns_key_context - # Unique identifier for the resource. This is the client_operation_id if - # the client specified it when the mutation was initiated, otherwise, - # it is generated by the server. The name must be 1-63 characters long - # and match the regular expression [-a-z0-9]? (output only) + # Unique identifier for the resource. This is the client_operation_id if the + # client specified it when the mutation was initiated, otherwise, it is + # generated by the server. The name must be 1-63 characters long and match the + # regular expression [-a-z0-9]? (output only) # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -821,23 +810,21 @@ module Google # @return [String] attr_accessor :start_time - # Status of the operation. Can be one of the following: "PENDING" or "DONE" - # (output only). A status of "DONE" means that the - # request to update the authoritative servers has been sent, but the - # servers might not be updated yet. + # Status of the operation. Can be one of the following: "PENDING" or "DONE" ( + # output only). A status of "DONE" means that the request to update the + # authoritative servers has been sent, but the servers might not be updated yet. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status - # Type of the operation. Operations include insert, update, and delete - # (output only). + # Type of the operation. Operations include insert, update, and delete (output + # only). # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # User who requested the operation, for example: user@example.com. - # cloud-dns-system for operations automatically done by the system. - # (output only) + # User who requested the operation, for example: user@example.com. cloud-dns- + # system for operations automatically done by the system. (output only) # Corresponds to the JSON property `user` # @return [String] attr_accessor :user @@ -894,15 +881,15 @@ module Google include Google::Apis::Core::Hashable # A zone is a subtree of the DNS namespace under one administrative - # responsibility. A ManagedZone is a resource that represents a DNS zone - # hosted by the Cloud DNS service. + # responsibility. A ManagedZone is a resource that represents a DNS zone hosted + # by the Cloud DNS service. # Corresponds to the JSON property `newValue` # @return [Google::Apis::DnsV2beta1::ManagedZone] attr_accessor :new_value # A zone is a subtree of the DNS namespace under one administrative - # responsibility. A ManagedZone is a resource that represents a DNS zone - # hosted by the Cloud DNS service. + # responsibility. A ManagedZone is a resource that represents a DNS zone hosted + # by the Cloud DNS service. # Corresponds to the JSON property `oldValue` # @return [Google::Apis::DnsV2beta1::ManagedZone] attr_accessor :old_value @@ -932,15 +919,14 @@ module Google # @return [String] attr_accessor :kind - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your page token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a consistent snapshot of a collection larger than the - # maximum page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your page token. In this way you can retrieve + # the complete contents of even very large collections one page at a time. + # However, if the contents of the collection change between the first and last + # paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a consistent + # snapshot of a collection larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1020,23 +1006,22 @@ module Google class Policy include Google::Apis::Core::Hashable - # Sets an alternative name server for the associated networks. When - # specified, all DNS queries are forwarded to a name server that you - # choose. Names such as .internal are not available when an alternative - # name server is specified. + # Sets an alternative name server for the associated networks. When specified, + # all DNS queries are forwarded to a name server that you choose. Names such as . + # internal are not available when an alternative name server is specified. # Corresponds to the JSON property `alternativeNameServerConfig` # @return [Google::Apis::DnsV2beta1::PolicyAlternativeNameServerConfig] attr_accessor :alternative_name_server_config - # A mutable string of at most 1024 characters associated with this resource - # for the user's convenience. Has no effect on the policy's function. + # A mutable string of at most 1024 characters associated with this resource for + # the user's convenience. Has no effect on the policy's function. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Allows networks bound to this policy to receive DNS queries sent by VMs or - # applications over VPN connections. When enabled, a virtual IP address will - # be allocated from each of the sub-networks that are bound to this policy. + # applications over VPN connections. When enabled, a virtual IP address will be + # allocated from each of the sub-networks that are bound to this policy. # Corresponds to the JSON property `enableInboundForwarding` # @return [Boolean] attr_accessor :enable_inbound_forwarding @@ -1095,10 +1080,9 @@ module Google # @return [String] attr_accessor :kind - # Sets an alternative name server for the associated networks. When - # specified, all DNS queries are forwarded to a name server that you - # choose. Names such as .internal are not available when an alternative - # name server is specified. + # Sets an alternative name server for the associated networks. When specified, + # all DNS queries are forwarded to a name server that you choose. Names such as . + # internal are not available when an alternative name server is specified. # Corresponds to the JSON property `targetNameServers` # @return [Array] attr_accessor :target_name_servers @@ -1118,11 +1102,10 @@ module Google class PolicyAlternativeNameServerConfigTargetNameServer include Google::Apis::Core::Hashable - # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, - # Cloud DNS will make forwarding decision based on address ranges, - # i.e. RFC1918 addresses go to the VPC, non-RFC1918 addresses go to the - # Internet. When set to PRIVATE, Cloud DNS will always send queries - # through VPC for this target. + # Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud + # DNS will make forwarding decision based on address ranges, i.e. RFC1918 + # addresses go to the VPC, non-RFC1918 addresses go to the Internet. When set to + # PRIVATE, Cloud DNS will always send queries through VPC for this target. # Corresponds to the JSON property `forwardingPath` # @return [String] attr_accessor :forwarding_path @@ -1158,10 +1141,9 @@ module Google # @return [String] attr_accessor :kind - # The fully qualified URL of the VPC network to bind to. - # This should be formatted like - # https://www.googleapis.com/compute/v1/projects/`project`/global/networks/` - # network` + # The fully qualified URL of the VPC network to bind to. This should be + # formatted like https://www.googleapis.com/compute/v1/projects/`project`/global/ + # networks/`network` # Corresponds to the JSON property `networkUrl` # @return [String] attr_accessor :network_url @@ -1193,8 +1175,8 @@ module Google # @return [String] attr_accessor :kind - # Unique numeric identifier for the resource; defined by the server (output - # only). + # Unique numeric identifier for the resource; defined by the server (output only) + # . # Corresponds to the JSON property `number` # @return [Fixnum] attr_accessor :number @@ -1236,8 +1218,7 @@ module Google # @return [Fixnum] attr_accessor :managed_zones - # Maximum allowed number of managed zones which can be attached to a - # network. + # Maximum allowed number of managed zones which can be attached to a network. # Corresponds to the JSON property `managedZonesPerNetwork` # @return [Fixnum] attr_accessor :managed_zones_per_network @@ -1263,8 +1244,7 @@ module Google # @return [Fixnum] attr_accessor :resource_records_per_rrset - # Maximum allowed number of ResourceRecordSets to add per - # ChangesCreateRequest. + # Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest. # Corresponds to the JSON property `rrsetAdditionsPerChange` # @return [Fixnum] attr_accessor :rrset_additions_per_change @@ -1290,8 +1270,7 @@ module Google # @return [Fixnum] attr_accessor :target_name_servers_per_policy - # Maximum allowed size for total rrdata in one ChangesCreateRequest in - # bytes. + # Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes. # Corresponds to the JSON property `totalRrdataSizePerChange` # @return [Fixnum] attr_accessor :total_rrdata_size_per_change @@ -1340,7 +1319,7 @@ module Google attr_accessor :name # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see - # examples. + # examples. # Corresponds to the JSON property `rrdatas` # @return [Array] attr_accessor :rrdatas @@ -1355,9 +1334,8 @@ module Google # @return [Fixnum] attr_accessor :ttl - # The identifier of a supported record type. See the list of - # Supported - # DNS record types. + # The identifier of a supported record type. See the list of Supported DNS + # record types. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1391,15 +1369,14 @@ module Google # @return [String] attr_accessor :kind - # The presence of this field indicates that there exist more results - # following your last page of results in pagination order. To fetch them, - # make another list request using this value as your pagination token. - # In this way you can retrieve the complete contents of even very large - # collections one page at a time. However, if the contents of the collection - # change between the first and last paginated list request, the set of all - # elements returned will be an inconsistent view of the collection. There is - # no way to retrieve a consistent snapshot of a collection larger than the - # maximum page size. + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your pagination token. In this way you can + # retrieve the complete contents of even very large collections one page at a + # time. However, if the contents of the collection change between the first and + # last paginated list request, the set of all elements returned will be an + # inconsistent view of the collection. There is no way to retrieve a consistent + # snapshot of a collection larger than the maximum page size. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1426,9 +1403,9 @@ module Google class ResponseHeader include Google::Apis::Core::Hashable - # For mutating operation requests that completed successfully. - # This is the client_operation_id if the client specified it, - # otherwise it is generated by the server (output only). + # For mutating operation requests that completed successfully. This is the + # client_operation_id if the client specified it, otherwise it is generated by + # the server (output only). # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id diff --git a/generated/google/apis/dns_v2beta1/service.rb b/generated/google/apis/dns_v2beta1/service.rb index 85b7a9584..2310bbb87 100644 --- a/generated/google/apis/dns_v2beta1/service.rb +++ b/generated/google/apis/dns_v2beta1/service.rb @@ -51,13 +51,12 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [Google::Apis::DnsV2beta1::Change] change_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -93,15 +92,14 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [String] change_id # The identifier of the requested change, from a previous # ResourceRecordSetsChangeResponse. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -136,14 +134,14 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] sort_by # Sorting criterion. The only supported value is change sequence. # @param [String] sort_order @@ -184,18 +182,17 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [String] dns_key_id # The identifier of the requested DnsKey. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] digest_type - # An optional comma-separated list of digest types to compute and display - # for key signing keys. If omitted, the recommended digest type will be - # computed and displayed. + # An optional comma-separated list of digest types to compute and display for + # key signing keys. If omitted, the recommended digest type will be computed and + # displayed. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -231,18 +228,18 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [String] digest_type - # An optional comma-separated list of digest types to compute and display - # for key signing keys. If omitted, the recommended digest type will be - # computed and displayed. + # An optional comma-separated list of digest types to compute and display for + # key signing keys. If omitted, the recommended digest type will be computed and + # displayed. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -282,9 +279,8 @@ module Google # @param [String] operation # Identifies the operation addressed by this request. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -321,11 +317,11 @@ module Google # @param [String] managed_zone # Identifies the managed zone addressed by this request. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] sort_by # Sorting criterion. The only supported values are START_TIME and ID. # @param [String] fields @@ -364,9 +360,8 @@ module Google # Identifies the project addressed by this request. # @param [Google::Apis::DnsV2beta1::ManagedZone] managed_zone_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -401,12 +396,11 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -438,12 +432,11 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -479,11 +472,11 @@ module Google # @param [String] dns_name # Restricts the list to return only zones with this domain name. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -518,13 +511,12 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [Google::Apis::DnsV2beta1::ManagedZone] managed_zone_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -560,13 +552,12 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [Google::Apis::DnsV2beta1::ManagedZone] managed_zone_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -603,9 +594,8 @@ module Google # Identifies the project addressed by this request. # @param [Google::Apis::DnsV2beta1::Policy] policy_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -643,9 +633,8 @@ module Google # @param [String] policy # User given friendly name of the policy addressed by this request. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -679,9 +668,8 @@ module Google # @param [String] policy # User given friendly name of the policy addressed by this request. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -715,11 +703,11 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -756,9 +744,8 @@ module Google # User given friendly name of the policy addressed by this request. # @param [Google::Apis::DnsV2beta1::Policy] policy_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -797,9 +784,8 @@ module Google # User given friendly name of the policy addressed by this request. # @param [Google::Apis::DnsV2beta1::Policy] policy_object # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -835,9 +821,8 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] client_operation_id - # For mutating operation requests only. An optional identifier - # specified by the client. Must be unique for operation resources in the - # Operations collection. + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -870,20 +855,20 @@ module Google # @param [String] project # Identifies the project addressed by this request. # @param [String] managed_zone - # Identifies the managed zone addressed by this request. Can be the managed - # zone name or id. + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. # @param [Fixnum] max_results - # Optional. Maximum number of results to be returned. If unspecified, the - # server will decide how many results to return. + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. # @param [String] name # Restricts the list to return only records with this fully qualified domain # name. # @param [String] page_token - # Optional. A tag returned by a previous list request that was truncated. - # Use this parameter to continue a previous list request. + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. # @param [String] type - # Restricts the list to return only records of this type. If present, the - # "name" parameter must also be present. + # Restricts the list to return only records of this type. If present, the "name" + # parameter must also be present. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/file_v1.rb b/generated/google/apis/file_v1.rb index a35934ca8..751facb1c 100644 --- a/generated/google/apis/file_v1.rb +++ b/generated/google/apis/file_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/filestore/ module FileV1 VERSION = 'V1' - REVISION = '20200707' + REVISION = '20200806' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/file_v1/classes.rb b/generated/google/apis/file_v1/classes.rb index 13eb24f58..4c6c68bb3 100644 --- a/generated/google/apis/file_v1/classes.rb +++ b/generated/google/apis/file_v1/classes.rb @@ -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 @@ -58,8 +56,8 @@ module Google class FileShareConfig include Google::Apis::Core::Hashable - # File share capacity in gigabytes (GB). - # Cloud Filestore defines 1 GB as 1024^3 bytes. + # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 + # bytes. # Corresponds to the JSON property `capacityGb` # @return [Fixnum] attr_accessor :capacity_gb @@ -85,10 +83,9 @@ module Google include Google::Apis::Core::Hashable # consumer_defined_name is the name that is set by the consumer. On the other - # hand Name field represents system-assigned id of an instance so consumers - # are not necessarily aware of it. - # consumer_defined_name is used for notification/UI purposes for consumer to - # recognize their instances. + # hand Name field represents system-assigned id of an instance so consumers are + # not necessarily aware of it. consumer_defined_name is used for notification/UI + # purposes for consumer to recognize their instances. # Corresponds to the JSON property `consumerDefinedName` # @return [String] attr_accessor :consumer_defined_name @@ -98,18 +95,17 @@ module Google # @return [String] attr_accessor :create_time - # Optional. Resource labels to represent user provided metadata. Each label - # is a key-value pair, where both the key and the value are arbitrary strings + # Optional. Resource labels to represent user provided metadata. Each label is a + # key-value pair, where both the key and the value are arbitrary strings # provided by the user. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The MaintenancePolicies that have been attached to the instance. - # The key must be of the type name of the oneof policy name defined in - # MaintenancePolicy, and the referenced policy must define the same policy - # type. For complete details of MaintenancePolicy, please refer to - # go/cloud-saas-mw-ug. + # The MaintenancePolicies that have been attached to the instance. The key must + # be of the type name of the oneof policy name defined in MaintenancePolicy, and + # the referenced policy must define the same policy type. For complete details + # of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. # Corresponds to the JSON property `maintenancePolicyNames` # @return [Hash] attr_accessor :maintenance_policy_names @@ -126,29 +122,28 @@ module Google # @return [Google::Apis::FileV1::GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings] attr_accessor :maintenance_settings - # Unique name of the resource. It uses the form: - # `projects/`project_id`/locations/`location_id`/instances/`instance_id`` + # Unique name of the resource. It uses the form: `projects/`project_id`/ + # locations/`location_id`/instances/`instance_id`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Output only. Custom string attributes used primarily to expose - # producer-specific information in monitoring dashboards. - # See go/get-instance-metadata. + # Output only. Custom string attributes used primarily to expose producer- + # specific information in monitoring dashboards. See go/get-instance-metadata. # Corresponds to the JSON property `producerMetadata` # @return [Hash] attr_accessor :producer_metadata - # Output only. The list of data plane resources provisioned for this - # instance, e.g. compute VMs. See go/get-instance-metadata. + # Output only. The list of data plane resources provisioned for this instance, e. + # g. compute VMs. See go/get-instance-metadata. # Corresponds to the JSON property `provisionedResources` # @return [Array] attr_accessor :provisioned_resources - # Link to the SLM instance template. Only populated when updating SLM - # instances via SSA's Actuation service adaptor. - # Service producers with custom control plane (e.g. Cloud SQL) doesn't - # need to populate this field. Instead they should use software_versions. + # Link to the SLM instance template. Only populated when updating SLM instances + # via SSA's Actuation service adaptor. Service producers with custom control + # plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they + # should use software_versions. # Corresponds to the JSON property `slmInstanceTemplate` # @return [String] attr_accessor :slm_instance_template @@ -159,8 +154,8 @@ module Google # @return [Google::Apis::FileV1::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata] attr_accessor :slo_metadata - # Software versions that are used to deploy this instance. This can be - # mutated by rollout services. + # Software versions that are used to deploy this instance. This can be mutated + # by rollout services. # Corresponds to the JSON property `softwareVersions` # @return [Hash] attr_accessor :software_versions @@ -171,8 +166,8 @@ module Google # @return [String] attr_accessor :state - # Output only. ID of the associated GCP tenant project. - # See go/get-instance-metadata. + # Output only. ID of the associated GCP tenant project. See go/get-instance- + # metadata. # Corresponds to the JSON property `tenantProjectId` # @return [String] attr_accessor :tenant_project_id @@ -211,9 +206,9 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule include Google::Apis::Core::Hashable - # Can this scheduled update be rescheduled? - # By default, it's true and API needs to do explicitly check whether it's - # set, if it's set as false explicitly, it's false + # Can this scheduled update be rescheduled? By default, it's true and API needs + # to do explicitly check whether it's set, if it's set as false explicitly, it's + # false # Corresponds to the JSON property `canReschedule` # @return [Boolean] attr_accessor :can_reschedule @@ -224,9 +219,9 @@ module Google # @return [String] attr_accessor :end_time - # The rollout management policy this maintenance schedule is associated - # with. When doing reschedule update request, the reschedule should be - # against this given policy. + # The rollout management policy this maintenance schedule is associated with. + # When doing reschedule update request, the reschedule should be against this + # given policy. # Corresponds to the JSON property `rolloutManagementPolicy` # @return [String] attr_accessor :rollout_management_policy @@ -255,8 +250,7 @@ module Google include Google::Apis::Core::Hashable # Optional. Exclude instance from maintenance. When true, rollout service will - # not - # attempt maintenance on the instance. Rollout service will include the + # not attempt maintenance on the instance. Rollout service will include the # instance in reported rollout progress as not attempted. # Corresponds to the JSON property `exclude` # @return [Boolean] @@ -273,18 +267,17 @@ module Google end end - # Node information for custom per-node SLO implementations. - # SSA does not support per-node SLO, but producers can populate per-node - # information in SloMetadata for custom precomputations. - # SSA Eligibility Exporter will emit per-node metric based on this information. + # Node information for custom per-node SLO implementations. SSA does not support + # per-node SLO, but producers can populate per-node information in SloMetadata + # for custom precomputations. SSA Eligibility Exporter will emit per-node metric + # based on this information. class GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata include Google::Apis::Core::Hashable - # By default node is eligible if instance is eligible. - # But individual node might be excluded from SLO by adding entry here. - # For semantic see SloMetadata.exclusions. - # If both instance and node level exclusions are present for time period, - # the node level's reason will be reported by Eligibility Exporter. + # By default node is eligible if instance is eligible. But individual node might + # be excluded from SLO by adding entry here. For semantic see SloMetadata. + # exclusions. If both instance and node level exclusions are present for time + # period, the node level's reason will be reported by Eligibility Exporter. # Corresponds to the JSON property `exclusions` # @return [Array] attr_accessor :exclusions @@ -294,8 +287,7 @@ module Google # @return [String] attr_accessor :location - # The id of the node. - # This should be equal to SaasInstanceNode.node_id. + # The id of the node. This should be equal to SaasInstanceNode.node_id. # Corresponds to the JSON property `nodeId` # @return [String] attr_accessor :node_id @@ -316,18 +308,17 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource include Google::Apis::Core::Hashable - # Type of the resource. This can be either a GCP resource or a custom one - # (e.g. another cloud provider's VM). For GCP compute resources use singular - # form of the names listed in GCP compute API documentation - # (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with - # 'compute-', for example: 'compute-instance', 'compute-disk', - # 'compute-autoscaler'. + # Type of the resource. This can be either a GCP resource or a custom one (e.g. + # another cloud provider's VM). For GCP compute resources use singular form of + # the names listed in GCP compute API documentation (https://cloud.google.com/ + # compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: ' + # compute-instance', 'compute-disk', 'compute-autoscaler'. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type - # URL identifying the resource, e.g. - # "https://www.googleapis.com/compute/v1/projects/...)". + # URL identifying the resource, e.g. "https://www.googleapis.com/compute/v1/ + # projects/...)". # Corresponds to the JSON property `resourceUrl` # @return [String] attr_accessor :resource_url @@ -343,9 +334,9 @@ module Google end end - # SloEligibility is a tuple containing eligibility value: true if an instance - # is eligible for SLO calculation or false if it should be excluded from all - # SLO-related calculations along with a user-defined reason. + # SloEligibility is a tuple containing eligibility value: true if an instance is + # eligible for SLO calculation or false if it should be excluded from all SLO- + # related calculations along with a user-defined reason. class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility include Google::Apis::Core::Hashable @@ -356,8 +347,7 @@ module Google alias_method :eligible?, :eligible # User-defined reason for the current value of instance eligibility. Usually, - # this can be directly mapped to the internal state. An empty reason is - # allowed. + # this can be directly mapped to the internal state. An empty reason is allowed. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -377,28 +367,27 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion include Google::Apis::Core::Hashable - # Exclusion duration. No restrictions on the possible values. - # When an ongoing operation is taking longer than initially expected, - # an existing entry in the exclusion list can be updated by extending the - # duration. This is supported by the subsystem exporting eligibility data - # as long as such extension is committed at least 10 minutes before the - # original exclusion expiration - otherwise it is possible that there will - # be "gaps" in the exclusion application in the exported timeseries. + # Exclusion duration. No restrictions on the possible values. When an ongoing + # operation is taking longer than initially expected, an existing entry in the + # exclusion list can be updated by extending the duration. This is supported by + # the subsystem exporting eligibility data as long as such extension is + # committed at least 10 minutes before the original exclusion expiration - + # otherwise it is possible that there will be "gaps" in the exclusion + # application in the exported timeseries. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # Human-readable reason for the exclusion. - # This should be a static string (e.g. "Disruptive update in progress") - # and should not contain dynamically generated data (e.g. instance name). - # Can be left empty. + # Human-readable reason for the exclusion. This should be a static string (e.g. " + # Disruptive update in progress") and should not contain dynamically generated + # data (e.g. instance name). Can be left empty. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason - # Name of an SLI that this exclusion applies to. Can be left empty, - # signaling that the instance should be excluded from all SLIs defined - # in the service SLO configuration. + # Name of an SLI that this exclusion applies to. Can be left empty, signaling + # that the instance should be excluded from all SLIs defined in the service SLO + # configuration. # Corresponds to the JSON property `sliName` # @return [String] attr_accessor :sli_name @@ -426,40 +415,38 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata include Google::Apis::Core::Hashable - # SloEligibility is a tuple containing eligibility value: true if an instance - # is eligible for SLO calculation or false if it should be excluded from all - # SLO-related calculations along with a user-defined reason. + # SloEligibility is a tuple containing eligibility value: true if an instance is + # eligible for SLO calculation or false if it should be excluded from all SLO- + # related calculations along with a user-defined reason. # Corresponds to the JSON property `eligibility` # @return [Google::Apis::FileV1::GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility] attr_accessor :eligibility - # List of SLO exclusion windows. When multiple entries in the list match - # (matching the exclusion time-window against current time point) - # the exclusion reason used in the first matching entry will be published. - # It is not needed to include expired exclusion in this list, as only the - # currently applicable exclusions are taken into account by the eligibility - # exporting subsystem (the historical state of exclusions will be reflected - # in the historically produced timeseries regardless of the current state). - # This field can be used to mark the instance as temporary ineligible - # for the purpose of SLO calculation. For permanent instance SLO exclusion, - # use of custom instance eligibility is recommended. See 'eligibility' field - # below. + # List of SLO exclusion windows. When multiple entries in the list match ( + # matching the exclusion time-window against current time point) the exclusion + # reason used in the first matching entry will be published. It is not needed to + # include expired exclusion in this list, as only the currently applicable + # exclusions are taken into account by the eligibility exporting subsystem (the + # historical state of exclusions will be reflected in the historically produced + # timeseries regardless of the current state). This field can be used to mark + # the instance as temporary ineligible for the purpose of SLO calculation. For + # permanent instance SLO exclusion, use of custom instance eligibility is + # recommended. See 'eligibility' field below. # Corresponds to the JSON property `exclusions` # @return [Array] attr_accessor :exclusions - # Optional. List of nodes. - # Some producers need to use per-node metadata to calculate SLO. - # This field allows such producers to publish per-node SLO meta data, - # which will be consumed by SSA Eligibility Exporter and published in the + # Optional. List of nodes. Some producers need to use per-node metadata to + # calculate SLO. This field allows such producers to publish per-node SLO meta + # data, which will be consumed by SSA Eligibility Exporter and published in the # form of per node metric to Monarch. # Corresponds to the JSON property `nodes` # @return [Array] attr_accessor :nodes # Name of the SLO tier the Instance belongs to. This name will be expected to - # match the tiers specified in the service SLO configuration. - # Field is mandatory and must not be empty. + # match the tiers specified in the service SLO configuration. Field is mandatory + # and must not be empty. # Corresponds to the JSON property `tier` # @return [String] attr_accessor :tier @@ -497,8 +484,8 @@ module Google # @return [String] attr_accessor :etag - # File system shares on the instance. - # For this version, only a single file share is supported. + # File system shares on the instance. For this version, only a single file share + # is supported. # Corresponds to the JSON property `fileShares` # @return [Array] attr_accessor :file_shares @@ -508,14 +495,14 @@ module Google # @return [Hash] attr_accessor :labels - # Output only. The resource name of the instance, in the format - # projects/`project`/locations/`location`/instances/`instance`. + # Output only. The resource name of the instance, in the format projects/` + # project`/locations/`location`/instances/`instance`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # VPC networks to which the instance is connected. - # For this version, only a single network is supported. + # VPC networks to which the instance is connected. For this version, only a + # single network is supported. # Corresponds to the JSON property `networks` # @return [Array] attr_accessor :networks @@ -558,17 +545,17 @@ module Google class ListInstancesResponse include Google::Apis::Core::Hashable - # A list of instances in the project for the specified location. - # If the `location` value in the request is "-", the response contains a list - # of instances from all locations. If any location is unreachable, the - # response will only return instances in reachable locations and the - # "unreachable" field will be populated with a list of unreachable locations. + # A list of instances in the project for the specified location. If the ` + # location` value in the request is "-", the response contains a list of + # instances from all locations. If any location is unreachable, the response + # will only return instances in reachable locations and the "unreachable" field + # will be populated with a list of unreachable locations. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances - # The token you can use to retrieve the next page of results. Not returned - # if there are no more results in the list. + # The token you can use to retrieve the next page of results. Not returned if + # there are no more results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -644,14 +631,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] attr_accessor :labels @@ -667,8 +654,8 @@ module Google # @return [Hash] 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 @@ -691,34 +678,30 @@ module Google class NetworkConfig include Google::Apis::Core::Hashable - # Output only. IPv4 addresses in the format - # `octet 1`.`octet 2`.`octet 3`.`octet 4` or IPv6 addresses in the format - # `block 1`:`block 2`:`block 3`:`block 4`:`block 5`:`block 6`:`block - # 7`:`block 8`. + # Output only. IPv4 addresses in the format `octet 1`.`octet 2`.`octet 3`.`octet + # 4` or IPv6 addresses in the format `block 1`:`block 2`:`block 3`:`block 4`:` + # block 5`:`block 6`:`block 7`:`block 8`. # Corresponds to the JSON property `ipAddresses` # @return [Array] attr_accessor :ip_addresses - # Internet protocol versions for which the instance has IP addresses - # assigned. For this version, only MODE_IPV4 is supported. + # Internet protocol versions for which the instance has IP addresses assigned. + # For this version, only MODE_IPV4 is supported. # Corresponds to the JSON property `modes` # @return [Array] attr_accessor :modes - # The name of the Google Compute Engine - # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the - # instance is connected. + # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and- + # firewalls#networks) to which the instance is connected. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network - # A /29 CIDR block in one of the - # [internal IP address - # ranges](https://www.arin.net/knowledge/address_filters.html) that - # identifies the range of IP addresses reserved for this instance. For - # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap - # with either existing subnets or assigned IP address ranges for other Cloud - # Filestore instances in the selected VPC network. + # A /29 CIDR block in one of the [internal IP address ranges](https://www.arin. + # net/knowledge/address_filters.html) that identifies the range of IP addresses + # reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/29. The + # range you specify can't overlap with either existing subnets or assigned IP + # address ranges for other Cloud Filestore instances in the selected VPC network. # Corresponds to the JSON property `reservedIpRange` # @return [String] attr_accessor :reserved_ip_range @@ -741,47 +724,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::FileV1::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] 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] attr_accessor :response @@ -809,10 +790,10 @@ module Google # @return [String] attr_accessor :api_version - # [Output only] Identifies whether the user has requested cancellation - # of the operation. Operations that have successfully been cancelled - # have Operation.error value with a google.rpc.Status.code of 1, - # corresponding to `Code.CANCELLED`. + # [Output only] Identifies whether the user has requested cancellation of the + # operation. Operations that have successfully been cancelled have Operation. + # error value with a google.rpc.Status.code of 1, corresponding to `Code. + # CANCELLED`. # Corresponds to the JSON property `cancelRequested` # @return [Boolean] attr_accessor :cancel_requested @@ -859,12 +840,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 @@ -873,15 +854,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>] 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 diff --git a/generated/google/apis/file_v1/service.rb b/generated/google/apis/file_v1/service.rb index bb2577d02..8cb3f0228 100644 --- a/generated/google/apis/file_v1/service.rb +++ b/generated/google/apis/file_v1/service.rb @@ -83,8 +83,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 @@ -122,13 +121,13 @@ module Google # Creates an instance. # @param [String] parent - # Required. The instance's project and location, in the format - # projects/`project_id`/locations/`location`. In Cloud Filestore, - # locations map to GCP zones, for example **us-west1-b**. + # Required. The instance's project and location, in the format projects/` + # project_id`/locations/`location`. In Cloud Filestore, locations map to GCP + # zones, for example **us-west1-b**. # @param [Google::Apis::FileV1::Instance] instance_object # @param [String] instance_id - # Required. The name of the instance to create. - # The name must be unique for the specified project and location. + # Required. The name of the instance to create. The name must be unique for the + # specified project and location. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -161,8 +160,8 @@ module Google # Deletes an instance. # @param [String] name - # Required. The instance resource name, in the format - # projects/`project_id`/locations/`location`/instances/`instance_id` + # Required. The instance resource name, in the format projects/`project_id`/ + # locations/`location`/instances/`instance_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -192,8 +191,8 @@ module Google # Gets the details of a specific instance. # @param [String] name - # Required. The instance resource name, in the format - # projects/`project_id`/locations/`location`/instances/`instance_id`. + # Required. The instance resource name, in the format projects/`project_id`/ + # locations/`location`/instances/`instance_id`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -221,14 +220,13 @@ module Google execute_or_queue_command(command, &block) end - # Lists all instances in a project for either a specified location - # or for all locations. + # Lists all instances in a project for either a specified location or for all + # locations. # @param [String] parent # Required. The project and location for which to retrieve instance information, - # in the format projects/`project_id`/locations/`location`. In Cloud - # Filestore, locations map to GCP zones, for example **us-west1-b**. To - # retrieve instance information for all locations, use "-" for the `location` - # value. + # in the format projects/`project_id`/locations/`location`. In Cloud Filestore, + # locations map to GCP zones, for example **us-west1-b**. To retrieve instance + # information for all locations, use "-" for the `location` value. # @param [String] filter # List filter. # @param [String] order_by @@ -236,8 +234,8 @@ module Google # @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 @@ -271,16 +269,13 @@ module Google # Updates the settings of a specific instance. # @param [String] name - # Output only. The resource name of the instance, in the format - # projects/`project`/locations/`location`/instances/`instance`. + # Output only. The resource name of the instance, in the format projects/` + # project`/locations/`location`/instances/`instance`. # @param [Google::Apis::FileV1::Instance] instance_object # @param [String] update_mask - # Mask of fields to update. At least one path must be supplied in this - # field. The elements of the repeated paths field may only include these - # fields: - # * "description" - # * "file_shares" - # * "labels" + # Mask of fields to update. At least one path must be supplied in this field. + # The elements of the repeated paths field may only include these fields: * " + # description" * "file_shares" * "labels" # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -311,15 +306,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. @@ -353,10 +346,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 @@ -386,9 +379,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 @@ -418,15 +410,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 diff --git a/generated/google/apis/file_v1beta1.rb b/generated/google/apis/file_v1beta1.rb index 97afa60aa..a32d4c0af 100644 --- a/generated/google/apis/file_v1beta1.rb +++ b/generated/google/apis/file_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/filestore/ module FileV1beta1 VERSION = 'V1beta1' - REVISION = '20200707' + REVISION = '20200806' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/file_v1beta1/classes.rb b/generated/google/apis/file_v1beta1/classes.rb index 6ce86d4d4..9134d8abc 100644 --- a/generated/google/apis/file_v1beta1/classes.rb +++ b/generated/google/apis/file_v1beta1/classes.rb @@ -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 @@ -58,8 +56,8 @@ module Google class FileShareConfig include Google::Apis::Core::Hashable - # File share capacity in gigabytes (GB). - # Cloud Filestore defines 1 GB as 1024^3 bytes. + # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 + # bytes. # Corresponds to the JSON property `capacityGb` # @return [Fixnum] attr_accessor :capacity_gb @@ -69,8 +67,7 @@ module Google # @return [String] attr_accessor :name - # Nfs Export Options. - # There is a limit of 10 export options per file share. + # Nfs Export Options. There is a limit of 10 export options per file share. # Corresponds to the JSON property `nfsExportOptions` # @return [Array] attr_accessor :nfs_export_options @@ -92,10 +89,9 @@ module Google include Google::Apis::Core::Hashable # consumer_defined_name is the name that is set by the consumer. On the other - # hand Name field represents system-assigned id of an instance so consumers - # are not necessarily aware of it. - # consumer_defined_name is used for notification/UI purposes for consumer to - # recognize their instances. + # hand Name field represents system-assigned id of an instance so consumers are + # not necessarily aware of it. consumer_defined_name is used for notification/UI + # purposes for consumer to recognize their instances. # Corresponds to the JSON property `consumerDefinedName` # @return [String] attr_accessor :consumer_defined_name @@ -105,18 +101,17 @@ module Google # @return [String] attr_accessor :create_time - # Optional. Resource labels to represent user provided metadata. Each label - # is a key-value pair, where both the key and the value are arbitrary strings + # Optional. Resource labels to represent user provided metadata. Each label is a + # key-value pair, where both the key and the value are arbitrary strings # provided by the user. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The MaintenancePolicies that have been attached to the instance. - # The key must be of the type name of the oneof policy name defined in - # MaintenancePolicy, and the referenced policy must define the same policy - # type. For complete details of MaintenancePolicy, please refer to - # go/cloud-saas-mw-ug. + # The MaintenancePolicies that have been attached to the instance. The key must + # be of the type name of the oneof policy name defined in MaintenancePolicy, and + # the referenced policy must define the same policy type. For complete details + # of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. # Corresponds to the JSON property `maintenancePolicyNames` # @return [Hash] attr_accessor :maintenance_policy_names @@ -133,29 +128,28 @@ module Google # @return [Google::Apis::FileV1beta1::GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings] attr_accessor :maintenance_settings - # Unique name of the resource. It uses the form: - # `projects/`project_id`/locations/`location_id`/instances/`instance_id`` + # Unique name of the resource. It uses the form: `projects/`project_id`/ + # locations/`location_id`/instances/`instance_id`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Output only. Custom string attributes used primarily to expose - # producer-specific information in monitoring dashboards. - # See go/get-instance-metadata. + # Output only. Custom string attributes used primarily to expose producer- + # specific information in monitoring dashboards. See go/get-instance-metadata. # Corresponds to the JSON property `producerMetadata` # @return [Hash] attr_accessor :producer_metadata - # Output only. The list of data plane resources provisioned for this - # instance, e.g. compute VMs. See go/get-instance-metadata. + # Output only. The list of data plane resources provisioned for this instance, e. + # g. compute VMs. See go/get-instance-metadata. # Corresponds to the JSON property `provisionedResources` # @return [Array] attr_accessor :provisioned_resources - # Link to the SLM instance template. Only populated when updating SLM - # instances via SSA's Actuation service adaptor. - # Service producers with custom control plane (e.g. Cloud SQL) doesn't - # need to populate this field. Instead they should use software_versions. + # Link to the SLM instance template. Only populated when updating SLM instances + # via SSA's Actuation service adaptor. Service producers with custom control + # plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they + # should use software_versions. # Corresponds to the JSON property `slmInstanceTemplate` # @return [String] attr_accessor :slm_instance_template @@ -166,8 +160,8 @@ module Google # @return [Google::Apis::FileV1beta1::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata] attr_accessor :slo_metadata - # Software versions that are used to deploy this instance. This can be - # mutated by rollout services. + # Software versions that are used to deploy this instance. This can be mutated + # by rollout services. # Corresponds to the JSON property `softwareVersions` # @return [Hash] attr_accessor :software_versions @@ -178,8 +172,8 @@ module Google # @return [String] attr_accessor :state - # Output only. ID of the associated GCP tenant project. - # See go/get-instance-metadata. + # Output only. ID of the associated GCP tenant project. See go/get-instance- + # metadata. # Corresponds to the JSON property `tenantProjectId` # @return [String] attr_accessor :tenant_project_id @@ -218,9 +212,9 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule include Google::Apis::Core::Hashable - # Can this scheduled update be rescheduled? - # By default, it's true and API needs to do explicitly check whether it's - # set, if it's set as false explicitly, it's false + # Can this scheduled update be rescheduled? By default, it's true and API needs + # to do explicitly check whether it's set, if it's set as false explicitly, it's + # false # Corresponds to the JSON property `canReschedule` # @return [Boolean] attr_accessor :can_reschedule @@ -231,9 +225,9 @@ module Google # @return [String] attr_accessor :end_time - # The rollout management policy this maintenance schedule is associated - # with. When doing reschedule update request, the reschedule should be - # against this given policy. + # The rollout management policy this maintenance schedule is associated with. + # When doing reschedule update request, the reschedule should be against this + # given policy. # Corresponds to the JSON property `rolloutManagementPolicy` # @return [String] attr_accessor :rollout_management_policy @@ -262,8 +256,7 @@ module Google include Google::Apis::Core::Hashable # Optional. Exclude instance from maintenance. When true, rollout service will - # not - # attempt maintenance on the instance. Rollout service will include the + # not attempt maintenance on the instance. Rollout service will include the # instance in reported rollout progress as not attempted. # Corresponds to the JSON property `exclude` # @return [Boolean] @@ -280,18 +273,17 @@ module Google end end - # Node information for custom per-node SLO implementations. - # SSA does not support per-node SLO, but producers can populate per-node - # information in SloMetadata for custom precomputations. - # SSA Eligibility Exporter will emit per-node metric based on this information. + # Node information for custom per-node SLO implementations. SSA does not support + # per-node SLO, but producers can populate per-node information in SloMetadata + # for custom precomputations. SSA Eligibility Exporter will emit per-node metric + # based on this information. class GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata include Google::Apis::Core::Hashable - # By default node is eligible if instance is eligible. - # But individual node might be excluded from SLO by adding entry here. - # For semantic see SloMetadata.exclusions. - # If both instance and node level exclusions are present for time period, - # the node level's reason will be reported by Eligibility Exporter. + # By default node is eligible if instance is eligible. But individual node might + # be excluded from SLO by adding entry here. For semantic see SloMetadata. + # exclusions. If both instance and node level exclusions are present for time + # period, the node level's reason will be reported by Eligibility Exporter. # Corresponds to the JSON property `exclusions` # @return [Array] attr_accessor :exclusions @@ -301,8 +293,7 @@ module Google # @return [String] attr_accessor :location - # The id of the node. - # This should be equal to SaasInstanceNode.node_id. + # The id of the node. This should be equal to SaasInstanceNode.node_id. # Corresponds to the JSON property `nodeId` # @return [String] attr_accessor :node_id @@ -323,18 +314,17 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource include Google::Apis::Core::Hashable - # Type of the resource. This can be either a GCP resource or a custom one - # (e.g. another cloud provider's VM). For GCP compute resources use singular - # form of the names listed in GCP compute API documentation - # (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with - # 'compute-', for example: 'compute-instance', 'compute-disk', - # 'compute-autoscaler'. + # Type of the resource. This can be either a GCP resource or a custom one (e.g. + # another cloud provider's VM). For GCP compute resources use singular form of + # the names listed in GCP compute API documentation (https://cloud.google.com/ + # compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: ' + # compute-instance', 'compute-disk', 'compute-autoscaler'. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type - # URL identifying the resource, e.g. - # "https://www.googleapis.com/compute/v1/projects/...)". + # URL identifying the resource, e.g. "https://www.googleapis.com/compute/v1/ + # projects/...)". # Corresponds to the JSON property `resourceUrl` # @return [String] attr_accessor :resource_url @@ -350,9 +340,9 @@ module Google end end - # SloEligibility is a tuple containing eligibility value: true if an instance - # is eligible for SLO calculation or false if it should be excluded from all - # SLO-related calculations along with a user-defined reason. + # SloEligibility is a tuple containing eligibility value: true if an instance is + # eligible for SLO calculation or false if it should be excluded from all SLO- + # related calculations along with a user-defined reason. class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility include Google::Apis::Core::Hashable @@ -363,8 +353,7 @@ module Google alias_method :eligible?, :eligible # User-defined reason for the current value of instance eligibility. Usually, - # this can be directly mapped to the internal state. An empty reason is - # allowed. + # this can be directly mapped to the internal state. An empty reason is allowed. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -384,28 +373,27 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion include Google::Apis::Core::Hashable - # Exclusion duration. No restrictions on the possible values. - # When an ongoing operation is taking longer than initially expected, - # an existing entry in the exclusion list can be updated by extending the - # duration. This is supported by the subsystem exporting eligibility data - # as long as such extension is committed at least 10 minutes before the - # original exclusion expiration - otherwise it is possible that there will - # be "gaps" in the exclusion application in the exported timeseries. + # Exclusion duration. No restrictions on the possible values. When an ongoing + # operation is taking longer than initially expected, an existing entry in the + # exclusion list can be updated by extending the duration. This is supported by + # the subsystem exporting eligibility data as long as such extension is + # committed at least 10 minutes before the original exclusion expiration - + # otherwise it is possible that there will be "gaps" in the exclusion + # application in the exported timeseries. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # Human-readable reason for the exclusion. - # This should be a static string (e.g. "Disruptive update in progress") - # and should not contain dynamically generated data (e.g. instance name). - # Can be left empty. + # Human-readable reason for the exclusion. This should be a static string (e.g. " + # Disruptive update in progress") and should not contain dynamically generated + # data (e.g. instance name). Can be left empty. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason - # Name of an SLI that this exclusion applies to. Can be left empty, - # signaling that the instance should be excluded from all SLIs defined - # in the service SLO configuration. + # Name of an SLI that this exclusion applies to. Can be left empty, signaling + # that the instance should be excluded from all SLIs defined in the service SLO + # configuration. # Corresponds to the JSON property `sliName` # @return [String] attr_accessor :sli_name @@ -433,40 +421,38 @@ module Google class GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata include Google::Apis::Core::Hashable - # SloEligibility is a tuple containing eligibility value: true if an instance - # is eligible for SLO calculation or false if it should be excluded from all - # SLO-related calculations along with a user-defined reason. + # SloEligibility is a tuple containing eligibility value: true if an instance is + # eligible for SLO calculation or false if it should be excluded from all SLO- + # related calculations along with a user-defined reason. # Corresponds to the JSON property `eligibility` # @return [Google::Apis::FileV1beta1::GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility] attr_accessor :eligibility - # List of SLO exclusion windows. When multiple entries in the list match - # (matching the exclusion time-window against current time point) - # the exclusion reason used in the first matching entry will be published. - # It is not needed to include expired exclusion in this list, as only the - # currently applicable exclusions are taken into account by the eligibility - # exporting subsystem (the historical state of exclusions will be reflected - # in the historically produced timeseries regardless of the current state). - # This field can be used to mark the instance as temporary ineligible - # for the purpose of SLO calculation. For permanent instance SLO exclusion, - # use of custom instance eligibility is recommended. See 'eligibility' field - # below. + # List of SLO exclusion windows. When multiple entries in the list match ( + # matching the exclusion time-window against current time point) the exclusion + # reason used in the first matching entry will be published. It is not needed to + # include expired exclusion in this list, as only the currently applicable + # exclusions are taken into account by the eligibility exporting subsystem (the + # historical state of exclusions will be reflected in the historically produced + # timeseries regardless of the current state). This field can be used to mark + # the instance as temporary ineligible for the purpose of SLO calculation. For + # permanent instance SLO exclusion, use of custom instance eligibility is + # recommended. See 'eligibility' field below. # Corresponds to the JSON property `exclusions` # @return [Array] attr_accessor :exclusions - # Optional. List of nodes. - # Some producers need to use per-node metadata to calculate SLO. - # This field allows such producers to publish per-node SLO meta data, - # which will be consumed by SSA Eligibility Exporter and published in the + # Optional. List of nodes. Some producers need to use per-node metadata to + # calculate SLO. This field allows such producers to publish per-node SLO meta + # data, which will be consumed by SSA Eligibility Exporter and published in the # form of per node metric to Monarch. # Corresponds to the JSON property `nodes` # @return [Array] attr_accessor :nodes # Name of the SLO tier the Instance belongs to. This name will be expected to - # match the tiers specified in the service SLO configuration. - # Field is mandatory and must not be empty. + # match the tiers specified in the service SLO configuration. Field is mandatory + # and must not be empty. # Corresponds to the JSON property `tier` # @return [String] attr_accessor :tier @@ -504,8 +490,8 @@ module Google # @return [String] attr_accessor :etag - # File system shares on the instance. - # For this version, only a single file share is supported. + # File system shares on the instance. For this version, only a single file share + # is supported. # Corresponds to the JSON property `fileShares` # @return [Array] attr_accessor :file_shares @@ -515,14 +501,14 @@ module Google # @return [Hash] attr_accessor :labels - # Output only. The resource name of the instance, in the format - # projects/`project_id`/locations/`location_id`/instances/`instance_id`. + # Output only. The resource name of the instance, in the format projects/` + # project_id`/locations/`location_id`/instances/`instance_id`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # VPC networks to which the instance is connected. - # For this version, only a single network is supported. + # VPC networks to which the instance is connected. For this version, only a + # single network is supported. # Corresponds to the JSON property `networks` # @return [Array] attr_accessor :networks @@ -565,17 +551,17 @@ module Google class ListInstancesResponse include Google::Apis::Core::Hashable - # A list of instances in the project for the specified location. - # If the `location` value in the request is "-", the response contains a list - # of instances from all locations. If any location is unreachable, the - # response will only return instances in reachable locations and the - # "unreachable" field will be populated with a list of unreachable locations. + # A list of instances in the project for the specified location. If the ` + # location` value in the request is "-", the response contains a list of + # instances from all locations. If any location is unreachable, the response + # will only return instances in reachable locations and the "unreachable" field + # will be populated with a list of unreachable locations. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances - # The token you can use to retrieve the next page of results. Not returned - # if there are no more results in the list. + # The token you can use to retrieve the next page of results. Not returned if + # there are no more results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -651,14 +637,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] attr_accessor :labels @@ -674,8 +660,8 @@ module Google # @return [Hash] 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 @@ -698,34 +684,31 @@ module Google class NetworkConfig include Google::Apis::Core::Hashable - # Output only. IPv4 addresses in the format - # `octet 1`.`octet 2`.`octet 3`.`octet 4` or IPv6 addresses in the format - # `block 1`:`block 2`:`block 3`:`block 4`:`block 5`:`block 6`:`block - # 7`:`block 8`. + # Output only. IPv4 addresses in the format `octet 1`.`octet 2`.`octet 3`.`octet + # 4` or IPv6 addresses in the format `block 1`:`block 2`:`block 3`:`block 4`:` + # block 5`:`block 6`:`block 7`:`block 8`. # Corresponds to the JSON property `ipAddresses` # @return [Array] attr_accessor :ip_addresses - # Internet protocol versions for which the instance has IP addresses - # assigned. For this version, only MODE_IPV4 is supported. + # Internet protocol versions for which the instance has IP addresses assigned. + # For this version, only MODE_IPV4 is supported. # Corresponds to the JSON property `modes` # @return [Array] attr_accessor :modes - # The name of the Google Compute Engine - # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the - # instance is connected. + # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and- + # firewalls#networks) to which the instance is connected. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network - # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the - # [internal IP address - # ranges](https://www.arin.net/knowledge/address_filters.html) that - # identifies the range of IP addresses reserved for this instance. For - # example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap - # with either existing subnets or assigned IP address ranges for other Cloud - # Filestore instances in the selected VPC network. + # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [ + # internal IP address ranges](https://www.arin.net/knowledge/address_filters. + # html) that identifies the range of IP addresses reserved for this instance. + # For example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't + # overlap with either existing subnets or assigned IP address ranges for other + # Cloud Filestore instances in the selected VPC network. # Corresponds to the JSON property `reservedIpRange` # @return [String] attr_accessor :reserved_ip_range @@ -747,44 +730,39 @@ module Google class NfsExportOptions include Google::Apis::Core::Hashable - # Either READ_ONLY, for allowing only read requests on the exported - # directory, or READ_WRITE, for allowing both read and write requests. - # The default is READ_WRITE. + # Either READ_ONLY, for allowing only read requests on the exported directory, + # or READ_WRITE, for allowing both read and write requests. The default is + # READ_WRITE. # Corresponds to the JSON property `accessMode` # @return [String] attr_accessor :access_mode - # An integer representing the anonymous group id with a default value of - # 65534. - # Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be + # An integer representing the anonymous group id with a default value of 65534. + # Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be # returned if this field is specified for other squash_mode settings. # Corresponds to the JSON property `anonGid` # @return [Fixnum] attr_accessor :anon_gid - # An integer representing the anonymous user id with a default value of - # 65534. - # Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be + # An integer representing the anonymous user id with a default value of 65534. + # Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be # returned if this field is specified for other squash_mode settings. # Corresponds to the JSON property `anonUid` # @return [Fixnum] attr_accessor :anon_uid - # List of either an IPv4 addresses in the format - # `octet 1`.`octet 2`.`octet 3`.`octet 4` or CIDR ranges in the format - # `octet 1`.`octet 2`.`octet 3`.`octet 4`/`mask size` which may mount the - # file share. - # Overlapping IP ranges are not allowed, both within and across - # NfsExportOptions. An error will be returned. + # List of either an IPv4 addresses in the format `octet 1`.`octet 2`.`octet 3`.` + # octet 4` or CIDR ranges in the format `octet 1`.`octet 2`.`octet 3`.`octet 4`/` + # mask size` which may mount the file share. Overlapping IP ranges are not + # allowed, both within and across NfsExportOptions. An error will be returned. # The limit is 64 IP ranges/addresses for each FileShareConfig among all # NfsExportOptions. # Corresponds to the JSON property `ipRanges` # @return [Array] attr_accessor :ip_ranges - # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, - # or ROOT_SQUASH, for not allowing root access. The default is - # NO_ROOT_SQUASH. + # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or + # ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. # Corresponds to the JSON property `squashMode` # @return [String] attr_accessor :squash_mode @@ -808,47 +786,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::FileV1beta1::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] 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] attr_accessor :response @@ -876,10 +852,10 @@ module Google # @return [String] attr_accessor :api_version - # [Output only] Identifies whether the user has requested cancellation - # of the operation. Operations that have successfully been cancelled - # have Operation.error value with a google.rpc.Status.code of 1, - # corresponding to `Code.CANCELLED`. + # [Output only] Identifies whether the user has requested cancellation of the + # operation. Operations that have successfully been cancelled have Operation. + # error value with a google.rpc.Status.code of 1, corresponding to `Code. + # CANCELLED`. # Corresponds to the JSON property `cancelRequested` # @return [Boolean] attr_accessor :cancel_requested @@ -926,12 +902,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 @@ -940,15 +916,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>] 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 diff --git a/generated/google/apis/file_v1beta1/service.rb b/generated/google/apis/file_v1beta1/service.rb index d30d8e2d0..227612bbb 100644 --- a/generated/google/apis/file_v1beta1/service.rb +++ b/generated/google/apis/file_v1beta1/service.rb @@ -83,8 +83,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 @@ -122,15 +121,15 @@ module Google # Creates an instance. # @param [String] parent - # Required. The instance's project and location, in the format - # projects/`project_id`/locations/`location`. In Cloud Filestore, - # locations map to GCP zones, for example **us-west1-b**. + # Required. The instance's project and location, in the format projects/` + # project_id`/locations/`location`. In Cloud Filestore, locations map to GCP + # zones, for example **us-west1-b**. # @param [Google::Apis::FileV1beta1::Instance] instance_object # @param [String] instance_id - # Required. The ID of the instance to create. - # The ID must be unique within the specified project and location. - # This value must start with a lowercase letter followed by up to 62 - # lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + # Required. The ID of the instance to create. The ID must be unique within the + # specified project and location. This value must start with a lowercase letter + # followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end + # with a hyphen. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -163,8 +162,8 @@ module Google # Deletes an instance. # @param [String] name - # Required. The instance resource name, in the format - # projects/`project_id`/locations/`location`/instances/`instance_id` + # Required. The instance resource name, in the format projects/`project_id`/ + # locations/`location`/instances/`instance_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -194,8 +193,8 @@ module Google # Gets the details of a specific instance. # @param [String] name - # Required. The instance resource name, in the format - # projects/`project_id`/locations/`location`/instances/`instance_id`. + # Required. The instance resource name, in the format projects/`project_id`/ + # locations/`location`/instances/`instance_id`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -223,14 +222,13 @@ module Google execute_or_queue_command(command, &block) end - # Lists all instances in a project for either a specified location - # or for all locations. + # Lists all instances in a project for either a specified location or for all + # locations. # @param [String] parent # Required. The project and location for which to retrieve instance information, - # in the format projects/`project_id`/locations/`location`. In Cloud - # Filestore, locations map to GCP zones, for example **us-west1-b**. To - # retrieve instance information for all locations, use "-" for the `location` - # value. + # in the format projects/`project_id`/locations/`location`. In Cloud Filestore, + # locations map to GCP zones, for example **us-west1-b**. To retrieve instance + # information for all locations, use "-" for the `location` value. # @param [String] filter # List filter. # @param [String] order_by @@ -238,8 +236,8 @@ module Google # @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 @@ -273,17 +271,13 @@ module Google # Updates the settings of a specific instance. # @param [String] name - # Output only. The resource name of the instance, in the format - # projects/`project_id`/locations/`location_id`/instances/`instance_id`. + # Output only. The resource name of the instance, in the format projects/` + # project_id`/locations/`location_id`/instances/`instance_id`. # @param [Google::Apis::FileV1beta1::Instance] instance_object # @param [String] update_mask - # Required. Mask of fields to update. At least one path must be supplied in - # this - # field. The elements of the repeated paths field may only include these - # fields: - # * "description" - # * "file_shares" - # * "labels" + # Required. Mask of fields to update. At least one path must be supplied in this + # field. The elements of the repeated paths field may only include these fields: + # * "description" * "file_shares" * "labels" # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -314,15 +308,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. @@ -356,10 +348,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 @@ -389,9 +381,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 @@ -421,15 +412,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 diff --git a/generated/google/apis/firebaserules_v1.rb b/generated/google/apis/firebaserules_v1.rb index 35c90fcd1..92d452b72 100644 --- a/generated/google/apis/firebaserules_v1.rb +++ b/generated/google/apis/firebaserules_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://firebase.google.com/docs/storage/security module FirebaserulesV1 VERSION = 'V1' - REVISION = '20200303' + REVISION = '20200807' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firebaserules_v1/classes.rb b/generated/google/apis/firebaserules_v1/classes.rb index 0f0ac1ab8..1b49cc865 100644 --- a/generated/google/apis/firebaserules_v1/classes.rb +++ b/generated/google/apis/firebaserules_v1/classes.rb @@ -26,13 +26,11 @@ module Google class Arg 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 `anyValue` # @return [Google::Apis::FirebaserulesV1::Empty] attr_accessor :any_value @@ -53,13 +51,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 @@ -72,8 +68,8 @@ module Google end end - # Describes where in a file an expression is found and what it was - # evaluated to over the course of its use. + # Describes where in a file an expression is found and what it was evaluated to + # over the course of its use. class ExpressionReport include Google::Apis::Core::Hashable @@ -163,26 +159,24 @@ module Google end end - # Mock function definition. - # Mocks must refer to a function declared by the target service. The type of - # the function args and result will be inferred at test time. If either the - # arg or result values are not compatible with function type declaration, the - # request will be considered invalid. - # More than one `FunctionMock` may be provided for a given function name so - # long as the `Arg` matchers are distinct. There may be only one function - # for a given overload where all `Arg` values are `Arg.any_value`. + # Mock function definition. Mocks must refer to a function declared by the + # target service. The type of the function args and result will be inferred at + # test time. If either the arg or result values are not compatible with function + # type declaration, the request will be considered invalid. More than one ` + # FunctionMock` may be provided for a given function name so long as the `Arg` + # matchers are distinct. There may be only one function for a given overload + # where all `Arg` values are `Arg.any_value`. class FunctionMock include Google::Apis::Core::Hashable # The list of `Arg` values to match. The order in which the arguments are - # provided is the order in which they must appear in the function - # invocation. + # provided is the order in which they must appear in the function invocation. # Corresponds to the JSON property `args` # @return [Array] attr_accessor :args - # The name of the function. - # The function name must match one provided by a service declaration. + # The name of the function. The function name must match one provided by a + # service declaration. # Corresponds to the JSON property `function` # @return [String] attr_accessor :function @@ -229,9 +223,8 @@ module Google # @return [String] attr_accessor :ruleset_name - # Optional, indicates the freshness of the result. The response is - # guaranteed to be the latest within an interval up to the - # sync_time (inclusive). + # Optional, indicates the freshness of the result. The response is guaranteed to + # be the latest within an interval up to the sync_time (inclusive). # Corresponds to the JSON property `syncTime` # @return [String] attr_accessor :sync_time @@ -344,8 +337,8 @@ module Google class Metadata include Google::Apis::Core::Hashable - # Services that this ruleset has declarations for (e.g., - # "cloud.firestore"). There may be 0+ of these. + # Services that this ruleset has declarations for (e.g., "cloud.firestore"). + # There may be 0+ of these. # Corresponds to the JSON property `services` # @return [Array] attr_accessor :services @@ -360,48 +353,42 @@ module Google end end - # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a - # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`. + # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a ` + # Ruleset`, rules-enabled services will be able to enforce the `Ruleset`. class Release include Google::Apis::Core::Hashable - # Time the release was created. - # Output only. + # Time the release was created. Output only. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # Resource name for the `Release`. - # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2` - # which affords developers a great deal of flexibility in mapping the name - # to the style that best fits their existing development practices. For - # example, a name could refer to an environment, an app, a version, or some - # combination of three. - # In the table below, for the project name `projects/foo`, the following - # relative release paths show how flat and structured names might be chosen - # to match a desired development / deployment strategy. - # Use Case | Flat Name | Structured Name - # -------------|---------------------|---------------- - # Environments | releases/qa | releases/qa - # Apps | releases/app1_qa | releases/app1/qa - # Versions | releases/app1_v2_qa | releases/app1/v2/qa - # The delimiter between the release name path elements can be almost anything - # and it should work equally well with the release name list filter, but in - # many ways the structured paths provide a clearer picture of the - # relationship between `Release` instances. - # Format: `projects/`project_id`/releases/`release_id`` + # Resource name for the `Release`. `Release` names may be structured `app1/prod/ + # v2` or flat `app1_prod_v2` which affords developers a great deal of + # flexibility in mapping the name to the style that best fits their existing + # development practices. For example, a name could refer to an environment, an + # app, a version, or some combination of three. In the table below, for the + # project name `projects/foo`, the following relative release paths show how + # flat and structured names might be chosen to match a desired development / + # deployment strategy. Use Case | Flat Name | Structured Name -------------|----- + # ----------------|---------------- Environments | releases/qa | releases/qa + # Apps | releases/app1_qa | releases/app1/qa Versions | releases/app1_v2_qa | + # releases/app1/v2/qa The delimiter between the release name path elements can + # be almost anything and it should work equally well with the release name list + # filter, but in many ways the structured paths provide a clearer picture of the + # relationship between `Release` instances. Format: `projects/`project_id`/ + # releases/`release_id`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must - # exist the `Release` to be created. + # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist + # the `Release` to be created. # Corresponds to the JSON property `rulesetName` # @return [String] attr_accessor :ruleset_name - # Time the release was updated. - # Output only. + # Time the release was updated. Output only. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -423,19 +410,17 @@ module Google class Result 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 `undefined` # @return [Google::Apis::FirebaserulesV1::Empty] attr_accessor :undefined - # The result is an actual value. The type of the value must match that - # of the type declared by the service. + # The result is an actual value. The type of the value must match that of the + # type declared by the service. # Corresponds to the JSON property `value` # @return [Object] attr_accessor :value @@ -456,8 +441,7 @@ module Google class Ruleset include Google::Apis::Core::Hashable - # Time the `Ruleset` was created. - # Output only. + # Time the `Ruleset` was created. Output only. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -467,9 +451,8 @@ module Google # @return [Google::Apis::FirebaserulesV1::Metadata] attr_accessor :metadata - # Name of the `Ruleset`. The ruleset_id is auto generated by the service. - # Format: `projects/`project_id`/rulesets/`ruleset_id`` - # Output only. + # Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format: + # `projects/`project_id`/rulesets/`ruleset_id`` Output only. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -557,11 +540,10 @@ module Google # `TestCase` messages provide the request context and an expectation as to # whether the given context will be allowed or denied. Test cases may specify - # the `request`, `resource`, and `function_mocks` to mock a function call to - # a service-provided function. - # The `request` object represents context present at request-time. - # The `resource` is the value of the target resource as it appears in - # persistent storage before the request is executed. + # the `request`, `resource`, and `function_mocks` to mock a function call to a + # service-provided function. The `request` object represents context present at + # request-time. The `resource` is the value of the target resource as it appears + # in persistent storage before the request is executed. class TestCase include Google::Apis::Core::Hashable @@ -575,9 +557,9 @@ module Google # @return [String] attr_accessor :expression_report_level - # Optional function mocks for service-defined functions. If not set, any - # service defined function is expected to return an error, which may or may - # not influence the test outcome. + # Optional function mocks for service-defined functions. If not set, any service + # defined function is expected to return an error, which may or may not + # influence the test outcome. # Corresponds to the JSON property `functionMocks` # @return [Array] attr_accessor :function_mocks @@ -587,29 +569,20 @@ module Google # @return [String] attr_accessor :path_encoding - # Request context. - # The exact format of the request context is service-dependent. See the - # appropriate service documentation for information about the supported - # fields and types on the request. Minimally, all services support the - # following fields and types: - # Request field | Type - # ---------------|----------------- - # auth.uid | `string` - # auth.token | `map` - # headers | `map` - # method | `string` - # params | `map` - # path | `string` - # time | `google.protobuf.Timestamp` - # If the request value is not well-formed for the service, the request will - # be rejected as an invalid argument. + # Request context. The exact format of the request context is service-dependent. + # See the appropriate service documentation for information about the supported + # fields and types on the request. Minimally, all services support the following + # fields and types: Request field | Type ---------------|----------------- auth. + # uid | `string` auth.token | `map` headers | `map` method | `string` params | ` + # map` path | `string` time | `google.protobuf.Timestamp` If the request value + # is not well-formed for the service, the request will be rejected as an invalid + # argument. # Corresponds to the JSON property `request` # @return [Object] attr_accessor :request - # Optional resource value as it appears in persistent storage before the - # request is fulfilled. - # The resource type depends on the `request.path` value. + # Optional resource value as it appears in persistent storage before the request + # is fulfilled. The resource type depends on the `request.path` value. # Corresponds to the JSON property `resource` # @return [Object] attr_accessor :resource @@ -629,16 +602,15 @@ module Google end end - # Test result message containing the state of the test as well as a - # description and source position for test failures. + # Test result message containing the state of the test as well as a description + # and source position for test failures. class TestResult include Google::Apis::Core::Hashable - # Debug messages related to test execution issues encountered during - # evaluation. - # Debug messages may be related to too many or too few invocations of - # function mocks or to runtime errors that occur during evaluation. - # For example: ```Unable to read variable [name: "resource"]``` + # Debug messages related to test execution issues encountered during evaluation. + # Debug messages may be related to too many or too few invocations of function + # mocks or to runtime errors that occur during evaluation. For example: ``` + # Unable to read variable [name: "resource"]``` # Corresponds to the JSON property `debugMessages` # @return [Array] attr_accessor :debug_messages @@ -650,18 +622,17 @@ module Google attr_accessor :error_position # The mapping from expression in the ruleset AST to the values they were - # evaluated to. Partially-nested to mirror AST structure. Note that this - # field is actually tracking expressions and not permission statements in - # contrast to the "visited_expressions" field above. Literal expressions - # are omitted. + # evaluated to. Partially-nested to mirror AST structure. Note that this field + # is actually tracking expressions and not permission statements in contrast to + # the "visited_expressions" field above. Literal expressions are omitted. # Corresponds to the JSON property `expressionReports` # @return [Array] attr_accessor :expression_reports - # The set of function calls made to service-defined methods. - # Function calls are included in the order in which they are encountered - # during evaluation, are provided for both mocked and unmocked functions, - # and included on the response regardless of the test `state`. + # The set of function calls made to service-defined methods. Function calls are + # included in the order in which they are encountered during evaluation, are + # provided for both mocked and unmocked functions, and included on the response + # regardless of the test `state`. # Corresponds to the JSON property `functionCalls` # @return [Array] attr_accessor :function_calls @@ -671,16 +642,11 @@ module Google # @return [String] attr_accessor :state - # The set of visited permission expressions for a given test. This returns - # the positions and evaluation results of all visited permission - # expressions which were relevant to the test case, e.g. - # ``` - # match /path ` - # allow read if: - # ` - # ``` - # For a detailed report of the intermediate evaluation states, see the - # `expression_reports` field + # The set of visited permission expressions for a given test. This returns the + # positions and evaluation results of all visited permission expressions which + # were relevant to the test case, e.g. ``` match /path ` allow read if: ` ``` + # For a detailed report of the intermediate evaluation states, see the ` + # expression_reports` field # Corresponds to the JSON property `visitedExpressions` # @return [Array] attr_accessor :visited_expressions @@ -710,8 +676,8 @@ module Google attr_accessor :source # `TestSuite` is a collection of `TestCase` instances that validate the logical - # correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within - # a `TestRuleset` invocation or as part of a `Release` object as a pre-release + # correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within a + # `TestRuleset` invocation or as part of a `Release` object as a pre-release # check. # Corresponds to the JSON property `testSuite` # @return [Google::Apis::FirebaserulesV1::TestSuite] @@ -732,15 +698,14 @@ module Google class TestRulesetResponse include Google::Apis::Core::Hashable - # Syntactic and semantic `Source` issues of varying severity. Issues of - # `ERROR` severity will prevent tests from executing. + # Syntactic and semantic `Source` issues of varying severity. Issues of `ERROR` + # severity will prevent tests from executing. # Corresponds to the JSON property `issues` # @return [Array] attr_accessor :issues - # The set of test results given the test cases in the `TestSuite`. - # The results will appear in the same order as the test cases appear in the - # `TestSuite`. + # The set of test results given the test cases in the `TestSuite`. The results + # will appear in the same order as the test cases appear in the `TestSuite`. # Corresponds to the JSON property `testResults` # @return [Array] attr_accessor :test_results @@ -757,8 +722,8 @@ module Google end # `TestSuite` is a collection of `TestCase` instances that validate the logical - # correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within - # a `TestRuleset` invocation or as part of a `Release` object as a pre-release + # correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within a + # `TestRuleset` invocation or as part of a `Release` object as a pre-release # check. class TestSuite include Google::Apis::Core::Hashable @@ -782,8 +747,8 @@ module Google class UpdateReleaseRequest include Google::Apis::Core::Hashable - # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a - # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`. + # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a ` + # Ruleset`, rules-enabled services will be able to enforce the `Ruleset`. # Corresponds to the JSON property `release` # @return [Google::Apis::FirebaserulesV1::Release] attr_accessor :release diff --git a/generated/google/apis/firebaserules_v1/service.rb b/generated/google/apis/firebaserules_v1/service.rb index 27d8d1899..d285497aa 100644 --- a/generated/google/apis/firebaserules_v1/service.rb +++ b/generated/google/apis/firebaserules_v1/service.rb @@ -48,30 +48,22 @@ module Google @batch_path = 'batch' end - # Test `Source` for syntactic and semantic correctness. Issues present, if - # any, will be returned to the caller with a description, severity, and - # source location. - # The test method may be executed with `Source` or a `Ruleset` name. + # Test `Source` for syntactic and semantic correctness. Issues present, if any, + # will be returned to the caller with a description, severity, and source + # location. The test method may be executed with `Source` or a `Ruleset` name. # Passing `Source` is useful for unit testing new rules. Passing a `Ruleset` - # name is useful for regression testing an existing rule. - # The following is an example of `Source` that permits users to upload images - # to a bucket bearing their user id and matching the correct metadata: - # _*Example*_ - # // Users are allowed to subscribe and unsubscribe to the blog. - # service firebase.storage ` - # match /users/`userId`/images/`imageName` ` - # allow write: if userId == request.auth.uid - # && (imageName.matches('*.png$') - # || imageName.matches('*.jpg$')) - # && resource.mimeType.matches('^image/') - # ` - # ` + # name is useful for regression testing an existing rule. The following is an + # example of `Source` that permits users to upload images to a bucket bearing + # their user id and matching the correct metadata: _*Example*_ // Users are + # allowed to subscribe and unsubscribe to the blog. service firebase.storage ` + # match /users/`userId`/images/`imageName` ` allow write: if userId == request. + # auth.uid && (imageName.matches('*.png$') || imageName.matches('*.jpg$')) && + # resource.mimeType.matches('^image/') ` ` # @param [String] name - # Tests may either provide `source` or a `Ruleset` resource name. - # For tests against `source`, the resource name must refer to the project: - # Format: `projects/`project_id`` - # For tests against a `Ruleset`, this must be the `Ruleset` resource name: - # Format: `projects/`project_id`/rulesets/`ruleset_id`` + # Tests may either provide `source` or a `Ruleset` resource name. For tests + # against `source`, the resource name must refer to the project: Format: ` + # projects/`project_id`` For tests against a `Ruleset`, this must be the ` + # Ruleset` resource name: Format: `projects/`project_id`/rulesets/`ruleset_id`` # @param [Google::Apis::FirebaserulesV1::TestRulesetRequest] test_ruleset_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -102,27 +94,23 @@ module Google execute_or_queue_command(command, &block) end - # Create a `Release`. - # Release names should reflect the developer's deployment practices. For - # example, the release name may include the environment name, application - # name, application version, or any other name meaningful to the developer. - # Once a `Release` refers to a `Ruleset`, the rules can be enforced by - # Firebase Rules-enabled services. - # More than one `Release` may be 'live' concurrently. Consider the following - # three `Release` names for `projects/foo` and the `Ruleset` to which they - # refer. - # Release Name | Ruleset Name - # --------------------------------|------------- - # projects/foo/releases/prod | projects/foo/rulesets/uuid123 - # projects/foo/releases/prod/beta | projects/foo/rulesets/uuid123 - # projects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456 - # The table reflects the `Ruleset` rollout in progress. The `prod` and - # `prod/beta` releases refer to the same `Ruleset`. However, `prod/v23` - # refers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be - # updated using the UpdateRelease method. + # Create a `Release`. Release names should reflect the developer's deployment + # practices. For example, the release name may include the environment name, + # application name, application version, or any other name meaningful to the + # developer. Once a `Release` refers to a `Ruleset`, the rules can be enforced + # by Firebase Rules-enabled services. More than one `Release` may be 'live' + # concurrently. Consider the following three `Release` names for `projects/foo` + # and the `Ruleset` to which they refer. Release Name | Ruleset Name ------------ + # --------------------|------------- projects/foo/releases/prod | projects/foo/ + # rulesets/uuid123 projects/foo/releases/prod/beta | projects/foo/rulesets/ + # uuid123 projects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456 The + # table reflects the `Ruleset` rollout in progress. The `prod` and `prod/beta` + # releases refer to the same `Ruleset`. However, `prod/v23` refers to a new ` + # Ruleset`. The `Ruleset` reference for a `Release` may be updated using the + # UpdateRelease method. # @param [String] name - # Resource name for the project which owns this `Release`. - # Format: `projects/`project_id`` + # Resource name for the project which owns this `Release`. Format: `projects/` + # project_id`` # @param [Google::Apis::FirebaserulesV1::Release] release_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -155,8 +143,8 @@ module Google # Delete a `Release` by resource name. # @param [String] name - # Resource name for the `Release` to delete. - # Format: `projects/`project_id`/releases/`release_id`` + # Resource name for the `Release` to delete. Format: `projects/`project_id`/ + # releases/`release_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -186,8 +174,8 @@ module Google # Get a `Release` by name. # @param [String] name - # Resource name of the `Release`. - # Format: `projects/`project_id`/releases/`release_id`` + # Resource name of the `Release`. Format: `projects/`project_id`/releases/` + # release_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -217,11 +205,11 @@ module Google # Get the `Release` executable to use when enforcing rules. # @param [String] name - # Resource name of the `Release`. - # Format: `projects/`project_id`/releases/`release_id`` + # Resource name of the `Release`. Format: `projects/`project_id`/releases/` + # release_id`` # @param [String] executable_version - # The requested runtime executable version. - # Defaults to FIREBASE_RULES_EXECUTABLE_V1. + # The requested runtime executable version. Defaults to + # FIREBASE_RULES_EXECUTABLE_V1. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -250,38 +238,32 @@ module Google execute_or_queue_command(command, &block) end - # List the `Release` values for a project. This list may optionally be - # filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any - # combination thereof. + # List the `Release` values for a project. This list may optionally be filtered + # by `Release` name, `Ruleset` name, `TestSuite` name, or any combination + # thereof. # @param [String] name - # Resource name for the project. - # Format: `projects/`project_id`` + # Resource name for the project. Format: `projects/`project_id`` # @param [String] filter - # `Release` filter. The list method supports filters with restrictions on the - # `Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`. - # Example 1: A filter of 'name=prod*' might return `Release`s with names - # within 'projects/foo' prefixed with 'prod': - # Name | Ruleset Name - # ------------------------------|------------- - # projects/foo/releases/prod | projects/foo/rulesets/uuid1234 - # projects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234 - # projects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888 - # Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only - # `Release` instances for 'projects/foo' with names prefixed with 'prod' - # referring to the same `Ruleset` name of 'uuid1234': - # Name | Ruleset Name - # ------------------------------|------------- - # projects/foo/releases/prod | projects/foo/rulesets/1234 - # projects/foo/releases/prod/v1 | projects/foo/rulesets/1234 - # In the examples, the filter parameters refer to the search filters are - # relative to the project. Fully qualified prefixed may also be used. e.g. - # `test_suite_name=projects/foo/testsuites/uuid1` + # `Release` filter. The list method supports filters with restrictions on the ` + # Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`. Example + # 1: A filter of 'name=prod*' might return `Release`s with names within ' + # projects/foo' prefixed with 'prod': Name | Ruleset Name ----------------------- + # -------|------------- projects/foo/releases/prod | projects/foo/rulesets/ + # uuid1234 projects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234 + # projects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888 Example 2: A + # filter of `name=prod* ruleset_name=uuid1234` would return only `Release` + # instances for 'projects/foo' with names prefixed with 'prod' referring to the + # same `Ruleset` name of 'uuid1234': Name | Ruleset Name ------------------------ + # ------|------------- projects/foo/releases/prod | projects/foo/rulesets/1234 + # projects/foo/releases/prod/v1 | projects/foo/rulesets/1234 In the examples, + # the filter parameters refer to the search filters are relative to the project. + # Fully qualified prefixed may also be used. e.g. `test_suite_name=projects/foo/ + # testsuites/uuid1` # @param [Fixnum] page_size - # Page size to load. Maximum of 100. Defaults to 10. - # Note: `page_size` is just a hint and the service may choose to load fewer - # than `page_size` results due to the size of the output. To traverse all of - # the releases, the caller should iterate until the `page_token` on the - # response is empty. + # Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a + # hint and the service may choose to load fewer than `page_size` results due to + # the size of the output. To traverse all of the releases, the caller should + # iterate until the `page_token` on the response is empty. # @param [String] page_token # Next page token for the next batch of `Release` instances. # @param [String] fields @@ -314,13 +296,12 @@ module Google execute_or_queue_command(command, &block) end - # Update a `Release` via PATCH. - # Only updates to the `ruleset_name` and `test_suite_name` fields will be - # honored. `Release` rename is not supported. To create a `Release` use the - # CreateRelease method. + # Update a `Release` via PATCH. Only updates to the `ruleset_name` and ` + # test_suite_name` fields will be honored. `Release` rename is not supported. To + # create a `Release` use the CreateRelease method. # @param [String] name - # Resource name for the project which owns this `Release`. - # Format: `projects/`project_id`` + # Resource name for the project which owns this `Release`. Format: `projects/` + # project_id`` # @param [Google::Apis::FirebaserulesV1::UpdateReleaseRequest] update_release_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -351,14 +332,13 @@ module Google execute_or_queue_command(command, &block) end - # Create a `Ruleset` from `Source`. - # The `Ruleset` is given a unique generated name which is returned to the - # caller. `Source` containing syntactic or semantics errors will result in an - # error response indicating the first error encountered. For a detailed view - # of `Source` issues, use TestRuleset. + # Create a `Ruleset` from `Source`. The `Ruleset` is given a unique generated + # name which is returned to the caller. `Source` containing syntactic or + # semantics errors will result in an error response indicating the first error + # encountered. For a detailed view of `Source` issues, use TestRuleset. # @param [String] name - # Resource name for Project which owns this `Ruleset`. - # Format: `projects/`project_id`` + # Resource name for Project which owns this `Ruleset`. Format: `projects/` + # project_id`` # @param [Google::Apis::FirebaserulesV1::Ruleset] ruleset_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -389,11 +369,11 @@ module Google execute_or_queue_command(command, &block) end - # Delete a `Ruleset` by resource name. - # If the `Ruleset` is referenced by a `Release` the operation will fail. + # Delete a `Ruleset` by resource name. If the `Ruleset` is referenced by a ` + # Release` the operation will fail. # @param [String] name - # Resource name for the ruleset to delete. - # Format: `projects/`project_id`/rulesets/`ruleset_id`` + # Resource name for the ruleset to delete. Format: `projects/`project_id`/ + # rulesets/`ruleset_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -423,8 +403,8 @@ module Google # Get a `Ruleset` by name including the full `Source` contents. # @param [String] name - # Resource name for the ruleset to get. - # Format: `projects/`project_id`/rulesets/`ruleset_id`` + # Resource name for the ruleset to get. Format: `projects/`project_id`/rulesets/` + # ruleset_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -453,23 +433,20 @@ module Google end # List `Ruleset` metadata only and optionally filter the results by `Ruleset` - # name. - # The full `Source` contents of a `Ruleset` may be retrieved with + # name. The full `Source` contents of a `Ruleset` may be retrieved with # GetRuleset. # @param [String] name - # Resource name for the project. - # Format: `projects/`project_id`` + # Resource name for the project. Format: `projects/`project_id`` # @param [String] filter - # `Ruleset` filter. The list method supports filters with restrictions on - # `Ruleset.name`. - # Filters on `Ruleset.create_time` should use the `date` function which - # parses strings that conform to the RFC 3339 date/time specifications. + # `Ruleset` filter. The list method supports filters with restrictions on ` + # Ruleset.name`. Filters on `Ruleset.create_time` should use the `date` function + # which parses strings that conform to the RFC 3339 date/time specifications. # Example: `create_time > date("2017-01-01T00:00:00Z") AND name=UUID-*` # @param [Fixnum] page_size - # Page size to load. Maximum of 100. Defaults to 10. - # Note: `page_size` is just a hint and the service may choose to load less - # than `page_size` due to the size of the output. To traverse all of the - # releases, caller should iterate until the `page_token` is empty. + # Page size to load. Maximum of 100. Defaults to 10. Note: `page_size` is just a + # hint and the service may choose to load less than `page_size` due to the size + # of the output. To traverse all of the releases, caller should iterate until + # the `page_token` is empty. # @param [String] page_token # Next page token for loading the next batch of `Ruleset` instances. # @param [String] fields diff --git a/generated/google/apis/homegraph_v1.rb b/generated/google/apis/homegraph_v1.rb index e6c50261d..2ca2357b8 100644 --- a/generated/google/apis/homegraph_v1.rb +++ b/generated/google/apis/homegraph_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/actions/smarthome/create-app#request-sync module HomegraphV1 VERSION = 'V1' - REVISION = '20200522' + REVISION = '20200810' end end end diff --git a/generated/google/apis/homegraph_v1/classes.rb b/generated/google/apis/homegraph_v1/classes.rb index 47b856b15..73a5bb78f 100644 --- a/generated/google/apis/homegraph_v1/classes.rb +++ b/generated/google/apis/homegraph_v1/classes.rb @@ -75,14 +75,10 @@ module Google # @return [Hash] attr_accessor :attributes - # Custom device attributes stored in Home Graph and provided to your - # smart home Action in each - # [QUERY](https://developers.google.com/assistant/smarthome/reference/intent/ - # query) - # and - # [EXECUTE](https://developers.google.com/assistant/smarthome/reference/intent/ - # execute) - # intent. + # Custom device attributes stored in Home Graph and provided to your smart home + # Action in each [QUERY](https://developers.google.com/assistant/smarthome/ + # reference/intent/query) and [EXECUTE](https://developers.google.com/assistant/ + # smarthome/reference/intent/execute) intent. # Corresponds to the JSON property `customData` # @return [Hash] attr_accessor :custom_data @@ -102,53 +98,48 @@ module Google # @return [Google::Apis::HomegraphV1::DeviceNames] attr_accessor :name - # Indicates whether your smart home Action will report notifications - # to Google for this device via - # ReportStateAndNotification. - # If your smart home Action enables users to control device notifications, - # you should update this field and call - # RequestSyncDevices. + # Indicates whether your smart home Action will report notifications to Google + # for this device via ReportStateAndNotification. If your smart home Action + # enables users to control device notifications, you should update this field + # and call RequestSyncDevices. # Corresponds to the JSON property `notificationSupportedByAgent` # @return [Boolean] attr_accessor :notification_supported_by_agent alias_method :notification_supported_by_agent?, :notification_supported_by_agent - # Alternate IDs associated with this device. - # This is used to identify cloud synced devices enabled for [local - # fulfillment](https://developers.google.com/assistant/smarthome/concepts/local). + # Alternate IDs associated with this device. This is used to identify cloud + # synced devices enabled for [local fulfillment](https://developers.google.com/ + # assistant/smarthome/concepts/local). # Corresponds to the JSON property `otherDeviceIds` # @return [Array] attr_accessor :other_device_ids - # Suggested name for the room where this device is installed. - # Google attempts to use this value during user setup. + # Suggested name for the room where this device is installed. Google attempts to + # use this value during user setup. # Corresponds to the JSON property `roomHint` # @return [String] attr_accessor :room_hint - # Suggested name for the structure where this device is installed. - # Google attempts to use this value during user setup. + # Suggested name for the structure where this device is installed. Google + # attempts to use this value during user setup. # Corresponds to the JSON property `structureHint` # @return [String] attr_accessor :structure_hint - # Traits supported by the device. - # See [device - # traits](https://developers.google.com/assistant/smarthome/traits). + # Traits supported by the device. See [device traits](https://developers.google. + # com/assistant/smarthome/traits). # Corresponds to the JSON property `traits` # @return [Array] attr_accessor :traits - # Hardware type of the device. - # See [device - # types](https://developers.google.com/assistant/smarthome/guides). + # Hardware type of the device. See [device types](https://developers.google.com/ + # assistant/smarthome/guides). # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # Indicates whether your smart home Action will report state of this device - # to Google via - # ReportStateAndNotification. + # Indicates whether your smart home Action will report state of this device to + # Google via ReportStateAndNotification. # Corresponds to the JSON property `willReportState` # @return [Boolean] attr_accessor :will_report_state @@ -244,13 +235,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 @@ -263,8 +252,8 @@ module Google end end - # Request type for the - # [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call. + # Request type for the [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) + # call. class QueryRequest include Google::Apis::Core::Hashable @@ -273,8 +262,8 @@ module Google # @return [String] attr_accessor :agent_user_id - # Required. Inputs containing third-party device IDs for which to - # get the device states. + # Required. Inputs containing third-party device IDs for which to get the device + # states. # Corresponds to the JSON property `inputs` # @return [Array] attr_accessor :inputs @@ -334,35 +323,13 @@ module Google end end - # Response type for the - # [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call. - # This should follow the same format as the Google smart home - # `action.devices.QUERY` - # [response](https://developers.google.com/assistant/smarthome/reference/intent/ - # query). - # # Example - # ```json - # ` - # "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", - # "payload": ` - # "devices": ` - # "123": ` - # "on": true, - # "online": true - # `, - # "456": ` - # "on": true, - # "online": true, - # "brightness": 80, - # "color": ` - # "name": "cerulean", - # "spectrumRGB": 31655 - # ` - # ` - # ` - # ` - # ` - # ``` + # Response type for the [`Query`](#google.home.graph.v1.HomeGraphApiService. + # Query) call. This should follow the same format as the Google smart home ` + # action.devices.QUERY` [response](https://developers.google.com/assistant/ + # smarthome/reference/intent/query). # Example ```json ` "requestId": "ff36a3cc- + # ec34-11e6-b1a0-64510650abcf", "payload": ` "devices": ` "123": ` "on": true, " + # online": true `, "456": ` "on": true, "online": true, "brightness": 80, "color" + # : ` "name": "cerulean", "spectrumRGB": 31655 ` ` ` ` ` ``` class QueryResponse include Google::Apis::Core::Hashable @@ -391,8 +358,7 @@ module Google class QueryResponsePayload include Google::Apis::Core::Hashable - # States of the devices. Map of third-party device ID to struct of device - # states. + # States of the devices. Map of third-party device ID to struct of device states. # Corresponds to the JSON property `devices` # @return [Hash>] attr_accessor :devices @@ -411,16 +377,16 @@ module Google class ReportStateAndNotificationDevice include Google::Apis::Core::Hashable - # Notifications metadata for devices. See the **Device NOTIFICATIONS** - # section of the individual trait [reference - # guides](https://developers.google.com/assistant/smarthome/traits). + # Notifications metadata for devices. See the **Device NOTIFICATIONS** section + # of the individual trait [reference guides](https://developers.google.com/ + # assistant/smarthome/traits). # Corresponds to the JSON property `notifications` # @return [Hash] attr_accessor :notifications - # States of devices to update. See the **Device STATES** section - # of the individual trait [reference - # guides](https://developers.google.com/assistant/smarthome/traits). + # States of devices to update. See the **Device STATES** section of the + # individual trait [reference guides](https://developers.google.com/assistant/ + # smarthome/traits). # Corresponds to the JSON property `states` # @return [Hash] attr_accessor :states @@ -436,32 +402,13 @@ module Google end end - # Request type for the - # [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService. - # ReportStateAndNotification) - # call. It may include states, notifications, or both. States and notifications - # are defined per `device_id` (for example, "123" and "456" in the following - # example). - # # Example - # ```json - # ` - # "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", - # "agentUserId": "1234", - # "payload": ` - # "devices": ` - # "states": ` - # "123": ` - # "on": true - # `, - # "456": ` - # "on": true, - # "brightness": 10 - # ` - # `, - # ` - # ` - # ` - # ``` + # Request type for the [`ReportStateAndNotification`](#google.home.graph.v1. + # HomeGraphApiService.ReportStateAndNotification) call. It may include states, + # notifications, or both. States and notifications are defined per `device_id` ( + # for example, "123" and "456" in the following example). # Example ```json ` " + # requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "agentUserId": "1234", " + # payload": ` "devices": ` "states": ` "123": ` "on": true `, "456": ` "on": + # true, "brightness": 10 ` `, ` ` ` ``` class ReportStateAndNotificationRequest include Google::Apis::Core::Hashable @@ -475,10 +422,10 @@ module Google # @return [String] attr_accessor :event_id - # Token to maintain state in the follow up notification response. - # Deprecated. See the [notifications - # guide](https://developers.google.com/assistant/smarthome/develop/notifications) - # for details on implementing follow up notifications. + # Token to maintain state in the follow up notification response. Deprecated. + # See the [notifications guide](https://developers.google.com/assistant/ + # smarthome/develop/notifications) for details on implementing follow up + # notifications. # Corresponds to the JSON property `followUpToken` # @return [String] attr_accessor :follow_up_token @@ -507,10 +454,8 @@ module Google end end - # Response type for the - # [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService. - # ReportStateAndNotification) - # call. + # Response type for the [`ReportStateAndNotification`](#google.home.graph.v1. + # HomeGraphApiService.ReportStateAndNotification) call. class ReportStateAndNotificationResponse include Google::Apis::Core::Hashable @@ -529,10 +474,8 @@ module Google end end - # Request type for the - # [`RequestSyncDevices`](#google.home.graph.v1.HomeGraphApiService. - # RequestSyncDevices) - # call. + # Request type for the [`RequestSyncDevices`](#google.home.graph.v1. + # HomeGraphApiService.RequestSyncDevices) call. class RequestSyncDevicesRequest include Google::Apis::Core::Hashable @@ -541,9 +484,9 @@ module Google # @return [String] attr_accessor :agent_user_id - # Optional. If set, the request will be added to a queue and a response will - # be returned immediately. This enables concurrent requests for the given - # `agent_user_id`, but the caller will not receive any error responses. + # Optional. If set, the request will be added to a queue and a response will be + # returned immediately. This enables concurrent requests for the given ` + # agent_user_id`, but the caller will not receive any error responses. # Corresponds to the JSON property `async` # @return [Boolean] attr_accessor :async @@ -560,12 +503,9 @@ module Google end end - # Response type for the - # [`RequestSyncDevices`](#google.home.graph.v1.HomeGraphApiService. - # RequestSyncDevices) - # call. - # Intentionally empty upon success. An HTTP response code is returned - # with more details upon failure. + # Response type for the [`RequestSyncDevices`](#google.home.graph.v1. + # HomeGraphApiService.RequestSyncDevices) call. Intentionally empty upon success. + # An HTTP response code is returned with more details upon failure. class RequestSyncDevicesResponse include Google::Apis::Core::Hashable @@ -623,45 +563,17 @@ module Google end end - # Response type for the - # [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) call. - # This should follow the same format as the Google smart home - # `action.devices.SYNC` - # [response](https://developers.google.com/assistant/smarthome/reference/intent/ - # sync). - # # Example - # ```json - # ` - # "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", - # "payload": ` - # "agentUserId": "1836.15267389", - # "devices": [` - # "id": "123", - # "type": "action.devices.types.OUTLET", - # "traits": [ - # "action.devices.traits.OnOff" - # ], - # "name": ` - # "defaultNames": ["My Outlet 1234"], - # "name": "Night light", - # "nicknames": ["wall plug"] - # `, - # "willReportState": false, - # "deviceInfo": ` - # "manufacturer": "lights-out-inc", - # "model": "hs1234", - # "hwVersion": "3.2", - # "swVersion": "11.4" - # `, - # "customData": ` - # "fooValue": 74, - # "barValue": true, - # "bazValue": "foo" - # ` - # `] - # ` - # ` - # ``` + # Response type for the [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) + # call. This should follow the same format as the Google smart home `action. + # devices.SYNC` [response](https://developers.google.com/assistant/smarthome/ + # reference/intent/sync). # Example ```json ` "requestId": "ff36a3cc-ec34-11e6- + # b1a0-64510650abcf", "payload": ` "agentUserId": "1836.15267389", "devices": [` + # "id": "123", "type": "action.devices.types.OUTLET", "traits": [ "action. + # devices.traits.OnOff" ], "name": ` "defaultNames": ["My Outlet 1234"], "name": + # "Night light", "nicknames": ["wall plug"] `, "willReportState": false, " + # deviceInfo": ` "manufacturer": "lights-out-inc", "model": "hs1234", "hwVersion" + # : "3.2", "swVersion": "11.4" `, "customData": ` "fooValue": 74, "barValue": + # true, "bazValue": "foo" ` `] ` ` ``` class SyncResponse include Google::Apis::Core::Hashable diff --git a/generated/google/apis/homegraph_v1/service.rb b/generated/google/apis/homegraph_v1/service.rb index d869cfcde..89a4597e9 100644 --- a/generated/google/apis/homegraph_v1/service.rb +++ b/generated/google/apis/homegraph_v1/service.rb @@ -47,14 +47,11 @@ module Google @batch_path = 'batch' end - # Unlinks the given third-party user from your smart home Action. - # All data related to this user will be deleted. - # For more details on how users link their accounts, see - # [fulfillment and - # authentication](https://developers.google.com/assistant/smarthome/concepts/ - # fulfillment-authentication). - # The third-party user's identity is passed in via the `agent_user_id` - # (see DeleteAgentUserRequest). + # Unlinks the given third-party user from your smart home Action. All data + # related to this user will be deleted. For more details on how users link their + # accounts, see [fulfillment and authentication](https://developers.google.com/ + # assistant/smarthome/concepts/fulfillment-authentication). The third-party user' + # s identity is passed in via the `agent_user_id` (see DeleteAgentUserRequest). # This request must be authorized using service account credentials from your # Actions console project. # @param [String] agent_user_id @@ -90,11 +87,9 @@ module Google end # Gets the current states in Home Graph for the given set of the third-party - # user's devices. - # The third-party user's identity is passed in via the `agent_user_id` - # (see QueryRequest). - # This request must be authorized using service account credentials from your - # Actions console project. + # user's devices. The third-party user's identity is passed in via the ` + # agent_user_id` (see QueryRequest). This request must be authorized using + # service account credentials from your Actions console project. # @param [Google::Apis::HomegraphV1::QueryRequest] query_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -124,19 +119,15 @@ module Google execute_or_queue_command(command, &block) end - # Reports device state and optionally sends device notifications. - # Called by your smart home Action when the state of a third-party device - # changes or you need to send a notification about the device. - # See [Implement Report - # State](https://developers.google.com/assistant/smarthome/develop/report-state) - # for more information. - # This method updates the device state according to its declared - # [traits](https://developers.google.com/assistant/smarthome/concepts/devices- - # traits). - # Publishing a new state value outside of these traits will result in an - # `INVALID_ARGUMENT` error response. - # The third-party user's identity is passed in via the `agent_user_id` - # (see ReportStateAndNotificationRequest). + # Reports device state and optionally sends device notifications. Called by your + # smart home Action when the state of a third-party device changes or you need + # to send a notification about the device. See [Implement Report State](https:// + # developers.google.com/assistant/smarthome/develop/report-state) for more + # information. This method updates the device state according to its declared [ + # traits](https://developers.google.com/assistant/smarthome/concepts/devices- + # traits). Publishing a new state value outside of these traits will result in + # an `INVALID_ARGUMENT` error response. The third-party user's identity is + # passed in via the `agent_user_id` (see ReportStateAndNotificationRequest). # This request must be authorized using service account credentials from your # Actions console project. # @param [Google::Apis::HomegraphV1::ReportStateAndNotificationRequest] report_state_and_notification_request_object @@ -168,12 +159,10 @@ module Google execute_or_queue_command(command, &block) end - # Requests Google to send an `action.devices.SYNC` - # [intent](https://developers.google.com/assistant/smarthome/reference/intent/ - # sync) - # to your smart home Action to update device metadata for the given user. - # The third-party user's identity is passed via the `agent_user_id` - # (see RequestSyncDevicesRequest). + # Requests Google to send an `action.devices.SYNC` [intent](https://developers. + # google.com/assistant/smarthome/reference/intent/sync) to your smart home + # Action to update device metadata for the given user. The third-party user's + # identity is passed via the `agent_user_id` (see RequestSyncDevicesRequest). # This request must be authorized using service account credentials from your # Actions console project. # @param [Google::Apis::HomegraphV1::RequestSyncDevicesRequest] request_sync_devices_request_object @@ -205,9 +194,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets all the devices associated with the given third-party user. - # The third-party user's identity is passed in via the `agent_user_id` - # (see SyncRequest). + # Gets all the devices associated with the given third-party user. The third- + # party user's identity is passed in via the `agent_user_id` (see SyncRequest). # This request must be authorized using service account credentials from your # Actions console project. # @param [Google::Apis::HomegraphV1::SyncRequest] sync_request_object diff --git a/generated/google/apis/iam_v1.rb b/generated/google/apis/iam_v1.rb index caccf7bb1..950bcf87c 100644 --- a/generated/google/apis/iam_v1.rb +++ b/generated/google/apis/iam_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/iam/ module IamV1 VERSION = 'V1' - REVISION = '20200709' + REVISION = '20200806' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/iam_v1/classes.rb b/generated/google/apis/iam_v1/classes.rb index faa990b92..287e73b9c 100644 --- a/generated/google/apis/iam_v1/classes.rb +++ b/generated/google/apis/iam_v1/classes.rb @@ -23,8 +23,8 @@ module Google module IamV1 # Audit log information specific to Cloud IAM admin APIs. This message is - # serialized as an `Any` type in the `ServiceData` message of an - # `AuditLog` message. + # serialized as an `Any` type in the `ServiceData` message of an `AuditLog` + # message. class AdminAuditData include Google::Apis::Core::Hashable @@ -44,53 +44,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 @@ -99,9 +67,9 @@ module Google # @return [Array] 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 @@ -117,9 +85,8 @@ module Google end end - # Audit log information specific to Cloud IAM. This message is serialized - # as an `Any` type in the `ServiceData` message of an - # `AuditLog` message. + # Audit log information specific to Cloud IAM. This message is serialized as an ` + # Any` type in the `ServiceData` message of an `AuditLog` message. class AuditData include Google::Apis::Core::Hashable @@ -138,28 +105,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] @@ -185,8 +139,8 @@ module Google class AuditableService include Google::Apis::Core::Hashable - # Public name of the service. - # For example, the service name for Cloud IAM is 'iam.googleapis.com'. + # Public name of the service. For example, the service name for Cloud IAM is ' + # iam.googleapis.com'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -205,69 +159,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::IamV1::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] 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 @@ -289,48 +231,38 @@ module Google class BindingDelta include Google::Apis::Core::Hashable - # The action that was performed on a Binding. - # Required + # The action that was performed on a Binding. Required # Corresponds to the JSON property `action` # @return [String] attr_accessor :action - # 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::IamV1::Expr] attr_accessor :condition - # A single identity requesting access for a Cloud Platform resource. - # Follows the same format of Binding.members. - # Required + # A single identity requesting access for a Cloud Platform resource. Follows the + # same format of Binding.members. Required # Corresponds to the JSON property `member` # @return [String] attr_accessor :member - # Role that is assigned to `members`. - # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. - # Required + # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor` + # , or `roles/owner`. Required # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -357,10 +289,9 @@ module Google # @return [Google::Apis::IamV1::Role] attr_accessor :role - # The role ID to use for this role. - # A role ID may contain alphanumeric characters, underscores (`_`), and - # periods (`.`). It must contain a minimum of 3 characters and a maximum of - # 64 characters. + # The role ID to use for this role. A role ID may contain alphanumeric + # characters, underscores (`_`), and periods (`.`). It must contain a minimum of + # 3 characters and a maximum of 64 characters. # Corresponds to the JSON property `roleId` # @return [String] attr_accessor :role_id @@ -380,16 +311,14 @@ module Google class CreateServiceAccountKeyRequest include Google::Apis::Core::Hashable - # Which type of key and algorithm to use for the key. - # The default is currently a 2K RSA key. However this may change in the - # future. + # Which type of key and algorithm to use for the key. The default is currently a + # 2K RSA key. However this may change in the future. # Corresponds to the JSON property `keyAlgorithm` # @return [String] attr_accessor :key_algorithm - # The output format of the private key. The default value is - # `TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google Credentials File - # format. + # The output format of the private key. The default value is ` + # TYPE_GOOGLE_CREDENTIALS_FILE`, which is the Google Credentials File format. # Corresponds to the JSON property `privateKeyType` # @return [String] attr_accessor :private_key_type @@ -409,23 +338,21 @@ module Google class CreateServiceAccountRequest include Google::Apis::Core::Hashable - # Required. The account id that is used to generate the service account - # email address and a stable unique id. It is unique within a project, - # must be 6-30 characters long, and match the regular expression - # `[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035. + # Required. The account id that is used to generate the service account email + # address and a stable unique id. It is unique within a project, must be 6-30 + # characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])` + # to comply with RFC1035. # Corresponds to the JSON property `accountId` # @return [String] attr_accessor :account_id - # An IAM service account. - # A service account is an account for an application or a virtual machine (VM) - # instance, not a person. You can use a service account to call Google APIs. To - # learn more, read the [overview of service - # accounts](https://cloud.google.com/iam/help/service-accounts/overview). - # When you create a service account, you specify the project ID that owns the - # service account, as well as a name that must be unique within the project. - # IAM uses these values to create an email address that identifies the service - # account. + # An IAM service account. A service account is an account for an application or + # a virtual machine (VM) instance, not a person. You can use a service account + # to call Google APIs. To learn more, read the [overview of service accounts]( + # https://cloud.google.com/iam/help/service-accounts/overview). When you create + # a service account, you specify the project ID that owns the service account, + # as well as a name that must be unique within the project. IAM uses these + # values to create an email address that identifies the service account. # Corresponds to the JSON property `serviceAccount` # @return [Google::Apis::IamV1::ServiceAccount] attr_accessor :service_account @@ -454,13 +381,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 @@ -486,52 +411,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 @@ -553,39 +469,31 @@ module Google class LintPolicyRequest 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::IamV1::Expr] attr_accessor :condition - # The full resource name of the policy this lint request is about. - # The name follows the Google Cloud Platform (GCP) resource format. - # For example, a GCP project with ID `my-project` will be named - # `//cloudresourcemanager.googleapis.com/projects/my-project`. - # The resource name is not used to read the policy instance from the Cloud - # IAM database. The candidate policy for lint has to be provided in the same - # request object. + # The full resource name of the policy this lint request is about. The name + # follows the Google Cloud Platform (GCP) resource format. For example, a GCP + # project with ID `my-project` will be named `//cloudresourcemanager.googleapis. + # com/projects/my-project`. The resource name is not used to read the policy + # instance from the Cloud IAM database. The candidate policy for lint has to be + # provided in the same request object. # Corresponds to the JSON property `fullResourceName` # @return [String] attr_accessor :full_resource_name @@ -601,8 +509,8 @@ module Google end end - # The response of a lint operation. An empty response indicates - # the operation was able to fully execute and no lint issue was found. + # The response of a lint operation. An empty response indicates the operation + # was able to fully execute and no lint issue was found. class LintPolicyResponse include Google::Apis::Core::Hashable @@ -630,12 +538,11 @@ module Google # @return [String] attr_accessor :debug_message - # The name of the field for which this lint result is about. - # For nested messages `field_name` consists of names of the embedded fields - # separated by period character. The top-level qualifier is the input object - # to lint in the request. For example, the `field_name` value - # `condition.expression` identifies a lint result for the `expression` field - # of the provided condition. + # The name of the field for which this lint result is about. For nested messages + # `field_name` consists of names of the embedded fields separated by period + # character. The top-level qualifier is the input object to lint in the request. + # For example, the `field_name` value `condition.expression` identifies a lint + # result for the `expression` field of the provided condition. # Corresponds to the JSON property `fieldName` # @return [String] attr_accessor :field_name @@ -657,8 +564,8 @@ module Google # @return [String] attr_accessor :severity - # The validation unit name, for instance - # "lintValidationUnits/ConditionComplexityCheck". + # The validation unit name, for instance "lintValidationUnits/ + # ConditionComplexityCheck". # Corresponds to the JSON property `validationUnitName` # @return [String] attr_accessor :validation_unit_name @@ -682,8 +589,8 @@ module Google class ListRolesResponse include Google::Apis::Core::Hashable - # To retrieve the next page of results, set - # `ListRolesRequest.page_token` to this value. + # To retrieve the next page of results, set `ListRolesRequest.page_token` to + # this value. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -732,9 +639,8 @@ module Google # @return [Array] attr_accessor :accounts - # To retrieve the next page of results, set - # ListServiceAccountsRequest.page_token - # to this value. + # To retrieve the next page of results, set ListServiceAccountsRequest. + # page_token to this value. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -750,24 +656,21 @@ module Google end end - # The request for - # PatchServiceAccount. - # You can patch only the `display_name` and `description` fields. You must use - # the `update_mask` field to specify which of these fields you want to patch. - # Only the fields specified in the request are guaranteed to be returned in - # the response. Other fields may be empty in the response. + # The request for PatchServiceAccount. You can patch only the `display_name` and + # `description` fields. You must use the `update_mask` field to specify which of + # these fields you want to patch. Only the fields specified in the request are + # guaranteed to be returned in the response. Other fields may be empty in the + # response. class PatchServiceAccountRequest include Google::Apis::Core::Hashable - # An IAM service account. - # A service account is an account for an application or a virtual machine (VM) - # instance, not a person. You can use a service account to call Google APIs. To - # learn more, read the [overview of service - # accounts](https://cloud.google.com/iam/help/service-accounts/overview). - # When you create a service account, you specify the project ID that owns the - # service account, as well as a name that must be unique within the project. - # IAM uses these values to create an email address that identifies the service - # account. + # An IAM service account. A service account is an account for an application or + # a virtual machine (VM) instance, not a person. You can use a service account + # to call Google APIs. To learn more, read the [overview of service accounts]( + # https://cloud.google.com/iam/help/service-accounts/overview). When you create + # a service account, you specify the project ID that owns the service account, + # as well as a name that must be unique within the project. IAM uses these + # values to create an email address that identifies the service account. # Corresponds to the JSON property `serviceAccount` # @return [Google::Apis::IamV1::ServiceAccount] attr_accessor :service_account @@ -803,8 +706,8 @@ module Google # @return [String] attr_accessor :custom_roles_support_level - # A brief description of what this Permission is used for. - # This permission can ONLY be used in predefined roles. + # A brief description of what this Permission is used for. This permission can + # ONLY be used in predefined roles. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -820,8 +723,8 @@ module Google attr_accessor :only_in_predefined_roles alias_method :only_in_predefined_roles?, :only_in_predefined_roles - # The preferred name for this permission. If present, then this permission is - # an alias of, and equivalent to, the listed primary_permission. + # The preferred name for this permission. If present, then this permission is an + # alias of, and equivalent to, the listed primary_permission. # Corresponds to the JSON property `primaryPermission` # @return [String] attr_accessor :primary_permission @@ -880,66 +783,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 @@ -948,48 +817,44 @@ module Google # @return [Array] 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] 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 @@ -1030,11 +895,10 @@ module Google class QueryAuditableServicesRequest include Google::Apis::Core::Hashable - # Required. The full resource name to query from the list of auditable - # services. - # The name follows the Google Cloud Platform resource format. - # For example, a Cloud Platform project with id `my-project` will be named - # `//cloudresourcemanager.googleapis.com/projects/my-project`. + # Required. The full resource name to query from the list of auditable services. + # The name follows the Google Cloud Platform resource format. For example, a + # Cloud Platform project with id `my-project` will be named `// + # cloudresourcemanager.googleapis.com/projects/my-project`. # Corresponds to the JSON property `fullResourceName` # @return [String] attr_accessor :full_resource_name @@ -1073,21 +937,20 @@ module Google include Google::Apis::Core::Hashable # Required. The full resource name to query from the list of grantable roles. - # The name follows the Google Cloud Platform resource format. - # For example, a Cloud Platform project with id `my-project` will be named - # `//cloudresourcemanager.googleapis.com/projects/my-project`. + # The name follows the Google Cloud Platform resource format. For example, a + # Cloud Platform project with id `my-project` will be named `// + # cloudresourcemanager.googleapis.com/projects/my-project`. # Corresponds to the JSON property `fullResourceName` # @return [String] attr_accessor :full_resource_name - # Optional limit on the number of roles to include in the response. - # The default is 300, and the maximum is 1,000. + # Optional limit on the number of roles to include in the response. The default + # is 300, and the maximum is 1,000. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size - # Optional pagination token returned in an earlier - # QueryGrantableRolesResponse. + # Optional pagination token returned in an earlier QueryGrantableRolesResponse. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token @@ -1114,8 +977,8 @@ module Google class QueryGrantableRolesResponse include Google::Apis::Core::Hashable - # To retrieve the next page of results, set - # `QueryGrantableRolesRequest.page_token` to this value. + # To retrieve the next page of results, set `QueryGrantableRolesRequest. + # page_token` to this value. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1141,16 +1004,15 @@ module Google include Google::Apis::Core::Hashable # Required. The full resource name to query from the list of testable - # permissions. - # The name follows the Google Cloud Platform resource format. - # For example, a Cloud Platform project with id `my-project` will be named - # `//cloudresourcemanager.googleapis.com/projects/my-project`. + # permissions. The name follows the Google Cloud Platform resource format. For + # example, a Cloud Platform project with id `my-project` will be named `// + # cloudresourcemanager.googleapis.com/projects/my-project`. # Corresponds to the JSON property `fullResourceName` # @return [String] attr_accessor :full_resource_name - # Optional limit on the number of permissions to include in the response. - # The default is 100, and the maximum is 1,000. + # Optional limit on the number of permissions to include in the response. The + # default is 100, and the maximum is 1,000. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size @@ -1177,8 +1039,8 @@ module Google class QueryTestablePermissionsResponse include Google::Apis::Core::Hashable - # To retrieve the next page of results, set - # `QueryTestableRolesRequest.page_token` to this value. + # To retrieve the next page of results, set `QueryTestableRolesRequest. + # page_token` to this value. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1203,8 +1065,8 @@ module Google class Role include Google::Apis::Core::Hashable - # The current deleted state of the role. This field is read only. - # It will be ignored in calls to CreateRole and UpdateRole. + # The current deleted state of the role. This field is read only. It will be + # ignored in calls to CreateRole and UpdateRole. # Corresponds to the JSON property `deleted` # @return [Boolean] attr_accessor :deleted @@ -1226,24 +1088,24 @@ module Google # @return [Array] attr_accessor :included_permissions - # The name of the role. - # When Role is used in CreateRole, the role name must not be set. - # When Role is used in output and other input such as UpdateRole, the role - # name is the complete path, e.g., roles/logging.viewer for predefined roles - # and organizations/`ORGANIZATION_ID`/roles/logging.viewer for custom roles. + # The name of the role. When Role is used in CreateRole, the role name must not + # be set. When Role is used in output and other input such as UpdateRole, the + # role name is the complete path, e.g., roles/logging.viewer for predefined + # roles and organizations/`ORGANIZATION_ID`/roles/logging.viewer for custom + # roles. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The current launch stage of the role. If the `ALPHA` launch stage has been - # selected for a role, the `stage` field will not be included in the - # returned definition for the role. + # selected for a role, the `stage` field will not be included in the returned + # definition for the role. # Corresponds to the JSON property `stage` # @return [String] attr_accessor :stage - # Optional. A human-readable title for the role. Typically this - # is limited to 100 UTF-8 bytes. + # Optional. A human-readable title for the role. Typically this is limited to + # 100 UTF-8 bytes. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -1264,21 +1126,18 @@ module Google end end - # An IAM service account. - # A service account is an account for an application or a virtual machine (VM) - # instance, not a person. You can use a service account to call Google APIs. To - # learn more, read the [overview of service - # accounts](https://cloud.google.com/iam/help/service-accounts/overview). - # When you create a service account, you specify the project ID that owns the - # service account, as well as a name that must be unique within the project. - # IAM uses these values to create an email address that identifies the service - # account. + # An IAM service account. A service account is an account for an application or + # a virtual machine (VM) instance, not a person. You can use a service account + # to call Google APIs. To learn more, read the [overview of service accounts]( + # https://cloud.google.com/iam/help/service-accounts/overview). When you create + # a service account, you specify the project ID that owns the service account, + # as well as a name that must be unique within the project. IAM uses these + # values to create an email address that identifies the service account. class ServiceAccount include Google::Apis::Core::Hashable # Optional. A user-specified, human-readable description of the service account. - # The - # maximum length is 256 UTF-8 bytes. + # The maximum length is 256 UTF-8 bytes. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1290,8 +1149,7 @@ module Google alias_method :disabled?, :disabled # Optional. A user-specified, human-readable name for the service account. The - # maximum - # length is 100 UTF-8 bytes. + # maximum length is 100 UTF-8 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -1307,19 +1165,15 @@ module Google # @return [String] attr_accessor :etag - # The resource name of the service account. - # Use one of the following formats: - # * `projects/`PROJECT_ID`/serviceAccounts/`EMAIL_ADDRESS`` - # * `projects/`PROJECT_ID`/serviceAccounts/`UNIQUE_ID`` - # As an alternative, you can use the `-` wildcard character instead of the - # project ID: - # * `projects/-/serviceAccounts/`EMAIL_ADDRESS`` - # * `projects/-/serviceAccounts/`UNIQUE_ID`` - # When possible, avoid using the `-` wildcard character, because it can cause - # response messages to contain misleading error codes. For example, if you - # try to get the service account - # `projects/-/serviceAccounts/fake@example.com`, which does not exist, the - # response contains an HTTP `403 Forbidden` error instead of a `404 Not + # The resource name of the service account. Use one of the following formats: * ` + # projects/`PROJECT_ID`/serviceAccounts/`EMAIL_ADDRESS`` * `projects/`PROJECT_ID` + # /serviceAccounts/`UNIQUE_ID`` As an alternative, you can use the `-` wildcard + # character instead of the project ID: * `projects/-/serviceAccounts/` + # EMAIL_ADDRESS`` * `projects/-/serviceAccounts/`UNIQUE_ID`` When possible, + # avoid using the `-` wildcard character, because it can cause response messages + # to contain misleading error codes. For example, if you try to get the service + # account `projects/-/serviceAccounts/fake@example.com`, which does not exist, + # the response contains an HTTP `403 Forbidden` error instead of a `404 Not # Found` error. # Corresponds to the JSON property `name` # @return [String] @@ -1335,11 +1189,11 @@ module Google # @return [String] attr_accessor :project_id - # Output only. The unique, stable numeric ID for the service account. - # Each service account retains its unique ID even if you delete the service - # account. For example, if you delete a service account, then create a new - # service account with the same name, the new service account has a different - # unique ID than the deleted service account. + # Output only. The unique, stable numeric ID for the service account. Each + # service account retains its unique ID even if you delete the service account. + # For example, if you delete a service account, then create a new service + # account with the same name, the new service account has a different unique ID + # than the deleted service account. # Corresponds to the JSON property `uniqueId` # @return [String] attr_accessor :unique_id @@ -1362,20 +1216,17 @@ module Google end end - # Represents a service account key. - # A service account has two sets of key-pairs: user-managed, and - # system-managed. - # User-managed key-pairs can be created and deleted by users. Users are - # responsible for rotating these keys periodically to ensure security of - # their service accounts. Users retain the private key of these key-pairs, - # and Google retains ONLY the public key. - # System-managed keys are automatically rotated by Google, and are used for - # signing for a maximum of two weeks. The rotation process is probabilistic, - # and usage of the new key will gradually ramp up and down over the key's - # lifetime. We recommend caching the public key set for a service account for - # no more than 24 hours to ensure you have access to the latest keys. - # Public keys for all service accounts are also published at the OAuth2 - # Service Account API. + # Represents a service account key. A service account has two sets of key-pairs: + # user-managed, and system-managed. User-managed key-pairs can be created and + # deleted by users. Users are responsible for rotating these keys periodically + # to ensure security of their service accounts. Users retain the private key of + # these key-pairs, and Google retains ONLY the public key. System-managed keys + # are automatically rotated by Google, and are used for signing for a maximum of + # two weeks. The rotation process is probabilistic, and usage of the new key + # will gradually ramp up and down over the key's lifetime. We recommend caching + # the public key set for a service account for no more than 24 hours to ensure + # you have access to the latest keys. Public keys for all service accounts are + # also published at the OAuth2 Service Account API. class ServiceAccountKey include Google::Apis::Core::Hashable @@ -1394,29 +1245,26 @@ module Google # @return [String] attr_accessor :key_type - # The resource name of the service account key in the following format - # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT`/keys/`key``. + # The resource name of the service account key in the following format `projects/ + # `PROJECT_ID`/serviceAccounts/`ACCOUNT`/keys/`key``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The private key data. Only provided in `CreateServiceAccountKey` - # responses. Make sure to keep the private key data secure because it - # allows for the assertion of the service account identity. - # When base64 decoded, the private key data can be used to authenticate with - # Google API client libraries and with - # gcloud - # auth activate-service-account. + # The private key data. Only provided in `CreateServiceAccountKey` responses. + # Make sure to keep the private key data secure because it allows for the + # assertion of the service account identity. When base64 decoded, the private + # key data can be used to authenticate with Google API client libraries and with + # gcloud auth activate-service-account. # Corresponds to the JSON property `privateKeyData` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :private_key_data - # The output format for the private key. - # Only provided in `CreateServiceAccountKey` responses, not - # in `GetServiceAccountKey` or `ListServiceAccountKey` responses. - # Google never exposes system-managed private keys, and never retains - # user-managed private keys. + # The output format for the private key. Only provided in ` + # CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or ` + # ListServiceAccountKey` responses. Google never exposes system-managed private + # keys, and never retains user-managed private keys. # Corresponds to the JSON property `privateKeyType` # @return [String] attr_accessor :private_key_type @@ -1432,10 +1280,9 @@ module Google # @return [String] attr_accessor :valid_after_time - # The key can be used before this timestamp. - # For system-managed key pairs, this timestamp is the end time for the - # private key signing operation. The public key could still be used - # for verification for a few hours after this time. + # The key can be used before this timestamp. For system-managed key pairs, this + # timestamp is the end time for the private key signing operation. The public + # key could still be used for verification for a few hours after this time. # Corresponds to the JSON property `validBeforeTime` # @return [String] attr_accessor :valid_before_time @@ -1463,74 +1310,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::IamV1::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 @@ -1546,15 +1358,13 @@ module Google end end - # Deprecated. [Migrate to Service Account Credentials - # API](https://cloud.google.com/iam/help/credentials/migrate-api). - # The service account sign blob request. + # Deprecated. [Migrate to Service Account Credentials API](https://cloud.google. + # com/iam/help/credentials/migrate-api). The service account sign blob request. class SignBlobRequest include Google::Apis::Core::Hashable - # Required. Deprecated. [Migrate to Service Account Credentials - # API](https://cloud.google.com/iam/help/credentials/migrate-api). - # The bytes to sign. + # Required. Deprecated. [Migrate to Service Account Credentials API](https:// + # cloud.google.com/iam/help/credentials/migrate-api). The bytes to sign. # Corresponds to the JSON property `bytesToSign` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1570,22 +1380,19 @@ module Google end end - # Deprecated. [Migrate to Service Account Credentials - # API](https://cloud.google.com/iam/help/credentials/migrate-api). - # The service account sign blob response. + # Deprecated. [Migrate to Service Account Credentials API](https://cloud.google. + # com/iam/help/credentials/migrate-api). The service account sign blob response. class SignBlobResponse include Google::Apis::Core::Hashable - # Deprecated. [Migrate to Service Account Credentials - # API](https://cloud.google.com/iam/help/credentials/migrate-api). - # The id of the key used to sign the blob. + # Deprecated. [Migrate to Service Account Credentials API](https://cloud.google. + # com/iam/help/credentials/migrate-api). The id of the key used to sign the blob. # Corresponds to the JSON property `keyId` # @return [String] attr_accessor :key_id - # Deprecated. [Migrate to Service Account Credentials - # API](https://cloud.google.com/iam/help/credentials/migrate-api). - # The signed blob. + # Deprecated. [Migrate to Service Account Credentials API](https://cloud.google. + # com/iam/help/credentials/migrate-api). The signed blob. # Corresponds to the JSON property `signature` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1602,22 +1409,19 @@ module Google end end - # Deprecated. [Migrate to Service Account Credentials - # API](https://cloud.google.com/iam/help/credentials/migrate-api). - # The service account sign JWT request. + # Deprecated. [Migrate to Service Account Credentials API](https://cloud.google. + # com/iam/help/credentials/migrate-api). The service account sign JWT request. class SignJwtRequest include Google::Apis::Core::Hashable - # Required. Deprecated. [Migrate to Service Account Credentials - # API](https://cloud.google.com/iam/help/credentials/migrate-api). - # The JWT payload to sign. Must be a serialized JSON object that contains a - # JWT Claims Set. For example: ``"sub": "user@example.com", "iat": 313435`` - # If the JWT Claims Set contains an expiration time (`exp`) claim, it must be - # an integer timestamp that is not in the past and no more than 1 hour in the - # future. - # If the JWT Claims Set does not contain an expiration time (`exp`) claim, - # this claim is added automatically, with a timestamp that is 1 hour in the - # future. + # Required. Deprecated. [Migrate to Service Account Credentials API](https:// + # cloud.google.com/iam/help/credentials/migrate-api). The JWT payload to sign. + # Must be a serialized JSON object that contains a JWT Claims Set. For example: ` + # `"sub": "user@example.com", "iat": 313435`` If the JWT Claims Set contains an + # expiration time (`exp`) claim, it must be an integer timestamp that is not in + # the past and no more than 1 hour in the future. If the JWT Claims Set does not + # contain an expiration time (`exp`) claim, this claim is added automatically, + # with a timestamp that is 1 hour in the future. # Corresponds to the JSON property `payload` # @return [String] attr_accessor :payload @@ -1632,22 +1436,19 @@ module Google end end - # Deprecated. [Migrate to Service Account Credentials - # API](https://cloud.google.com/iam/help/credentials/migrate-api). - # The service account sign JWT response. + # Deprecated. [Migrate to Service Account Credentials API](https://cloud.google. + # com/iam/help/credentials/migrate-api). The service account sign JWT response. class SignJwtResponse include Google::Apis::Core::Hashable - # Deprecated. [Migrate to Service Account Credentials - # API](https://cloud.google.com/iam/help/credentials/migrate-api). - # The id of the key used to sign the JWT. + # Deprecated. [Migrate to Service Account Credentials API](https://cloud.google. + # com/iam/help/credentials/migrate-api). The id of the key used to sign the JWT. # Corresponds to the JSON property `keyId` # @return [String] attr_accessor :key_id - # Deprecated. [Migrate to Service Account Credentials - # API](https://cloud.google.com/iam/help/credentials/migrate-api). - # The signed JWT. + # Deprecated. [Migrate to Service Account Credentials API](https://cloud.google. + # com/iam/help/credentials/migrate-api). The signed JWT. # Corresponds to the JSON property `signedJwt` # @return [String] attr_accessor :signed_jwt @@ -1667,10 +1468,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] attr_accessor :permissions @@ -1689,8 +1489,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] attr_accessor :permissions @@ -1742,15 +1541,13 @@ module Google class UndeleteServiceAccountResponse include Google::Apis::Core::Hashable - # An IAM service account. - # A service account is an account for an application or a virtual machine (VM) - # instance, not a person. You can use a service account to call Google APIs. To - # learn more, read the [overview of service - # accounts](https://cloud.google.com/iam/help/service-accounts/overview). - # When you create a service account, you specify the project ID that owns the - # service account, as well as a name that must be unique within the project. - # IAM uses these values to create an email address that identifies the service - # account. + # An IAM service account. A service account is an account for an application or + # a virtual machine (VM) instance, not a person. You can use a service account + # to call Google APIs. To learn more, read the [overview of service accounts]( + # https://cloud.google.com/iam/help/service-accounts/overview). When you create + # a service account, you specify the project ID that owns the service account, + # as well as a name that must be unique within the project. IAM uses these + # values to create an email address that identifies the service account. # Corresponds to the JSON property `restoredAccount` # @return [Google::Apis::IamV1::ServiceAccount] attr_accessor :restored_account @@ -1769,9 +1566,8 @@ module Google class UploadServiceAccountKeyRequest include Google::Apis::Core::Hashable - # A field that allows clients to upload their own public key. If set, - # use this public key data to create a service account key for given - # service account. + # A field that allows clients to upload their own public key. If set, use this + # public key data to create a service account key for given service account. # Please note, the expected format for this field is X509_PEM. # Corresponds to the JSON property `publicKeyData` # NOTE: Values are automatically base64 encoded/decoded in the client library. diff --git a/generated/google/apis/iam_v1/service.rb b/generated/google/apis/iam_v1/service.rb index 671e721c1..0eb2a686a 100644 --- a/generated/google/apis/iam_v1/service.rb +++ b/generated/google/apis/iam_v1/service.rb @@ -49,9 +49,8 @@ module Google @batch_path = 'batch' end - # Lints, or validates, an IAM policy. Currently checks the - # google.iam.v1.Binding.condition field, which contains a condition - # expression for a role binding. + # Lints, or validates, an IAM policy. Currently checks the google.iam.v1.Binding. + # condition field, which contains a condition expression for a role binding. # Successful calls to this method always return an HTTP `200 OK` status code, # even if the linter detects an issue in the IAM policy. # @param [Google::Apis::IamV1::LintPolicyRequest] lint_policy_request_object @@ -83,9 +82,8 @@ module Google execute_or_queue_command(command, &block) end - # Returns a list of services that allow you to opt into audit logs that are - # not generated by default. - # To learn more about audit logs, see the [Logging + # Returns a list of services that allow you to opt into audit logs that are not + # generated by default. To learn more about audit logs, see the [Logging # documentation](https://cloud.google.com/logging/docs/audit). # @param [Google::Apis::IamV1::QueryAuditableServicesRequest] query_auditable_services_request_object # @param [String] fields @@ -118,24 +116,19 @@ module Google # Creates a new custom Role. # @param [String] parent - # The `parent` parameter's value depends on the target resource for the - # request, namely - # [`projects`](/iam/reference/rest/v1/projects.roles) or - # [`organizations`](/iam/reference/rest/v1/organizations.roles). Each - # resource type's `parent` value format is described below: - # * [`projects.roles.create()`](/iam/reference/rest/v1/projects.roles/create): - # `projects/`PROJECT_ID``. This method creates project-level - # [custom roles](/iam/docs/understanding-custom-roles). - # Example request URL: - # `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles` - # * [`organizations.roles.create()`](/iam/reference/rest/v1/organizations.roles/ - # create): - # `organizations/`ORGANIZATION_ID``. This method creates organization-level - # [custom roles](/iam/docs/understanding-custom-roles). Example request - # URL: - # `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles` - # Note: Wildcard (*) values are invalid; you must specify a complete project - # ID or organization ID. + # The `parent` parameter's value depends on the target resource for the request, + # namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`] + # (/iam/reference/rest/v1/organizations.roles). Each resource type's `parent` + # value format is described below: * [`projects.roles.create()`](/iam/reference/ + # rest/v1/projects.roles/create): `projects/`PROJECT_ID``. This method creates + # project-level [custom roles](/iam/docs/understanding-custom-roles). Example + # request URL: `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles` * [` + # organizations.roles.create()`](/iam/reference/rest/v1/organizations.roles/ + # create): `organizations/`ORGANIZATION_ID``. This method creates organization- + # level [custom roles](/iam/docs/understanding-custom-roles). Example request + # URL: `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles` + # Note: Wildcard (*) values are invalid; you must specify a complete project ID + # or organization ID. # @param [Google::Apis::IamV1::CreateRoleRequest] create_role_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -166,39 +159,30 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a custom Role. - # When you delete a custom role, the following changes occur immediately: - # * You cannot bind a member to the custom role in an IAM - # Policy. - # * Existing bindings to the custom role are not changed, but they have no - # effect. - # * By default, the response from ListRoles does not include the custom - # role. - # You have 7 days to undelete the custom role. After 7 days, the following - # changes occur: - # * The custom role is permanently deleted and cannot be recovered. - # * If an IAM policy contains a binding to the custom role, the binding is - # permanently removed. + # Deletes a custom Role. When you delete a custom role, the following changes + # occur immediately: * You cannot bind a member to the custom role in an IAM + # Policy. * Existing bindings to the custom role are not changed, but they have + # no effect. * By default, the response from ListRoles does not include the + # custom role. You have 7 days to undelete the custom role. After 7 days, the + # following changes occur: * The custom role is permanently deleted and cannot + # be recovered. * If an IAM policy contains a binding to the custom role, the + # binding is permanently removed. # @param [String] name - # The `name` parameter's value depends on the target resource for the - # request, namely - # [`projects`](/iam/reference/rest/v1/projects.roles) or - # [`organizations`](/iam/reference/rest/v1/organizations.roles). Each - # resource type's `name` value format is described below: - # * [`projects.roles.delete()`](/iam/reference/rest/v1/projects.roles/delete): - # `projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID``. This method deletes only - # [custom roles](/iam/docs/understanding-custom-roles) that have been - # created at the project level. Example request URL: - # `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID`` - # * [`organizations.roles.delete()`](/iam/reference/rest/v1/organizations.roles/ - # delete): - # `organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID``. This method - # deletes only [custom roles](/iam/docs/understanding-custom-roles) that - # have been created at the organization level. Example request URL: - # `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles/` - # CUSTOM_ROLE_ID`` - # Note: Wildcard (*) values are invalid; you must specify a complete project - # ID or organization ID. + # The `name` parameter's value depends on the target resource for the request, + # namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`] + # (/iam/reference/rest/v1/organizations.roles). Each resource type's `name` + # value format is described below: * [`projects.roles.delete()`](/iam/reference/ + # rest/v1/projects.roles/delete): `projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID``. + # This method deletes only [custom roles](/iam/docs/understanding-custom-roles) + # that have been created at the project level. Example request URL: `https://iam. + # googleapis.com/v1/projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID`` * [` + # organizations.roles.delete()`](/iam/reference/rest/v1/organizations.roles/ + # delete): `organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID``. This method + # deletes only [custom roles](/iam/docs/understanding-custom-roles) that have + # been created at the organization level. Example request URL: `https://iam. + # googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID`` Note: + # Wildcard (*) values are invalid; you must specify a complete project ID or + # organization ID. # @param [String] etag # Used to perform a consistent read-modify-write. # @param [String] fields @@ -231,31 +215,25 @@ module Google # Gets the definition of a Role. # @param [String] name - # The `name` parameter's value depends on the target resource for the - # request, namely - # [`roles`](/iam/reference/rest/v1/roles), - # [`projects`](/iam/reference/rest/v1/projects.roles), or - # [`organizations`](/iam/reference/rest/v1/organizations.roles). Each - # resource type's `name` value format is described below: - # * [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/`ROLE_NAME``. - # This method returns results from all - # [predefined roles](/iam/docs/understanding-roles#predefined_roles) in - # Cloud IAM. Example request URL: - # `https://iam.googleapis.com/v1/roles/`ROLE_NAME`` - # * [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get): - # `projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID``. This method returns only - # [custom roles](/iam/docs/understanding-custom-roles) that have been - # created at the project level. Example request URL: - # `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID`` - # * [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get) - # : - # `organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID``. This method - # returns only [custom roles](/iam/docs/understanding-custom-roles) that - # have been created at the organization level. Example request URL: - # `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles/` - # CUSTOM_ROLE_ID`` - # Note: Wildcard (*) values are invalid; you must specify a complete project - # ID or organization ID. + # The `name` parameter's value depends on the target resource for the request, + # namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/ + # rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/ + # organizations.roles). Each resource type's `name` value format is described + # below: * [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/`ROLE_NAME`` + # . This method returns results from all [predefined roles](/iam/docs/ + # understanding-roles#predefined_roles) in Cloud IAM. Example request URL: ` + # https://iam.googleapis.com/v1/roles/`ROLE_NAME`` * [`projects.roles.get()`](/ + # iam/reference/rest/v1/projects.roles/get): `projects/`PROJECT_ID`/roles/` + # CUSTOM_ROLE_ID``. This method returns only [custom roles](/iam/docs/ + # understanding-custom-roles) that have been created at the project level. + # Example request URL: `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/ + # roles/`CUSTOM_ROLE_ID`` * [`organizations.roles.get()`](/iam/reference/rest/v1/ + # organizations.roles/get): `organizations/`ORGANIZATION_ID`/roles/` + # CUSTOM_ROLE_ID``. This method returns only [custom roles](/iam/docs/ + # understanding-custom-roles) that have been created at the organization level. + # Example request URL: `https://iam.googleapis.com/v1/organizations/` + # ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID`` Note: Wildcard (*) values are invalid; + # you must specify a complete project ID or organization ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -283,45 +261,38 @@ module Google execute_or_queue_command(command, &block) end - # Lists every predefined Role that IAM supports, or every custom role - # that is defined for an organization or project. + # Lists every predefined Role that IAM supports, or every custom role that is + # defined for an organization or project. # @param [String] parent - # The `parent` parameter's value depends on the target resource for the - # request, namely - # [`roles`](/iam/reference/rest/v1/roles), - # [`projects`](/iam/reference/rest/v1/projects.roles), or - # [`organizations`](/iam/reference/rest/v1/organizations.roles). Each - # resource type's `parent` value format is described below: - # * [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. - # This method doesn't require a resource; it simply returns all - # [predefined roles](/iam/docs/understanding-roles#predefined_roles) in - # Cloud IAM. Example request URL: - # `https://iam.googleapis.com/v1/roles` - # * [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list): - # `projects/`PROJECT_ID``. This method lists all project-level - # [custom roles](/iam/docs/understanding-custom-roles). - # Example request URL: - # `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles` - # * [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/ - # list): - # `organizations/`ORGANIZATION_ID``. This method lists all - # organization-level [custom roles](/iam/docs/understanding-custom-roles). - # Example request URL: - # `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles` - # Note: Wildcard (*) values are invalid; you must specify a complete project - # ID or organization ID. + # The `parent` parameter's value depends on the target resource for the request, + # namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/ + # rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/ + # organizations.roles). Each resource type's `parent` value format is described + # below: * [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. + # This method doesn't require a resource; it simply returns all [predefined + # roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example + # request URL: `https://iam.googleapis.com/v1/roles` * [`projects.roles.list()`]( + # /iam/reference/rest/v1/projects.roles/list): `projects/`PROJECT_ID``. This + # method lists all project-level [custom roles](/iam/docs/understanding-custom- + # roles). Example request URL: `https://iam.googleapis.com/v1/projects/` + # PROJECT_ID`/roles` * [`organizations.roles.list()`](/iam/reference/rest/v1/ + # organizations.roles/list): `organizations/`ORGANIZATION_ID``. This method + # lists all organization-level [custom roles](/iam/docs/understanding-custom- + # roles). Example request URL: `https://iam.googleapis.com/v1/organizations/` + # ORGANIZATION_ID`/roles` Note: Wildcard (*) values are invalid; you must + # specify a complete project ID or organization ID. # @param [Fixnum] page_size - # Optional limit on the number of roles to include in the response. - # The default is 300, and the maximum is 1,000. + # Optional limit on the number of roles to include in the response. The default + # is 300, and the maximum is 1,000. # @param [String] page_token # Optional pagination token returned in an earlier ListRolesResponse. # @param [Boolean] show_deleted # Include Roles that have been deleted. # @param [String] view - # Optional view for the returned Role objects. When `FULL` is specified, - # the `includedPermissions` field is returned, which includes a list of all - # permissions in the role. The default value is `BASIC`, which does not - # return the `includedPermissions` field. + # Optional view for the returned Role objects. When `FULL` is specified, the ` + # includedPermissions` field is returned, which includes a list of all + # permissions in the role. The default value is `BASIC`, which does not return + # the `includedPermissions` field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -355,25 +326,21 @@ module Google # Updates the definition of a custom Role. # @param [String] name - # The `name` parameter's value depends on the target resource for the - # request, namely - # [`projects`](/iam/reference/rest/v1/projects.roles) or - # [`organizations`](/iam/reference/rest/v1/organizations.roles). Each - # resource type's `name` value format is described below: - # * [`projects.roles.patch()`](/iam/reference/rest/v1/projects.roles/patch): - # `projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID``. This method updates only - # [custom roles](/iam/docs/understanding-custom-roles) that have been - # created at the project level. Example request URL: - # `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID`` - # * [`organizations.roles.patch()`](/iam/reference/rest/v1/organizations.roles/ - # patch): - # `organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID``. This method - # updates only [custom roles](/iam/docs/understanding-custom-roles) that - # have been created at the organization level. Example request URL: - # `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles/` - # CUSTOM_ROLE_ID`` - # Note: Wildcard (*) values are invalid; you must specify a complete project - # ID or organization ID. + # The `name` parameter's value depends on the target resource for the request, + # namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`] + # (/iam/reference/rest/v1/organizations.roles). Each resource type's `name` + # value format is described below: * [`projects.roles.patch()`](/iam/reference/ + # rest/v1/projects.roles/patch): `projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID``. + # This method updates only [custom roles](/iam/docs/understanding-custom-roles) + # that have been created at the project level. Example request URL: `https://iam. + # googleapis.com/v1/projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID`` * [` + # organizations.roles.patch()`](/iam/reference/rest/v1/organizations.roles/patch) + # : `organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID``. This method + # updates only [custom roles](/iam/docs/understanding-custom-roles) that have + # been created at the organization level. Example request URL: `https://iam. + # googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID`` Note: + # Wildcard (*) values are invalid; you must specify a complete project ID or + # organization ID. # @param [Google::Apis::IamV1::Role] role_object # @param [String] update_mask # A mask describing which fields in the Role have changed. @@ -409,26 +376,21 @@ module Google # Undeletes a custom Role. # @param [String] name - # The `name` parameter's value depends on the target resource for the - # request, namely - # [`projects`](/iam/reference/rest/v1/projects.roles) or - # [`organizations`](/iam/reference/rest/v1/organizations.roles). Each - # resource type's `name` value format is described below: - # * [`projects.roles.undelete()`](/iam/reference/rest/v1/projects.roles/undelete) - # : - # `projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID``. This method undeletes - # only [custom roles](/iam/docs/understanding-custom-roles) that have been - # created at the project level. Example request URL: - # `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID`` - # * [`organizations.roles.undelete()`](/iam/reference/rest/v1/organizations. - # roles/undelete): - # `organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID``. This method - # undeletes only [custom roles](/iam/docs/understanding-custom-roles) that - # have been created at the organization level. Example request URL: - # `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles/` - # CUSTOM_ROLE_ID`` - # Note: Wildcard (*) values are invalid; you must specify a complete project - # ID or organization ID. + # The `name` parameter's value depends on the target resource for the request, + # namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`] + # (/iam/reference/rest/v1/organizations.roles). Each resource type's `name` + # value format is described below: * [`projects.roles.undelete()`](/iam/ + # reference/rest/v1/projects.roles/undelete): `projects/`PROJECT_ID`/roles/` + # CUSTOM_ROLE_ID``. This method undeletes only [custom roles](/iam/docs/ + # understanding-custom-roles) that have been created at the project level. + # Example request URL: `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/ + # roles/`CUSTOM_ROLE_ID`` * [`organizations.roles.undelete()`](/iam/reference/ + # rest/v1/organizations.roles/undelete): `organizations/`ORGANIZATION_ID`/roles/` + # CUSTOM_ROLE_ID``. This method undeletes only [custom roles](/iam/docs/ + # understanding-custom-roles) that have been created at the organization level. + # Example request URL: `https://iam.googleapis.com/v1/organizations/` + # ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID`` Note: Wildcard (*) values are invalid; + # you must specify a complete project ID or organization ID. # @param [Google::Apis::IamV1::UndeleteRoleRequest] undelete_role_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -460,8 +422,7 @@ module Google end # Lists every permission that you can test on a resource. A permission is - # testable if you can check whether a member has that permission on the - # resource. + # testable if you can check whether a member has that permission on the resource. # @param [Google::Apis::IamV1::QueryTestablePermissionsRequest] query_testable_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -493,24 +454,19 @@ module Google # Creates a new custom Role. # @param [String] parent - # The `parent` parameter's value depends on the target resource for the - # request, namely - # [`projects`](/iam/reference/rest/v1/projects.roles) or - # [`organizations`](/iam/reference/rest/v1/organizations.roles). Each - # resource type's `parent` value format is described below: - # * [`projects.roles.create()`](/iam/reference/rest/v1/projects.roles/create): - # `projects/`PROJECT_ID``. This method creates project-level - # [custom roles](/iam/docs/understanding-custom-roles). - # Example request URL: - # `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles` - # * [`organizations.roles.create()`](/iam/reference/rest/v1/organizations.roles/ - # create): - # `organizations/`ORGANIZATION_ID``. This method creates organization-level - # [custom roles](/iam/docs/understanding-custom-roles). Example request - # URL: - # `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles` - # Note: Wildcard (*) values are invalid; you must specify a complete project - # ID or organization ID. + # The `parent` parameter's value depends on the target resource for the request, + # namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`] + # (/iam/reference/rest/v1/organizations.roles). Each resource type's `parent` + # value format is described below: * [`projects.roles.create()`](/iam/reference/ + # rest/v1/projects.roles/create): `projects/`PROJECT_ID``. This method creates + # project-level [custom roles](/iam/docs/understanding-custom-roles). Example + # request URL: `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles` * [` + # organizations.roles.create()`](/iam/reference/rest/v1/organizations.roles/ + # create): `organizations/`ORGANIZATION_ID``. This method creates organization- + # level [custom roles](/iam/docs/understanding-custom-roles). Example request + # URL: `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles` + # Note: Wildcard (*) values are invalid; you must specify a complete project ID + # or organization ID. # @param [Google::Apis::IamV1::CreateRoleRequest] create_role_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -541,39 +497,30 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a custom Role. - # When you delete a custom role, the following changes occur immediately: - # * You cannot bind a member to the custom role in an IAM - # Policy. - # * Existing bindings to the custom role are not changed, but they have no - # effect. - # * By default, the response from ListRoles does not include the custom - # role. - # You have 7 days to undelete the custom role. After 7 days, the following - # changes occur: - # * The custom role is permanently deleted and cannot be recovered. - # * If an IAM policy contains a binding to the custom role, the binding is - # permanently removed. + # Deletes a custom Role. When you delete a custom role, the following changes + # occur immediately: * You cannot bind a member to the custom role in an IAM + # Policy. * Existing bindings to the custom role are not changed, but they have + # no effect. * By default, the response from ListRoles does not include the + # custom role. You have 7 days to undelete the custom role. After 7 days, the + # following changes occur: * The custom role is permanently deleted and cannot + # be recovered. * If an IAM policy contains a binding to the custom role, the + # binding is permanently removed. # @param [String] name - # The `name` parameter's value depends on the target resource for the - # request, namely - # [`projects`](/iam/reference/rest/v1/projects.roles) or - # [`organizations`](/iam/reference/rest/v1/organizations.roles). Each - # resource type's `name` value format is described below: - # * [`projects.roles.delete()`](/iam/reference/rest/v1/projects.roles/delete): - # `projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID``. This method deletes only - # [custom roles](/iam/docs/understanding-custom-roles) that have been - # created at the project level. Example request URL: - # `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID`` - # * [`organizations.roles.delete()`](/iam/reference/rest/v1/organizations.roles/ - # delete): - # `organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID``. This method - # deletes only [custom roles](/iam/docs/understanding-custom-roles) that - # have been created at the organization level. Example request URL: - # `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles/` - # CUSTOM_ROLE_ID`` - # Note: Wildcard (*) values are invalid; you must specify a complete project - # ID or organization ID. + # The `name` parameter's value depends on the target resource for the request, + # namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`] + # (/iam/reference/rest/v1/organizations.roles). Each resource type's `name` + # value format is described below: * [`projects.roles.delete()`](/iam/reference/ + # rest/v1/projects.roles/delete): `projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID``. + # This method deletes only [custom roles](/iam/docs/understanding-custom-roles) + # that have been created at the project level. Example request URL: `https://iam. + # googleapis.com/v1/projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID`` * [` + # organizations.roles.delete()`](/iam/reference/rest/v1/organizations.roles/ + # delete): `organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID``. This method + # deletes only [custom roles](/iam/docs/understanding-custom-roles) that have + # been created at the organization level. Example request URL: `https://iam. + # googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID`` Note: + # Wildcard (*) values are invalid; you must specify a complete project ID or + # organization ID. # @param [String] etag # Used to perform a consistent read-modify-write. # @param [String] fields @@ -606,31 +553,25 @@ module Google # Gets the definition of a Role. # @param [String] name - # The `name` parameter's value depends on the target resource for the - # request, namely - # [`roles`](/iam/reference/rest/v1/roles), - # [`projects`](/iam/reference/rest/v1/projects.roles), or - # [`organizations`](/iam/reference/rest/v1/organizations.roles). Each - # resource type's `name` value format is described below: - # * [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/`ROLE_NAME``. - # This method returns results from all - # [predefined roles](/iam/docs/understanding-roles#predefined_roles) in - # Cloud IAM. Example request URL: - # `https://iam.googleapis.com/v1/roles/`ROLE_NAME`` - # * [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get): - # `projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID``. This method returns only - # [custom roles](/iam/docs/understanding-custom-roles) that have been - # created at the project level. Example request URL: - # `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID`` - # * [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get) - # : - # `organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID``. This method - # returns only [custom roles](/iam/docs/understanding-custom-roles) that - # have been created at the organization level. Example request URL: - # `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles/` - # CUSTOM_ROLE_ID`` - # Note: Wildcard (*) values are invalid; you must specify a complete project - # ID or organization ID. + # The `name` parameter's value depends on the target resource for the request, + # namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/ + # rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/ + # organizations.roles). Each resource type's `name` value format is described + # below: * [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/`ROLE_NAME`` + # . This method returns results from all [predefined roles](/iam/docs/ + # understanding-roles#predefined_roles) in Cloud IAM. Example request URL: ` + # https://iam.googleapis.com/v1/roles/`ROLE_NAME`` * [`projects.roles.get()`](/ + # iam/reference/rest/v1/projects.roles/get): `projects/`PROJECT_ID`/roles/` + # CUSTOM_ROLE_ID``. This method returns only [custom roles](/iam/docs/ + # understanding-custom-roles) that have been created at the project level. + # Example request URL: `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/ + # roles/`CUSTOM_ROLE_ID`` * [`organizations.roles.get()`](/iam/reference/rest/v1/ + # organizations.roles/get): `organizations/`ORGANIZATION_ID`/roles/` + # CUSTOM_ROLE_ID``. This method returns only [custom roles](/iam/docs/ + # understanding-custom-roles) that have been created at the organization level. + # Example request URL: `https://iam.googleapis.com/v1/organizations/` + # ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID`` Note: Wildcard (*) values are invalid; + # you must specify a complete project ID or organization ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -658,45 +599,38 @@ module Google execute_or_queue_command(command, &block) end - # Lists every predefined Role that IAM supports, or every custom role - # that is defined for an organization or project. + # Lists every predefined Role that IAM supports, or every custom role that is + # defined for an organization or project. # @param [String] parent - # The `parent` parameter's value depends on the target resource for the - # request, namely - # [`roles`](/iam/reference/rest/v1/roles), - # [`projects`](/iam/reference/rest/v1/projects.roles), or - # [`organizations`](/iam/reference/rest/v1/organizations.roles). Each - # resource type's `parent` value format is described below: - # * [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. - # This method doesn't require a resource; it simply returns all - # [predefined roles](/iam/docs/understanding-roles#predefined_roles) in - # Cloud IAM. Example request URL: - # `https://iam.googleapis.com/v1/roles` - # * [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list): - # `projects/`PROJECT_ID``. This method lists all project-level - # [custom roles](/iam/docs/understanding-custom-roles). - # Example request URL: - # `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles` - # * [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/ - # list): - # `organizations/`ORGANIZATION_ID``. This method lists all - # organization-level [custom roles](/iam/docs/understanding-custom-roles). - # Example request URL: - # `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles` - # Note: Wildcard (*) values are invalid; you must specify a complete project - # ID or organization ID. + # The `parent` parameter's value depends on the target resource for the request, + # namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/ + # rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/ + # organizations.roles). Each resource type's `parent` value format is described + # below: * [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. + # This method doesn't require a resource; it simply returns all [predefined + # roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example + # request URL: `https://iam.googleapis.com/v1/roles` * [`projects.roles.list()`]( + # /iam/reference/rest/v1/projects.roles/list): `projects/`PROJECT_ID``. This + # method lists all project-level [custom roles](/iam/docs/understanding-custom- + # roles). Example request URL: `https://iam.googleapis.com/v1/projects/` + # PROJECT_ID`/roles` * [`organizations.roles.list()`](/iam/reference/rest/v1/ + # organizations.roles/list): `organizations/`ORGANIZATION_ID``. This method + # lists all organization-level [custom roles](/iam/docs/understanding-custom- + # roles). Example request URL: `https://iam.googleapis.com/v1/organizations/` + # ORGANIZATION_ID`/roles` Note: Wildcard (*) values are invalid; you must + # specify a complete project ID or organization ID. # @param [Fixnum] page_size - # Optional limit on the number of roles to include in the response. - # The default is 300, and the maximum is 1,000. + # Optional limit on the number of roles to include in the response. The default + # is 300, and the maximum is 1,000. # @param [String] page_token # Optional pagination token returned in an earlier ListRolesResponse. # @param [Boolean] show_deleted # Include Roles that have been deleted. # @param [String] view - # Optional view for the returned Role objects. When `FULL` is specified, - # the `includedPermissions` field is returned, which includes a list of all - # permissions in the role. The default value is `BASIC`, which does not - # return the `includedPermissions` field. + # Optional view for the returned Role objects. When `FULL` is specified, the ` + # includedPermissions` field is returned, which includes a list of all + # permissions in the role. The default value is `BASIC`, which does not return + # the `includedPermissions` field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -730,25 +664,21 @@ module Google # Updates the definition of a custom Role. # @param [String] name - # The `name` parameter's value depends on the target resource for the - # request, namely - # [`projects`](/iam/reference/rest/v1/projects.roles) or - # [`organizations`](/iam/reference/rest/v1/organizations.roles). Each - # resource type's `name` value format is described below: - # * [`projects.roles.patch()`](/iam/reference/rest/v1/projects.roles/patch): - # `projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID``. This method updates only - # [custom roles](/iam/docs/understanding-custom-roles) that have been - # created at the project level. Example request URL: - # `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID`` - # * [`organizations.roles.patch()`](/iam/reference/rest/v1/organizations.roles/ - # patch): - # `organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID``. This method - # updates only [custom roles](/iam/docs/understanding-custom-roles) that - # have been created at the organization level. Example request URL: - # `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles/` - # CUSTOM_ROLE_ID`` - # Note: Wildcard (*) values are invalid; you must specify a complete project - # ID or organization ID. + # The `name` parameter's value depends on the target resource for the request, + # namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`] + # (/iam/reference/rest/v1/organizations.roles). Each resource type's `name` + # value format is described below: * [`projects.roles.patch()`](/iam/reference/ + # rest/v1/projects.roles/patch): `projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID``. + # This method updates only [custom roles](/iam/docs/understanding-custom-roles) + # that have been created at the project level. Example request URL: `https://iam. + # googleapis.com/v1/projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID`` * [` + # organizations.roles.patch()`](/iam/reference/rest/v1/organizations.roles/patch) + # : `organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID``. This method + # updates only [custom roles](/iam/docs/understanding-custom-roles) that have + # been created at the organization level. Example request URL: `https://iam. + # googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID`` Note: + # Wildcard (*) values are invalid; you must specify a complete project ID or + # organization ID. # @param [Google::Apis::IamV1::Role] role_object # @param [String] update_mask # A mask describing which fields in the Role have changed. @@ -784,26 +714,21 @@ module Google # Undeletes a custom Role. # @param [String] name - # The `name` parameter's value depends on the target resource for the - # request, namely - # [`projects`](/iam/reference/rest/v1/projects.roles) or - # [`organizations`](/iam/reference/rest/v1/organizations.roles). Each - # resource type's `name` value format is described below: - # * [`projects.roles.undelete()`](/iam/reference/rest/v1/projects.roles/undelete) - # : - # `projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID``. This method undeletes - # only [custom roles](/iam/docs/understanding-custom-roles) that have been - # created at the project level. Example request URL: - # `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID`` - # * [`organizations.roles.undelete()`](/iam/reference/rest/v1/organizations. - # roles/undelete): - # `organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID``. This method - # undeletes only [custom roles](/iam/docs/understanding-custom-roles) that - # have been created at the organization level. Example request URL: - # `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles/` - # CUSTOM_ROLE_ID`` - # Note: Wildcard (*) values are invalid; you must specify a complete project - # ID or organization ID. + # The `name` parameter's value depends on the target resource for the request, + # namely [`projects`](/iam/reference/rest/v1/projects.roles) or [`organizations`] + # (/iam/reference/rest/v1/organizations.roles). Each resource type's `name` + # value format is described below: * [`projects.roles.undelete()`](/iam/ + # reference/rest/v1/projects.roles/undelete): `projects/`PROJECT_ID`/roles/` + # CUSTOM_ROLE_ID``. This method undeletes only [custom roles](/iam/docs/ + # understanding-custom-roles) that have been created at the project level. + # Example request URL: `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/ + # roles/`CUSTOM_ROLE_ID`` * [`organizations.roles.undelete()`](/iam/reference/ + # rest/v1/organizations.roles/undelete): `organizations/`ORGANIZATION_ID`/roles/` + # CUSTOM_ROLE_ID``. This method undeletes only [custom roles](/iam/docs/ + # understanding-custom-roles) that have been created at the organization level. + # Example request URL: `https://iam.googleapis.com/v1/organizations/` + # ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID`` Note: Wildcard (*) values are invalid; + # you must specify a complete project ID or organization ID. # @param [Google::Apis::IamV1::UndeleteRoleRequest] undelete_role_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -868,24 +793,21 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a ServiceAccount. - # **Warning:** After you delete a service account, you might not be able to - # undelete it. If you know that you need to re-enable the service account in - # the future, use DisableServiceAccount instead. - # If you delete a service account, IAM permanently removes the service - # account 30 days later. Google Cloud cannot recover the service account - # after it is permanently removed, even if you file a support request. - # To help avoid unplanned outages, we recommend that you disable the service - # account before you delete it. Use DisableServiceAccount to disable the - # service account, then wait at least 24 hours and watch for unintended - # consequences. If there are no unintended consequences, you can delete the - # service account. + # Deletes a ServiceAccount. **Warning:** After you delete a service account, you + # might not be able to undelete it. If you know that you need to re-enable the + # service account in the future, use DisableServiceAccount instead. If you + # delete a service account, IAM permanently removes the service account 30 days + # later. Google Cloud cannot recover the service account after it is permanently + # removed, even if you file a support request. To help avoid unplanned outages, + # we recommend that you disable the service account before you delete it. Use + # DisableServiceAccount to disable the service account, then wait at least 24 + # hours and watch for unintended consequences. If there are no unintended + # consequences, you can delete the service account. # @param [String] name - # Required. The resource name of the service account in the following format: - # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. - # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from - # the account. The `ACCOUNT` value can be the `email` address or the - # `unique_id` of the service account. + # Required. The resource name of the service account in the following format: ` + # projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. Using `-` as a wildcard for + # the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value + # can be the `email` address or the `unique_id` of the service account. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -913,25 +835,22 @@ module Google execute_or_queue_command(command, &block) end - # Disables a ServiceAccount immediately. - # If an application uses the service account to authenticate, that - # application can no longer call Google APIs or access Google Cloud - # resources. Existing access tokens for the service account are rejected, and - # requests for new access tokens will fail. - # To re-enable the service account, use EnableServiceAccount. After you - # re-enable the service account, its existing access tokens will be accepted, - # and you can request new access tokens. - # To help avoid unplanned outages, we recommend that you disable the service - # account before you delete it. Use this method to disable the service - # account, then wait at least 24 hours and watch for unintended consequences. - # If there are no unintended consequences, you can delete the service account - # with DeleteServiceAccount. + # Disables a ServiceAccount immediately. If an application uses the service + # account to authenticate, that application can no longer call Google APIs or + # access Google Cloud resources. Existing access tokens for the service account + # are rejected, and requests for new access tokens will fail. To re-enable the + # service account, use EnableServiceAccount. After you re-enable the service + # account, its existing access tokens will be accepted, and you can request new + # access tokens. To help avoid unplanned outages, we recommend that you disable + # the service account before you delete it. Use this method to disable the + # service account, then wait at least 24 hours and watch for unintended + # consequences. If there are no unintended consequences, you can delete the + # service account with DeleteServiceAccount. # @param [String] name - # The resource name of the service account in the following format: - # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. - # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from - # the account. The `ACCOUNT` value can be the `email` address or the - # `unique_id` of the service account. + # The resource name of the service account in the following format: `projects/` + # PROJECT_ID`/serviceAccounts/`ACCOUNT``. Using `-` as a wildcard for the ` + # PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can + # be the `email` address or the `unique_id` of the service account. # @param [Google::Apis::IamV1::DisableServiceAccountRequest] disable_service_account_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -962,18 +881,16 @@ module Google execute_or_queue_command(command, &block) end - # Enables a ServiceAccount that was disabled by - # DisableServiceAccount. - # If the service account is already enabled, then this method has no effect. - # If the service account was disabled by other means—for example, if Google - # disabled the service account because it was compromised—you cannot use this - # method to enable the service account. + # Enables a ServiceAccount that was disabled by DisableServiceAccount. If the + # service account is already enabled, then this method has no effect. If the + # service account was disabled by other means—for example, if Google disabled + # the service account because it was compromised—you cannot use this method to + # enable the service account. # @param [String] name - # The resource name of the service account in the following format: - # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. - # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from - # the account. The `ACCOUNT` value can be the `email` address or the - # `unique_id` of the service account. + # The resource name of the service account in the following format: `projects/` + # PROJECT_ID`/serviceAccounts/`ACCOUNT``. Using `-` as a wildcard for the ` + # PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can + # be the `email` address or the `unique_id` of the service account. # @param [Google::Apis::IamV1::EnableServiceAccountRequest] enable_service_account_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1006,11 +923,10 @@ module Google # Gets a ServiceAccount. # @param [String] name - # Required. The resource name of the service account in the following format: - # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. - # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from - # the account. The `ACCOUNT` value can be the `email` address or the - # `unique_id` of the service account. + # Required. The resource name of the service account in the following format: ` + # projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. Using `-` as a wildcard for + # the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value + # can be the `email` address or the `unique_id` of the service account. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1038,29 +954,25 @@ module Google execute_or_queue_command(command, &block) end - # Gets the IAM policy that is attached to a ServiceAccount. This IAM - # policy specifies which members have access to the service account. - # This method does not tell you whether the service account has been granted - # any roles on other resources. To check whether a service account has role - # grants on a resource, use the `getIamPolicy` method for that resource. For - # example, to view the role grants for a project, call the Resource Manager - # API's - # [`projects.getIamPolicy`](https://cloud.google.com/resource-manager/reference/ - # rest/v1/projects/getIamPolicy) - # method. + # Gets the IAM policy that is attached to a ServiceAccount. This IAM policy + # specifies which members have access to the service account. This method does + # not tell you whether the service account has been granted any roles on other + # resources. To check whether a service account has role grants on a resource, + # use the `getIamPolicy` method for that resource. For example, to view the role + # grants for a project, call the Resource Manager API's [`projects.getIamPolicy`] + # (https://cloud.google.com/resource-manager/reference/rest/v1/projects/ + # getIamPolicy) method. # @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 @@ -1094,14 +1006,13 @@ module Google # Required. The resource name of the project associated with the service # accounts, such as `projects/my-project-123`. # @param [Fixnum] page_size - # Optional limit on the number of service accounts to include in the - # response. Further accounts can subsequently be obtained by including the - # ListServiceAccountsResponse.next_page_token - # in a subsequent request. - # The default is 20, and the maximum is 100. + # Optional limit on the number of service accounts to include in the response. + # Further accounts can subsequently be obtained by including the + # ListServiceAccountsResponse.next_page_token in a subsequent request. The + # default is 20, and the maximum is 100. # @param [String] page_token - # Optional pagination token returned in an earlier - # ListServiceAccountsResponse.next_page_token. + # Optional pagination token returned in an earlier ListServiceAccountsResponse. + # next_page_token. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1133,19 +1044,15 @@ module Google # Patches a ServiceAccount. # @param [String] name - # The resource name of the service account. - # Use one of the following formats: - # * `projects/`PROJECT_ID`/serviceAccounts/`EMAIL_ADDRESS`` - # * `projects/`PROJECT_ID`/serviceAccounts/`UNIQUE_ID`` - # As an alternative, you can use the `-` wildcard character instead of the - # project ID: - # * `projects/-/serviceAccounts/`EMAIL_ADDRESS`` - # * `projects/-/serviceAccounts/`UNIQUE_ID`` - # When possible, avoid using the `-` wildcard character, because it can cause - # response messages to contain misleading error codes. For example, if you - # try to get the service account - # `projects/-/serviceAccounts/fake@example.com`, which does not exist, the - # response contains an HTTP `403 Forbidden` error instead of a `404 Not + # The resource name of the service account. Use one of the following formats: * ` + # projects/`PROJECT_ID`/serviceAccounts/`EMAIL_ADDRESS`` * `projects/`PROJECT_ID` + # /serviceAccounts/`UNIQUE_ID`` As an alternative, you can use the `-` wildcard + # character instead of the project ID: * `projects/-/serviceAccounts/` + # EMAIL_ADDRESS`` * `projects/-/serviceAccounts/`UNIQUE_ID`` When possible, + # avoid using the `-` wildcard character, because it can cause response messages + # to contain misleading error codes. For example, if you try to get the service + # account `projects/-/serviceAccounts/fake@example.com`, which does not exist, + # the response contains an HTTP `403 Forbidden` error instead of a `404 Not # Found` error. # @param [Google::Apis::IamV1::PatchServiceAccountRequest] patch_service_account_request_object # @param [String] fields @@ -1177,23 +1084,20 @@ module Google execute_or_queue_command(command, &block) end - # Sets the IAM policy that is attached to a ServiceAccount. - # Use this method to grant or revoke access to the service account. For - # example, you could grant a member the ability to impersonate the service - # account. - # This method does not enable the service account to access other resources. - # To grant roles to a service account on a resource, follow these steps: - # 1. Call the resource's `getIamPolicy` method to get its current IAM policy. - # 2. Edit the policy so that it binds the service account to an IAM role for - # the resource. - # 3. Call the resource's `setIamPolicy` method to update its IAM policy. - # For detailed instructions, see - # [Granting roles to a service account for specific - # resources](https://cloud.google.com/iam/help/service-accounts/granting-access- - # to-service-accounts). + # Sets the IAM policy that is attached to a ServiceAccount. Use this method to + # grant or revoke access to the service account. For example, you could grant a + # member the ability to impersonate the service account. This method does not + # enable the service account to access other resources. To grant roles to a + # service account on a resource, follow these steps: 1. Call the resource's ` + # getIamPolicy` method to get its current IAM policy. 2. Edit the policy so that + # it binds the service account to an IAM role for the resource. 3. Call the + # resource's `setIamPolicy` method to update its IAM policy. For detailed + # instructions, see [Granting roles to a service account for specific resources]( + # https://cloud.google.com/iam/help/service-accounts/granting-access-to-service- + # accounts). # @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::IamV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1224,23 +1128,20 @@ module Google execute_or_queue_command(command, &block) end - # **Note:** This method is deprecated and will stop working on July 1, 2021. - # Use the - # [`signBlob`](https://cloud.google.com/iam/help/rest-credentials/v1/projects. - # serviceAccounts/signBlob) - # method in the IAM Service Account Credentials API instead. If you currently - # use this method, see the [migration + # **Note:** This method is deprecated and will stop working on July 1, 2021. Use + # the [`signBlob`](https://cloud.google.com/iam/help/rest-credentials/v1/ + # projects.serviceAccounts/signBlob) method in the IAM Service Account + # Credentials API instead. If you currently use this method, see the [migration # guide](https://cloud.google.com/iam/help/credentials/migrate-api) for - # instructions. - # Signs a blob using the system-managed private key for a ServiceAccount. + # instructions. Signs a blob using the system-managed private key for a + # ServiceAccount. # @param [String] name - # Required. Deprecated. [Migrate to Service Account Credentials - # API](https://cloud.google.com/iam/help/credentials/migrate-api). - # The resource name of the service account in the following format: - # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. - # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from - # the account. The `ACCOUNT` value can be the `email` address or the - # `unique_id` of the service account. + # Required. Deprecated. [Migrate to Service Account Credentials API](https:// + # cloud.google.com/iam/help/credentials/migrate-api). The resource name of the + # service account in the following format: `projects/`PROJECT_ID`/ + # serviceAccounts/`ACCOUNT``. Using `-` as a wildcard for the `PROJECT_ID` will + # infer the project from the account. The `ACCOUNT` value can be the `email` + # address or the `unique_id` of the service account. # @param [Google::Apis::IamV1::SignBlobRequest] sign_blob_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1271,24 +1172,19 @@ module Google execute_or_queue_command(command, &block) end - # **Note:** This method is deprecated and will stop working on July 1, 2021. - # Use the - # [`signJwt`](https://cloud.google.com/iam/help/rest-credentials/v1/projects. - # serviceAccounts/signJwt) - # method in the IAM Service Account Credentials API instead. If you currently - # use this method, see the [migration - # guide](https://cloud.google.com/iam/help/credentials/migrate-api) for - # instructions. - # Signs a JSON Web Token (JWT) using the system-managed private key for a - # ServiceAccount. + # **Note:** This method is deprecated and will stop working on July 1, 2021. Use + # the [`signJwt`](https://cloud.google.com/iam/help/rest-credentials/v1/projects. + # serviceAccounts/signJwt) method in the IAM Service Account Credentials API + # instead. If you currently use this method, see the [migration guide](https:// + # cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a + # JSON Web Token (JWT) using the system-managed private key for a ServiceAccount. # @param [String] name - # Required. Deprecated. [Migrate to Service Account Credentials - # API](https://cloud.google.com/iam/help/credentials/migrate-api). - # The resource name of the service account in the following format: - # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. - # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from - # the account. The `ACCOUNT` value can be the `email` address or the - # `unique_id` of the service account. + # Required. Deprecated. [Migrate to Service Account Credentials API](https:// + # cloud.google.com/iam/help/credentials/migrate-api). The resource name of the + # service account in the following format: `projects/`PROJECT_ID`/ + # serviceAccounts/`ACCOUNT``. Using `-` as a wildcard for the `PROJECT_ID` will + # infer the project from the account. The `ACCOUNT` value can be the `email` + # address or the `unique_id` of the service account. # @param [Google::Apis::IamV1::SignJwtRequest] sign_jwt_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1319,11 +1215,10 @@ module Google execute_or_queue_command(command, &block) end - # Tests whether the caller has the specified permissions on a - # ServiceAccount. + # Tests whether the caller has the specified permissions on a ServiceAccount. # @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::IamV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1354,17 +1249,15 @@ module Google execute_or_queue_command(command, &block) end - # Restores a deleted ServiceAccount. - # **Important:** It is not always possible to restore a deleted service - # account. Use this method only as a last resort. + # Restores a deleted ServiceAccount. **Important:** It is not always possible to + # restore a deleted service account. Use this method only as a last resort. # After you delete a service account, IAM permanently removes the service # account 30 days later. There is no way to restore a deleted service account # that has been permanently removed. # @param [String] name - # The resource name of the service account in the following format: - # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT_UNIQUE_ID``. - # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from - # the account. + # The resource name of the service account in the following format: `projects/` + # PROJECT_ID`/serviceAccounts/`ACCOUNT_UNIQUE_ID``. Using `-` as a wildcard for + # the `PROJECT_ID` will infer the project from the account. # @param [Google::Apis::IamV1::UndeleteServiceAccountRequest] undelete_service_account_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1396,23 +1289,18 @@ module Google end # **Note:** We are in the process of deprecating this method. Use - # PatchServiceAccount instead. - # Updates a ServiceAccount. - # You can update only the `display_name` and `description` fields. + # PatchServiceAccount instead. Updates a ServiceAccount. You can update only the + # `display_name` and `description` fields. # @param [String] name - # The resource name of the service account. - # Use one of the following formats: - # * `projects/`PROJECT_ID`/serviceAccounts/`EMAIL_ADDRESS`` - # * `projects/`PROJECT_ID`/serviceAccounts/`UNIQUE_ID`` - # As an alternative, you can use the `-` wildcard character instead of the - # project ID: - # * `projects/-/serviceAccounts/`EMAIL_ADDRESS`` - # * `projects/-/serviceAccounts/`UNIQUE_ID`` - # When possible, avoid using the `-` wildcard character, because it can cause - # response messages to contain misleading error codes. For example, if you - # try to get the service account - # `projects/-/serviceAccounts/fake@example.com`, which does not exist, the - # response contains an HTTP `403 Forbidden` error instead of a `404 Not + # The resource name of the service account. Use one of the following formats: * ` + # projects/`PROJECT_ID`/serviceAccounts/`EMAIL_ADDRESS`` * `projects/`PROJECT_ID` + # /serviceAccounts/`UNIQUE_ID`` As an alternative, you can use the `-` wildcard + # character instead of the project ID: * `projects/-/serviceAccounts/` + # EMAIL_ADDRESS`` * `projects/-/serviceAccounts/`UNIQUE_ID`` When possible, + # avoid using the `-` wildcard character, because it can cause response messages + # to contain misleading error codes. For example, if you try to get the service + # account `projects/-/serviceAccounts/fake@example.com`, which does not exist, + # the response contains an HTTP `403 Forbidden` error instead of a `404 Not # Found` error. # @param [Google::Apis::IamV1::ServiceAccount] service_account_object # @param [String] fields @@ -1446,11 +1334,10 @@ module Google # Creates a ServiceAccountKey. # @param [String] name - # Required. The resource name of the service account in the following format: - # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. - # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from - # the account. The `ACCOUNT` value can be the `email` address or the - # `unique_id` of the service account. + # Required. The resource name of the service account in the following format: ` + # projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. Using `-` as a wildcard for + # the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value + # can be the `email` address or the `unique_id` of the service account. # @param [Google::Apis::IamV1::CreateServiceAccountKeyRequest] create_service_account_key_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1484,10 +1371,10 @@ module Google # Deletes a ServiceAccountKey. # @param [String] name # Required. The resource name of the service account key in the following format: - # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT`/keys/`key``. - # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from - # the account. The `ACCOUNT` value can be the `email` address or the - # `unique_id` of the service account. + # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT`/keys/`key``. Using `-` as a + # wildcard for the `PROJECT_ID` will infer the project from the account. The ` + # ACCOUNT` value can be the `email` address or the `unique_id` of the service + # account. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1518,13 +1405,13 @@ module Google # Gets a ServiceAccountKey. # @param [String] name # Required. The resource name of the service account key in the following format: - # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT`/keys/`key``. - # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from - # the account. The `ACCOUNT` value can be the `email` address or the - # `unique_id` of the service account. + # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT`/keys/`key``. Using `-` as a + # wildcard for the `PROJECT_ID` will infer the project from the account. The ` + # ACCOUNT` value can be the `email` address or the `unique_id` of the service + # account. # @param [String] public_key_type - # The output format of the public key requested. - # X509_PEM is the default output format. + # The output format of the public key requested. X509_PEM is the default output + # format. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1555,15 +1442,14 @@ module Google # Lists every ServiceAccountKey for a service account. # @param [String] name - # Required. The resource name of the service account in the following format: - # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. - # Using `-` as a wildcard for the `PROJECT_ID`, will infer the project from - # the account. The `ACCOUNT` value can be the `email` address or the - # `unique_id` of the service account. + # Required. The resource name of the service account in the following format: ` + # projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. Using `-` as a wildcard for + # the `PROJECT_ID`, will infer the project from the account. The `ACCOUNT` value + # can be the `email` address or the `unique_id` of the service account. # @param [Array, String] key_types - # Filters the types of keys the user wants to include in the list - # response. Duplicate key types are not allowed. If no key type - # is provided, all keys are returned. + # Filters the types of keys the user wants to include in the list response. + # Duplicate key types are not allowed. If no key type is provided, all keys are + # returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1594,11 +1480,10 @@ module Google # Creates a ServiceAccountKey, using a public key that you provide. # @param [String] name - # The resource name of the service account in the following format: - # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. - # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from - # the account. The `ACCOUNT` value can be the `email` address or the - # `unique_id` of the service account. + # The resource name of the service account in the following format: `projects/` + # PROJECT_ID`/serviceAccounts/`ACCOUNT``. Using `-` as a wildcard for the ` + # PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can + # be the `email` address or the `unique_id` of the service account. # @param [Google::Apis::IamV1::UploadServiceAccountKeyRequest] upload_service_account_key_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1631,31 +1516,25 @@ module Google # Gets the definition of a Role. # @param [String] name - # The `name` parameter's value depends on the target resource for the - # request, namely - # [`roles`](/iam/reference/rest/v1/roles), - # [`projects`](/iam/reference/rest/v1/projects.roles), or - # [`organizations`](/iam/reference/rest/v1/organizations.roles). Each - # resource type's `name` value format is described below: - # * [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/`ROLE_NAME``. - # This method returns results from all - # [predefined roles](/iam/docs/understanding-roles#predefined_roles) in - # Cloud IAM. Example request URL: - # `https://iam.googleapis.com/v1/roles/`ROLE_NAME`` - # * [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get): - # `projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID``. This method returns only - # [custom roles](/iam/docs/understanding-custom-roles) that have been - # created at the project level. Example request URL: - # `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles/`CUSTOM_ROLE_ID`` - # * [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get) - # : - # `organizations/`ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID``. This method - # returns only [custom roles](/iam/docs/understanding-custom-roles) that - # have been created at the organization level. Example request URL: - # `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles/` - # CUSTOM_ROLE_ID`` - # Note: Wildcard (*) values are invalid; you must specify a complete project - # ID or organization ID. + # The `name` parameter's value depends on the target resource for the request, + # namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/ + # rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/ + # organizations.roles). Each resource type's `name` value format is described + # below: * [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/`ROLE_NAME`` + # . This method returns results from all [predefined roles](/iam/docs/ + # understanding-roles#predefined_roles) in Cloud IAM. Example request URL: ` + # https://iam.googleapis.com/v1/roles/`ROLE_NAME`` * [`projects.roles.get()`](/ + # iam/reference/rest/v1/projects.roles/get): `projects/`PROJECT_ID`/roles/` + # CUSTOM_ROLE_ID``. This method returns only [custom roles](/iam/docs/ + # understanding-custom-roles) that have been created at the project level. + # Example request URL: `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/ + # roles/`CUSTOM_ROLE_ID`` * [`organizations.roles.get()`](/iam/reference/rest/v1/ + # organizations.roles/get): `organizations/`ORGANIZATION_ID`/roles/` + # CUSTOM_ROLE_ID``. This method returns only [custom roles](/iam/docs/ + # understanding-custom-roles) that have been created at the organization level. + # Example request URL: `https://iam.googleapis.com/v1/organizations/` + # ORGANIZATION_ID`/roles/`CUSTOM_ROLE_ID`` Note: Wildcard (*) values are invalid; + # you must specify a complete project ID or organization ID. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1683,45 +1562,38 @@ module Google execute_or_queue_command(command, &block) end - # Lists every predefined Role that IAM supports, or every custom role - # that is defined for an organization or project. + # Lists every predefined Role that IAM supports, or every custom role that is + # defined for an organization or project. # @param [Fixnum] page_size - # Optional limit on the number of roles to include in the response. - # The default is 300, and the maximum is 1,000. + # Optional limit on the number of roles to include in the response. The default + # is 300, and the maximum is 1,000. # @param [String] page_token # Optional pagination token returned in an earlier ListRolesResponse. # @param [String] parent - # The `parent` parameter's value depends on the target resource for the - # request, namely - # [`roles`](/iam/reference/rest/v1/roles), - # [`projects`](/iam/reference/rest/v1/projects.roles), or - # [`organizations`](/iam/reference/rest/v1/organizations.roles). Each - # resource type's `parent` value format is described below: - # * [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. - # This method doesn't require a resource; it simply returns all - # [predefined roles](/iam/docs/understanding-roles#predefined_roles) in - # Cloud IAM. Example request URL: - # `https://iam.googleapis.com/v1/roles` - # * [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list): - # `projects/`PROJECT_ID``. This method lists all project-level - # [custom roles](/iam/docs/understanding-custom-roles). - # Example request URL: - # `https://iam.googleapis.com/v1/projects/`PROJECT_ID`/roles` - # * [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/ - # list): - # `organizations/`ORGANIZATION_ID``. This method lists all - # organization-level [custom roles](/iam/docs/understanding-custom-roles). - # Example request URL: - # `https://iam.googleapis.com/v1/organizations/`ORGANIZATION_ID`/roles` - # Note: Wildcard (*) values are invalid; you must specify a complete project - # ID or organization ID. + # The `parent` parameter's value depends on the target resource for the request, + # namely [`roles`](/iam/reference/rest/v1/roles), [`projects`](/iam/reference/ + # rest/v1/projects.roles), or [`organizations`](/iam/reference/rest/v1/ + # organizations.roles). Each resource type's `parent` value format is described + # below: * [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. + # This method doesn't require a resource; it simply returns all [predefined + # roles](/iam/docs/understanding-roles#predefined_roles) in Cloud IAM. Example + # request URL: `https://iam.googleapis.com/v1/roles` * [`projects.roles.list()`]( + # /iam/reference/rest/v1/projects.roles/list): `projects/`PROJECT_ID``. This + # method lists all project-level [custom roles](/iam/docs/understanding-custom- + # roles). Example request URL: `https://iam.googleapis.com/v1/projects/` + # PROJECT_ID`/roles` * [`organizations.roles.list()`](/iam/reference/rest/v1/ + # organizations.roles/list): `organizations/`ORGANIZATION_ID``. This method + # lists all organization-level [custom roles](/iam/docs/understanding-custom- + # roles). Example request URL: `https://iam.googleapis.com/v1/organizations/` + # ORGANIZATION_ID`/roles` Note: Wildcard (*) values are invalid; you must + # specify a complete project ID or organization ID. # @param [Boolean] show_deleted # Include Roles that have been deleted. # @param [String] view - # Optional view for the returned Role objects. When `FULL` is specified, - # the `includedPermissions` field is returned, which includes a list of all - # permissions in the role. The default value is `BASIC`, which does not - # return the `includedPermissions` field. + # Optional view for the returned Role objects. When `FULL` is specified, the ` + # includedPermissions` field is returned, which includes a list of all + # permissions in the role. The default value is `BASIC`, which does not return + # the `includedPermissions` field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1754,8 +1626,7 @@ module Google end # Lists roles that can be granted on a Google Cloud resource. A role is - # grantable if the IAM policy for the resource can contain bindings to the - # role. + # grantable if the IAM policy for the resource can contain bindings to the role. # @param [Google::Apis::IamV1::QueryGrantableRolesRequest] query_grantable_roles_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/osconfig_v1.rb b/generated/google/apis/osconfig_v1.rb index bb14e84c4..296f0410b 100644 --- a/generated/google/apis/osconfig_v1.rb +++ b/generated/google/apis/osconfig_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/ module OsconfigV1 VERSION = 'V1' - REVISION = '20200731' + REVISION = '20200807' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/osconfig_v1/classes.rb b/generated/google/apis/osconfig_v1/classes.rb index 47c03061a..fc5a38f04 100644 --- a/generated/google/apis/osconfig_v1/classes.rb +++ b/generated/google/apis/osconfig_v1/classes.rb @@ -22,8 +22,8 @@ module Google module Apis module OsconfigV1 - # Apt patching is completed by executing `apt-get update && apt-get - # upgrade`. Additional options can be set to control how this is executed. + # Apt patching is completed by executing `apt-get update && apt-get upgrade`. + # Additional options can be set to control how this is executed. class AptSettings include Google::Apis::Core::Hashable @@ -32,16 +32,15 @@ module Google # @return [Array] attr_accessor :excludes - # An exclusive list of packages to be updated. These are the only packages - # that will be updated. If these packages are not installed, they will be - # ignored. This field cannot be specified with any other patch configuration - # fields. + # An exclusive list of packages to be updated. These are the only packages that + # will be updated. If these packages are not installed, they will be ignored. + # This field cannot be specified with any other patch configuration fields. # Corresponds to the JSON property `exclusivePackages` # @return [Array] attr_accessor :exclusive_packages - # By changing the type to DIST, the patching is performed - # using `apt-get dist-upgrade` instead. + # By changing the type to DIST, the patching is performed using `apt-get dist- + # upgrade` instead. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -71,13 +70,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 @@ -187,8 +184,8 @@ module Google class ExecStepConfig include Google::Apis::Core::Hashable - # Defaults to [0]. A list of possible return values that the - # execution can return to indicate a success. + # Defaults to [0]. A list of possible return values that the execution can + # return to indicate a success. # Corresponds to the JSON property `allowedSuccessCodes` # @return [Array] attr_accessor :allowed_success_codes @@ -199,9 +196,9 @@ module Google attr_accessor :gcs_object # The script interpreter to use to run the script. If no interpreter is - # specified the script will be executed directly, which will likely - # only succeed for scripts with [shebang lines] - # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). + # specified the script will be executed directly, which will likely only succeed + # for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\ + # )). # Corresponds to the JSON property `interpreter` # @return [String] attr_accessor :interpreter @@ -224,13 +221,12 @@ module Google end end - # A request message to initiate patching across Compute Engine - # instances. + # A request message to initiate patching across Compute Engine instances. class ExecutePatchJobRequest include Google::Apis::Core::Hashable - # Description of the patch job. Length of the description is limited - # to 1024 characters. + # Description of the patch job. Length of the description is limited to 1024 + # characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -240,29 +236,26 @@ module Google # @return [String] attr_accessor :display_name - # If this patch is a dry-run only, instances are contacted but - # will do nothing. + # If this patch is a dry-run only, instances are contacted but will do nothing. # Corresponds to the JSON property `dryRun` # @return [Boolean] attr_accessor :dry_run alias_method :dry_run?, :dry_run - # Duration of the patch job. After the duration ends, the patch job - # times out. + # Duration of the patch job. After the duration ends, the patch job times out. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # A filter to target VM instances for patching. The targeted - # VMs must meet all criteria specified. So if both labels and zones are - # specified, the patch job targets only VMs with those labels and in those - # zones. + # A filter to target VM instances for patching. The targeted VMs must meet all + # criteria specified. So if both labels and zones are specified, the patch job + # targets only VMs with those labels and in those zones. # Corresponds to the JSON property `instanceFilter` # @return [Google::Apis::OsconfigV1::PatchInstanceFilter] attr_accessor :instance_filter - # Patch configuration specifications. Contains details on how to apply the - # patch(es) to a VM instance. + # Patch configuration specifications. Contains details on how to apply the patch( + # es) to a VM instance. # Corresponds to the JSON property `patchConfig` # @return [Google::Apis::OsconfigV1::PatchConfig] attr_accessor :patch_config @@ -293,9 +286,8 @@ module Google class ExtractArchiveResource include Google::Apis::Core::Hashable - # Local file path that signals this resource is in the desired state. - # The absence of this file will indicate whether the archive needs to be - # extracted. + # Local file path that signals this resource is in the desired state. The + # absence of this file will indicate whether the archive needs to be extracted. # Corresponds to the JSON property `creates` # @return [String] attr_accessor :creates @@ -305,9 +297,9 @@ module Google # @return [String] attr_accessor :destination - # Whether to overwrite existing files during extraction. If this is set to - # true, any existing files in the destination location will be overwritten by - # the extraction. + # Whether to overwrite existing files during extraction. If this is set to true, + # any existing files in the destination location will be overwritten by the + # extraction. # Corresponds to the JSON property `overwrite` # @return [Boolean] attr_accessor :overwrite @@ -341,10 +333,9 @@ module Google class File include Google::Apis::Core::Hashable - # Defaults to false. When false, files will be subject to validations - # based on the file type: - # Remote: A checksum must be specified. - # GCS: An object generation number must be specified. + # Defaults to false. When false, files will be subject to validations based on + # the file type: Remote: A checksum must be specified. GCS: An object generation + # number must be specified. # Corresponds to the JSON property `allowInsecure` # @return [Boolean] attr_accessor :allow_insecure @@ -418,8 +409,8 @@ module Google # @return [String] attr_accessor :sha256_checksum - # URI from which to fetch the object. It should contain both the protocol - # and path following the format `protocol`://`location`. + # URI from which to fetch the object. It should contain both the protocol and + # path following the format `protocol`://`location`. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -454,18 +445,14 @@ module Google # @return [String] attr_accessor :path - # Consists of three octal digits which represent, in - # order, the permissions of the owner, group, and other users for the - # file (similarly to the numeric mode used in the linux chmod utility). - # Each digit represents a three bit number with the 4 bit - # corresponding to the read permissions, the 2 bit corresponds to the - # write bit, and the one bit corresponds to the execute permission. - # Default behavior is 755. - # Below are some examples of permissions and their associated values: - # read, write, and execute: 7 - # read and execute: 5 - # read and write: 6 - # read only: 4 + # Consists of three octal digits which represent, in order, the permissions of + # the owner, group, and other users for the file (similarly to the numeric mode + # used in the linux chmod utility). Each digit represents a three bit number + # with the 4 bit corresponding to the read permissions, the 2 bit corresponds to + # the write bit, and the one bit corresponds to the execute permission. Default + # behavior is 755. Below are some examples of permissions and their associated + # values: read, write, and execute: 7 read and execute: 5 read and write: 6 read + # only: 4 # Corresponds to the JSON property `permissions` # @return [String] attr_accessor :permissions @@ -499,8 +486,8 @@ module Google # @return [Fixnum] attr_accessor :fixed - # Specifies the relative value defined as a percentage, which will be - # multiplied by a reference value. + # Specifies the relative value defined as a percentage, which will be multiplied + # by a reference value. # Corresponds to the JSON property `percent` # @return [Fixnum] attr_accessor :percent @@ -565,8 +552,7 @@ module Google class ListPatchDeploymentsResponse include Google::Apis::Core::Hashable - # A pagination token that can be used to get the next page of patch - # deployments. + # A pagination token that can be used to get the next page of patch deployments. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -637,15 +623,15 @@ module Google end end - # Represents a monthly schedule. An example of a valid monthly schedule is - # "on the third Tuesday of the month" or "on the 15th of the month". + # Represents a monthly schedule. An example of a valid monthly schedule is "on + # the third Tuesday of the month" or "on the 15th of the month". class MonthlySchedule include Google::Apis::Core::Hashable # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 - # indicates the last day of the month. - # Months without the target day will be skipped. For example, a schedule to - # run "every month on the 31st" will not run in February, April, June, etc. + # indicates the last day of the month. Months without the target day will be + # skipped. For example, a schedule to run "every month on the 31st" will not run + # in February, April, June, etc. # Corresponds to the JSON property `monthDay` # @return [Fixnum] attr_accessor :month_day @@ -666,8 +652,8 @@ module Google end end - # Sets the time for a one time patch deployment. Timestamp is in - # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https: + # //www.ietf.org/rfc/rfc3339.txt) text format. class OneTimeSchedule include Google::Apis::Core::Hashable @@ -690,9 +676,8 @@ module Google class PackageResource include Google::Apis::Core::Hashable - # A package managed by APT. - # install: `apt-get update && apt-get -y install [name]` - # remove: `apt-get -y remove [name]` + # A package managed by APT. install: `apt-get update && apt-get -y install [name] + # ` remove: `apt-get -y remove [name]` # Corresponds to the JSON property `apt` # @return [Google::Apis::OsconfigV1::PackageResourceApt] attr_accessor :apt @@ -702,21 +687,20 @@ module Google # @return [Google::Apis::OsconfigV1::PackageResourceDeb] attr_accessor :deb - # The desired_state the agent should maintain for this package. The - # default is to ensure the package is installed. + # The desired_state the agent should maintain for this package. The default is + # to ensure the package is installed. # Corresponds to the JSON property `desiredState` # @return [String] attr_accessor :desired_state - # A package managed by GooGet. - # install: `googet -noconfirm install package` + # A package managed by GooGet. install: `googet -noconfirm install package` # remove: `googet -noconfirm remove package` # Corresponds to the JSON property `googet` # @return [Google::Apis::OsconfigV1::PackageResourceGooGet] attr_accessor :googet - # An MSI package. MSI packages only support INSTALLED state. - # Install msiexec /i /qn /norestart + # An MSI package. MSI packages only support INSTALLED state. Install msiexec /i / + # qn /norestart # Corresponds to the JSON property `msi` # @return [Google::Apis::OsconfigV1::PackageResourceMsi] attr_accessor :msi @@ -726,16 +710,14 @@ module Google # @return [Google::Apis::OsconfigV1::PackageResourceRpm] attr_accessor :rpm - # A package managed by YUM. - # install: `yum -y install package` - # remove: `yum -y remove package` + # A package managed by YUM. install: `yum -y install package` remove: `yum -y + # remove package` # Corresponds to the JSON property `yum` # @return [Google::Apis::OsconfigV1::PackageResourceYum] attr_accessor :yum - # A package managed by Zypper. - # install: `zypper -y install package` - # remove: `zypper -y rm package` + # A package managed by Zypper. install: `zypper -y install package` remove: ` + # zypper -y rm package` # Corresponds to the JSON property `zypper` # @return [Google::Apis::OsconfigV1::PackageResourceZypper] attr_accessor :zypper @@ -757,9 +739,8 @@ module Google end end - # A package managed by APT. - # install: `apt-get update && apt-get -y install [name]` - # remove: `apt-get -y remove [name]` + # A package managed by APT. install: `apt-get update && apt-get -y install [name] + # ` remove: `apt-get -y remove [name]` class PackageResourceApt include Google::Apis::Core::Hashable @@ -782,9 +763,8 @@ module Google class PackageResourceDeb include Google::Apis::Core::Hashable - # Whether dependencies should also be installed. - # install when false: `dpkg -i package` - # install when true: `apt-get update && apt-get -y install package.deb` + # Whether dependencies should also be installed. install when false: `dpkg -i + # package` install when true: `apt-get update && apt-get -y install package.deb` # Corresponds to the JSON property `pullDeps` # @return [Boolean] attr_accessor :pull_deps @@ -806,8 +786,7 @@ module Google end end - # A package managed by GooGet. - # install: `googet -noconfirm install package` + # A package managed by GooGet. install: `googet -noconfirm install package` # remove: `googet -noconfirm remove package` class PackageResourceGooGet include Google::Apis::Core::Hashable @@ -827,19 +806,19 @@ module Google end end - # An MSI package. MSI packages only support INSTALLED state. - # Install msiexec /i /qn /norestart + # An MSI package. MSI packages only support INSTALLED state. Install msiexec /i / + # qn /norestart class PackageResourceMsi include Google::Apis::Core::Hashable - # Return codes that indicate that the software installed or updated - # successfully. Behaviour defaults to [0] + # Return codes that indicate that the software installed or updated successfully. + # Behaviour defaults to [0] # Corresponds to the JSON property `allowedSuccessCodes` # @return [Array] attr_accessor :allowed_success_codes - # Flags to use during package install. - # Appended to the defalts of "/i /qn /norestart" + # Flags to use during package install. Appended to the defalts of "/i /qn / + # norestart" # Corresponds to the JSON property `flags` # @return [Array] attr_accessor :flags @@ -865,10 +844,9 @@ module Google class PackageResourceRpm include Google::Apis::Core::Hashable - # Whether dependencies should also be installed. - # install when false: `rpm --upgrade --replacepkgs package.rpm` - # install when true: `yum -y install package.rpm` or - # `zypper -y install package.rpm` + # Whether dependencies should also be installed. install when false: `rpm -- + # upgrade --replacepkgs package.rpm` install when true: `yum -y install package. + # rpm` or `zypper -y install package.rpm` # Corresponds to the JSON property `pullDeps` # @return [Boolean] attr_accessor :pull_deps @@ -890,9 +868,8 @@ module Google end end - # A package managed by YUM. - # install: `yum -y install package` - # remove: `yum -y remove package` + # A package managed by YUM. install: `yum -y install package` remove: `yum -y + # remove package` class PackageResourceYum include Google::Apis::Core::Hashable @@ -911,9 +888,8 @@ module Google end end - # A package managed by Zypper. - # install: `zypper -y install package` - # remove: `zypper -y rm package` + # A package managed by Zypper. install: `zypper -y install package` remove: ` + # zypper -y rm package` class PackageResourceZypper include Google::Apis::Core::Hashable @@ -932,13 +908,13 @@ module Google end end - # Patch configuration specifications. Contains details on how to apply the - # patch(es) to a VM instance. + # Patch configuration specifications. Contains details on how to apply the patch( + # es) to a VM instance. class PatchConfig include Google::Apis::Core::Hashable - # Apt patching is completed by executing `apt-get update && apt-get - # upgrade`. Additional options can be set to control how this is executed. + # Apt patching is completed by executing `apt-get update && apt-get upgrade`. + # Additional options can be set to control how this is executed. # Corresponds to the JSON property `apt` # @return [Google::Apis::OsconfigV1::AptSettings] attr_accessor :apt @@ -968,15 +944,15 @@ module Google # @return [Google::Apis::OsconfigV1::WindowsUpdateSettings] attr_accessor :windows_update - # Yum patching is performed by executing `yum update`. Additional options - # can be set to control how this is executed. - # Note that not all settings are supported on all platforms. + # Yum patching is performed by executing `yum update`. Additional options can be + # set to control how this is executed. Note that not all settings are supported + # on all platforms. # Corresponds to the JSON property `yum` # @return [Google::Apis::OsconfigV1::YumSettings] attr_accessor :yum - # Zypper patching is performed by running `zypper patch`. - # See also https://en.opensuse.org/SDB:Zypper_manual. + # Zypper patching is performed by running `zypper patch`. See also https://en. + # opensuse.org/SDB:Zypper_manual. # Corresponds to the JSON property `zypper` # @return [Google::Apis::OsconfigV1::ZypperSettings] attr_accessor :zypper @@ -1001,21 +977,19 @@ module Google # Patch deployments are configurations that individual patch jobs use to # complete a patch. These configurations include instance filter, package # repository settings, and a schedule. For more information about creating and - # managing patch deployments, see [Scheduling patch - # jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch- - # jobs). + # managing patch deployments, see [Scheduling patch jobs](https://cloud.google. + # com/compute/docs/os-patch-management/schedule-patch-jobs). class PatchDeployment include Google::Apis::Core::Hashable - # Output only. Time the patch deployment was created. Timestamp is in - # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + # Output only. Time the patch deployment was created. Timestamp is in [RFC3339]( + # https://www.ietf.org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Optional. Description of the patch deployment. Length of the description is - # limited - # to 1024 characters. + # limited to 1024 characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1025,37 +999,35 @@ module Google # @return [String] attr_accessor :duration - # A filter to target VM instances for patching. The targeted - # VMs must meet all criteria specified. So if both labels and zones are - # specified, the patch job targets only VMs with those labels and in those - # zones. + # A filter to target VM instances for patching. The targeted VMs must meet all + # criteria specified. So if both labels and zones are specified, the patch job + # targets only VMs with those labels and in those zones. # Corresponds to the JSON property `instanceFilter` # @return [Google::Apis::OsconfigV1::PatchInstanceFilter] attr_accessor :instance_filter # Output only. The last time a patch job was started by this deployment. - # Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text - # format. + # Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `lastExecuteTime` # @return [String] attr_accessor :last_execute_time # Unique name for the patch deployment resource in a project. The patch - # deployment name is in the form: - # `projects/`project_id`/patchDeployments/`patch_deployment_id``. - # This field is ignored when you create a new patch deployment. + # deployment name is in the form: `projects/`project_id`/patchDeployments/` + # patch_deployment_id``. This field is ignored when you create a new patch + # deployment. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Sets the time for a one time patch deployment. Timestamp is in - # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https: + # //www.ietf.org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `oneTimeSchedule` # @return [Google::Apis::OsconfigV1::OneTimeSchedule] attr_accessor :one_time_schedule - # Patch configuration specifications. Contains details on how to apply the - # patch(es) to a VM instance. + # Patch configuration specifications. Contains details on how to apply the patch( + # es) to a VM instance. # Corresponds to the JSON property `patchConfig` # @return [Google::Apis::OsconfigV1::PatchConfig] attr_accessor :patch_config @@ -1071,8 +1043,8 @@ module Google # @return [Google::Apis::OsconfigV1::PatchRollout] attr_accessor :rollout - # Output only. Time the patch deployment was last updated. Timestamp is in - # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + # Output only. Time the patch deployment was last updated. Timestamp is in [ + # RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -1097,10 +1069,9 @@ module Google end end - # A filter to target VM instances for patching. The targeted - # VMs must meet all criteria specified. So if both labels and zones are - # specified, the patch job targets only VMs with those labels and in those - # zones. + # A filter to target VM instances for patching. The targeted VMs must meet all + # criteria specified. So if both labels and zones are specified, the patch job + # targets only VMs with those labels and in those zones. class PatchInstanceFilter include Google::Apis::Core::Hashable @@ -1111,30 +1082,30 @@ module Google attr_accessor :all alias_method :all?, :all - # Targets VM instances matching ANY of these GroupLabels. This allows - # targeting of disparate groups of VM instances. + # Targets VM instances matching ANY of these GroupLabels. This allows targeting + # of disparate groups of VM instances. # Corresponds to the JSON property `groupLabels` # @return [Array] attr_accessor :group_labels - # Targets VMs whose name starts with one of these prefixes. Similar to - # labels, this is another way to group VMs when targeting configs, for - # example prefix="prod-". + # Targets VMs whose name starts with one of these prefixes. Similar to labels, + # this is another way to group VMs when targeting configs, for example prefix=" + # prod-". # Corresponds to the JSON property `instanceNamePrefixes` # @return [Array] attr_accessor :instance_name_prefixes # Targets any of the VM instances specified. Instances are specified by their - # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, - # `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or - # `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/ - # instances/[INSTANCE_NAME]` + # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[ + # PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www. + # googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[ + # INSTANCE_NAME]` # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances - # Targets VM instances in ANY of these zones. Leave empty to target VM - # instances in any zone. + # Targets VM instances in ANY of these zones. Leave empty to target VM instances + # in any zone. # Corresponds to the JSON property `zones` # @return [Array] attr_accessor :zones @@ -1153,18 +1124,17 @@ module Google end end - # Targets a group of VM instances by using their [assigned - # labels](https://cloud.google.com/compute/docs/labeling-resources). Labels - # are key-value pairs. A `GroupLabel` is a combination of labels - # that is used to target VMs for a patch job. - # For example, a patch job can target VMs that have the following - # `GroupLabel`: ``"env":"test", "app":"web"``. This means that the patch job - # is applied to VMs that have both the labels `env=test` and `app=web`. + # Targets a group of VM instances by using their [assigned labels](https://cloud. + # google.com/compute/docs/labeling-resources). Labels are key-value pairs. A ` + # GroupLabel` is a combination of labels that is used to target VMs for a patch + # job. For example, a patch job can target VMs that have the following ` + # GroupLabel`: ``"env":"test", "app":"web"``. This means that the patch job is + # applied to VMs that have both the labels `env=test` and `app=web`. class PatchInstanceFilterGroupLabel include Google::Apis::Core::Hashable - # Compute Engine instance labels that must be present for a VM - # instance to be targeted by this filter. + # Compute Engine instance labels that must be present for a VM instance to be + # targeted by this filter. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -1179,14 +1149,11 @@ module Google end end - # A high level representation of a patch job that is either in progress - # or has completed. - # Instance details are not included in the job. To paginate through instance - # details, use ListPatchJobInstanceDetails. - # For more information about patch jobs, see - # [Creating patch - # jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch- - # job). + # A high level representation of a patch job that is either in progress or has + # completed. Instance details are not included in the job. To paginate through + # instance details, use ListPatchJobInstanceDetails. For more information about + # patch jobs, see [Creating patch jobs](https://cloud.google.com/compute/docs/os- + # patch-management/create-patch-job). class PatchJob include Google::Apis::Core::Hashable @@ -1195,8 +1162,8 @@ module Google # @return [String] attr_accessor :create_time - # Description of the patch job. Length of the description is limited - # to 1024 characters. + # Description of the patch job. Length of the description is limited to 1024 + # characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1206,49 +1173,45 @@ module Google # @return [String] attr_accessor :display_name - # If this patch job is a dry run, the agent reports that it has - # finished without running any updates on the VM instance. + # If this patch job is a dry run, the agent reports that it has finished without + # running any updates on the VM instance. # Corresponds to the JSON property `dryRun` # @return [Boolean] attr_accessor :dry_run alias_method :dry_run?, :dry_run - # Duration of the patch job. After the duration ends, the - # patch job times out. + # Duration of the patch job. After the duration ends, the patch job times out. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # If this patch job failed, this message provides information about the - # failure. + # If this patch job failed, this message provides information about the failure. # Corresponds to the JSON property `errorMessage` # @return [String] attr_accessor :error_message - # A summary of the current patch state across all instances that this patch - # job affects. Contains counts of instances in different states. These states - # map to `InstancePatchState`. List patch job instance details to see the - # specific states of each instance. + # A summary of the current patch state across all instances that this patch job + # affects. Contains counts of instances in different states. These states map to + # `InstancePatchState`. List patch job instance details to see the specific + # states of each instance. # Corresponds to the JSON property `instanceDetailsSummary` # @return [Google::Apis::OsconfigV1::PatchJobInstanceDetailsSummary] attr_accessor :instance_details_summary - # A filter to target VM instances for patching. The targeted - # VMs must meet all criteria specified. So if both labels and zones are - # specified, the patch job targets only VMs with those labels and in those - # zones. + # A filter to target VM instances for patching. The targeted VMs must meet all + # criteria specified. So if both labels and zones are specified, the patch job + # targets only VMs with those labels and in those zones. # Corresponds to the JSON property `instanceFilter` # @return [Google::Apis::OsconfigV1::PatchInstanceFilter] attr_accessor :instance_filter - # Unique identifier for this patch job in the form - # `projects/*/patchJobs/*` + # Unique identifier for this patch job in the form `projects/*/patchJobs/*` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Patch configuration specifications. Contains details on how to apply the - # patch(es) to a VM instance. + # Patch configuration specifications. Contains details on how to apply the patch( + # es) to a VM instance. # Corresponds to the JSON property `patchConfig` # @return [Google::Apis::OsconfigV1::PatchConfig] attr_accessor :patch_config @@ -1258,8 +1221,8 @@ module Google # @return [String] attr_accessor :patch_deployment - # Reflects the overall progress of the patch job in the range of - # 0.0 being no progress to 100.0 being complete. + # Reflects the overall progress of the patch job in the range of 0.0 being no + # progress to 100.0 being complete. # Corresponds to the JSON property `percentComplete` # @return [Float] attr_accessor :percent_complete @@ -1305,8 +1268,7 @@ module Google end # Patch details for a VM instance. For more information about reviewing VM - # instance details, see - # [Listing all VM instance details for a specific patch + # instance details, see [Listing all VM instance details for a specific patch # job](https://cloud.google.com/compute/docs/os-patch-management/manage-patch- # jobs#list-instance-details). class PatchJobInstanceDetails @@ -1322,8 +1284,8 @@ module Google # @return [String] attr_accessor :failure_reason - # The unique identifier for the instance. This identifier is - # defined by the server. + # The unique identifier for the instance. This identifier is defined by the + # server. # Corresponds to the JSON property `instanceSystemId` # @return [String] attr_accessor :instance_system_id @@ -1352,10 +1314,10 @@ module Google end end - # A summary of the current patch state across all instances that this patch - # job affects. Contains counts of instances in different states. These states - # map to `InstancePatchState`. List patch job instance details to see the - # specific states of each instance. + # A summary of the current patch state across all instances that this patch job + # affects. Contains counts of instances in different states. These states map to + # `InstancePatchState`. List patch job instance details to see the specific + # states of each instance. class PatchJobInstanceDetailsSummary include Google::Apis::Core::Hashable @@ -1385,8 +1347,8 @@ module Google attr_accessor :inactive_instance_count # Number of instances that do not appear to be running the agent. Check to - # ensure that the agent is installed, running, and able to communicate with - # the service. + # ensure that the agent is installed, running, and able to communicate with the + # service. # Corresponds to the JSON property `noAgentDetectedInstanceCount` # @return [Fixnum] attr_accessor :no_agent_detected_instance_count @@ -1492,8 +1454,7 @@ module Google include Google::Apis::Core::Hashable # Optional. The end time at which a recurring patch deployment schedule is no - # longer - # active. + # longer active. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -1508,8 +1469,8 @@ module Google # @return [String] attr_accessor :last_execute_time - # Represents a monthly schedule. An example of a valid monthly schedule is - # "on the third Tuesday of the month" or "on the 15th of the month". + # Represents a monthly schedule. An example of a valid monthly schedule is "on + # the third Tuesday of the month" or "on the 15th of the month". # Corresponds to the JSON property `monthly` # @return [Google::Apis::OsconfigV1::MonthlySchedule] attr_accessor :monthly @@ -1519,21 +1480,21 @@ module Google # @return [String] attr_accessor :next_execute_time - # Optional. The time that the recurring schedule becomes effective. - # Defaults to `create_time` of the patch deployment. + # Optional. The time that the recurring schedule becomes effective. Defaults to ` + # create_time` of the patch deployment. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time - # Represents a time of day. The date and time zone are either not significant - # or are specified elsewhere. An API may choose to allow leap seconds. Related + # Represents a time of day. The date and time zone are either not significant or + # are specified elsewhere. An API may choose to allow leap seconds. Related # types are google.type.Date and `google.protobuf.Timestamp`. # Corresponds to the JSON property `timeOfDay` # @return [Google::Apis::OsconfigV1::TimeOfDay] attr_accessor :time_of_day - # Represents a time zone from the - # [IANA Time Zone Database](https://www.iana.org/time-zones). + # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/ + # time-zones). # Corresponds to the JSON property `timeZone` # @return [Google::Apis::OsconfigV1::TimeZone] attr_accessor :time_zone @@ -1565,26 +1526,26 @@ module Google class RepositoryResource include Google::Apis::Core::Hashable - # Represents a single apt package repository. These will be added to a repo - # file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. + # Represents a single apt package repository. These will be added to a repo file + # that will be managed at /etc/apt/sources.list.d/google_osconfig.list. # Corresponds to the JSON property `apt` # @return [Google::Apis::OsconfigV1::RepositoryResourceAptRepository] attr_accessor :apt - # Represents a Goo package repository. These will be added to a repo file - # that will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. + # Represents a Goo package repository. These will be added to a repo file that + # will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. # Corresponds to the JSON property `goo` # @return [Google::Apis::OsconfigV1::RepositoryResourceGooRepository] attr_accessor :goo - # Represents a single yum package repository. These will be added to a repo - # file that will be managed at /etc/yum.repos.d/google_osconfig.repo. + # Represents a single yum package repository. These will be added to a repo file + # that will be managed at /etc/yum.repos.d/google_osconfig.repo. # Corresponds to the JSON property `yum` # @return [Google::Apis::OsconfigV1::RepositoryResourceYumRepository] attr_accessor :yum - # Represents a single zypper package repository. These will be added to a - # repo file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. + # Represents a single zypper package repository. These will be added to a repo + # file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. # Corresponds to the JSON property `zypper` # @return [Google::Apis::OsconfigV1::RepositoryResourceZypperRepository] attr_accessor :zypper @@ -1602,8 +1563,8 @@ module Google end end - # Represents a single apt package repository. These will be added to a repo - # file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. + # Represents a single apt package repository. These will be added to a repo file + # that will be managed at /etc/apt/sources.list.d/google_osconfig.list. class RepositoryResourceAptRepository include Google::Apis::Core::Hashable @@ -1622,8 +1583,8 @@ module Google # @return [String] attr_accessor :distribution - # URI of the key file for this repository. The agent will maintain - # a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg. + # URI of the key file for this repository. The agent will maintain a keyring at / + # etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg. # Corresponds to the JSON property `gpgKey` # @return [String] attr_accessor :gpg_key @@ -1647,8 +1608,8 @@ module Google end end - # Represents a Goo package repository. These will be added to a repo file - # that will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. + # Represents a Goo package repository. These will be added to a repo file that + # will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. class RepositoryResourceGooRepository include Google::Apis::Core::Hashable @@ -1673,8 +1634,8 @@ module Google end end - # Represents a single yum package repository. These will be added to a repo - # file that will be managed at /etc/yum.repos.d/google_osconfig.repo. + # Represents a single yum package repository. These will be added to a repo file + # that will be managed at /etc/yum.repos.d/google_osconfig.repo. class RepositoryResourceYumRepository include Google::Apis::Core::Hashable @@ -1693,10 +1654,9 @@ module Google # @return [Array] attr_accessor :gpg_keys - # A one word, unique name for this repository. This will be - # the `repo id` in the yum config file and also the `display_name` if - # `display_name` is omitted. This id is also used as the unique identifier - # when checking for resource conflicts. + # A one word, unique name for this repository. This will be the `repo id` in the + # yum config file and also the `display_name` if `display_name` is omitted. This + # id is also used as the unique identifier when checking for resource conflicts. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1714,8 +1674,8 @@ module Google end end - # Represents a single zypper package repository. These will be added to a - # repo file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. + # Represents a single zypper package repository. These will be added to a repo + # file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. class RepositoryResourceZypperRepository include Google::Apis::Core::Hashable @@ -1734,10 +1694,10 @@ module Google # @return [Array] attr_accessor :gpg_keys - # A one word, unique name for this repository. This will be - # the `repo id` in the zypper config file and also the `display_name` if - # `display_name` is omitted. This id is also used as the unique identifier - # when checking for GuestPolicy conflicts. + # A one word, unique name for this repository. This will be the `repo id` in the + # zypper config file and also the `display_name` if `display_name` is omitted. + # This id is also used as the unique identifier when checking for GuestPolicy + # conflicts. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -1768,14 +1728,14 @@ module Google end end - # Represents a time of day. The date and time zone are either not significant - # or are specified elsewhere. An API may choose to allow leap seconds. Related + # Represents a time of day. The date and time zone are either not significant or + # are specified elsewhere. An API may choose to allow leap seconds. Related # types are google.type.Date and `google.protobuf.Timestamp`. class TimeOfDay include Google::Apis::Core::Hashable - # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose - # to allow the value "24:00:00" for scenarios like business closing time. + # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to + # allow the value "24:00:00" for scenarios like business closing time. # Corresponds to the JSON property `hours` # @return [Fixnum] attr_accessor :hours @@ -1809,8 +1769,8 @@ module Google end end - # Represents a time zone from the - # [IANA Time Zone Database](https://www.iana.org/time-zones). + # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/ + # time-zones). class TimeZone include Google::Apis::Core::Hashable @@ -1845,8 +1805,7 @@ module Google attr_accessor :day_of_week # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the - # month. -1 - # indicates the last week of the month. + # month. -1 indicates the last week of the month. # Corresponds to the JSON property `weekOrdinal` # @return [Fixnum] attr_accessor :week_ordinal @@ -1896,9 +1855,8 @@ module Google # @return [Array] attr_accessor :excludes - # An exclusive list of kbs to be updated. These are the only patches - # that will be updated. This field must not be used with other - # patch configurations. + # An exclusive list of kbs to be updated. These are the only patches that will + # be updated. This field must not be used with other patch configurations. # Corresponds to the JSON property `exclusivePatches` # @return [Array] attr_accessor :exclusive_patches @@ -1915,22 +1873,21 @@ module Google end end - # Yum patching is performed by executing `yum update`. Additional options - # can be set to control how this is executed. - # Note that not all settings are supported on all platforms. + # Yum patching is performed by executing `yum update`. Additional options can be + # set to control how this is executed. Note that not all settings are supported + # on all platforms. class YumSettings include Google::Apis::Core::Hashable - # List of packages to exclude from update. These packages are excluded by - # using the yum `--exclude` flag. + # List of packages to exclude from update. These packages are excluded by using + # the yum `--exclude` flag. # Corresponds to the JSON property `excludes` # @return [Array] attr_accessor :excludes - # An exclusive list of packages to be updated. These are the only packages - # that will be updated. If these packages are not installed, they will be - # ignored. This field must not be specified with any other patch - # configuration fields. + # An exclusive list of packages to be updated. These are the only packages that + # will be updated. If these packages are not installed, they will be ignored. + # This field must not be specified with any other patch configuration fields. # Corresponds to the JSON property `exclusivePackages` # @return [Array] attr_accessor :exclusive_packages @@ -1941,8 +1898,7 @@ module Google attr_accessor :minimal alias_method :minimal?, :minimal - # Adds the `--security` flag to `yum update`. Not supported on - # all platforms. + # Adds the `--security` flag to `yum update`. Not supported on all platforms. # Corresponds to the JSON property `security` # @return [Boolean] attr_accessor :security @@ -1961,13 +1917,13 @@ module Google end end - # Zypper patching is performed by running `zypper patch`. - # See also https://en.opensuse.org/SDB:Zypper_manual. + # Zypper patching is performed by running `zypper patch`. See also https://en. + # opensuse.org/SDB:Zypper_manual. class ZypperSettings include Google::Apis::Core::Hashable - # Install only patches with these categories. - # Common categories include security, recommended, and feature. + # Install only patches with these categories. Common categories include security, + # recommended, and feature. # Corresponds to the JSON property `categories` # @return [Array] attr_accessor :categories @@ -1977,15 +1933,15 @@ module Google # @return [Array] attr_accessor :excludes - # An exclusive list of patches to be updated. These are the only patches - # that will be installed using 'zypper patch patch:' command. - # This field must not be used with any other patch configuration fields. + # An exclusive list of patches to be updated. These are the only patches that + # will be installed using 'zypper patch patch:' command. This field must not be + # used with any other patch configuration fields. # Corresponds to the JSON property `exclusivePatches` # @return [Array] attr_accessor :exclusive_patches - # Install only patches with these severities. - # Common severities include critical, important, moderate, and low. + # Install only patches with these severities. Common severities include critical, + # important, moderate, and low. # Corresponds to the JSON property `severities` # @return [Array] attr_accessor :severities diff --git a/generated/google/apis/osconfig_v1/service.rb b/generated/google/apis/osconfig_v1/service.rb index c0acbd1d8..1b3dbf69e 100644 --- a/generated/google/apis/osconfig_v1/service.rb +++ b/generated/google/apis/osconfig_v1/service.rb @@ -55,12 +55,9 @@ module Google # @param [Google::Apis::OsconfigV1::PatchDeployment] patch_deployment_object # @param [String] patch_deployment_id # Required. A name for the patch deployment in the project. When creating a name - # the following rules apply: - # * Must contain only lowercase letters, numbers, and hyphens. - # * Must start with a letter. - # * Must be between 1-63 characters. - # * Must end with a number or a letter. - # * Must be unique within the project. + # the following rules apply: * Must contain only lowercase letters, numbers, and + # hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must + # end with a number or a letter. * Must be unique within the project. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -93,8 +90,8 @@ module Google # Delete an OS Config patch deployment. # @param [String] name - # Required. The resource name of the patch deployment in the form - # `projects/*/patchDeployments/*`. + # Required. The resource name of the patch deployment in the form `projects/*/ + # patchDeployments/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -124,8 +121,8 @@ module Google # Get an OS Config patch deployment. # @param [String] name - # Required. The resource name of the patch deployment in the form - # `projects/*/patchDeployments/*`. + # Required. The resource name of the patch deployment in the form `projects/*/ + # patchDeployments/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -160,8 +157,7 @@ module Google # Optional. The maximum number of patch deployments to return. Default is 100. # @param [String] page_token # Optional. A pagination token returned from a previous call to - # ListPatchDeployments - # that indicates where this listing should continue from. + # ListPatchDeployments that indicates where this listing should continue from. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -191,8 +187,8 @@ module Google execute_or_queue_command(command, &block) end - # Cancel a patch job. The patch job must be active. Canceled patch jobs - # cannot be restarted. + # Cancel a patch job. The patch job must be active. Canceled patch jobs cannot + # be restarted. # @param [String] name # Required. Name of the patch in the form `projects/*/patchJobs/*` # @param [Google::Apis::OsconfigV1::CancelPatchJobRequest] cancel_patch_job_request_object @@ -258,8 +254,8 @@ module Google execute_or_queue_command(command, &block) end - # Get the patch job. This can be used to track the progress of an - # ongoing patch job or review the details of completed jobs. + # Get the patch job. This can be used to track the progress of an ongoing patch + # job or review the details of completed jobs. # @param [String] name # Required. Name of the patch in the form `projects/*/patchJobs/*` # @param [String] fields @@ -293,14 +289,14 @@ module Google # @param [String] parent # Required. In the form of `projects/*` # @param [String] filter - # If provided, this field specifies the criteria that must be met by patch - # jobs to be included in the response. - # Currently, filtering is only available on the patch_deployment field. + # If provided, this field specifies the criteria that must be met by patch jobs + # to be included in the response. Currently, filtering is only available on the + # patch_deployment field. # @param [Fixnum] page_size # The maximum number of instance status to return. # @param [String] page_token - # A pagination token returned from a previous call - # that indicates where this listing should continue from. + # A pagination token returned from a previous call that indicates where this + # listing should continue from. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -336,14 +332,13 @@ module Google # Required. The parent for the instances are in the form of `projects/*/ # patchJobs/*`. # @param [String] filter - # A filter expression that filters results listed in the response. This - # field supports filtering results by instance zone, name, state, or - # `failure_reason`. + # A filter expression that filters results listed in the response. This field + # supports filtering results by instance zone, name, state, or `failure_reason`. # @param [Fixnum] page_size - # The maximum number of instance details records to return. Default is 100. + # The maximum number of instance details records to return. Default is 100. # @param [String] page_token - # A pagination token returned from a previous call - # that indicates where this listing should continue from. + # A pagination token returned from a previous call that indicates where this + # listing should continue from. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/osconfig_v1beta.rb b/generated/google/apis/osconfig_v1beta.rb index 8f2066798..c697279ac 100644 --- a/generated/google/apis/osconfig_v1beta.rb +++ b/generated/google/apis/osconfig_v1beta.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/ module OsconfigV1beta VERSION = 'V1beta' - REVISION = '20200731' + REVISION = '20200807' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/osconfig_v1beta/classes.rb b/generated/google/apis/osconfig_v1beta/classes.rb index 4b671c168..0cc833d3f 100644 --- a/generated/google/apis/osconfig_v1beta/classes.rb +++ b/generated/google/apis/osconfig_v1beta/classes.rb @@ -22,9 +22,8 @@ module Google module Apis module OsconfigV1beta - # Represents a single Apt package repository. This repository is added to - # a repo file that is stored at - # `/etc/apt/sources.list.d/google_osconfig.list`. + # Represents a single Apt package repository. This repository is added to a repo + # file that is stored at `/etc/apt/sources.list.d/google_osconfig.list`. class AptRepository include Google::Apis::Core::Hashable @@ -44,9 +43,9 @@ module Google # @return [String] attr_accessor :distribution - # URI of the key file for this repository. The agent maintains - # a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg` containing - # all the keys in any applied guest policy. + # URI of the key file for this repository. The agent maintains a keyring at `/ + # etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg` containing all the keys in + # any applied guest policy. # Corresponds to the JSON property `gpgKey` # @return [String] attr_accessor :gpg_key @@ -70,8 +69,8 @@ module Google end end - # Apt patching is completed by executing `apt-get update && apt-get - # upgrade`. Additional options can be set to control how this is executed. + # Apt patching is completed by executing `apt-get update && apt-get upgrade`. + # Additional options can be set to control how this is executed. class AptSettings include Google::Apis::Core::Hashable @@ -80,16 +79,15 @@ module Google # @return [Array] attr_accessor :excludes - # An exclusive list of packages to be updated. These are the only packages - # that will be updated. If these packages are not installed, they will be - # ignored. This field cannot be specified with any other patch configuration - # fields. + # An exclusive list of packages to be updated. These are the only packages that + # will be updated. If these packages are not installed, they will be ignored. + # This field cannot be specified with any other patch configuration fields. # Corresponds to the JSON property `exclusivePackages` # @return [Array] attr_accessor :exclusive_packages - # By changing the type to DIST, the patching is performed - # using `apt-get dist-upgrade` instead. + # By changing the type to DIST, the patching is performed using `apt-get dist- + # upgrade` instead. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -107,51 +105,45 @@ module Google end # An assignment represents the group or groups of VM instances that the policy - # applies to. - # If an assignment is empty, it applies to all VM instances. Otherwise, the - # targeted VM instances must meet all the criteria specified. So if both - # labels and zones are specified, the policy applies to VM instances with those - # labels and in those zones. + # applies to. If an assignment is empty, it applies to all VM instances. + # Otherwise, the targeted VM instances must meet all the criteria specified. So + # if both labels and zones are specified, the policy applies to VM instances + # with those labels and in those zones. class Assignment include Google::Apis::Core::Hashable - # Targets instances matching at least one of these label sets. This allows - # an assignment to target disparate groups, for example "env=prod or - # env=staging". + # Targets instances matching at least one of these label sets. This allows an + # assignment to target disparate groups, for example "env=prod or env=staging". # Corresponds to the JSON property `groupLabels` # @return [Array] attr_accessor :group_labels - # Targets VM instances whose name starts with one of these prefixes. - # Like labels, this is another way to group VM instances when targeting - # configs, for example prefix="prod-". - # Only supported for project-level policies. + # Targets VM instances whose name starts with one of these prefixes. Like labels, + # this is another way to group VM instances when targeting configs, for example + # prefix="prod-". Only supported for project-level policies. # Corresponds to the JSON property `instanceNamePrefixes` # @return [Array] attr_accessor :instance_name_prefixes - # Targets any of the instances specified. Instances are specified by their - # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`. - # Instance targeting is uncommon and is supported to facilitate the - # management of changes by the instance or to target specific VM instances - # for development and testing. - # Only supported for project-level policies and must reference instances - # within this project. + # Targets any of the instances specified. Instances are specified by their URI + # in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`. Instance targeting is + # uncommon and is supported to facilitate the management of changes by the + # instance or to target specific VM instances for development and testing. Only + # supported for project-level policies and must reference instances within this + # project. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances - # Targets VM instances matching at least one of the following OS types. - # VM instances must match all supplied criteria for a given OsType to be - # included. + # Targets VM instances matching at least one of the following OS types. VM + # instances must match all supplied criteria for a given OsType to be included. # Corresponds to the JSON property `osTypes` # @return [Array] attr_accessor :os_types - # Targets instances in any of these zones. Leave empty to target instances - # in any zone. - # Zonal targeting is uncommon and is supported to facilitate the management - # of changes by zone. + # Targets instances in any of these zones. Leave empty to target instances in + # any zone. Zonal targeting is uncommon and is supported to facilitate the + # management of changes by zone. # Corresponds to the JSON property `zones` # @return [Array] attr_accessor :zones @@ -170,13 +162,13 @@ module Google end end - # Represents a group of VM intances that can be identified as having all - # these labels, for example "env=prod and app=web". + # Represents a group of VM intances that can be identified as having all these + # labels, for example "env=prod and app=web". class AssignmentGroupLabel include Google::Apis::Core::Hashable - # Google Compute Engine instance labels that must be present for an - # instance to be included in this assignment group. + # Google Compute Engine instance labels that must be present for an instance to + # be included in this assignment group. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -195,14 +187,14 @@ module Google class AssignmentOsType include Google::Apis::Core::Hashable - # Targets VM instances with OS Inventory enabled and having the following - # OS architecture. + # Targets VM instances with OS Inventory enabled and having the following OS + # architecture. # Corresponds to the JSON property `osArchitecture` # @return [String] attr_accessor :os_architecture - # Targets VM instances with OS Inventory enabled and having the following - # OS short name, for example "debian" or "windows". + # Targets VM instances with OS Inventory enabled and having the following OS + # short name, for example "debian" or "windows". # Corresponds to the JSON property `osShortName` # @return [String] attr_accessor :os_short_name @@ -273,23 +265,16 @@ module Google class EffectiveGuestPolicySourcedPackage include Google::Apis::Core::Hashable - # Package is a reference to the software package to be installed or removed. - # The agent on the VM instance uses the system package manager to apply the - # config. - # These are the commands that the agent uses to install or remove - # packages. - # Apt + # Package is a reference to the software package to be installed or removed. The + # agent on the VM instance uses the system package manager to apply the config. + # These are the commands that the agent uses to install or remove packages. Apt # install: `apt-get update && apt-get -y install package1 package2 package3` - # remove: `apt-get -y remove package1 package2 package3` - # Yum - # install: `yum -y install package1 package2 package3` - # remove: `yum -y remove package1 package2 package3` - # Zypper - # install: `zypper install package1 package2 package3` - # remove: `zypper rm package1 package2` - # Googet - # install: `googet -noconfirm install package1 package2 package3` - # remove: `googet -noconfirm remove package1 package2 package3` + # remove: `apt-get -y remove package1 package2 package3` Yum install: `yum -y + # install package1 package2 package3` remove: `yum -y remove package1 package2 + # package3` Zypper install: `zypper install package1 package2 package3` remove: ` + # zypper rm package1 package2` Googet install: `googet -noconfirm install + # package1 package2 package3` remove: `googet -noconfirm remove package1 + # package2 package3` # Corresponds to the JSON property `package` # @return [Google::Apis::OsconfigV1beta::Package] attr_accessor :package @@ -340,22 +325,17 @@ module Google include Google::Apis::Core::Hashable # A software recipe is a set of instructions for installing and configuring a - # piece of software. It consists of a set of artifacts that are - # downloaded, and a set of steps that install, configure, and/or update the - # software. - # Recipes support installing and updating software from artifacts in the - # following formats: - # Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. - # Additionally, recipes support executing a script (either defined in a file or - # directly in this api) in bash, sh, cmd, and powershell. - # Updating a software recipe - # If a recipe is assigned to an instance and there is a recipe with the same - # name but a lower version already installed and the assigned state - # of the recipe is `UPDATED`, then the recipe is updated to - # the new version. - # Script Working Directories - # Each script or execution step is run in its own temporary directory which - # is deleted after completing the step. + # piece of software. It consists of a set of artifacts that are downloaded, and + # a set of steps that install, configure, and/or update the software. Recipes + # support installing and updating software from artifacts in the following + # formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM + # package. Additionally, recipes support executing a script (either defined in a + # file or directly in this api) in bash, sh, cmd, and powershell. Updating a + # software recipe If a recipe is assigned to an instance and there is a recipe + # with the same name but a lower version already installed and the assigned + # state of the recipe is `UPDATED`, then the recipe is updated to the new + # version. Script Working Directories Each script or execution step is run in + # its own temporary directory which is deleted after completing the step. # Corresponds to the JSON property `softwareRecipe` # @return [Google::Apis::OsconfigV1beta::SoftwareRecipe] attr_accessor :software_recipe @@ -376,13 +356,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 @@ -492,8 +470,8 @@ module Google class ExecStepConfig include Google::Apis::Core::Hashable - # Defaults to [0]. A list of possible return values that the - # execution can return to indicate a success. + # Defaults to [0]. A list of possible return values that the execution can + # return to indicate a success. # Corresponds to the JSON property `allowedSuccessCodes` # @return [Array] attr_accessor :allowed_success_codes @@ -504,9 +482,9 @@ module Google attr_accessor :gcs_object # The script interpreter to use to run the script. If no interpreter is - # specified the script will be executed directly, which will likely - # only succeed for scripts with [shebang lines] - # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). + # specified the script will be executed directly, which will likely only succeed + # for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\ + # )). # Corresponds to the JSON property `interpreter` # @return [String] attr_accessor :interpreter @@ -533,8 +511,8 @@ module Google class ExecutePatchJobRequest include Google::Apis::Core::Hashable - # Description of the patch job. Length of the description is limited - # to 1024 characters. + # Description of the patch job. Length of the description is limited to 1024 + # characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -544,29 +522,26 @@ module Google # @return [String] attr_accessor :display_name - # If this patch is a dry-run only, instances are contacted but - # will do nothing. + # If this patch is a dry-run only, instances are contacted but will do nothing. # Corresponds to the JSON property `dryRun` # @return [Boolean] attr_accessor :dry_run alias_method :dry_run?, :dry_run - # Duration of the patch job. After the duration ends, the patch job - # times out. + # Duration of the patch job. After the duration ends, the patch job times out. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # A filter to target VM instances for patching. The targeted - # VMs must meet all criteria specified. So if both labels and zones are - # specified, the patch job targets only VMs with those labels and in those - # zones. + # A filter to target VM instances for patching. The targeted VMs must meet all + # criteria specified. So if both labels and zones are specified, the patch job + # targets only VMs with those labels and in those zones. # Corresponds to the JSON property `instanceFilter` # @return [Google::Apis::OsconfigV1beta::PatchInstanceFilter] attr_accessor :instance_filter - # Patch configuration specifications. Contains details on how to apply the - # patch(es) to a VM instance. + # Patch configuration specifications. Contains details on how to apply the patch( + # es) to a VM instance. # Corresponds to the JSON property `patchConfig` # @return [Google::Apis::OsconfigV1beta::PatchConfig] attr_accessor :patch_config @@ -597,9 +572,8 @@ module Google class ExtractArchiveResource include Google::Apis::Core::Hashable - # Local file path that signals this resource is in the desired state. - # The absence of this file will indicate whether the archive needs to be - # extracted. + # Local file path that signals this resource is in the desired state. The + # absence of this file will indicate whether the archive needs to be extracted. # Corresponds to the JSON property `creates` # @return [String] attr_accessor :creates @@ -609,9 +583,9 @@ module Google # @return [String] attr_accessor :destination - # Whether to overwrite existing files during extraction. If this is set to - # true, any existing files in the destination location will be overwritten by - # the extraction. + # Whether to overwrite existing files during extraction. If this is set to true, + # any existing files in the destination location will be overwritten by the + # extraction. # Corresponds to the JSON property `overwrite` # @return [Boolean] attr_accessor :overwrite @@ -645,10 +619,9 @@ module Google class File include Google::Apis::Core::Hashable - # Defaults to false. When false, files will be subject to validations - # based on the file type: - # Remote: A checksum must be specified. - # GCS: An object generation number must be specified. + # Defaults to false. When false, files will be subject to validations based on + # the file type: Remote: A checksum must be specified. GCS: An object generation + # number must be specified. # Corresponds to the JSON property `allowInsecure` # @return [Boolean] attr_accessor :allow_insecure @@ -722,8 +695,8 @@ module Google # @return [String] attr_accessor :sha256_checksum - # URI from which to fetch the object. It should contain both the protocol - # and path following the format `protocol`://`location`. + # URI from which to fetch the object. It should contain both the protocol and + # path following the format `protocol`://`location`. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -758,18 +731,14 @@ module Google # @return [String] attr_accessor :path - # Consists of three octal digits which represent, in - # order, the permissions of the owner, group, and other users for the - # file (similarly to the numeric mode used in the linux chmod utility). - # Each digit represents a three bit number with the 4 bit - # corresponding to the read permissions, the 2 bit corresponds to the - # write bit, and the one bit corresponds to the execute permission. - # Default behavior is 755. - # Below are some examples of permissions and their associated values: - # read, write, and execute: 7 - # read and execute: 5 - # read and write: 6 - # read only: 4 + # Consists of three octal digits which represent, in order, the permissions of + # the owner, group, and other users for the file (similarly to the numeric mode + # used in the linux chmod utility). Each digit represents a three bit number + # with the 4 bit corresponding to the read permissions, the 2 bit corresponds to + # the write bit, and the one bit corresponds to the execute permission. Default + # behavior is 755. Below are some examples of permissions and their associated + # values: read, write, and execute: 7 read and execute: 5 read and write: 6 read + # only: 4 # Corresponds to the JSON property `permissions` # @return [String] attr_accessor :permissions @@ -803,8 +772,8 @@ module Google # @return [Fixnum] attr_accessor :fixed - # Specifies the relative value defined as a percentage, which will be - # multiplied by a reference value. + # Specifies the relative value defined as a percentage, which will be multiplied + # by a reference value. # Corresponds to the JSON property `percent` # @return [Fixnum] attr_accessor :percent @@ -830,8 +799,7 @@ module Google attr_accessor :bucket # Required. Generation number of the Google Cloud Storage object. This is used - # to - # ensure that the ExecStep specified by this PatchJob does not change. + # to ensure that the ExecStep specified by this PatchJob does not change. # Corresponds to the JSON property `generationNumber` # @return [Fixnum] attr_accessor :generation_number @@ -853,8 +821,8 @@ module Google end end - # Represents a Goo package repository. These is added to a repo file - # that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo. + # Represents a Goo package repository. These is added to a repo file that is + # stored at C:/ProgramData/GooGet/repos/google_osconfig.repo. class GooRepository include Google::Apis::Core::Hashable @@ -900,11 +868,10 @@ module Google include Google::Apis::Core::Hashable # An assignment represents the group or groups of VM instances that the policy - # applies to. - # If an assignment is empty, it applies to all VM instances. Otherwise, the - # targeted VM instances must meet all the criteria specified. So if both - # labels and zones are specified, the policy applies to VM instances with those - # labels and in those zones. + # applies to. If an assignment is empty, it applies to all VM instances. + # Otherwise, the targeted VM instances must meet all the criteria specified. So + # if both labels and zones are specified, the policy applies to VM instances + # with those labels and in those zones. # Corresponds to the JSON property `assignment` # @return [Google::Apis::OsconfigV1beta::Assignment] attr_accessor :assignment @@ -914,30 +881,28 @@ module Google # @return [String] attr_accessor :create_time - # Description of the guest policy. Length of the description is limited - # to 1024 characters. + # Description of the guest policy. Length of the description is limited to 1024 + # characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The etag for this guest policy. - # If this is provided on update, it must match the server's etag. + # The etag for this guest policy. If this is provided on update, it must match + # the server's etag. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # Required. Unique name of the resource in this project using one of the - # following - # forms: - # `projects/`project_number`/guestPolicies/`guest_policy_id``. + # following forms: `projects/`project_number`/guestPolicies/`guest_policy_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # A list of package repositories to configure on the VM instance. This is - # done before any other configs are applied so they can use these repos. - # Package repositories are only configured if the corresponding package - # manager(s) are available. + # A list of package repositories to configure on the VM instance. This is done + # before any other configs are applied so they can use these repos. Package + # repositories are only configured if the corresponding package manager(s) are + # available. # Corresponds to the JSON property `packageRepositories` # @return [Array] attr_accessor :package_repositories @@ -984,8 +949,7 @@ module Google # @return [Array] attr_accessor :guest_policies - # A pagination token that can be used to get the next page - # of guest policies. + # A pagination token that can be used to get the next page of guest policies. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1005,8 +969,7 @@ module Google class ListPatchDeploymentsResponse include Google::Apis::Core::Hashable - # A pagination token that can be used to get the next page of patch - # deployments. + # A pagination token that can be used to get the next page of patch deployments. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1082,23 +1045,20 @@ module Google class LookupEffectiveGuestPolicyRequest include Google::Apis::Core::Hashable - # Architecture of OS running on the instance. The OS Config agent only - # provides this field for targeting if OS Inventory is enabled for that - # instance. + # Architecture of OS running on the instance. The OS Config agent only provides + # this field for targeting if OS Inventory is enabled for that instance. # Corresponds to the JSON property `osArchitecture` # @return [String] attr_accessor :os_architecture # Short name of the OS running on the instance. The OS Config agent only - # provides this field for targeting if OS Inventory is enabled for that - # instance. + # provides this field for targeting if OS Inventory is enabled for that instance. # Corresponds to the JSON property `osShortName` # @return [String] attr_accessor :os_short_name - # Version of the OS running on the instance. The OS Config agent only - # provides this field for targeting if OS Inventory is enabled for that - # VM instance. + # Version of the OS running on the instance. The OS Config agent only provides + # this field for targeting if OS Inventory is enabled for that VM instance. # Corresponds to the JSON property `osVersion` # @return [String] attr_accessor :os_version @@ -1115,15 +1075,15 @@ module Google end end - # Represents a monthly schedule. An example of a valid monthly schedule is - # "on the third Tuesday of the month" or "on the 15th of the month". + # Represents a monthly schedule. An example of a valid monthly schedule is "on + # the third Tuesday of the month" or "on the 15th of the month". class MonthlySchedule include Google::Apis::Core::Hashable # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 - # indicates the last day of the month. - # Months without the target day will be skipped. For example, a schedule to - # run "every month on the 31st" will not run in February, April, June, etc. + # indicates the last day of the month. Months without the target day will be + # skipped. For example, a schedule to run "every month on the 31st" will not run + # in February, April, June, etc. # Corresponds to the JSON property `monthDay` # @return [Fixnum] attr_accessor :month_day @@ -1144,8 +1104,8 @@ module Google end end - # Sets the time for a one time patch deployment. Timestamp is in - # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https: + # //www.ietf.org/rfc/rfc3339.txt) text format. class OneTimeSchedule include Google::Apis::Core::Hashable @@ -1164,47 +1124,37 @@ module Google end end - # Package is a reference to the software package to be installed or removed. - # The agent on the VM instance uses the system package manager to apply the - # config. - # These are the commands that the agent uses to install or remove - # packages. - # Apt + # Package is a reference to the software package to be installed or removed. The + # agent on the VM instance uses the system package manager to apply the config. + # These are the commands that the agent uses to install or remove packages. Apt # install: `apt-get update && apt-get -y install package1 package2 package3` - # remove: `apt-get -y remove package1 package2 package3` - # Yum - # install: `yum -y install package1 package2 package3` - # remove: `yum -y remove package1 package2 package3` - # Zypper - # install: `zypper install package1 package2 package3` - # remove: `zypper rm package1 package2` - # Googet - # install: `googet -noconfirm install package1 package2 package3` - # remove: `googet -noconfirm remove package1 package2 package3` + # remove: `apt-get -y remove package1 package2 package3` Yum install: `yum -y + # install package1 package2 package3` remove: `yum -y remove package1 package2 + # package3` Zypper install: `zypper install package1 package2 package3` remove: ` + # zypper rm package1 package2` Googet install: `googet -noconfirm install + # package1 package2 package3` remove: `googet -noconfirm remove package1 + # package2 package3` class Package include Google::Apis::Core::Hashable - # The desired_state the agent should maintain for this package. The - # default is to ensure the package is installed. + # The desired_state the agent should maintain for this package. The default is + # to ensure the package is installed. # Corresponds to the JSON property `desiredState` # @return [String] attr_accessor :desired_state - # Type of package manager that can be used to install this package. - # If a system does not have the package manager, the package is not - # installed or removed no error message is returned. By default, - # or if you specify `ANY`, - # the agent attempts to install and remove this package using the default - # package manager. This is useful when creating a policy that applies to - # different types of systems. - # The default behavior is ANY. + # Type of package manager that can be used to install this package. If a system + # does not have the package manager, the package is not installed or removed no + # error message is returned. By default, or if you specify `ANY`, the agent + # attempts to install and remove this package using the default package manager. + # This is useful when creating a policy that applies to different types of + # systems. The default behavior is ANY. # Corresponds to the JSON property `manager` # @return [String] attr_accessor :manager # Required. The name of the package. A package is uniquely identified for - # conflict - # validation by checking the package name and the manager(s) that the + # conflict validation by checking the package name and the manager(s) that the # package targets. # Corresponds to the JSON property `name` # @return [String] @@ -1226,21 +1176,20 @@ module Google class PackageRepository include Google::Apis::Core::Hashable - # Represents a single Apt package repository. This repository is added to - # a repo file that is stored at - # `/etc/apt/sources.list.d/google_osconfig.list`. + # Represents a single Apt package repository. This repository is added to a repo + # file that is stored at `/etc/apt/sources.list.d/google_osconfig.list`. # Corresponds to the JSON property `apt` # @return [Google::Apis::OsconfigV1beta::AptRepository] attr_accessor :apt - # Represents a Goo package repository. These is added to a repo file - # that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo. + # Represents a Goo package repository. These is added to a repo file that is + # stored at C:/ProgramData/GooGet/repos/google_osconfig.repo. # Corresponds to the JSON property `goo` # @return [Google::Apis::OsconfigV1beta::GooRepository] attr_accessor :goo - # Represents a single Yum package repository. This repository is added to a - # repo file that is stored at `/etc/yum.repos.d/google_osconfig.repo`. + # Represents a single Yum package repository. This repository is added to a repo + # file that is stored at `/etc/yum.repos.d/google_osconfig.repo`. # Corresponds to the JSON property `yum` # @return [Google::Apis::OsconfigV1beta::YumRepository] attr_accessor :yum @@ -1268,9 +1217,8 @@ module Google class PackageResource include Google::Apis::Core::Hashable - # A package managed by APT. - # install: `apt-get update && apt-get -y install [name]` - # remove: `apt-get -y remove [name]` + # A package managed by APT. install: `apt-get update && apt-get -y install [name] + # ` remove: `apt-get -y remove [name]` # Corresponds to the JSON property `apt` # @return [Google::Apis::OsconfigV1beta::PackageResourceApt] attr_accessor :apt @@ -1280,21 +1228,20 @@ module Google # @return [Google::Apis::OsconfigV1beta::PackageResourceDeb] attr_accessor :deb - # The desired_state the agent should maintain for this package. The - # default is to ensure the package is installed. + # The desired_state the agent should maintain for this package. The default is + # to ensure the package is installed. # Corresponds to the JSON property `desiredState` # @return [String] attr_accessor :desired_state - # A package managed by GooGet. - # install: `googet -noconfirm install package` + # A package managed by GooGet. install: `googet -noconfirm install package` # remove: `googet -noconfirm remove package` # Corresponds to the JSON property `googet` # @return [Google::Apis::OsconfigV1beta::PackageResourceGooGet] attr_accessor :googet - # An MSI package. MSI packages only support INSTALLED state. - # Install msiexec /i /qn /norestart + # An MSI package. MSI packages only support INSTALLED state. Install msiexec /i / + # qn /norestart # Corresponds to the JSON property `msi` # @return [Google::Apis::OsconfigV1beta::PackageResourceMsi] attr_accessor :msi @@ -1304,16 +1251,14 @@ module Google # @return [Google::Apis::OsconfigV1beta::PackageResourceRpm] attr_accessor :rpm - # A package managed by YUM. - # install: `yum -y install package` - # remove: `yum -y remove package` + # A package managed by YUM. install: `yum -y install package` remove: `yum -y + # remove package` # Corresponds to the JSON property `yum` # @return [Google::Apis::OsconfigV1beta::PackageResourceYum] attr_accessor :yum - # A package managed by Zypper. - # install: `zypper -y install package` - # remove: `zypper -y rm package` + # A package managed by Zypper. install: `zypper -y install package` remove: ` + # zypper -y rm package` # Corresponds to the JSON property `zypper` # @return [Google::Apis::OsconfigV1beta::PackageResourceZypper] attr_accessor :zypper @@ -1335,9 +1280,8 @@ module Google end end - # A package managed by APT. - # install: `apt-get update && apt-get -y install [name]` - # remove: `apt-get -y remove [name]` + # A package managed by APT. install: `apt-get update && apt-get -y install [name] + # ` remove: `apt-get -y remove [name]` class PackageResourceApt include Google::Apis::Core::Hashable @@ -1360,9 +1304,8 @@ module Google class PackageResourceDeb include Google::Apis::Core::Hashable - # Whether dependencies should also be installed. - # install when false: `dpkg -i package` - # install when true: `apt-get update && apt-get -y install package.deb` + # Whether dependencies should also be installed. install when false: `dpkg -i + # package` install when true: `apt-get update && apt-get -y install package.deb` # Corresponds to the JSON property `pullDeps` # @return [Boolean] attr_accessor :pull_deps @@ -1384,8 +1327,7 @@ module Google end end - # A package managed by GooGet. - # install: `googet -noconfirm install package` + # A package managed by GooGet. install: `googet -noconfirm install package` # remove: `googet -noconfirm remove package` class PackageResourceGooGet include Google::Apis::Core::Hashable @@ -1405,19 +1347,19 @@ module Google end end - # An MSI package. MSI packages only support INSTALLED state. - # Install msiexec /i /qn /norestart + # An MSI package. MSI packages only support INSTALLED state. Install msiexec /i / + # qn /norestart class PackageResourceMsi include Google::Apis::Core::Hashable - # Return codes that indicate that the software installed or updated - # successfully. Behaviour defaults to [0] + # Return codes that indicate that the software installed or updated successfully. + # Behaviour defaults to [0] # Corresponds to the JSON property `allowedSuccessCodes` # @return [Array] attr_accessor :allowed_success_codes - # Flags to use during package install. - # Appended to the defalts of "/i /qn /norestart" + # Flags to use during package install. Appended to the defalts of "/i /qn / + # norestart" # Corresponds to the JSON property `flags` # @return [Array] attr_accessor :flags @@ -1443,10 +1385,9 @@ module Google class PackageResourceRpm include Google::Apis::Core::Hashable - # Whether dependencies should also be installed. - # install when false: `rpm --upgrade --replacepkgs package.rpm` - # install when true: `yum -y install package.rpm` or - # `zypper -y install package.rpm` + # Whether dependencies should also be installed. install when false: `rpm -- + # upgrade --replacepkgs package.rpm` install when true: `yum -y install package. + # rpm` or `zypper -y install package.rpm` # Corresponds to the JSON property `pullDeps` # @return [Boolean] attr_accessor :pull_deps @@ -1468,9 +1409,8 @@ module Google end end - # A package managed by YUM. - # install: `yum -y install package` - # remove: `yum -y remove package` + # A package managed by YUM. install: `yum -y install package` remove: `yum -y + # remove package` class PackageResourceYum include Google::Apis::Core::Hashable @@ -1489,9 +1429,8 @@ module Google end end - # A package managed by Zypper. - # install: `zypper -y install package` - # remove: `zypper -y rm package` + # A package managed by Zypper. install: `zypper -y install package` remove: ` + # zypper -y rm package` class PackageResourceZypper include Google::Apis::Core::Hashable @@ -1510,13 +1449,13 @@ module Google end end - # Patch configuration specifications. Contains details on how to apply the - # patch(es) to a VM instance. + # Patch configuration specifications. Contains details on how to apply the patch( + # es) to a VM instance. class PatchConfig include Google::Apis::Core::Hashable - # Apt patching is completed by executing `apt-get update && apt-get - # upgrade`. Additional options can be set to control how this is executed. + # Apt patching is completed by executing `apt-get update && apt-get upgrade`. + # Additional options can be set to control how this is executed. # Corresponds to the JSON property `apt` # @return [Google::Apis::OsconfigV1beta::AptSettings] attr_accessor :apt @@ -1546,15 +1485,15 @@ module Google # @return [Google::Apis::OsconfigV1beta::WindowsUpdateSettings] attr_accessor :windows_update - # Yum patching is performed by executing `yum update`. Additional options - # can be set to control how this is executed. - # Note that not all settings are supported on all platforms. + # Yum patching is performed by executing `yum update`. Additional options can be + # set to control how this is executed. Note that not all settings are supported + # on all platforms. # Corresponds to the JSON property `yum` # @return [Google::Apis::OsconfigV1beta::YumSettings] attr_accessor :yum - # Zypper patching is performed by running `zypper patch`. - # See also https://en.opensuse.org/SDB:Zypper_manual. + # Zypper patching is performed by running `zypper patch`. See also https://en. + # opensuse.org/SDB:Zypper_manual. # Corresponds to the JSON property `zypper` # @return [Google::Apis::OsconfigV1beta::ZypperSettings] attr_accessor :zypper @@ -1579,21 +1518,19 @@ module Google # Patch deployments are configurations that individual patch jobs use to # complete a patch. These configurations include instance filter, package # repository settings, and a schedule. For more information about creating and - # managing patch deployments, see [Scheduling patch - # jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch- - # jobs). + # managing patch deployments, see [Scheduling patch jobs](https://cloud.google. + # com/compute/docs/os-patch-management/schedule-patch-jobs). class PatchDeployment include Google::Apis::Core::Hashable - # Output only. Time the patch deployment was created. Timestamp is in - # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + # Output only. Time the patch deployment was created. Timestamp is in [RFC3339]( + # https://www.ietf.org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Optional. Description of the patch deployment. Length of the description is - # limited - # to 1024 characters. + # limited to 1024 characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1603,37 +1540,35 @@ module Google # @return [String] attr_accessor :duration - # A filter to target VM instances for patching. The targeted - # VMs must meet all criteria specified. So if both labels and zones are - # specified, the patch job targets only VMs with those labels and in those - # zones. + # A filter to target VM instances for patching. The targeted VMs must meet all + # criteria specified. So if both labels and zones are specified, the patch job + # targets only VMs with those labels and in those zones. # Corresponds to the JSON property `instanceFilter` # @return [Google::Apis::OsconfigV1beta::PatchInstanceFilter] attr_accessor :instance_filter # Output only. The last time a patch job was started by this deployment. - # Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text - # format. + # Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `lastExecuteTime` # @return [String] attr_accessor :last_execute_time # Unique name for the patch deployment resource in a project. The patch - # deployment name is in the form: - # `projects/`project_id`/patchDeployments/`patch_deployment_id``. - # This field is ignored when you create a new patch deployment. + # deployment name is in the form: `projects/`project_id`/patchDeployments/` + # patch_deployment_id``. This field is ignored when you create a new patch + # deployment. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Sets the time for a one time patch deployment. Timestamp is in - # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + # Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https: + # //www.ietf.org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `oneTimeSchedule` # @return [Google::Apis::OsconfigV1beta::OneTimeSchedule] attr_accessor :one_time_schedule - # Patch configuration specifications. Contains details on how to apply the - # patch(es) to a VM instance. + # Patch configuration specifications. Contains details on how to apply the patch( + # es) to a VM instance. # Corresponds to the JSON property `patchConfig` # @return [Google::Apis::OsconfigV1beta::PatchConfig] attr_accessor :patch_config @@ -1649,8 +1584,8 @@ module Google # @return [Google::Apis::OsconfigV1beta::PatchRollout] attr_accessor :rollout - # Output only. Time the patch deployment was last updated. Timestamp is in - # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + # Output only. Time the patch deployment was last updated. Timestamp is in [ + # RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -1675,10 +1610,9 @@ module Google end end - # A filter to target VM instances for patching. The targeted - # VMs must meet all criteria specified. So if both labels and zones are - # specified, the patch job targets only VMs with those labels and in those - # zones. + # A filter to target VM instances for patching. The targeted VMs must meet all + # criteria specified. So if both labels and zones are specified, the patch job + # targets only VMs with those labels and in those zones. class PatchInstanceFilter include Google::Apis::Core::Hashable @@ -1695,24 +1629,24 @@ module Google # @return [Array] attr_accessor :group_labels - # Targets VMs whose name starts with one of these prefixes. Similar to - # labels, this is another way to group VMs when targeting configs, for - # example prefix="prod-". + # Targets VMs whose name starts with one of these prefixes. Similar to labels, + # this is another way to group VMs when targeting configs, for example prefix=" + # prod-". # Corresponds to the JSON property `instanceNamePrefixes` # @return [Array] attr_accessor :instance_name_prefixes # Targets any of the VM instances specified. Instances are specified by their - # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, - # `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or - # `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/ - # instances/[INSTANCE_NAME]` + # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[ + # PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www. + # googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[ + # INSTANCE_NAME]` # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances - # Targets VM instances in ANY of these zones. Leave empty to target VM - # instances in any zone. + # Targets VM instances in ANY of these zones. Leave empty to target VM instances + # in any zone. # Corresponds to the JSON property `zones` # @return [Array] attr_accessor :zones @@ -1731,13 +1665,13 @@ module Google end end - # Represents a group of VMs that can be identified as having all these - # labels, for example "env=prod and app=web". + # Represents a group of VMs that can be identified as having all these labels, + # for example "env=prod and app=web". class PatchInstanceFilterGroupLabel include Google::Apis::Core::Hashable - # Compute Engine instance labels that must be present for a VM instance to - # be targeted by this filter. + # Compute Engine instance labels that must be present for a VM instance to be + # targeted by this filter. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -1752,14 +1686,11 @@ module Google end end - # A high level representation of a patch job that is either in progress - # or has completed. - # Instance details are not included in the job. To paginate through instance - # details, use `ListPatchJobInstanceDetails`. - # For more information about patch jobs, see - # [Creating patch - # jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch- - # job). + # A high level representation of a patch job that is either in progress or has + # completed. Instance details are not included in the job. To paginate through + # instance details, use `ListPatchJobInstanceDetails`. For more information + # about patch jobs, see [Creating patch jobs](https://cloud.google.com/compute/ + # docs/os-patch-management/create-patch-job). class PatchJob include Google::Apis::Core::Hashable @@ -1768,8 +1699,8 @@ module Google # @return [String] attr_accessor :create_time - # Description of the patch job. Length of the description is limited - # to 1024 characters. + # Description of the patch job. Length of the description is limited to 1024 + # characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1779,49 +1710,45 @@ module Google # @return [String] attr_accessor :display_name - # If this patch job is a dry run, the agent reports that it has - # finished without running any updates on the VM instance. + # If this patch job is a dry run, the agent reports that it has finished without + # running any updates on the VM instance. # Corresponds to the JSON property `dryRun` # @return [Boolean] attr_accessor :dry_run alias_method :dry_run?, :dry_run - # Duration of the patch job. After the duration ends, the - # patch job times out. + # Duration of the patch job. After the duration ends, the patch job times out. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration - # If this patch job failed, this message provides information about the - # failure. + # If this patch job failed, this message provides information about the failure. # Corresponds to the JSON property `errorMessage` # @return [String] attr_accessor :error_message - # A summary of the current patch state across all instances that this patch - # job affects. Contains counts of instances in different states. These states - # map to `InstancePatchState`. List patch job instance details to see the - # specific states of each instance. + # A summary of the current patch state across all instances that this patch job + # affects. Contains counts of instances in different states. These states map to + # `InstancePatchState`. List patch job instance details to see the specific + # states of each instance. # Corresponds to the JSON property `instanceDetailsSummary` # @return [Google::Apis::OsconfigV1beta::PatchJobInstanceDetailsSummary] attr_accessor :instance_details_summary - # A filter to target VM instances for patching. The targeted - # VMs must meet all criteria specified. So if both labels and zones are - # specified, the patch job targets only VMs with those labels and in those - # zones. + # A filter to target VM instances for patching. The targeted VMs must meet all + # criteria specified. So if both labels and zones are specified, the patch job + # targets only VMs with those labels and in those zones. # Corresponds to the JSON property `instanceFilter` # @return [Google::Apis::OsconfigV1beta::PatchInstanceFilter] attr_accessor :instance_filter - # Unique identifier for this patch job in the form - # `projects/*/patchJobs/*` + # Unique identifier for this patch job in the form `projects/*/patchJobs/*` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Patch configuration specifications. Contains details on how to apply the - # patch(es) to a VM instance. + # Patch configuration specifications. Contains details on how to apply the patch( + # es) to a VM instance. # Corresponds to the JSON property `patchConfig` # @return [Google::Apis::OsconfigV1beta::PatchConfig] attr_accessor :patch_config @@ -1831,8 +1758,8 @@ module Google # @return [String] attr_accessor :patch_deployment - # Reflects the overall progress of the patch job in the range of - # 0.0 being no progress to 100.0 being complete. + # Reflects the overall progress of the patch job in the range of 0.0 being no + # progress to 100.0 being complete. # Corresponds to the JSON property `percentComplete` # @return [Float] attr_accessor :percent_complete @@ -1878,8 +1805,7 @@ module Google end # Patch details for a VM instance. For more information about reviewing VM - # instance details, see - # [Listing all VM instance details for a specific patch + # instance details, see [Listing all VM instance details for a specific patch # job](https://cloud.google.com/compute/docs/os-patch-management/manage-patch- # jobs#list-instance-details). class PatchJobInstanceDetails @@ -1895,8 +1821,8 @@ module Google # @return [String] attr_accessor :failure_reason - # The unique identifier for the instance. This identifier is - # defined by the server. + # The unique identifier for the instance. This identifier is defined by the + # server. # Corresponds to the JSON property `instanceSystemId` # @return [String] attr_accessor :instance_system_id @@ -1925,10 +1851,10 @@ module Google end end - # A summary of the current patch state across all instances that this patch - # job affects. Contains counts of instances in different states. These states - # map to `InstancePatchState`. List patch job instance details to see the - # specific states of each instance. + # A summary of the current patch state across all instances that this patch job + # affects. Contains counts of instances in different states. These states map to + # `InstancePatchState`. List patch job instance details to see the specific + # states of each instance. class PatchJobInstanceDetailsSummary include Google::Apis::Core::Hashable @@ -1958,8 +1884,8 @@ module Google attr_accessor :inactive_instance_count # Number of instances that do not appear to be running the agent. Check to - # ensure that the agent is installed, running, and able to communicate with - # the service. + # ensure that the agent is installed, running, and able to communicate with the + # service. # Corresponds to the JSON property `noAgentDetectedInstanceCount` # @return [Fixnum] attr_accessor :no_agent_detected_instance_count @@ -2065,8 +1991,7 @@ module Google include Google::Apis::Core::Hashable # Optional. The end time at which a recurring patch deployment schedule is no - # longer - # active. + # longer active. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -2081,8 +2006,8 @@ module Google # @return [String] attr_accessor :last_execute_time - # Represents a monthly schedule. An example of a valid monthly schedule is - # "on the third Tuesday of the month" or "on the 15th of the month". + # Represents a monthly schedule. An example of a valid monthly schedule is "on + # the third Tuesday of the month" or "on the 15th of the month". # Corresponds to the JSON property `monthly` # @return [Google::Apis::OsconfigV1beta::MonthlySchedule] attr_accessor :monthly @@ -2092,21 +2017,21 @@ module Google # @return [String] attr_accessor :next_execute_time - # Optional. The time that the recurring schedule becomes effective. - # Defaults to `create_time` of the patch deployment. + # Optional. The time that the recurring schedule becomes effective. Defaults to ` + # create_time` of the patch deployment. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time - # Represents a time of day. The date and time zone are either not significant - # or are specified elsewhere. An API may choose to allow leap seconds. Related + # Represents a time of day. The date and time zone are either not significant or + # are specified elsewhere. An API may choose to allow leap seconds. Related # types are google.type.Date and `google.protobuf.Timestamp`. # Corresponds to the JSON property `timeOfDay` # @return [Google::Apis::OsconfigV1beta::TimeOfDay] attr_accessor :time_of_day - # Represents a time zone from the - # [IANA Time Zone Database](https://www.iana.org/time-zones). + # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/ + # time-zones). # Corresponds to the JSON property `timeZone` # @return [Google::Apis::OsconfigV1beta::TimeZone] attr_accessor :time_zone @@ -2138,26 +2063,26 @@ module Google class RepositoryResource include Google::Apis::Core::Hashable - # Represents a single apt package repository. These will be added to a repo - # file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. + # Represents a single apt package repository. These will be added to a repo file + # that will be managed at /etc/apt/sources.list.d/google_osconfig.list. # Corresponds to the JSON property `apt` # @return [Google::Apis::OsconfigV1beta::RepositoryResourceAptRepository] attr_accessor :apt - # Represents a Goo package repository. These will be added to a repo file - # that will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. + # Represents a Goo package repository. These will be added to a repo file that + # will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. # Corresponds to the JSON property `goo` # @return [Google::Apis::OsconfigV1beta::RepositoryResourceGooRepository] attr_accessor :goo - # Represents a single yum package repository. These will be added to a repo - # file that will be managed at /etc/yum.repos.d/google_osconfig.repo. + # Represents a single yum package repository. These will be added to a repo file + # that will be managed at /etc/yum.repos.d/google_osconfig.repo. # Corresponds to the JSON property `yum` # @return [Google::Apis::OsconfigV1beta::RepositoryResourceYumRepository] attr_accessor :yum - # Represents a single zypper package repository. These will be added to a - # repo file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. + # Represents a single zypper package repository. These will be added to a repo + # file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. # Corresponds to the JSON property `zypper` # @return [Google::Apis::OsconfigV1beta::RepositoryResourceZypperRepository] attr_accessor :zypper @@ -2175,8 +2100,8 @@ module Google end end - # Represents a single apt package repository. These will be added to a repo - # file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. + # Represents a single apt package repository. These will be added to a repo file + # that will be managed at /etc/apt/sources.list.d/google_osconfig.list. class RepositoryResourceAptRepository include Google::Apis::Core::Hashable @@ -2195,8 +2120,8 @@ module Google # @return [String] attr_accessor :distribution - # URI of the key file for this repository. The agent will maintain - # a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg. + # URI of the key file for this repository. The agent will maintain a keyring at / + # etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg. # Corresponds to the JSON property `gpgKey` # @return [String] attr_accessor :gpg_key @@ -2220,8 +2145,8 @@ module Google end end - # Represents a Goo package repository. These will be added to a repo file - # that will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. + # Represents a Goo package repository. These will be added to a repo file that + # will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. class RepositoryResourceGooRepository include Google::Apis::Core::Hashable @@ -2246,8 +2171,8 @@ module Google end end - # Represents a single yum package repository. These will be added to a repo - # file that will be managed at /etc/yum.repos.d/google_osconfig.repo. + # Represents a single yum package repository. These will be added to a repo file + # that will be managed at /etc/yum.repos.d/google_osconfig.repo. class RepositoryResourceYumRepository include Google::Apis::Core::Hashable @@ -2266,10 +2191,9 @@ module Google # @return [Array] attr_accessor :gpg_keys - # A one word, unique name for this repository. This will be - # the `repo id` in the yum config file and also the `display_name` if - # `display_name` is omitted. This id is also used as the unique identifier - # when checking for resource conflicts. + # A one word, unique name for this repository. This will be the `repo id` in the + # yum config file and also the `display_name` if `display_name` is omitted. This + # id is also used as the unique identifier when checking for resource conflicts. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -2287,8 +2211,8 @@ module Google end end - # Represents a single zypper package repository. These will be added to a - # repo file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. + # Represents a single zypper package repository. These will be added to a repo + # file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. class RepositoryResourceZypperRepository include Google::Apis::Core::Hashable @@ -2307,10 +2231,10 @@ module Google # @return [Array] attr_accessor :gpg_keys - # A one word, unique name for this repository. This will be - # the `repo id` in the zypper config file and also the `display_name` if - # `display_name` is omitted. This id is also used as the unique identifier - # when checking for GuestPolicy conflicts. + # A one word, unique name for this repository. This will be the `repo id` in the + # zypper config file and also the `display_name` if `display_name` is omitted. + # This id is also used as the unique identifier when checking for GuestPolicy + # conflicts. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -2342,22 +2266,17 @@ module Google end # A software recipe is a set of instructions for installing and configuring a - # piece of software. It consists of a set of artifacts that are - # downloaded, and a set of steps that install, configure, and/or update the - # software. - # Recipes support installing and updating software from artifacts in the - # following formats: - # Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. - # Additionally, recipes support executing a script (either defined in a file or - # directly in this api) in bash, sh, cmd, and powershell. - # Updating a software recipe - # If a recipe is assigned to an instance and there is a recipe with the same - # name but a lower version already installed and the assigned state - # of the recipe is `UPDATED`, then the recipe is updated to - # the new version. - # Script Working Directories - # Each script or execution step is run in its own temporary directory which - # is deleted after completing the step. + # piece of software. It consists of a set of artifacts that are downloaded, and + # a set of steps that install, configure, and/or update the software. Recipes + # support installing and updating software from artifacts in the following + # formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM + # package. Additionally, recipes support executing a script (either defined in a + # file or directly in this api) in bash, sh, cmd, and powershell. Updating a + # software recipe If a recipe is assigned to an instance and there is a recipe + # with the same name but a lower version already installed and the assigned + # state of the recipe is `UPDATED`, then the recipe is updated to the new + # version. Script Working Directories Each script or execution step is run in + # its own temporary directory which is deleted after completing the step. class SoftwareRecipe include Google::Apis::Core::Hashable @@ -2367,45 +2286,41 @@ module Google attr_accessor :artifacts # Default is INSTALLED. The desired state the agent should maintain for this - # recipe. - # INSTALLED: The software recipe is installed on the instance but - # won't be updated to new versions. - # UPDATED: The software recipe is installed on the instance. The recipe is - # updated to a higher version, if a higher version of the recipe is - # assigned to this instance. - # REMOVE: Remove is unsupported for software recipes and attempts to - # create or update a recipe to the REMOVE state is rejected. + # recipe. INSTALLED: The software recipe is installed on the instance but won't + # be updated to new versions. UPDATED: The software recipe is installed on the + # instance. The recipe is updated to a higher version, if a higher version of + # the recipe is assigned to this instance. REMOVE: Remove is unsupported for + # software recipes and attempts to create or update a recipe to the REMOVE state + # is rejected. # Corresponds to the JSON property `desiredState` # @return [String] attr_accessor :desired_state - # Actions to be taken for installing this recipe. On failure it stops - # executing steps and does not attempt another installation. Any steps taken - # (including partially completed steps) are not rolled back. + # Actions to be taken for installing this recipe. On failure it stops executing + # steps and does not attempt another installation. Any steps taken (including + # partially completed steps) are not rolled back. # Corresponds to the JSON property `installSteps` # @return [Array] attr_accessor :install_steps # Required. Unique identifier for the recipe. Only one recipe with a given name - # is - # installed on an instance. - # Names are also used to identify resources which helps to determine whether - # guest policies have conflicts. This means that requests to create multiple - # recipes with the same name and version are rejected since they - # could potentially have conflicting assignments. + # is installed on an instance. Names are also used to identify resources which + # helps to determine whether guest policies have conflicts. This means that + # requests to create multiple recipes with the same name and version are + # rejected since they could potentially have conflicting assignments. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Actions to be taken for updating this recipe. On failure it stops - # executing steps and does not attempt another update for this recipe. Any - # steps taken (including partially completed steps) are not rolled back. + # Actions to be taken for updating this recipe. On failure it stops executing + # steps and does not attempt another update for this recipe. Any steps taken ( + # including partially completed steps) are not rolled back. # Corresponds to the JSON property `updateSteps` # @return [Array] attr_accessor :update_steps - # The version of this software recipe. Version can be up to 4 period - # separated numbers (e.g. 12.34.56.78). + # The version of this software recipe. Version can be up to 4 period separated + # numbers (e.g. 12.34.56.78). # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -2429,11 +2344,10 @@ module Google class SoftwareRecipeArtifact include Google::Apis::Core::Hashable - # Defaults to false. When false, recipes are subject to validations - # based on the artifact type: - # Remote: A checksum must be specified, and only protocols with - # transport-layer security are permitted. - # GCS: An object generation number must be specified. + # Defaults to false. When false, recipes are subject to validations based on the + # artifact type: Remote: A checksum must be specified, and only protocols with + # transport-layer security are permitted. GCS: An object generation number must + # be specified. # Corresponds to the JSON property `allowInsecure` # @return [Boolean] attr_accessor :allow_insecure @@ -2472,28 +2386,24 @@ module Google class SoftwareRecipeArtifactGcs include Google::Apis::Core::Hashable - # Bucket of the Google Cloud Storage object. - # Given an example URL: - # `https://storage.googleapis.com/my-bucket/foo/bar#1234567` - # this value would be `my-bucket`. + # Bucket of the Google Cloud Storage object. Given an example URL: `https:// + # storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `my- + # bucket`. # Corresponds to the JSON property `bucket` # @return [String] attr_accessor :bucket - # Must be provided if allow_insecure is false. - # Generation number of the Google Cloud Storage object. - # `https://storage.googleapis.com/my-bucket/foo/bar#1234567` - # this value would be `1234567`. + # Must be provided if allow_insecure is false. Generation number of the Google + # Cloud Storage object. `https://storage.googleapis.com/my-bucket/foo/bar# + # 1234567` this value would be `1234567`. # Corresponds to the JSON property `generation` # @return [Fixnum] attr_accessor :generation - # Name of the Google Cloud Storage object. - # As specified [here] - # (https://cloud.google.com/storage/docs/naming#objectnames) - # Given an example URL: - # `https://storage.googleapis.com/my-bucket/foo/bar#1234567` - # this value would be `foo/bar`. + # Name of the Google Cloud Storage object. As specified [here] (https://cloud. + # google.com/storage/docs/naming#objectnames) Given an example URL: `https:// + # storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `foo/bar` + # . # Corresponds to the JSON property `object` # @return [String] attr_accessor :object @@ -2514,17 +2424,16 @@ module Google class SoftwareRecipeArtifactRemote include Google::Apis::Core::Hashable - # Must be provided if `allow_insecure` is `false`. - # SHA256 checksum in hex format, to compare to the checksum of the - # artifact. If the checksum is not empty and it doesn't match the - # artifact then the recipe installation fails before running any of the - # steps. + # Must be provided if `allow_insecure` is `false`. SHA256 checksum in hex format, + # to compare to the checksum of the artifact. If the checksum is not empty and + # it doesn't match the artifact then the recipe installation fails before + # running any of the steps. # Corresponds to the JSON property `checksum` # @return [String] attr_accessor :checksum - # URI from which to fetch the object. It should contain both the protocol - # and path following the format `protocol`://`location`. + # URI from which to fetch the object. It should contain both the protocol and + # path following the format `protocol`://`location`. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -2609,26 +2518,22 @@ module Google # @return [String] attr_accessor :destination - # Whether to allow this step to overwrite existing files. If this is - # false and the file already exists the file is not overwritten - # and the step is considered a success. Defaults to false. + # Whether to allow this step to overwrite existing files. If this is false and + # the file already exists the file is not overwritten and the step is considered + # a success. Defaults to false. # Corresponds to the JSON property `overwrite` # @return [Boolean] attr_accessor :overwrite alias_method :overwrite?, :overwrite - # Consists of three octal digits which represent, in - # order, the permissions of the owner, group, and other users for the - # file (similarly to the numeric mode used in the linux chmod utility). - # Each digit represents a three bit number with the 4 bit - # corresponding to the read permissions, the 2 bit corresponds to the - # write bit, and the one bit corresponds to the execute permission. - # Default behavior is 755. - # Below are some examples of permissions and their associated values: - # read, write, and execute: 7 - # read and execute: 5 - # read and write: 6 - # read only: 4 + # Consists of three octal digits which represent, in order, the permissions of + # the owner, group, and other users for the file (similarly to the numeric mode + # used in the linux chmod utility). Each digit represents a three bit number + # with the 4 bit corresponding to the read permissions, the 2 bit corresponds to + # the write bit, and the one bit corresponds to the execute permission. Default + # behavior is 755. Below are some examples of permissions and their associated + # values: read, write, and execute: 7 read and execute: 5 read and write: 6 read + # only: 4 # Corresponds to the JSON property `permissions` # @return [String] attr_accessor :permissions @@ -2650,8 +2555,8 @@ module Google class SoftwareRecipeStepExecFile include Google::Apis::Core::Hashable - # Defaults to [0]. A list of possible return values that the program - # can return to indicate a success. + # Defaults to [0]. A list of possible return values that the program can return + # to indicate a success. # Corresponds to the JSON property `allowedExitCodes` # @return [Array] attr_accessor :allowed_exit_codes @@ -2693,8 +2598,7 @@ module Google # @return [String] attr_accessor :artifact_id - # Directory to extract archive to. - # Defaults to `/` on Linux or `C:\` on Windows. + # Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows. # Corresponds to the JSON property `destination` # @return [String] attr_accessor :destination @@ -2739,8 +2643,8 @@ module Google class SoftwareRecipeStepInstallMsi include Google::Apis::Core::Hashable - # Return codes that indicate that the software installed or updated - # successfully. Behaviour defaults to [0] + # Return codes that indicate that the software installed or updated successfully. + # Behaviour defaults to [0] # Corresponds to the JSON property `allowedExitCodes` # @return [Array] attr_accessor :allowed_exit_codes @@ -2750,8 +2654,8 @@ module Google # @return [String] attr_accessor :artifact_id - # The flags to use when installing the MSI - # defaults to ["/i"] (i.e. the install flag). + # The flags to use when installing the MSI defaults to ["/i"] (i.e. the install + # flag). # Corresponds to the JSON property `flags` # @return [Array] attr_accessor :flags @@ -2791,16 +2695,15 @@ module Google class SoftwareRecipeStepRunScript include Google::Apis::Core::Hashable - # Return codes that indicate that the software installed or updated - # successfully. Behaviour defaults to [0] + # Return codes that indicate that the software installed or updated successfully. + # Behaviour defaults to [0] # Corresponds to the JSON property `allowedExitCodes` # @return [Array] attr_accessor :allowed_exit_codes # The script interpreter to use to run the script. If no interpreter is - # specified the script is executed directly, which likely - # only succeed for scripts with - # [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). + # specified the script is executed directly, which likely only succeed for + # scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). # Corresponds to the JSON property `interpreter` # @return [String] attr_accessor :interpreter @@ -2822,14 +2725,14 @@ module Google end end - # Represents a time of day. The date and time zone are either not significant - # or are specified elsewhere. An API may choose to allow leap seconds. Related + # Represents a time of day. The date and time zone are either not significant or + # are specified elsewhere. An API may choose to allow leap seconds. Related # types are google.type.Date and `google.protobuf.Timestamp`. class TimeOfDay include Google::Apis::Core::Hashable - # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose - # to allow the value "24:00:00" for scenarios like business closing time. + # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to + # allow the value "24:00:00" for scenarios like business closing time. # Corresponds to the JSON property `hours` # @return [Fixnum] attr_accessor :hours @@ -2863,8 +2766,8 @@ module Google end end - # Represents a time zone from the - # [IANA Time Zone Database](https://www.iana.org/time-zones). + # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/ + # time-zones). class TimeZone include Google::Apis::Core::Hashable @@ -2899,8 +2802,7 @@ module Google attr_accessor :day_of_week # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the - # month. -1 - # indicates the last week of the month. + # month. -1 indicates the last week of the month. # Corresponds to the JSON property `weekOrdinal` # @return [Fixnum] attr_accessor :week_ordinal @@ -2950,9 +2852,8 @@ module Google # @return [Array] attr_accessor :excludes - # An exclusive list of kbs to be updated. These are the only patches - # that will be updated. This field must not be used with other - # patch configurations. + # An exclusive list of kbs to be updated. These are the only patches that will + # be updated. This field must not be used with other patch configurations. # Corresponds to the JSON property `exclusivePatches` # @return [Array] attr_accessor :exclusive_patches @@ -2969,8 +2870,8 @@ module Google end end - # Represents a single Yum package repository. This repository is added to a - # repo file that is stored at `/etc/yum.repos.d/google_osconfig.repo`. + # Represents a single Yum package repository. This repository is added to a repo + # file that is stored at `/etc/yum.repos.d/google_osconfig.repo`. class YumRepository include Google::Apis::Core::Hashable @@ -2989,10 +2890,10 @@ module Google # @return [Array] attr_accessor :gpg_keys - # Required. A one word, unique name for this repository. This is - # the `repo id` in the Yum config file and also the `display_name` if - # `display_name` is omitted. This id is also used as the unique identifier - # when checking for guest policy conflicts. + # Required. A one word, unique name for this repository. This is the `repo id` + # in the Yum config file and also the `display_name` if `display_name` is + # omitted. This id is also used as the unique identifier when checking for guest + # policy conflicts. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -3010,22 +2911,21 @@ module Google end end - # Yum patching is performed by executing `yum update`. Additional options - # can be set to control how this is executed. - # Note that not all settings are supported on all platforms. + # Yum patching is performed by executing `yum update`. Additional options can be + # set to control how this is executed. Note that not all settings are supported + # on all platforms. class YumSettings include Google::Apis::Core::Hashable - # List of packages to exclude from update. These packages are excluded by - # using the yum `--exclude` flag. + # List of packages to exclude from update. These packages are excluded by using + # the yum `--exclude` flag. # Corresponds to the JSON property `excludes` # @return [Array] attr_accessor :excludes - # An exclusive list of packages to be updated. These are the only packages - # that will be updated. If these packages are not installed, they will be - # ignored. This field must not be specified with any other patch - # configuration fields. + # An exclusive list of packages to be updated. These are the only packages that + # will be updated. If these packages are not installed, they will be ignored. + # This field must not be specified with any other patch configuration fields. # Corresponds to the JSON property `exclusivePackages` # @return [Array] attr_accessor :exclusive_packages @@ -3036,8 +2936,7 @@ module Google attr_accessor :minimal alias_method :minimal?, :minimal - # Adds the `--security` flag to `yum update`. Not supported on - # all platforms. + # Adds the `--security` flag to `yum update`. Not supported on all platforms. # Corresponds to the JSON property `security` # @return [Boolean] attr_accessor :security @@ -3076,10 +2975,10 @@ module Google # @return [Array] attr_accessor :gpg_keys - # Required. A one word, unique name for this repository. This is - # the `repo id` in the zypper config file and also the `display_name` if - # `display_name` is omitted. This id is also used as the unique identifier - # when checking for guest policy conflicts. + # Required. A one word, unique name for this repository. This is the `repo id` + # in the zypper config file and also the `display_name` if `display_name` is + # omitted. This id is also used as the unique identifier when checking for guest + # policy conflicts. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -3097,13 +2996,13 @@ module Google end end - # Zypper patching is performed by running `zypper patch`. - # See also https://en.opensuse.org/SDB:Zypper_manual. + # Zypper patching is performed by running `zypper patch`. See also https://en. + # opensuse.org/SDB:Zypper_manual. class ZypperSettings include Google::Apis::Core::Hashable - # Install only patches with these categories. - # Common categories include security, recommended, and feature. + # Install only patches with these categories. Common categories include security, + # recommended, and feature. # Corresponds to the JSON property `categories` # @return [Array] attr_accessor :categories @@ -3113,15 +3012,15 @@ module Google # @return [Array] attr_accessor :excludes - # An exclusive list of patches to be updated. These are the only patches - # that will be installed using 'zypper patch patch:' command. - # This field must not be used with any other patch configuration fields. + # An exclusive list of patches to be updated. These are the only patches that + # will be installed using 'zypper patch patch:' command. This field must not be + # used with any other patch configuration fields. # Corresponds to the JSON property `exclusivePatches` # @return [Array] attr_accessor :exclusive_patches - # Install only patches with these severities. - # Common severities include critical, important, moderate, and low. + # Install only patches with these severities. Common severities include critical, + # important, moderate, and low. # Corresponds to the JSON property `severities` # @return [Array] attr_accessor :severities diff --git a/generated/google/apis/osconfig_v1beta/service.rb b/generated/google/apis/osconfig_v1beta/service.rb index f299e9724..f3c8d181c 100644 --- a/generated/google/apis/osconfig_v1beta/service.rb +++ b/generated/google/apis/osconfig_v1beta/service.rb @@ -50,17 +50,14 @@ module Google # Create an OS Config guest policy. # @param [String] parent - # Required. The resource name of the parent using one of the following forms: - # `projects/`project_number``. + # Required. The resource name of the parent using one of the following forms: ` + # projects/`project_number``. # @param [Google::Apis::OsconfigV1beta::GuestPolicy] guest_policy_object # @param [String] guest_policy_id - # Required. The logical name of the guest policy in the project - # with the following restrictions: - # * Must contain only lowercase letters, numbers, and hyphens. - # * Must start with a letter. - # * Must be between 1-63 characters. - # * Must end with a number or a letter. - # * Must be unique within the project. + # Required. The logical name of the guest policy in the project with the + # following restrictions: * Must contain only lowercase letters, numbers, and + # hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must + # end with a number or a letter. * Must be unique within the project. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -93,9 +90,8 @@ module Google # Delete an OS Config guest policy. # @param [String] name - # Required. The resource name of the guest policy using one of the following - # forms: - # `projects/`project_number`/guestPolicies/`guest_policy_id``. + # Required. The resource name of the guest policy using one of the following + # forms: `projects/`project_number`/guestPolicies/`guest_policy_id``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -126,8 +122,7 @@ module Google # Get an OS Config guest policy. # @param [String] name # Required. The resource name of the guest policy using one of the following - # forms: - # `projects/`project_number`/guestPolicies/`guest_policy_id``. + # forms: `projects/`project_number`/guestPolicies/`guest_policy_id``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -157,13 +152,13 @@ module Google # Get a page of OS Config guest policies. # @param [String] parent - # Required. The resource name of the parent using one of the following forms: - # `projects/`project_number``. + # Required. The resource name of the parent using one of the following forms: ` + # projects/`project_number``. # @param [Fixnum] page_size # The maximum number of guest policies to return. # @param [String] page_token - # A pagination token returned from a previous call to `ListGuestPolicies` - # that indicates where this listing should continue from. + # A pagination token returned from a previous call to `ListGuestPolicies` that + # indicates where this listing should continue from. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -196,13 +191,10 @@ module Google # Update an OS Config guest policy. # @param [String] name # Required. Unique name of the resource in this project using one of the - # following - # forms: - # `projects/`project_number`/guestPolicies/`guest_policy_id``. + # following forms: `projects/`project_number`/guestPolicies/`guest_policy_id``. # @param [Google::Apis::OsconfigV1beta::GuestPolicy] guest_policy_object # @param [String] update_mask - # Field mask that controls which fields of the guest policy should be - # updated. + # Field mask that controls which fields of the guest policy should be updated. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -240,12 +232,9 @@ module Google # @param [Google::Apis::OsconfigV1beta::PatchDeployment] patch_deployment_object # @param [String] patch_deployment_id # Required. A name for the patch deployment in the project. When creating a name - # the following rules apply: - # * Must contain only lowercase letters, numbers, and hyphens. - # * Must start with a letter. - # * Must be between 1-63 characters. - # * Must end with a number or a letter. - # * Must be unique within the project. + # the following rules apply: * Must contain only lowercase letters, numbers, and + # hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must + # end with a number or a letter. * Must be unique within the project. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -278,8 +267,8 @@ module Google # Delete an OS Config patch deployment. # @param [String] name - # Required. The resource name of the patch deployment in the form - # `projects/*/patchDeployments/*`. + # Required. The resource name of the patch deployment in the form `projects/*/ + # patchDeployments/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -309,8 +298,8 @@ module Google # Get an OS Config patch deployment. # @param [String] name - # Required. The resource name of the patch deployment in the form - # `projects/*/patchDeployments/*`. + # Required. The resource name of the patch deployment in the form `projects/*/ + # patchDeployments/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -345,8 +334,7 @@ module Google # Optional. The maximum number of patch deployments to return. Default is 100. # @param [String] page_token # Optional. A pagination token returned from a previous call to - # ListPatchDeployments - # that indicates where this listing should continue from. + # ListPatchDeployments that indicates where this listing should continue from. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -376,8 +364,8 @@ module Google execute_or_queue_command(command, &block) end - # Cancel a patch job. The patch job must be active. Canceled patch jobs - # cannot be restarted. + # Cancel a patch job. The patch job must be active. Canceled patch jobs cannot + # be restarted. # @param [String] name # Required. Name of the patch in the form `projects/*/patchJobs/*` # @param [Google::Apis::OsconfigV1beta::CancelPatchJobRequest] cancel_patch_job_request_object @@ -443,8 +431,8 @@ module Google execute_or_queue_command(command, &block) end - # Get the patch job. This can be used to track the progress of an - # ongoing patch job or review the details of completed jobs. + # Get the patch job. This can be used to track the progress of an ongoing patch + # job or review the details of completed jobs. # @param [String] name # Required. Name of the patch in the form `projects/*/patchJobs/*` # @param [String] fields @@ -478,14 +466,14 @@ module Google # @param [String] parent # Required. In the form of `projects/*` # @param [String] filter - # If provided, this field specifies the criteria that must be met by patch - # jobs to be included in the response. - # Currently, filtering is only available on the patch_deployment field. + # If provided, this field specifies the criteria that must be met by patch jobs + # to be included in the response. Currently, filtering is only available on the + # patch_deployment field. # @param [Fixnum] page_size # The maximum number of instance status to return. # @param [String] page_token - # A pagination token returned from a previous call - # that indicates where this listing should continue from. + # A pagination token returned from a previous call that indicates where this + # listing should continue from. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -521,14 +509,13 @@ module Google # Required. The parent for the instances are in the form of `projects/*/ # patchJobs/*`. # @param [String] filter - # A filter expression that filters results listed in the response. This - # field supports filtering results by instance zone, name, state, or - # `failure_reason`. + # A filter expression that filters results listed in the response. This field + # supports filtering results by instance zone, name, state, or `failure_reason`. # @param [Fixnum] page_size - # The maximum number of instance details records to return. Default is 100. + # The maximum number of instance details records to return. Default is 100. # @param [String] page_token - # A pagination token returned from a previous call - # that indicates where this listing should continue from. + # A pagination token returned from a previous call that indicates where this + # listing should continue from. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -559,8 +546,8 @@ module Google execute_or_queue_command(command, &block) end - # Lookup the effective guest policy that applies to a VM instance. This - # lookup merges all policies that are assigned to the instance ancestry. + # Lookup the effective guest policy that applies to a VM instance. This lookup + # merges all policies that are assigned to the instance ancestry. # @param [String] instance # Required. The VM instance whose policies are being looked up. # @param [Google::Apis::OsconfigV1beta::LookupEffectiveGuestPolicyRequest] lookup_effective_guest_policy_request_object diff --git a/generated/google/apis/remotebuildexecution_v1.rb b/generated/google/apis/remotebuildexecution_v1.rb index 01b2b89b9..f35cd8835 100644 --- a/generated/google/apis/remotebuildexecution_v1.rb +++ b/generated/google/apis/remotebuildexecution_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/remote-build-execution/docs/ module RemotebuildexecutionV1 VERSION = 'V1' - REVISION = '20200721' + REVISION = '20200810' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/remotebuildexecution_v1/classes.rb b/generated/google/apis/remotebuildexecution_v1/classes.rb index 993b43ba5..de2c6c062 100644 --- a/generated/google/apis/remotebuildexecution_v1/classes.rb +++ b/generated/google/apis/remotebuildexecution_v1/classes.rb @@ -23,120 +23,107 @@ module Google module RemotebuildexecutionV1 # An `Action` captures all the information about an execution which is required - # to reproduce it. - # `Action`s are the core component of the [Execution] service. A single - # `Action` represents a repeatable action that can be performed by the + # to reproduce it. `Action`s are the core component of the [Execution] service. + # A single `Action` represents a repeatable action that can be performed by the # execution service. `Action`s can be succinctly identified by the digest of # their wire format encoding and, once an `Action` has been executed, will be # cached in the action cache. Future requests can then use the cached result - # rather than needing to run afresh. - # When a server completes execution of an - # Action, it MAY choose to - # cache the result in - # the ActionCache unless - # `do_not_cache` is `true`. Clients SHOULD expect the server to do so. By - # default, future calls to - # Execute the same - # `Action` will also serve their results from the cache. Clients must take care - # to understand the caching behaviour. Ideally, all `Action`s will be - # reproducible so that serving a result from cache is always desirable and - # correct. + # rather than needing to run afresh. When a server completes execution of an + # Action, it MAY choose to cache the result in the ActionCache unless ` + # do_not_cache` is `true`. Clients SHOULD expect the server to do so. By default, + # future calls to Execute the same `Action` will also serve their results from + # the cache. Clients must take care to understand the caching behaviour. Ideally, + # all `Action`s will be reproducible so that serving a result from cache is + # always desirable and correct. class BuildBazelRemoteExecutionV2Action include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `commandDigest` # @return [Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest] attr_accessor :command_digest - # If true, then the `Action`'s result cannot be cached, and in-flight - # requests for the same `Action` may not be merged. + # If true, then the `Action`'s result cannot be cached, and in-flight requests + # for the same `Action` may not be merged. # Corresponds to the JSON property `doNotCache` # @return [Boolean] attr_accessor :do_not_cache alias_method :do_not_cache?, :do_not_cache # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `inputRootDigest` # @return [Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest] attr_accessor :input_root_digest - # List of required supported NodeProperty - # keys. In order to ensure that equivalent `Action`s always hash to the same - # value, the supported node properties MUST be lexicographically sorted by name. - # Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. - # The interpretation of these properties is server-dependent. If a property is - # not recognized by the server, the server will return an `INVALID_ARGUMENT` - # error. + # List of required supported NodeProperty keys. In order to ensure that + # equivalent `Action`s always hash to the same value, the supported node + # properties MUST be lexicographically sorted by name. Sorting of strings is + # done by code point, equivalently, by the UTF-8 bytes. The interpretation of + # these properties is server-dependent. If a property is not recognized by the + # server, the server will return an `INVALID_ARGUMENT` error. # Corresponds to the JSON property `outputNodeProperties` # @return [Array] attr_accessor :output_node_properties - # A timeout after which the execution should be killed. If the timeout is - # absent, then the client is specifying that the execution should continue - # as long as the server will let it. The server SHOULD impose a timeout if - # the client does not specify one, however, if the client does specify a - # timeout that is longer than the server's maximum timeout, the server MUST - # reject the request. - # The timeout is a part of the - # Action message, and - # therefore two `Actions` with different timeouts are different, even if they - # are otherwise identical. This is because, if they were not, running an - # `Action` with a lower timeout than is required might result in a cache hit - # from an execution run with a longer timeout, hiding the fact that the - # timeout is too short. By encoding it directly in the `Action`, a lower - # timeout will result in a cache miss and the execution timeout will fail - # immediately, rather than whenever the cache entry gets evicted. + # A timeout after which the execution should be killed. If the timeout is absent, + # then the client is specifying that the execution should continue as long as + # the server will let it. The server SHOULD impose a timeout if the client does + # not specify one, however, if the client does specify a timeout that is longer + # than the server's maximum timeout, the server MUST reject the request. The + # timeout is a part of the Action message, and therefore two `Actions` with + # different timeouts are different, even if they are otherwise identical. This + # is because, if they were not, running an `Action` with a lower timeout than is + # required might result in a cache hit from an execution run with a longer + # timeout, hiding the fact that the timeout is too short. By encoding it + # directly in the `Action`, a lower timeout will result in a cache miss and the + # execution timeout will fail immediately, rather than whenever the cache entry + # gets evicted. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout @@ -155,8 +142,7 @@ module Google end end - # An ActionResult represents the result of an - # Action being run. + # An ActionResult represents the result of an Action being run. class BuildBazelRemoteExecutionV2ActionResult include Google::Apis::Core::Hashable @@ -170,84 +156,41 @@ module Google # @return [Fixnum] attr_accessor :exit_code - # The output directories of the action. For each output directory requested - # in the `output_directories` or `output_paths` field of the Action, if the + # The output directories of the action. For each output directory requested in + # the `output_directories` or `output_paths` field of the Action, if the # corresponding directory existed after the action completed, a single entry - # will be present in the output list, which will contain the digest of a - # Tree message containing the - # directory tree, and the path equal exactly to the corresponding Action - # output_directories member. - # As an example, suppose the Action had an output directory `a/b/dir` and the - # execution produced the following contents in `a/b/dir`: a file named `bar` - # and a directory named `foo` with an executable file named `baz`. Then, - # output_directory will contain (hashes shortened for readability): - # ```json - # // OutputDirectory proto: - # ` - # path: "a/b/dir" - # tree_digest: ` - # hash: "4a73bc9d03...", - # size: 55 - # ` - # ` - # // Tree proto with hash "4a73bc9d03..." and size 55: - # ` - # root: ` - # files: [ - # ` - # name: "bar", - # digest: ` - # hash: "4a73bc9d03...", - # size: 65534 - # ` - # ` - # ], - # directories: [ - # ` - # name: "foo", - # digest: ` - # hash: "4cf2eda940...", - # size: 43 - # ` - # ` - # ] - # ` - # children : ` - # // (Directory proto with hash "4cf2eda940..." and size 43) - # files: [ - # ` - # name: "baz", - # digest: ` - # hash: "b2c941073e...", - # size: 1294, - # `, - # is_executable: true - # ` - # ] - # ` - # ` - # ``` - # If an output of the same name as listed in `output_files` of - # the Command was found in `output_directories`, but was not a directory, the - # server will return a FAILED_PRECONDITION. + # will be present in the output list, which will contain the digest of a Tree + # message containing the directory tree, and the path equal exactly to the + # corresponding Action output_directories member. As an example, suppose the + # Action had an output directory `a/b/dir` and the execution produced the + # following contents in `a/b/dir`: a file named `bar` and a directory named `foo` + # with an executable file named `baz`. Then, output_directory will contain ( + # hashes shortened for readability): ```json // OutputDirectory proto: ` path: " + # a/b/dir" tree_digest: ` hash: "4a73bc9d03...", size: 55 ` ` // Tree proto with + # hash "4a73bc9d03..." and size 55: ` root: ` files: [ ` name: "bar", digest: ` + # hash: "4a73bc9d03...", size: 65534 ` ` ], directories: [ ` name: "foo", digest: + # ` hash: "4cf2eda940...", size: 43 ` ` ] ` children : ` // (Directory proto + # with hash "4cf2eda940..." and size 43) files: [ ` name: "baz", digest: ` hash: + # "b2c941073e...", size: 1294, `, is_executable: true ` ] ` ` ``` If an output + # of the same name as listed in `output_files` of the Command was found in ` + # output_directories`, but was not a directory, the server will return a + # FAILED_PRECONDITION. # Corresponds to the JSON property `outputDirectories` # @return [Array] attr_accessor :output_directories # The output directories of the action that are symbolic links to other # directories. Those may be links to other output directories, or input - # directories, or even absolute paths outside of the working directory, - # if the server supports - # SymlinkAbsolutePathStrategy.ALLOWED. - # For each output directory requested in the `output_directories` field of - # the Action, if the directory existed after the action completed, a - # single entry will be present either in this field, or in the - # `output_directories` field, if the directory was not a symbolic link. - # If an output of the same name was found, but was a symbolic link to a file - # instead of a directory, the server will return a FAILED_PRECONDITION. - # If the action does not produce the requested output, then that output - # will be omitted from the list. The server is free to arrange the output - # list as desired; clients MUST NOT assume that the output list is sorted. + # directories, or even absolute paths outside of the working directory, if the + # server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output directory + # requested in the `output_directories` field of the Action, if the directory + # existed after the action completed, a single entry will be present either in + # this field, or in the `output_directories` field, if the directory was not a + # symbolic link. If an output of the same name was found, but was a symbolic + # link to a file instead of a directory, the server will return a + # FAILED_PRECONDITION. If the action does not produce the requested output, then + # that output will be omitted from the list. The server is free to arrange the + # output list as desired; clients MUST NOT assume that the output list is sorted. # DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API # should still populate this field in addition to `output_symlinks`. # Corresponds to the JSON property `outputDirectorySymlinks` @@ -257,131 +200,119 @@ module Google # The output files of the action that are symbolic links to other files. Those # may be links to other output files, or input files, or even absolute paths # outside of the working directory, if the server supports - # SymlinkAbsolutePathStrategy.ALLOWED. - # For each output file requested in the `output_files` or `output_paths` - # field of the Action, if the corresponding file existed after - # the action completed, a single entry will be present either in this field, - # or in the `output_files` field, if the file was not a symbolic link. - # If an output symbolic link of the same name as listed in `output_files` of - # the Command was found, but its target type was not a regular file, the - # server will return a FAILED_PRECONDITION. - # If the action does not produce the requested output, then that output - # will be omitted from the list. The server is free to arrange the output - # list as desired; clients MUST NOT assume that the output list is sorted. - # DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API - # should still populate this field in addition to `output_symlinks`. + # SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in the ` + # output_files` or `output_paths` field of the Action, if the corresponding file + # existed after the action completed, a single entry will be present either in + # this field, or in the `output_files` field, if the file was not a symbolic + # link. If an output symbolic link of the same name as listed in `output_files` + # of the Command was found, but its target type was not a regular file, the + # server will return a FAILED_PRECONDITION. If the action does not produce the + # requested output, then that output will be omitted from the list. The server + # is free to arrange the output list as desired; clients MUST NOT assume that + # the output list is sorted. DEPRECATED as of v2.1. Servers that wish to be + # compatible with v2.0 API should still populate this field in addition to ` + # output_symlinks`. # Corresponds to the JSON property `outputFileSymlinks` # @return [Array] attr_accessor :output_file_symlinks - # The output files of the action. For each output file requested in the - # `output_files` or `output_paths` field of the Action, if the corresponding - # file existed after the action completed, a single entry will be present - # either in this field, or the `output_file_symlinks` field if the file was - # a symbolic link to another file (`output_symlinks` field after v2.1). - # If an output listed in `output_files` was found, but was a directory rather - # than a regular file, the server will return a FAILED_PRECONDITION. - # If the action does not produce the requested output, then that output - # will be omitted from the list. The server is free to arrange the output - # list as desired; clients MUST NOT assume that the output list is sorted. + # The output files of the action. For each output file requested in the ` + # output_files` or `output_paths` field of the Action, if the corresponding file + # existed after the action completed, a single entry will be present either in + # this field, or the `output_file_symlinks` field if the file was a symbolic + # link to another file (`output_symlinks` field after v2.1). If an output listed + # in `output_files` was found, but was a directory rather than a regular file, + # the server will return a FAILED_PRECONDITION. If the action does not produce + # the requested output, then that output will be omitted from the list. The + # server is free to arrange the output list as desired; clients MUST NOT assume + # that the output list is sorted. # Corresponds to the JSON property `outputFiles` # @return [Array] attr_accessor :output_files - # New in v2.1: this field will only be populated if the command - # `output_paths` field was used, and not the pre v2.1 `output_files` or - # `output_directories` fields. - # The output paths of the action that are symbolic links to other paths. Those - # may be links to other outputs, or inputs, or even absolute paths - # outside of the working directory, if the server supports - # SymlinkAbsolutePathStrategy.ALLOWED. - # A single entry for each output requested in `output_paths` - # field of the Action, if the corresponding path existed after - # the action completed and was a symbolic link. - # If the action does not produce a requested output, then that output - # will be omitted from the list. The server is free to arrange the output - # list as desired; clients MUST NOT assume that the output list is sorted. + # New in v2.1: this field will only be populated if the command `output_paths` + # field was used, and not the pre v2.1 `output_files` or `output_directories` + # fields. The output paths of the action that are symbolic links to other paths. + # Those may be links to other outputs, or inputs, or even absolute paths outside + # of the working directory, if the server supports SymlinkAbsolutePathStrategy. + # ALLOWED. A single entry for each output requested in `output_paths` field of + # the Action, if the corresponding path existed after the action completed and + # was a symbolic link. If the action does not produce a requested output, then + # that output will be omitted from the list. The server is free to arrange the + # output list as desired; clients MUST NOT assume that the output list is sorted. # Corresponds to the JSON property `outputSymlinks` # @return [Array] attr_accessor :output_symlinks # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `stderrDigest` # @return [Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest] attr_accessor :stderr_digest - # The standard error buffer of the action. The server SHOULD NOT inline - # stderr unless requested by the client in the - # GetActionResultRequest - # message. The server MAY omit inlining, even if requested, and MUST do so if - # inlining - # would cause the response to exceed message size limits. + # The standard error buffer of the action. The server SHOULD NOT inline stderr + # unless requested by the client in the GetActionResultRequest message. The + # server MAY omit inlining, even if requested, and MUST do so if inlining would + # cause the response to exceed message size limits. # Corresponds to the JSON property `stderrRaw` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :stderr_raw # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `stdoutDigest` # @return [Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest] attr_accessor :stdout_digest - # The standard output buffer of the action. The server SHOULD NOT inline - # stdout unless requested by the client in the - # GetActionResultRequest - # message. The server MAY omit inlining, even if requested, and MUST do so if - # inlining - # would cause the response to exceed message size limits. + # The standard output buffer of the action. The server SHOULD NOT inline stdout + # unless requested by the client in the GetActionResultRequest message. The + # server MAY omit inlining, even if requested, and MUST do so if inlining would + # cause the response to exceed message size limits. # Corresponds to the JSON property `stdoutRaw` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -407,12 +338,11 @@ module Google end end - # A `Command` is the actual command executed by a worker running an - # Action and specifications of its - # environment. - # Except as otherwise required, the environment (such as which system - # libraries or binaries are available, and what filesystems are mounted where) - # is defined by and specific to the implementation of the remote execution API. + # A `Command` is the actual command executed by a worker running an Action and + # specifications of its environment. Except as otherwise required, the + # environment (such as which system libraries or binaries are available, and + # what filesystems are mounted where) is defined by and specific to the + # implementation of the remote execution API. class BuildBazelRemoteExecutionV2Command include Google::Apis::Core::Hashable @@ -425,105 +355,90 @@ module Google # The environment variables to set when running the program. The worker may # provide its own default environment variables; these defaults can be - # overridden using this field. Additional variables can also be specified. - # In order to ensure that equivalent - # Commands always hash to the same - # value, the environment variables MUST be lexicographically sorted by name. - # Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. + # overridden using this field. Additional variables can also be specified. In + # order to ensure that equivalent Commands always hash to the same value, the + # environment variables MUST be lexicographically sorted by name. Sorting of + # strings is done by code point, equivalently, by the UTF-8 bytes. # Corresponds to the JSON property `environmentVariables` # @return [Array] attr_accessor :environment_variables - # A list of the output directories that the client expects to retrieve from - # the action. Only the listed directories will be returned (an entire - # directory structure will be returned as a - # Tree message digest, see - # OutputDirectory), as - # well as files listed in `output_files`. Other files or directories that - # may be created during command execution are discarded. - # The paths are relative to the working directory of the action execution. - # The paths are specified using a single forward slash (`/`) as a path - # separator, even if the execution platform natively uses a different - # separator. The path MUST NOT include a trailing slash, nor a leading slash, - # being a relative path. The special value of empty string is allowed, - # although not recommended, and can be used to capture the entire working - # directory tree, including inputs. - # In order to ensure consistent hashing of the same Action, the output paths - # MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 - # bytes). - # An output directory cannot be duplicated or have the same path as any of - # the listed output files. An output directory is allowed to be a parent of - # another output directory. + # A list of the output directories that the client expects to retrieve from the + # action. Only the listed directories will be returned (an entire directory + # structure will be returned as a Tree message digest, see OutputDirectory), as + # well as files listed in `output_files`. Other files or directories that may be + # created during command execution are discarded. The paths are relative to the + # working directory of the action execution. The paths are specified using a + # single forward slash (`/`) as a path separator, even if the execution platform + # natively uses a different separator. The path MUST NOT include a trailing + # slash, nor a leading slash, being a relative path. The special value of empty + # string is allowed, although not recommended, and can be used to capture the + # entire working directory tree, including inputs. In order to ensure consistent + # hashing of the same Action, the output paths MUST be sorted lexicographically + # by code point (or, equivalently, by UTF-8 bytes). An output directory cannot + # be duplicated or have the same path as any of the listed output files. An + # output directory is allowed to be a parent of another output directory. # Directories leading up to the output directories (but not the output - # directories themselves) are created by the worker prior to execution, even - # if they are not explicitly part of the input root. - # DEPRECATED since 2.1: Use `output_paths` instead. + # directories themselves) are created by the worker prior to execution, even if + # they are not explicitly part of the input root. DEPRECATED since 2.1: Use ` + # output_paths` instead. # Corresponds to the JSON property `outputDirectories` # @return [Array] attr_accessor :output_directories - # A list of the output files that the client expects to retrieve from the - # action. Only the listed files, as well as directories listed in - # `output_directories`, will be returned to the client as output. - # Other files or directories that may be created during command execution - # are discarded. - # The paths are relative to the working directory of the action execution. - # The paths are specified using a single forward slash (`/`) as a path - # separator, even if the execution platform natively uses a different - # separator. The path MUST NOT include a trailing slash, nor a leading slash, - # being a relative path. - # In order to ensure consistent hashing of the same Action, the output paths - # MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 - # bytes). - # An output file cannot be duplicated, be a parent of another output file, or - # have the same path as any of the listed output directories. - # Directories leading up to the output files are created by the worker prior - # to execution, even if they are not explicitly part of the input root. - # DEPRECATED since v2.1: Use `output_paths` instead. + # A list of the output files that the client expects to retrieve from the action. + # Only the listed files, as well as directories listed in `output_directories`, + # will be returned to the client as output. Other files or directories that may + # be created during command execution are discarded. The paths are relative to + # the working directory of the action execution. The paths are specified using a + # single forward slash (`/`) as a path separator, even if the execution platform + # natively uses a different separator. The path MUST NOT include a trailing + # slash, nor a leading slash, being a relative path. In order to ensure + # consistent hashing of the same Action, the output paths MUST be sorted + # lexicographically by code point (or, equivalently, by UTF-8 bytes). An output + # file cannot be duplicated, be a parent of another output file, or have the + # same path as any of the listed output directories. Directories leading up to + # the output files are created by the worker prior to execution, even if they + # are not explicitly part of the input root. DEPRECATED since v2.1: Use ` + # output_paths` instead. # Corresponds to the JSON property `outputFiles` # @return [Array] attr_accessor :output_files - # A list of the output paths that the client expects to retrieve from the - # action. Only the listed paths will be returned to the client as output. - # The type of the output (file or directory) is not specified, and will be - # determined by the server after action execution. If the resulting path is - # a file, it will be returned in an - # OutputFile) typed field. - # If the path is a directory, the entire directory structure will be returned - # as a Tree message digest, see - # OutputDirectory) - # Other files or directories that may be created during command execution - # are discarded. - # The paths are relative to the working directory of the action execution. - # The paths are specified using a single forward slash (`/`) as a path - # separator, even if the execution platform natively uses a different - # separator. The path MUST NOT include a trailing slash, nor a leading slash, - # being a relative path. - # In order to ensure consistent hashing of the same Action, the output paths - # MUST be deduplicated and sorted lexicographically by code point (or, - # equivalently, by UTF-8 bytes). - # Directories leading up to the output paths are created by the worker prior - # to execution, even if they are not explicitly part of the input root. - # New in v2.1: this field supersedes the DEPRECATED `output_files` and - # `output_directories` fields. If `output_paths` is used, `output_files` and - # `output_directories` will be ignored! + # A list of the output paths that the client expects to retrieve from the action. + # Only the listed paths will be returned to the client as output. The type of + # the output (file or directory) is not specified, and will be determined by the + # server after action execution. If the resulting path is a file, it will be + # returned in an OutputFile) typed field. If the path is a directory, the entire + # directory structure will be returned as a Tree message digest, see + # OutputDirectory) Other files or directories that may be created during command + # execution are discarded. The paths are relative to the working directory of + # the action execution. The paths are specified using a single forward slash (`/` + # ) as a path separator, even if the execution platform natively uses a + # different separator. The path MUST NOT include a trailing slash, nor a leading + # slash, being a relative path. In order to ensure consistent hashing of the + # same Action, the output paths MUST be deduplicated and sorted + # lexicographically by code point (or, equivalently, by UTF-8 bytes). + # Directories leading up to the output paths are created by the worker prior to + # execution, even if they are not explicitly part of the input root. New in v2.1: + # this field supersedes the DEPRECATED `output_files` and `output_directories` + # fields. If `output_paths` is used, `output_files` and `output_directories` + # will be ignored! # Corresponds to the JSON property `outputPaths` # @return [Array] attr_accessor :output_paths # A `Platform` is a set of requirements, such as hardware, operating system, or - # compiler toolchain, for an - # Action's execution - # environment. A `Platform` is represented as a series of key-value pairs - # representing the properties that are required of the platform. + # compiler toolchain, for an Action's execution environment. A `Platform` is + # represented as a series of key-value pairs representing the properties that + # are required of the platform. # Corresponds to the JSON property `platform` # @return [Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Platform] attr_accessor :platform - # The working directory, relative to the input root, for the command to run - # in. It must be a directory which exists in the input tree. If it is left - # empty, then the action is run in the input root. + # The working directory, relative to the input root, for the command to run in. + # It must be a directory which exists in the input tree. If it is left empty, + # then the action is run in the input root. # Corresponds to the JSON property `workingDirectory` # @return [String] attr_accessor :working_directory @@ -571,31 +486,29 @@ module Google end # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. class BuildBazelRemoteExecutionV2Digest include Google::Apis::Core::Hashable @@ -622,75 +535,31 @@ module Google end # A `Directory` represents a directory node in a file tree, containing zero or - # more children FileNodes, - # DirectoryNodes and - # SymlinkNodes. - # Each `Node` contains its name in the directory, either the digest of its - # content (either a file blob or a `Directory` proto) or a symlink target, as - # well as possibly some metadata about the file or directory. - # In order to ensure that two equivalent directory trees hash to the same - # value, the following restrictions MUST be obeyed when constructing a - # a `Directory`: - # * Every child in the directory must have a path of exactly one segment. - # Multiple levels of directory hierarchy may not be collapsed. - # * Each child in the directory must have a unique path segment (file name). - # Note that while the API itself is case-sensitive, the environment where - # the Action is executed may or may not be case-sensitive. That is, it is - # legal to call the API with a Directory that has both "Foo" and "foo" as - # children, but the Action may be rejected by the remote system upon - # execution. - # * The files, directories and symlinks in the directory must each be sorted - # in lexicographical order by path. The path strings must be sorted by code - # point, equivalently, by UTF-8 bytes. - # * The NodeProperties of files, - # directories, and symlinks must be sorted in lexicographical order by - # property name. - # A `Directory` that obeys the restrictions is said to be in canonical form. - # As an example, the following could be used for a file named `bar` and a + # more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains + # its name in the directory, either the digest of its content (either a file + # blob or a `Directory` proto) or a symlink target, as well as possibly some + # metadata about the file or directory. In order to ensure that two equivalent + # directory trees hash to the same value, the following restrictions MUST be + # obeyed when constructing a a `Directory`: * Every child in the directory must + # have a path of exactly one segment. Multiple levels of directory hierarchy may + # not be collapsed. * Each child in the directory must have a unique path + # segment (file name). Note that while the API itself is case-sensitive, the + # environment where the Action is executed may or may not be case-sensitive. + # That is, it is legal to call the API with a Directory that has both "Foo" and " + # foo" as children, but the Action may be rejected by the remote system upon + # execution. * The files, directories and symlinks in the directory must each be + # sorted in lexicographical order by path. The path strings must be sorted by + # code point, equivalently, by UTF-8 bytes. * The NodeProperties of files, + # directories, and symlinks must be sorted in lexicographical order by property + # name. A `Directory` that obeys the restrictions is said to be in canonical + # form. As an example, the following could be used for a file named `bar` and a # directory named `foo` with an executable file named `baz` (hashes shortened - # for readability): - # ```json - # // (Directory proto) - # ` - # files: [ - # ` - # name: "bar", - # digest: ` - # hash: "4a73bc9d03...", - # size: 65534 - # `, - # node_properties: [ - # ` - # "name": "MTime", - # "value": "2017-01-15T01:30:15.01Z" - # ` - # ] - # ` - # ], - # directories: [ - # ` - # name: "foo", - # digest: ` - # hash: "4cf2eda940...", - # size: 43 - # ` - # ` - # ] - # ` - # // (Directory proto with hash "4cf2eda940..." and size 43) - # ` - # files: [ - # ` - # name: "baz", - # digest: ` - # hash: "b2c941073e...", - # size: 1294, - # `, - # is_executable: true - # ` - # ] - # ` - # ``` + # for readability): ```json // (Directory proto) ` files: [ ` name: "bar", + # digest: ` hash: "4a73bc9d03...", size: 65534 `, node_properties: [ ` "name": " + # MTime", "value": "2017-01-15T01:30:15.01Z" ` ] ` ], directories: [ ` name: " + # foo", digest: ` hash: "4cf2eda940...", size: 43 ` ` ] ` // (Directory proto + # with hash "4cf2eda940..." and size 43) ` files: [ ` name: "baz", digest: ` + # hash: "b2c941073e...", size: 1294, `, is_executable: true ` ] ` ``` class BuildBazelRemoteExecutionV2Directory include Google::Apis::Core::Hashable @@ -727,38 +596,35 @@ module Google end end - # A `DirectoryNode` represents a child of a - # Directory which is itself - # a `Directory` and its associated metadata. + # A `DirectoryNode` represents a child of a Directory which is itself a ` + # Directory` and its associated metadata. class BuildBazelRemoteExecutionV2DirectoryNode include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest] attr_accessor :digest @@ -779,40 +645,35 @@ module Google end end - # Metadata about an ongoing - # execution, which - # will be contained in the metadata - # field of the - # Operation. + # Metadata about an ongoing execution, which will be contained in the metadata + # field of the Operation. class BuildBazelRemoteExecutionV2ExecuteOperationMetadata include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `actionDigest` # @return [Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest] attr_accessor :action_digest @@ -822,15 +683,13 @@ module Google # @return [String] attr_accessor :stage - # If set, the client can use this name with - # ByteStream.Read to stream the + # If set, the client can use this name with ByteStream.Read to stream the # standard error. # Corresponds to the JSON property `stderrStreamName` # @return [String] attr_accessor :stderr_stream_name - # If set, the client can use this name with - # ByteStream.Read to stream the + # If set, the client can use this name with ByteStream.Read to stream the # standard output. # Corresponds to the JSON property `stdoutStreamName` # @return [String] @@ -849,11 +708,8 @@ module Google end end - # The response message for - # Execution.Execute, - # which will be contained in the response - # field of the - # Operation. + # The response message for Execution.Execute, which will be contained in the + # response field of the Operation. class BuildBazelRemoteExecutionV2ExecuteResponse include Google::Apis::Core::Hashable @@ -869,29 +725,27 @@ module Google # @return [String] attr_accessor :message - # An ActionResult represents the result of an - # Action being run. + # An ActionResult represents the result of an Action being run. # Corresponds to the JSON property `result` # @return [Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2ActionResult] attr_accessor :result # An optional list of additional log outputs the server wishes to provide. A - # server can use this to return execution-specific logs however it wishes. - # This is intended primarily to make it easier for users to debug issues that - # may be outside of the actual job execution, such as by identifying the - # worker executing the action or by providing logs from the worker's setup - # phase. The keys SHOULD be human readable so that a client can display them - # to a user. + # server can use this to return execution-specific logs however it wishes. This + # is intended primarily to make it easier for users to debug issues that may be + # outside of the actual job execution, such as by identifying the worker + # executing the action or by providing logs from the worker's setup phase. The + # keys SHOULD be human readable so that a client can display them to a user. # Corresponds to the JSON property `serverLogs` # @return [Hash] attr_accessor :server_logs - # 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::RemotebuildexecutionV1::GoogleRpcStatus] attr_accessor :status @@ -988,31 +842,29 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest] attr_accessor :digest @@ -1051,40 +903,38 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest] attr_accessor :digest - # This is a hint as to the purpose of the log, and is set to true if the log - # is human-readable text that can be usefully displayed to a user, and false - # otherwise. For instance, if a command-line client wishes to print the - # server logs to the terminal for a failed action, this allows it to avoid - # displaying a binary file. + # This is a hint as to the purpose of the log, and is set to true if the log is + # human-readable text that can be usefully displayed to a user, and false + # otherwise. For instance, if a command-line client wishes to print the server + # logs to the terminal for a failed action, this allows it to avoid displaying a + # binary file. # Corresponds to the JSON property `humanReadable` # @return [Boolean] attr_accessor :human_readable @@ -1101,10 +951,8 @@ module Google end end - # A single property for FileNodes, - # DirectoryNodes, and - # SymlinkNodes. The server is - # responsible for specifying the property `name`s that it accepts. If + # A single property for FileNodes, DirectoryNodes, and SymlinkNodes. The server + # is responsible for specifying the property `name`s that it accepts. If # permitted by the server, the same `name` may occur multiple times. class BuildBazelRemoteExecutionV2NodeProperty include Google::Apis::Core::Hashable @@ -1136,39 +984,37 @@ module Google include Google::Apis::Core::Hashable # The full path of the directory relative to the working directory. The path - # separator is a forward slash `/`. Since this is a relative path, it MUST - # NOT begin with a leading forward slash. The empty string value is allowed, - # and it denotes the entire working directory. + # separator is a forward slash `/`. Since this is a relative path, it MUST NOT + # begin with a leading forward slash. The empty string value is allowed, and it + # denotes the entire working directory. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `treeDigest` # @return [Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest] attr_accessor :tree_digest @@ -1184,51 +1030,45 @@ module Google end end - # An `OutputFile` is similar to a - # FileNode, but it is used as an - # output in an `ActionResult`. It allows a full file path rather than - # only a name. + # An `OutputFile` is similar to a FileNode, but it is used as an output in an ` + # ActionResult`. It allows a full file path rather than only a name. class BuildBazelRemoteExecutionV2OutputFile include Google::Apis::Core::Hashable # The contents of the file if inlining was requested. The server SHOULD NOT - # inline - # file contents unless requested by the client in the - # GetActionResultRequest - # message. The server MAY omit inlining, even if requested, and MUST do so if - # inlining - # would cause the response to exceed message size limits. + # inline file contents unless requested by the client in the + # GetActionResultRequest message. The server MAY omit inlining, even if + # requested, and MUST do so if inlining would cause the response to exceed + # message size limits. # Corresponds to the JSON property `contents` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :contents # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest] attr_accessor :digest @@ -1245,8 +1085,8 @@ module Google attr_accessor :node_properties # The full path of the file relative to the working directory, including the - # filename. The path separator is a forward slash `/`. Since this is a - # relative path, it MUST NOT begin with a leading forward slash. + # filename. The path separator is a forward slash `/`. Since this is a relative + # path, it MUST NOT begin with a leading forward slash. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path @@ -1265,32 +1105,29 @@ module Google end end - # An `OutputSymlink` is similar to a - # Symlink, but it is used as an - # output in an `ActionResult`. - # `OutputSymlink` is binary-compatible with `SymlinkNode`. + # An `OutputSymlink` is similar to a Symlink, but it is used as an output in an ` + # ActionResult`. `OutputSymlink` is binary-compatible with `SymlinkNode`. class BuildBazelRemoteExecutionV2OutputSymlink include Google::Apis::Core::Hashable - # The supported node properties of the OutputSymlink, if requested by the - # Action. + # The supported node properties of the OutputSymlink, if requested by the Action. # Corresponds to the JSON property `nodeProperties` # @return [Array] attr_accessor :node_properties # The full path of the symlink relative to the working directory, including the - # filename. The path separator is a forward slash `/`. Since this is a - # relative path, it MUST NOT begin with a leading forward slash. + # filename. The path separator is a forward slash `/`. Since this is a relative + # path, it MUST NOT begin with a leading forward slash. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path - # The target path of the symlink. The path separator is a forward slash `/`. - # The target path can be relative to the parent directory of the symlink or - # it can be an absolute path starting with `/`. Support for absolute paths - # can be checked using the Capabilities - # API. The canonical form forbids the substrings `/./` and `//` in the target - # path. `..` components are allowed anywhere in the target path. + # The target path of the symlink. The path separator is a forward slash `/`. The + # target path can be relative to the parent directory of the symlink or it can + # be an absolute path starting with `/`. Support for absolute paths can be + # checked using the Capabilities API. The canonical form forbids the substrings ` + # /./` and `//` in the target path. `..` components are allowed anywhere in the + # target path. # Corresponds to the JSON property `target` # @return [String] attr_accessor :target @@ -1308,17 +1145,16 @@ module Google end # A `Platform` is a set of requirements, such as hardware, operating system, or - # compiler toolchain, for an - # Action's execution - # environment. A `Platform` is represented as a series of key-value pairs - # representing the properties that are required of the platform. + # compiler toolchain, for an Action's execution environment. A `Platform` is + # represented as a series of key-value pairs representing the properties that + # are required of the platform. class BuildBazelRemoteExecutionV2Platform include Google::Apis::Core::Hashable - # The properties that make up this platform. In order to ensure that - # equivalent `Platform`s always hash to the same value, the properties MUST - # be lexicographically sorted by name, and then by value. Sorting of strings - # is done by code point, equivalently, by the UTF-8 bytes. + # The properties that make up this platform. In order to ensure that equivalent ` + # Platform`s always hash to the same value, the properties MUST be + # lexicographically sorted by name, and then by value. Sorting of strings is + # done by code point, equivalently, by the UTF-8 bytes. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -1335,19 +1171,16 @@ module Google # A single property for the environment. The server is responsible for # specifying the property `name`s that it accepts. If an unknown `name` is - # provided in the requirements for an - # Action, the server SHOULD - # reject the execution request. If permitted by the server, the same `name` - # may occur multiple times. - # The server is also responsible for specifying the interpretation of - # property `value`s. For instance, a property describing how much RAM must be - # available may be interpreted as allowing a worker with 16GB to fulfill a - # request for 8GB, while a property describing the OS environment on which - # the action must be performed may require an exact match with the worker's - # OS. - # The server MAY use the `value` of one or more properties to determine how - # it sets up the execution environment, such as by making specific system - # files available to the worker. + # provided in the requirements for an Action, the server SHOULD reject the + # execution request. If permitted by the server, the same `name` may occur + # multiple times. The server is also responsible for specifying the + # interpretation of property `value`s. For instance, a property describing how + # much RAM must be available may be interpreted as allowing a worker with 16GB + # to fulfill a request for 8GB, while a property describing the OS environment + # on which the action must be performed may require an exact match with the + # worker's OS. The server MAY use the `value` of one or more properties to + # determine how it sets up the execution environment, such as by making specific + # system files available to the worker. class BuildBazelRemoteExecutionV2PlatformProperty include Google::Apis::Core::Hashable @@ -1375,27 +1208,25 @@ module Google # An optional Metadata to attach to any RPC request to tell the server about an # external context of the request. The server may use this for logging or other # purposes. To use it, the client attaches the header to the call using the - # canonical proto serialization: - # * name: `build.bazel.remote.execution.v2.requestmetadata-bin` - # * contents: the base64 encoded binary `RequestMetadata` message. - # Note: the gRPC library serializes binary headers encoded in base 64 by - # default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md# - # requests). - # Therefore, if the gRPC library is used to pass/retrieve this + # canonical proto serialization: * name: `build.bazel.remote.execution.v2. + # requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` + # message. Note: the gRPC library serializes binary headers encoded in base 64 + # by default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md# + # requests). Therefore, if the gRPC library is used to pass/retrieve this # metadata, the user may ignore the base64 encoding and assume it is simply # serialized as a binary message. class BuildBazelRemoteExecutionV2RequestMetadata include Google::Apis::Core::Hashable - # An identifier that ties multiple requests to the same action. - # For example, multiple requests to the CAS, Action Cache, and Execution - # API are used in order to compile foo.cc. + # An identifier that ties multiple requests to the same action. For example, + # multiple requests to the CAS, Action Cache, and Execution API are used in + # order to compile foo.cc. # Corresponds to the JSON property `actionId` # @return [String] attr_accessor :action_id - # An identifier to tie multiple tool invocations together. For example, - # runs of foo_test, bar_test and baz_test on a post-submit of a given patch. + # An identifier to tie multiple tool invocations together. For example, runs of + # foo_test, bar_test and baz_test on a post-submit of a given patch. # Corresponds to the JSON property `correlatedInvocationsId` # @return [String] attr_accessor :correlated_invocations_id @@ -1405,8 +1236,8 @@ module Google # @return [Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2ToolDetails] attr_accessor :tool_details - # An identifier that ties multiple actions together to a final result. - # For example, multiple actions are required to build and run foo_test. + # An identifier that ties multiple actions together to a final result. For + # example, multiple actions are required to build and run foo_test. # Corresponds to the JSON property `toolInvocationId` # @return [String] attr_accessor :tool_invocation_id @@ -1438,12 +1269,12 @@ module Google # @return [Array] attr_accessor :node_properties - # The target path of the symlink. The path separator is a forward slash `/`. - # The target path can be relative to the parent directory of the symlink or - # it can be an absolute path starting with `/`. Support for absolute paths - # can be checked using the Capabilities - # API. The canonical form forbids the substrings `/./` and `//` in the target - # path. `..` components are allowed anywhere in the target path. + # The target path of the symlink. The path separator is a forward slash `/`. The + # target path can be relative to the parent directory of the symlink or it can + # be an absolute path starting with `/`. Support for absolute paths can be + # checked using the Capabilities API. The canonical form forbids the substrings ` + # /./` and `//` in the target path. `..` components are allowed anywhere in the + # target path. # Corresponds to the JSON property `target` # @return [String] attr_accessor :target @@ -1485,90 +1316,45 @@ module Google end end - # A `Tree` contains all the - # Directory protos in a - # single directory Merkle tree, compressed into one message. + # A `Tree` contains all the Directory protos in a single directory Merkle tree, + # compressed into one message. class BuildBazelRemoteExecutionV2Tree include Google::Apis::Core::Hashable # All the child directories: the directories referred to by the root and, - # recursively, all its children. In order to reconstruct the directory tree, - # the client must take the digests of each of the child directories and then - # build up a tree starting from the `root`. + # recursively, all its children. In order to reconstruct the directory tree, the + # client must take the digests of each of the child directories and then build + # up a tree starting from the `root`. # Corresponds to the JSON property `children` # @return [Array] attr_accessor :children # A `Directory` represents a directory node in a file tree, containing zero or - # more children FileNodes, - # DirectoryNodes and - # SymlinkNodes. - # Each `Node` contains its name in the directory, either the digest of its - # content (either a file blob or a `Directory` proto) or a symlink target, as - # well as possibly some metadata about the file or directory. - # In order to ensure that two equivalent directory trees hash to the same - # value, the following restrictions MUST be obeyed when constructing a - # a `Directory`: - # * Every child in the directory must have a path of exactly one segment. - # Multiple levels of directory hierarchy may not be collapsed. - # * Each child in the directory must have a unique path segment (file name). - # Note that while the API itself is case-sensitive, the environment where - # the Action is executed may or may not be case-sensitive. That is, it is - # legal to call the API with a Directory that has both "Foo" and "foo" as - # children, but the Action may be rejected by the remote system upon - # execution. - # * The files, directories and symlinks in the directory must each be sorted - # in lexicographical order by path. The path strings must be sorted by code - # point, equivalently, by UTF-8 bytes. - # * The NodeProperties of files, - # directories, and symlinks must be sorted in lexicographical order by - # property name. - # A `Directory` that obeys the restrictions is said to be in canonical form. - # As an example, the following could be used for a file named `bar` and a + # more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains + # its name in the directory, either the digest of its content (either a file + # blob or a `Directory` proto) or a symlink target, as well as possibly some + # metadata about the file or directory. In order to ensure that two equivalent + # directory trees hash to the same value, the following restrictions MUST be + # obeyed when constructing a a `Directory`: * Every child in the directory must + # have a path of exactly one segment. Multiple levels of directory hierarchy may + # not be collapsed. * Each child in the directory must have a unique path + # segment (file name). Note that while the API itself is case-sensitive, the + # environment where the Action is executed may or may not be case-sensitive. + # That is, it is legal to call the API with a Directory that has both "Foo" and " + # foo" as children, but the Action may be rejected by the remote system upon + # execution. * The files, directories and symlinks in the directory must each be + # sorted in lexicographical order by path. The path strings must be sorted by + # code point, equivalently, by UTF-8 bytes. * The NodeProperties of files, + # directories, and symlinks must be sorted in lexicographical order by property + # name. A `Directory` that obeys the restrictions is said to be in canonical + # form. As an example, the following could be used for a file named `bar` and a # directory named `foo` with an executable file named `baz` (hashes shortened - # for readability): - # ```json - # // (Directory proto) - # ` - # files: [ - # ` - # name: "bar", - # digest: ` - # hash: "4a73bc9d03...", - # size: 65534 - # `, - # node_properties: [ - # ` - # "name": "MTime", - # "value": "2017-01-15T01:30:15.01Z" - # ` - # ] - # ` - # ], - # directories: [ - # ` - # name: "foo", - # digest: ` - # hash: "4cf2eda940...", - # size: 43 - # ` - # ` - # ] - # ` - # // (Directory proto with hash "4cf2eda940..." and size 43) - # ` - # files: [ - # ` - # name: "baz", - # digest: ` - # hash: "b2c941073e...", - # size: 1294, - # `, - # is_executable: true - # ` - # ] - # ` - # ``` + # for readability): ```json // (Directory proto) ` files: [ ` name: "bar", + # digest: ` hash: "4a73bc9d03...", size: 65534 `, node_properties: [ ` "name": " + # MTime", "value": "2017-01-15T01:30:15.01Z" ` ] ` ], directories: [ ` name: " + # foo", digest: ` hash: "4cf2eda940...", size: 43 ` ` ] ` // (Directory proto + # with hash "4cf2eda940..." and size 43) ` files: [ ` name: "baz", digest: ` + # hash: "b2c941073e...", size: 1294, `, is_executable: true ` ] ` ``` # Corresponds to the JSON property `root` # @return [Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Directory] attr_accessor :root @@ -1608,8 +1394,8 @@ module Google class GoogleDevtoolsRemotebuildbotCommandDurations include Google::Apis::Core::Hashable - # The time spent preparing the command to be run in a Docker container - # (includes pulling the Docker image, if necessary). + # The time spent preparing the command to be run in a Docker container (includes + # pulling the Docker image, if necessary). # Corresponds to the JSON property `dockerPrep` # @return [String] attr_accessor :docker_prep @@ -1685,13 +1471,13 @@ module Google end end - # CommandEvents contains counters for the number of warnings and errors - # that occurred during the execution of a command. + # CommandEvents contains counters for the number of warnings and errors that + # occurred during the execution of a command. class GoogleDevtoolsRemotebuildbotCommandEvents include Google::Apis::Core::Hashable - # Indicates whether we are using a cached Docker image (true) or had to pull - # the Docker image (false) for this command. + # Indicates whether we are using a cached Docker image (true) or had to pull the + # Docker image (false) for this command. # Corresponds to the JSON property `dockerCacheHit` # @return [Boolean] attr_accessor :docker_cache_hit @@ -1861,28 +1647,24 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest include Google::Apis::Core::Hashable - # Instance conceptually encapsulates all Remote Build Execution resources - # for remote builds. - # An instance consists of storage and compute resources (for example, - # `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for - # running remote builds. - # All Remote Build Execution API calls are scoped to an instance. + # Instance conceptually encapsulates all Remote Build Execution resources for + # remote builds. An instance consists of storage and compute resources (for + # example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for + # running remote builds. All Remote Build Execution API calls are scoped to an + # instance. # Corresponds to the JSON property `instance` # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance] attr_accessor :instance - # ID of the created instance. - # A valid `instance_id` must: - # be 6-50 characters long, - # contain only lowercase letters, digits, hyphens and underscores, - # start with a lowercase letter, and - # end with a lowercase letter or a digit. + # ID of the created instance. A valid `instance_id` must: be 6-50 characters + # long, contain only lowercase letters, digits, hyphens and underscores, start + # with a lowercase letter, and end with a lowercase letter or a digit. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id - # Resource name of the project containing the instance. - # Format: `projects/[PROJECT_ID]`. + # Resource name of the project containing the instance. Format: `projects/[ + # PROJECT_ID]`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -1903,18 +1685,15 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest include Google::Apis::Core::Hashable - # Resource name of the instance in which to create the new worker pool. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Resource name of the instance in which to create the new worker pool. Format: ` + # projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # ID of the created worker pool. - # A valid pool ID must: - # be 6-50 characters long, - # contain only lowercase letters, digits, hyphens and underscores, - # start with a lowercase letter, and - # end with a lowercase letter or a digit. + # ID of the created worker pool. A valid pool ID must: be 6-50 characters long, + # contain only lowercase letters, digits, hyphens and underscores, start with a + # lowercase letter, and end with a lowercase letter or a digit. # Corresponds to the JSON property `poolId` # @return [String] attr_accessor :pool_id @@ -1940,8 +1719,8 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest include Google::Apis::Core::Hashable - # Name of the instance to delete. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1960,9 +1739,8 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest include Google::Apis::Core::Hashable - # Name of the worker pool to delete. - # Format: - # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + # Name of the worker pool to delete. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]/workerpools/[POOL_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1977,12 +1755,107 @@ module Google end end + # FeaturePolicy defines features allowed to be used on RBE instances, as well as + # instance-wide behavior changes that take effect without opt-in or opt-out at + # usage time. + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy + include Google::Apis::Core::Hashable + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `containerImageSources` + # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :container_image_sources + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerAddCapabilities` + # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_add_capabilities + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerChrootPath` + # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_chroot_path + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerNetwork` + # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_network + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerPrivileged` + # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_privileged + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerRunAsRoot` + # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_run_as_root + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerRuntime` + # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_runtime + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerSiblingContainers` + # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_sibling_containers + + # linux_isolation allows overriding the docker runtime used for containers + # started on Linux. + # Corresponds to the JSON property `linuxIsolation` + # @return [String] + attr_accessor :linux_isolation + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @container_image_sources = args[:container_image_sources] if args.key?(:container_image_sources) + @docker_add_capabilities = args[:docker_add_capabilities] if args.key?(:docker_add_capabilities) + @docker_chroot_path = args[:docker_chroot_path] if args.key?(:docker_chroot_path) + @docker_network = args[:docker_network] if args.key?(:docker_network) + @docker_privileged = args[:docker_privileged] if args.key?(:docker_privileged) + @docker_run_as_root = args[:docker_run_as_root] if args.key?(:docker_run_as_root) + @docker_runtime = args[:docker_runtime] if args.key?(:docker_runtime) + @docker_sibling_containers = args[:docker_sibling_containers] if args.key?(:docker_sibling_containers) + @linux_isolation = args[:linux_isolation] if args.key?(:linux_isolation) + end + end + + # Defines whether a feature can be used or what values are accepted. + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature + include Google::Apis::Core::Hashable + + # A list of acceptable values. Only effective when the policy is `RESTRICTED`. + # Corresponds to the JSON property `allowedValues` + # @return [Array] + attr_accessor :allowed_values + + # The policy of the feature. + # Corresponds to the JSON property `policy` + # @return [String] + attr_accessor :policy + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allowed_values = args[:allowed_values] if args.key?(:allowed_values) + @policy = args[:policy] if args.key?(:policy) + end + end + # The request used for `GetInstance`. class GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest include Google::Apis::Core::Hashable - # Name of the instance to retrieve. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2001,9 +1874,8 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest include Google::Apis::Core::Hashable - # Name of the worker pool to retrieve. - # Format: - # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + # Name of the worker pool to retrieve. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]/workerpools/[POOL_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2018,15 +1890,21 @@ module Google end end - # Instance conceptually encapsulates all Remote Build Execution resources - # for remote builds. - # An instance consists of storage and compute resources (for example, - # `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for - # running remote builds. - # All Remote Build Execution API calls are scoped to an instance. + # Instance conceptually encapsulates all Remote Build Execution resources for + # remote builds. An instance consists of storage and compute resources (for + # example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for + # running remote builds. All Remote Build Execution API calls are scoped to an + # instance. class GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance include Google::Apis::Core::Hashable + # FeaturePolicy defines features allowed to be used on RBE instances, as well as + # instance-wide behavior changes that take effect without opt-in or opt-out at + # usage time. + # Corresponds to the JSON property `featurePolicy` + # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy] + attr_accessor :feature_policy + # The location is a GCP region. Currently only `us-central1` is supported. # Corresponds to the JSON property `location` # @return [String] @@ -2038,10 +1916,9 @@ module Google attr_accessor :logging_enabled alias_method :logging_enabled?, :logging_enabled - # Output only. Instance resource name formatted as: - # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. - # Name should not be populated when creating an instance since it is provided - # in the `instance_id` field. + # Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/ + # instances/[INSTANCE_ID]`. Name should not be populated when creating an + # instance since it is provided in the `instance_id` field. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2057,6 +1934,7 @@ module Google # Update properties of this object def update!(**args) + @feature_policy = args[:feature_policy] if args.key?(:feature_policy) @location = args[:location] if args.key?(:location) @logging_enabled = args[:logging_enabled] if args.key?(:logging_enabled) @name = args[:name] if args.key?(:name) @@ -2068,8 +1946,7 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesRequest include Google::Apis::Core::Hashable - # Resource name of the project. - # Format: `projects/[PROJECT_ID]`. + # Resource name of the project. Format: `projects/[PROJECT_ID]`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -2107,32 +1984,26 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest include Google::Apis::Core::Hashable - # Optional. A filter expression that filters resources listed in - # the response. The expression must specify the field name, a comparison - # operator, and the value that you want to use for filtering. The value - # must be a string, a number, or a boolean. String values are - # case-insensitive. - # The comparison operator must be either `:`, `=`, `!=`, `>`, `>=`, `<=` or - # `<`. - # The `:` operator can be used with string fields to match substrings. - # For non-string fields it is equivalent to the `=` operator. - # The `:*` comparison can be used to test whether a key has been defined. - # You can also filter on nested fields. - # To filter on multiple expressions, you can separate expression using - # `AND` and `OR` operators, using parentheses to specify precedence. If - # neither operator is specified, `AND` is assumed. - # Examples: - # Include only pools with more than 100 reserved workers: - # `(worker_count > 100) (worker_config.reserved = true)` - # Include only pools with a certain label or machines of the n1-standard - # family: + # Optional. A filter expression that filters resources listed in the response. + # The expression must specify the field name, a comparison operator, and the + # value that you want to use for filtering. The value must be a string, a number, + # or a boolean. String values are case-insensitive. The comparison operator + # must be either `:`, `=`, `!=`, `>`, `>=`, `<=` or `<`. The `:` operator can be + # used with string fields to match substrings. For non-string fields it is + # equivalent to the `=` operator. The `:*` comparison can be used to test + # whether a key has been defined. You can also filter on nested fields. To + # filter on multiple expressions, you can separate expression using `AND` and ` + # OR` operators, using parentheses to specify precedence. If neither operator is + # specified, `AND` is assumed. Examples: Include only pools with more than 100 + # reserved workers: `(worker_count > 100) (worker_config.reserved = true)` + # Include only pools with a certain label or machines of the n1-standard family: # `worker_config.labels.key1 : * OR worker_config.machine_type: n1-standard` # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter - # Resource name of the instance. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -2171,36 +2042,33 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest include Google::Apis::Core::Hashable - # Instance conceptually encapsulates all Remote Build Execution resources - # for remote builds. - # An instance consists of storage and compute resources (for example, - # `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for - # running remote builds. - # All Remote Build Execution API calls are scoped to an instance. + # Instance conceptually encapsulates all Remote Build Execution resources for + # remote builds. An instance consists of storage and compute resources (for + # example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for + # running remote builds. All Remote Build Execution API calls are scoped to an + # instance. # Corresponds to the JSON property `instance` # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance] attr_accessor :instance - # Deprecated, use instance.logging_enabled instead. - # Whether to enable Stackdriver logging for this instance. + # Deprecated, use instance.logging_enabled instead. Whether to enable + # Stackdriver logging for this instance. # Corresponds to the JSON property `loggingEnabled` # @return [Boolean] attr_accessor :logging_enabled alias_method :logging_enabled?, :logging_enabled - # Deprecated, use instance.Name instead. - # Name of the instance to update. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Deprecated, use instance.Name instead. Name of the instance to update. Format: + # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The update mask applies to instance. For the `FieldMask` definition, see - # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# - # fieldmask - # If an empty update_mask is provided, only the non-default valued field in - # the worker pool field will be updated. Note that in order to update a field - # to the default value (zero, false, empty string) an explicit update_mask + # The update mask applies to instance. For the `FieldMask` definition, see https: + # //developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask If an empty update_mask is provided, only the non-default valued + # field in the worker pool field will be updated. Note that in order to update a + # field to the default value (zero, false, empty string) an explicit update_mask # must be provided. # Corresponds to the JSON property `updateMask` # @return [String] @@ -2223,13 +2091,11 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest include Google::Apis::Core::Hashable - # The update mask applies to worker_pool. For the `FieldMask` definition, - # see + # The update mask applies to worker_pool. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# - # fieldmask - # If an empty update_mask is provided, only the non-default valued field in - # the worker pool field will be updated. Note that in order to update a field - # to the default value (zero, false, empty string) an explicit update_mask + # fieldmask If an empty update_mask is provided, only the non-default valued + # field in the worker pool field will be updated. Note that in order to update a + # field to the default value (zero, false, empty string) an explicit update_mask # must be provided. # Corresponds to the JSON property `updateMask` # @return [String] @@ -2251,8 +2117,7 @@ module Google end end - # Defines the configuration to be used for a creating workers in - # the worker pool. + # Defines the configuration to be used for a creating workers in the worker pool. class GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig include Google::Apis::Core::Hashable @@ -2261,34 +2126,31 @@ module Google # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig] attr_accessor :accelerator - # Required. Size of the disk attached to the worker, in GB. - # See https://cloud.google.com/compute/docs/disks/ + # Required. Size of the disk attached to the worker, in GB. See https://cloud. + # google.com/compute/docs/disks/ # Corresponds to the JSON property `diskSizeGb` # @return [Fixnum] attr_accessor :disk_size_gb - # Required. Disk Type to use for the worker. - # See [Storage - # options](https://cloud.google.com/compute/docs/disks/#introduction). - # Currently only `pd-standard` and `pd-ssd` are supported. + # Required. Disk Type to use for the worker. See [Storage options](https://cloud. + # google.com/compute/docs/disks/#introduction). Currently only `pd-standard` and + # `pd-ssd` are supported. # Corresponds to the JSON property `diskType` # @return [String] attr_accessor :disk_type - # Labels associated with the workers. - # Label keys and values can be no longer than 63 characters, can only contain - # lowercase letters, numeric characters, underscores and dashes. - # International letters are permitted. Label keys must start with a letter. - # Label values are optional. - # There can not be more than 64 labels per resource. + # Labels associated with the workers. Label keys and values can be no longer + # than 63 characters, can only contain lowercase letters, numeric characters, + # underscores and dashes. International letters are permitted. Label keys must + # start with a letter. Label values are optional. There can not be more than 64 + # labels per resource. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Required. Machine type of the worker, such as `n1-standard-2`. - # See https://cloud.google.com/compute/docs/machine-types for a list of - # supported machine types. Note that `f1-micro` and `g1-small` are not yet - # supported. + # Required. Machine type of the worker, such as `n1-standard-2`. See https:// + # cloud.google.com/compute/docs/machine-types for a list of supported machine + # types. Note that `f1-micro` and `g1-small` are not yet supported. # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type @@ -2298,25 +2160,24 @@ module Google # @return [Fixnum] attr_accessor :max_concurrent_actions - # Minimum CPU platform to use when creating the worker. - # See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms). + # Minimum CPU platform to use when creating the worker. See [CPU Platforms]( + # https://cloud.google.com/compute/docs/cpu-platforms). # Corresponds to the JSON property `minCpuPlatform` # @return [String] attr_accessor :min_cpu_platform - # Determines the type of network access granted to workers. Possible values: - # - "public": Workers can connect to the public internet. - # - "private": Workers can only connect to Google APIs and services. - # - "restricted-private": Workers can only connect to Google APIs that are - # reachable through `restricted.googleapis.com` (`199.36.153.4/30`). + # Determines the type of network access granted to workers. Possible values: - " + # public": Workers can connect to the public internet. - "private": Workers can + # only connect to Google APIs and services. - "restricted-private": Workers can + # only connect to Google APIs that are reachable through `restricted.googleapis. + # com` (`199.36.153.4/30`). # Corresponds to the JSON property `networkAccess` # @return [String] attr_accessor :network_access - # Determines whether the worker is reserved (equivalent to a Compute Engine - # on-demand VM and therefore won't be preempted). - # See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for more - # details. + # Determines whether the worker is reserved (equivalent to a Compute Engine on- + # demand VM and therefore won't be preempted). See [Preemptible VMs](https:// + # cloud.google.com/preemptible-vms/) for more details. # Corresponds to the JSON property `reserved` # @return [Boolean] attr_accessor :reserved @@ -2360,10 +2221,9 @@ module Google # @return [String] attr_accessor :channel - # WorkerPool resource name formatted as: - # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. - # name should not be populated when creating a worker pool since it is - # provided in the `poolId` field. + # WorkerPool resource name formatted as: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]/workerpools/[POOL_ID]`. name should not be populated when + # creating a worker pool since it is provided in the `poolId` field. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2373,14 +2233,13 @@ module Google # @return [String] attr_accessor :state - # Defines the configuration to be used for a creating workers in - # the worker pool. + # Defines the configuration to be used for a creating workers in the worker pool. # Corresponds to the JSON property `workerConfig` # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig] attr_accessor :worker_config - # The desired number of workers in the worker pool. Must be a value between - # 0 and 15000. + # The desired number of workers in the worker pool. Must be a value between 0 + # and 15000. # Corresponds to the JSON property `workerCount` # @return [Fixnum] attr_accessor :worker_count @@ -2402,14 +2261,13 @@ module Google # AdminTemp is a prelimiary set of administration tasks. It's called "Temp" # because we do not yet know the best way to represent admin tasks; it's - # possible that this will be entirely replaced in later versions of this API. - # If this message proves to be sufficient, it will be renamed in the alpha or - # beta release of this API. - # This message (suitably marshalled into a protobuf.Any) can be used as the - # inline_assignment field in a lease; the lease assignment field should simply - # be `"admin"` in these cases. - # This message is heavily based on Swarming administration tasks from the LUCI - # project (http://github.com/luci/luci-py/appengine/swarming). + # possible that this will be entirely replaced in later versions of this API. If + # this message proves to be sufficient, it will be renamed in the alpha or beta + # release of this API. This message (suitably marshalled into a protobuf.Any) + # can be used as the inline_assignment field in a lease; the lease assignment + # field should simply be `"admin"` in these cases. This message is heavily based + # on Swarming administration tasks from the LUCI project (http://github.com/luci/ + # luci-py/appengine/swarming). class GoogleDevtoolsRemoteworkersV1test2AdminTemp include Google::Apis::Core::Hashable @@ -2445,13 +2303,12 @@ module Google attr_accessor :contents # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemoteworkersV1test2Digest] attr_accessor :digest @@ -2467,27 +2324,26 @@ module Google end end - # DEPRECATED - use CommandResult instead. - # Describes the actual outputs from the task. + # DEPRECATED - use CommandResult instead. Describes the actual outputs from the + # task. class GoogleDevtoolsRemoteworkersV1test2CommandOutputs include Google::Apis::Core::Hashable # exit_code is only fully reliable if the status' code is OK. If the task - # exceeded its deadline or was cancelled, the process may still produce an - # exit code as it is cancelled, and this will be populated, but a successful - # (zero) is unlikely to be correct unless the status code is OK. + # exceeded its deadline or was cancelled, the process may still produce an exit + # code as it is cancelled, and this will be populated, but a successful (zero) + # is unlikely to be correct unless the status code is OK. # Corresponds to the JSON property `exitCode` # @return [Fixnum] attr_accessor :exit_code # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. # Corresponds to the JSON property `outputs` # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemoteworkersV1test2Digest] attr_accessor :outputs @@ -2503,9 +2359,8 @@ module Google end end - # DEPRECATED - use CommandResult instead. - # Can be used as part of CompleteRequest.metadata, or are part of a more - # sophisticated message. + # DEPRECATED - use CommandResult instead. Can be used as part of CompleteRequest. + # metadata, or are part of a more sophisticated message. class GoogleDevtoolsRemoteworkersV1test2CommandOverhead include Google::Apis::Core::Hashable @@ -2516,8 +2371,8 @@ module Google # @return [String] attr_accessor :duration - # The amount of time *not* spent executing the command (ie - # uploading/downloading files). + # The amount of time *not* spent executing the command (ie uploading/downloading + # files). # Corresponds to the JSON property `overhead` # @return [String] attr_accessor :overhead @@ -2545,46 +2400,44 @@ module Google # @return [String] attr_accessor :duration - # The exit code of the process. An exit code of "0" should only be trusted if - # `status` has a code of OK (otherwise it may simply be unset). + # The exit code of the process. An exit code of "0" should only be trusted if ` + # status` has a code of OK (otherwise it may simply be unset). # Corresponds to the JSON property `exitCode` # @return [Fixnum] attr_accessor :exit_code - # Implementation-dependent metadata about the task. Both servers and bots - # may define messages which can be encoded here; bots are free to provide - # metadata in multiple formats, and servers are free to choose one or more - # of the values to process and ignore others. In particular, it is *not* - # considered an error for the bot to provide the server with a field that it - # doesn't know about. + # Implementation-dependent metadata about the task. Both servers and bots may + # define messages which can be encoded here; bots are free to provide metadata + # in multiple formats, and servers are free to choose one or more of the values + # to process and ignore others. In particular, it is *not* considered an error + # for the bot to provide the server with a field that it doesn't know about. # Corresponds to the JSON property `metadata` # @return [Array>] attr_accessor :metadata # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. # Corresponds to the JSON property `outputs` # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemoteworkersV1test2Digest] attr_accessor :outputs - # The amount of time *not* spent executing the command (ie - # uploading/downloading files). + # The amount of time *not* spent executing the command (ie uploading/downloading + # files). # Corresponds to the JSON property `overhead` # @return [String] attr_accessor :overhead - # 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::RemotebuildexecutionV1::GoogleRpcStatus] attr_accessor :status @@ -2640,14 +2493,13 @@ module Google class GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs include Google::Apis::Core::Hashable - # The command itself to run (e.g., argv). - # This field should be passed directly to the underlying operating system, - # and so it must be sensible to that operating system. For example, on - # Windows, the first argument might be "C:\Windows\System32\ping.exe" - - # that is, using drive letters and backslashes. A command for a *nix - # system, on the other hand, would use forward slashes. - # All other fields in the RWAPI must consistently use forward slashes, - # since those fields may be interpretted by both the service and the bot. + # The command itself to run (e.g., argv). This field should be passed directly + # to the underlying operating system, and so it must be sensible to that + # operating system. For example, on Windows, the first argument might be "C:\ + # Windows\System32\ping.exe" - that is, using drive letters and backslashes. A + # command for a *nix system, on the other hand, would use forward slashes. All + # other fields in the RWAPI must consistently use forward slashes, since those + # fields may be interpretted by both the service and the bot. # Corresponds to the JSON property `arguments` # @return [Array] attr_accessor :arguments @@ -2657,31 +2509,29 @@ module Google # @return [Array] attr_accessor :environment_variables - # The input filesystem to be set up prior to the task beginning. The - # contents should be a repeated set of FileMetadata messages though other - # formats are allowed if better for the implementation (eg, a LUCI-style - # .isolated file). - # This field is repeated since implementations might want to cache the - # metadata, in which case it may be useful to break up portions of the - # filesystem that change frequently (eg, specific input files) from those - # that don't (eg, standard header files). + # The input filesystem to be set up prior to the task beginning. The contents + # should be a repeated set of FileMetadata messages though other formats are + # allowed if better for the implementation (eg, a LUCI-style .isolated file). + # This field is repeated since implementations might want to cache the metadata, + # in which case it may be useful to break up portions of the filesystem that + # change frequently (eg, specific input files) from those that don't (eg, + # standard header files). # Corresponds to the JSON property `files` # @return [Array] attr_accessor :files - # Inline contents for blobs expected to be needed by the bot to execute the - # task. For example, contents of entries in `files` or blobs that are - # indirectly referenced by an entry there. - # The bot should check against this list before downloading required task - # inputs to reduce the number of communications between itself and the - # remote CAS server. + # Inline contents for blobs expected to be needed by the bot to execute the task. + # For example, contents of entries in `files` or blobs that are indirectly + # referenced by an entry there. The bot should check against this list before + # downloading required task inputs to reduce the number of communications + # between itself and the remote CAS server. # Corresponds to the JSON property `inlineBlobs` # @return [Array] attr_accessor :inline_blobs - # Directory from which a command is executed. It is a relative directory - # with respect to the bot's working directory (i.e., "./"). If it is - # non-empty, then it must exist under "./". Otherwise, "./" will be used. + # Directory from which a command is executed. It is a relative directory with + # respect to the bot's working directory (i.e., "./"). If it is non-empty, then + # it must exist under "./". Otherwise, "./" will be used. # Corresponds to the JSON property `workingDirectory` # @return [String] attr_accessor :working_directory @@ -2729,32 +2579,32 @@ module Google class GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs include Google::Apis::Core::Hashable - # A list of expected directories, relative to the execution root. All paths - # MUST be delimited by forward slashes. + # A list of expected directories, relative to the execution root. All paths MUST + # be delimited by forward slashes. # Corresponds to the JSON property `directories` # @return [Array] attr_accessor :directories - # A list of expected files, relative to the execution root. All paths - # MUST be delimited by forward slashes. + # A list of expected files, relative to the execution root. All paths MUST be + # delimited by forward slashes. # Corresponds to the JSON property `files` # @return [Array] attr_accessor :files - # The destination to which any stderr should be sent. The method by which - # the bot should send the stream contents to that destination is not - # defined in this API. As examples, the destination could be a file - # referenced in the `files` field in this message, or it could be a URI - # that must be written via the ByteStream API. + # The destination to which any stderr should be sent. The method by which the + # bot should send the stream contents to that destination is not defined in this + # API. As examples, the destination could be a file referenced in the `files` + # field in this message, or it could be a URI that must be written via the + # ByteStream API. # Corresponds to the JSON property `stderrDestination` # @return [String] attr_accessor :stderr_destination - # The destination to which any stdout should be sent. The method by which - # the bot should send the stream contents to that destination is not - # defined in this API. As examples, the destination could be a file - # referenced in the `files` field in this message, or it could be a URI - # that must be written via the ByteStream API. + # The destination to which any stdout should be sent. The method by which the + # bot should send the stream contents to that destination is not defined in this + # API. As examples, the destination could be a file referenced in the `files` + # field in this message, or it could be a URI that must be written via the + # ByteStream API. # Corresponds to the JSON property `stdoutDestination` # @return [String] attr_accessor :stdout_destination @@ -2776,27 +2626,26 @@ module Google class GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts include Google::Apis::Core::Hashable - # This specifies the maximum time that the task can run, excluding the - # time required to download inputs or upload outputs. That is, the worker - # will terminate the task if it runs longer than this. + # This specifies the maximum time that the task can run, excluding the time + # required to download inputs or upload outputs. That is, the worker will + # terminate the task if it runs longer than this. # Corresponds to the JSON property `execution` # @return [String] attr_accessor :execution - # This specifies the maximum amount of time the task can be idle - that is, - # go without generating some output in either stdout or stderr. If the - # process is silent for more than the specified time, the worker will - # terminate the task. + # This specifies the maximum amount of time the task can be idle - that is, go + # without generating some output in either stdout or stderr. If the process is + # silent for more than the specified time, the worker will terminate the task. # Corresponds to the JSON property `idle` # @return [String] attr_accessor :idle # If the execution or IO timeouts are exceeded, the worker will try to - # gracefully terminate the task and return any existing logs. However, - # tasks may be hard-frozen in which case this process will fail. This - # timeout specifies how long to wait for a terminated task to shut down - # gracefully (e.g. via SIGTERM) before we bring down the hammer (e.g. - # SIGKILL on *nix, CTRL_BREAK_EVENT on Windows). + # gracefully terminate the task and return any existing logs. However, tasks may + # be hard-frozen in which case this process will fail. This timeout specifies + # how long to wait for a terminated task to shut down gracefully (e.g. via + # SIGTERM) before we bring down the hammer (e.g. SIGKILL on *nix, + # CTRL_BREAK_EVENT on Windows). # Corresponds to the JSON property `shutdown` # @return [String] attr_accessor :shutdown @@ -2814,13 +2663,12 @@ module Google end # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. class GoogleDevtoolsRemoteworkersV1test2Digest include Google::Apis::Core::Hashable @@ -2831,9 +2679,9 @@ module Google attr_accessor :hash_prop # The size of the contents. While this is not strictly required as part of an - # identifier (after all, any given hash will have exactly one canonical - # size), it's useful in almost all cases when one might want to send or - # retrieve blobs of content and is included here for this reason. + # identifier (after all, any given hash will have exactly one canonical size), + # it's useful in almost all cases when one might want to send or retrieve blobs + # of content and is included here for this reason. # Corresponds to the JSON property `sizeBytes` # @return [Fixnum] attr_accessor :size_bytes @@ -2881,13 +2729,12 @@ module Google include Google::Apis::Core::Hashable # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemoteworkersV1test2Digest] attr_accessor :digest @@ -2913,21 +2760,20 @@ module Google class GoogleDevtoolsRemoteworkersV1test2FileMetadata include Google::Apis::Core::Hashable - # If the file is small enough, its contents may also or alternatively be - # listed here. + # If the file is small enough, its contents may also or alternatively be listed + # here. # Corresponds to the JSON property `contents` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :contents # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemoteworkersV1test2Digest] attr_accessor :digest @@ -2938,11 +2784,11 @@ module Google attr_accessor :is_executable alias_method :is_executable?, :is_executable - # The path of this file. If this message is part of the - # CommandOutputs.outputs fields, the path is relative to the execution root - # and must correspond to an entry in CommandTask.outputs.files. If this - # message is part of a Directory message, then the path is relative to the - # root of that directory. All paths MUST be delimited by forward slashes. + # The path of this file. If this message is part of the CommandOutputs.outputs + # fields, the path is relative to the execution root and must correspond to an + # entry in CommandTask.outputs.files. If this message is part of a Directory + # message, then the path is relative to the root of that directory. All paths + # MUST be delimited by forward slashes. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path @@ -3003,47 +2849,45 @@ module Google class GoogleLongrunningOperation 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::RemotebuildexecutionV1::GoogleRpcStatus] 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] 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] attr_accessor :response @@ -3062,13 +2906,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 GoogleProtobufEmpty include Google::Apis::Core::Hashable @@ -3081,12 +2923,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 GoogleRpcStatus include Google::Apis::Core::Hashable @@ -3095,15 +2937,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>] 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 diff --git a/generated/google/apis/remotebuildexecution_v1/representations.rb b/generated/google/apis/remotebuildexecution_v1/representations.rb index 6dfb21eec..d86dc2c80 100644 --- a/generated/google/apis/remotebuildexecution_v1/representations.rb +++ b/generated/google/apis/remotebuildexecution_v1/representations.rb @@ -226,6 +226,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -766,6 +778,37 @@ module Google end end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :container_image_sources, as: 'containerImageSources', class: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_add_capabilities, as: 'dockerAddCapabilities', class: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_chroot_path, as: 'dockerChrootPath', class: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_network, as: 'dockerNetwork', class: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_privileged, as: 'dockerPrivileged', class: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_run_as_root, as: 'dockerRunAsRoot', class: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_runtime, as: 'dockerRuntime', class: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_sibling_containers, as: 'dockerSiblingContainers', class: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :linux_isolation, as: 'linuxIsolation' + end + end + + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :allowed_values, as: 'allowedValues' + property :policy, as: 'policy' + end + end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -783,6 +826,8 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance # @private class Representation < Google::Apis::Core::JsonRepresentation + property :feature_policy, as: 'featurePolicy', class: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy, decorator: Google::Apis::RemotebuildexecutionV1::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy::Representation + property :location, as: 'location' property :logging_enabled, as: 'loggingEnabled' property :name, as: 'name' diff --git a/generated/google/apis/remotebuildexecution_v1/service.rb b/generated/google/apis/remotebuildexecution_v1/service.rb index 98c6a7281..a7b382a60 100644 --- a/generated/google/apis/remotebuildexecution_v1/service.rb +++ b/generated/google/apis/remotebuildexecution_v1/service.rb @@ -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 @@ -86,11 +85,9 @@ module Google execute_or_queue_command(command, &block) end - # Uploads media. Upload is supported on - # the URI `/upload/v1/media/`+name``. + # Uploads media. Upload is supported on the URI `/upload/v1/media/`+name``. # @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 [Google::Apis::RemotebuildexecutionV1::GoogleBytestreamMedia] google_bytestream_media_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -131,15 +128,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. @@ -173,10 +168,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 @@ -206,15 +201,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 @@ -253,9 +247,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 diff --git a/generated/google/apis/remotebuildexecution_v1alpha.rb b/generated/google/apis/remotebuildexecution_v1alpha.rb index 97224e2a6..9bde4251e 100644 --- a/generated/google/apis/remotebuildexecution_v1alpha.rb +++ b/generated/google/apis/remotebuildexecution_v1alpha.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/remote-build-execution/docs/ module RemotebuildexecutionV1alpha VERSION = 'V1alpha' - REVISION = '20200721' + REVISION = '20200810' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/remotebuildexecution_v1alpha/classes.rb b/generated/google/apis/remotebuildexecution_v1alpha/classes.rb index 5652991d2..326f58826 100644 --- a/generated/google/apis/remotebuildexecution_v1alpha/classes.rb +++ b/generated/google/apis/remotebuildexecution_v1alpha/classes.rb @@ -23,120 +23,107 @@ module Google module RemotebuildexecutionV1alpha # An `Action` captures all the information about an execution which is required - # to reproduce it. - # `Action`s are the core component of the [Execution] service. A single - # `Action` represents a repeatable action that can be performed by the + # to reproduce it. `Action`s are the core component of the [Execution] service. + # A single `Action` represents a repeatable action that can be performed by the # execution service. `Action`s can be succinctly identified by the digest of # their wire format encoding and, once an `Action` has been executed, will be # cached in the action cache. Future requests can then use the cached result - # rather than needing to run afresh. - # When a server completes execution of an - # Action, it MAY choose to - # cache the result in - # the ActionCache unless - # `do_not_cache` is `true`. Clients SHOULD expect the server to do so. By - # default, future calls to - # Execute the same - # `Action` will also serve their results from the cache. Clients must take care - # to understand the caching behaviour. Ideally, all `Action`s will be - # reproducible so that serving a result from cache is always desirable and - # correct. + # rather than needing to run afresh. When a server completes execution of an + # Action, it MAY choose to cache the result in the ActionCache unless ` + # do_not_cache` is `true`. Clients SHOULD expect the server to do so. By default, + # future calls to Execute the same `Action` will also serve their results from + # the cache. Clients must take care to understand the caching behaviour. Ideally, + # all `Action`s will be reproducible so that serving a result from cache is + # always desirable and correct. class BuildBazelRemoteExecutionV2Action include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `commandDigest` # @return [Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest] attr_accessor :command_digest - # If true, then the `Action`'s result cannot be cached, and in-flight - # requests for the same `Action` may not be merged. + # If true, then the `Action`'s result cannot be cached, and in-flight requests + # for the same `Action` may not be merged. # Corresponds to the JSON property `doNotCache` # @return [Boolean] attr_accessor :do_not_cache alias_method :do_not_cache?, :do_not_cache # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `inputRootDigest` # @return [Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest] attr_accessor :input_root_digest - # List of required supported NodeProperty - # keys. In order to ensure that equivalent `Action`s always hash to the same - # value, the supported node properties MUST be lexicographically sorted by name. - # Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. - # The interpretation of these properties is server-dependent. If a property is - # not recognized by the server, the server will return an `INVALID_ARGUMENT` - # error. + # List of required supported NodeProperty keys. In order to ensure that + # equivalent `Action`s always hash to the same value, the supported node + # properties MUST be lexicographically sorted by name. Sorting of strings is + # done by code point, equivalently, by the UTF-8 bytes. The interpretation of + # these properties is server-dependent. If a property is not recognized by the + # server, the server will return an `INVALID_ARGUMENT` error. # Corresponds to the JSON property `outputNodeProperties` # @return [Array] attr_accessor :output_node_properties - # A timeout after which the execution should be killed. If the timeout is - # absent, then the client is specifying that the execution should continue - # as long as the server will let it. The server SHOULD impose a timeout if - # the client does not specify one, however, if the client does specify a - # timeout that is longer than the server's maximum timeout, the server MUST - # reject the request. - # The timeout is a part of the - # Action message, and - # therefore two `Actions` with different timeouts are different, even if they - # are otherwise identical. This is because, if they were not, running an - # `Action` with a lower timeout than is required might result in a cache hit - # from an execution run with a longer timeout, hiding the fact that the - # timeout is too short. By encoding it directly in the `Action`, a lower - # timeout will result in a cache miss and the execution timeout will fail - # immediately, rather than whenever the cache entry gets evicted. + # A timeout after which the execution should be killed. If the timeout is absent, + # then the client is specifying that the execution should continue as long as + # the server will let it. The server SHOULD impose a timeout if the client does + # not specify one, however, if the client does specify a timeout that is longer + # than the server's maximum timeout, the server MUST reject the request. The + # timeout is a part of the Action message, and therefore two `Actions` with + # different timeouts are different, even if they are otherwise identical. This + # is because, if they were not, running an `Action` with a lower timeout than is + # required might result in a cache hit from an execution run with a longer + # timeout, hiding the fact that the timeout is too short. By encoding it + # directly in the `Action`, a lower timeout will result in a cache miss and the + # execution timeout will fail immediately, rather than whenever the cache entry + # gets evicted. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout @@ -155,8 +142,7 @@ module Google end end - # An ActionResult represents the result of an - # Action being run. + # An ActionResult represents the result of an Action being run. class BuildBazelRemoteExecutionV2ActionResult include Google::Apis::Core::Hashable @@ -170,84 +156,41 @@ module Google # @return [Fixnum] attr_accessor :exit_code - # The output directories of the action. For each output directory requested - # in the `output_directories` or `output_paths` field of the Action, if the + # The output directories of the action. For each output directory requested in + # the `output_directories` or `output_paths` field of the Action, if the # corresponding directory existed after the action completed, a single entry - # will be present in the output list, which will contain the digest of a - # Tree message containing the - # directory tree, and the path equal exactly to the corresponding Action - # output_directories member. - # As an example, suppose the Action had an output directory `a/b/dir` and the - # execution produced the following contents in `a/b/dir`: a file named `bar` - # and a directory named `foo` with an executable file named `baz`. Then, - # output_directory will contain (hashes shortened for readability): - # ```json - # // OutputDirectory proto: - # ` - # path: "a/b/dir" - # tree_digest: ` - # hash: "4a73bc9d03...", - # size: 55 - # ` - # ` - # // Tree proto with hash "4a73bc9d03..." and size 55: - # ` - # root: ` - # files: [ - # ` - # name: "bar", - # digest: ` - # hash: "4a73bc9d03...", - # size: 65534 - # ` - # ` - # ], - # directories: [ - # ` - # name: "foo", - # digest: ` - # hash: "4cf2eda940...", - # size: 43 - # ` - # ` - # ] - # ` - # children : ` - # // (Directory proto with hash "4cf2eda940..." and size 43) - # files: [ - # ` - # name: "baz", - # digest: ` - # hash: "b2c941073e...", - # size: 1294, - # `, - # is_executable: true - # ` - # ] - # ` - # ` - # ``` - # If an output of the same name as listed in `output_files` of - # the Command was found in `output_directories`, but was not a directory, the - # server will return a FAILED_PRECONDITION. + # will be present in the output list, which will contain the digest of a Tree + # message containing the directory tree, and the path equal exactly to the + # corresponding Action output_directories member. As an example, suppose the + # Action had an output directory `a/b/dir` and the execution produced the + # following contents in `a/b/dir`: a file named `bar` and a directory named `foo` + # with an executable file named `baz`. Then, output_directory will contain ( + # hashes shortened for readability): ```json // OutputDirectory proto: ` path: " + # a/b/dir" tree_digest: ` hash: "4a73bc9d03...", size: 55 ` ` // Tree proto with + # hash "4a73bc9d03..." and size 55: ` root: ` files: [ ` name: "bar", digest: ` + # hash: "4a73bc9d03...", size: 65534 ` ` ], directories: [ ` name: "foo", digest: + # ` hash: "4cf2eda940...", size: 43 ` ` ] ` children : ` // (Directory proto + # with hash "4cf2eda940..." and size 43) files: [ ` name: "baz", digest: ` hash: + # "b2c941073e...", size: 1294, `, is_executable: true ` ] ` ` ``` If an output + # of the same name as listed in `output_files` of the Command was found in ` + # output_directories`, but was not a directory, the server will return a + # FAILED_PRECONDITION. # Corresponds to the JSON property `outputDirectories` # @return [Array] attr_accessor :output_directories # The output directories of the action that are symbolic links to other # directories. Those may be links to other output directories, or input - # directories, or even absolute paths outside of the working directory, - # if the server supports - # SymlinkAbsolutePathStrategy.ALLOWED. - # For each output directory requested in the `output_directories` field of - # the Action, if the directory existed after the action completed, a - # single entry will be present either in this field, or in the - # `output_directories` field, if the directory was not a symbolic link. - # If an output of the same name was found, but was a symbolic link to a file - # instead of a directory, the server will return a FAILED_PRECONDITION. - # If the action does not produce the requested output, then that output - # will be omitted from the list. The server is free to arrange the output - # list as desired; clients MUST NOT assume that the output list is sorted. + # directories, or even absolute paths outside of the working directory, if the + # server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output directory + # requested in the `output_directories` field of the Action, if the directory + # existed after the action completed, a single entry will be present either in + # this field, or in the `output_directories` field, if the directory was not a + # symbolic link. If an output of the same name was found, but was a symbolic + # link to a file instead of a directory, the server will return a + # FAILED_PRECONDITION. If the action does not produce the requested output, then + # that output will be omitted from the list. The server is free to arrange the + # output list as desired; clients MUST NOT assume that the output list is sorted. # DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API # should still populate this field in addition to `output_symlinks`. # Corresponds to the JSON property `outputDirectorySymlinks` @@ -257,131 +200,119 @@ module Google # The output files of the action that are symbolic links to other files. Those # may be links to other output files, or input files, or even absolute paths # outside of the working directory, if the server supports - # SymlinkAbsolutePathStrategy.ALLOWED. - # For each output file requested in the `output_files` or `output_paths` - # field of the Action, if the corresponding file existed after - # the action completed, a single entry will be present either in this field, - # or in the `output_files` field, if the file was not a symbolic link. - # If an output symbolic link of the same name as listed in `output_files` of - # the Command was found, but its target type was not a regular file, the - # server will return a FAILED_PRECONDITION. - # If the action does not produce the requested output, then that output - # will be omitted from the list. The server is free to arrange the output - # list as desired; clients MUST NOT assume that the output list is sorted. - # DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API - # should still populate this field in addition to `output_symlinks`. + # SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in the ` + # output_files` or `output_paths` field of the Action, if the corresponding file + # existed after the action completed, a single entry will be present either in + # this field, or in the `output_files` field, if the file was not a symbolic + # link. If an output symbolic link of the same name as listed in `output_files` + # of the Command was found, but its target type was not a regular file, the + # server will return a FAILED_PRECONDITION. If the action does not produce the + # requested output, then that output will be omitted from the list. The server + # is free to arrange the output list as desired; clients MUST NOT assume that + # the output list is sorted. DEPRECATED as of v2.1. Servers that wish to be + # compatible with v2.0 API should still populate this field in addition to ` + # output_symlinks`. # Corresponds to the JSON property `outputFileSymlinks` # @return [Array] attr_accessor :output_file_symlinks - # The output files of the action. For each output file requested in the - # `output_files` or `output_paths` field of the Action, if the corresponding - # file existed after the action completed, a single entry will be present - # either in this field, or the `output_file_symlinks` field if the file was - # a symbolic link to another file (`output_symlinks` field after v2.1). - # If an output listed in `output_files` was found, but was a directory rather - # than a regular file, the server will return a FAILED_PRECONDITION. - # If the action does not produce the requested output, then that output - # will be omitted from the list. The server is free to arrange the output - # list as desired; clients MUST NOT assume that the output list is sorted. + # The output files of the action. For each output file requested in the ` + # output_files` or `output_paths` field of the Action, if the corresponding file + # existed after the action completed, a single entry will be present either in + # this field, or the `output_file_symlinks` field if the file was a symbolic + # link to another file (`output_symlinks` field after v2.1). If an output listed + # in `output_files` was found, but was a directory rather than a regular file, + # the server will return a FAILED_PRECONDITION. If the action does not produce + # the requested output, then that output will be omitted from the list. The + # server is free to arrange the output list as desired; clients MUST NOT assume + # that the output list is sorted. # Corresponds to the JSON property `outputFiles` # @return [Array] attr_accessor :output_files - # New in v2.1: this field will only be populated if the command - # `output_paths` field was used, and not the pre v2.1 `output_files` or - # `output_directories` fields. - # The output paths of the action that are symbolic links to other paths. Those - # may be links to other outputs, or inputs, or even absolute paths - # outside of the working directory, if the server supports - # SymlinkAbsolutePathStrategy.ALLOWED. - # A single entry for each output requested in `output_paths` - # field of the Action, if the corresponding path existed after - # the action completed and was a symbolic link. - # If the action does not produce a requested output, then that output - # will be omitted from the list. The server is free to arrange the output - # list as desired; clients MUST NOT assume that the output list is sorted. + # New in v2.1: this field will only be populated if the command `output_paths` + # field was used, and not the pre v2.1 `output_files` or `output_directories` + # fields. The output paths of the action that are symbolic links to other paths. + # Those may be links to other outputs, or inputs, or even absolute paths outside + # of the working directory, if the server supports SymlinkAbsolutePathStrategy. + # ALLOWED. A single entry for each output requested in `output_paths` field of + # the Action, if the corresponding path existed after the action completed and + # was a symbolic link. If the action does not produce a requested output, then + # that output will be omitted from the list. The server is free to arrange the + # output list as desired; clients MUST NOT assume that the output list is sorted. # Corresponds to the JSON property `outputSymlinks` # @return [Array] attr_accessor :output_symlinks # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `stderrDigest` # @return [Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest] attr_accessor :stderr_digest - # The standard error buffer of the action. The server SHOULD NOT inline - # stderr unless requested by the client in the - # GetActionResultRequest - # message. The server MAY omit inlining, even if requested, and MUST do so if - # inlining - # would cause the response to exceed message size limits. + # The standard error buffer of the action. The server SHOULD NOT inline stderr + # unless requested by the client in the GetActionResultRequest message. The + # server MAY omit inlining, even if requested, and MUST do so if inlining would + # cause the response to exceed message size limits. # Corresponds to the JSON property `stderrRaw` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :stderr_raw # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `stdoutDigest` # @return [Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest] attr_accessor :stdout_digest - # The standard output buffer of the action. The server SHOULD NOT inline - # stdout unless requested by the client in the - # GetActionResultRequest - # message. The server MAY omit inlining, even if requested, and MUST do so if - # inlining - # would cause the response to exceed message size limits. + # The standard output buffer of the action. The server SHOULD NOT inline stdout + # unless requested by the client in the GetActionResultRequest message. The + # server MAY omit inlining, even if requested, and MUST do so if inlining would + # cause the response to exceed message size limits. # Corresponds to the JSON property `stdoutRaw` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -407,12 +338,11 @@ module Google end end - # A `Command` is the actual command executed by a worker running an - # Action and specifications of its - # environment. - # Except as otherwise required, the environment (such as which system - # libraries or binaries are available, and what filesystems are mounted where) - # is defined by and specific to the implementation of the remote execution API. + # A `Command` is the actual command executed by a worker running an Action and + # specifications of its environment. Except as otherwise required, the + # environment (such as which system libraries or binaries are available, and + # what filesystems are mounted where) is defined by and specific to the + # implementation of the remote execution API. class BuildBazelRemoteExecutionV2Command include Google::Apis::Core::Hashable @@ -425,105 +355,90 @@ module Google # The environment variables to set when running the program. The worker may # provide its own default environment variables; these defaults can be - # overridden using this field. Additional variables can also be specified. - # In order to ensure that equivalent - # Commands always hash to the same - # value, the environment variables MUST be lexicographically sorted by name. - # Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. + # overridden using this field. Additional variables can also be specified. In + # order to ensure that equivalent Commands always hash to the same value, the + # environment variables MUST be lexicographically sorted by name. Sorting of + # strings is done by code point, equivalently, by the UTF-8 bytes. # Corresponds to the JSON property `environmentVariables` # @return [Array] attr_accessor :environment_variables - # A list of the output directories that the client expects to retrieve from - # the action. Only the listed directories will be returned (an entire - # directory structure will be returned as a - # Tree message digest, see - # OutputDirectory), as - # well as files listed in `output_files`. Other files or directories that - # may be created during command execution are discarded. - # The paths are relative to the working directory of the action execution. - # The paths are specified using a single forward slash (`/`) as a path - # separator, even if the execution platform natively uses a different - # separator. The path MUST NOT include a trailing slash, nor a leading slash, - # being a relative path. The special value of empty string is allowed, - # although not recommended, and can be used to capture the entire working - # directory tree, including inputs. - # In order to ensure consistent hashing of the same Action, the output paths - # MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 - # bytes). - # An output directory cannot be duplicated or have the same path as any of - # the listed output files. An output directory is allowed to be a parent of - # another output directory. + # A list of the output directories that the client expects to retrieve from the + # action. Only the listed directories will be returned (an entire directory + # structure will be returned as a Tree message digest, see OutputDirectory), as + # well as files listed in `output_files`. Other files or directories that may be + # created during command execution are discarded. The paths are relative to the + # working directory of the action execution. The paths are specified using a + # single forward slash (`/`) as a path separator, even if the execution platform + # natively uses a different separator. The path MUST NOT include a trailing + # slash, nor a leading slash, being a relative path. The special value of empty + # string is allowed, although not recommended, and can be used to capture the + # entire working directory tree, including inputs. In order to ensure consistent + # hashing of the same Action, the output paths MUST be sorted lexicographically + # by code point (or, equivalently, by UTF-8 bytes). An output directory cannot + # be duplicated or have the same path as any of the listed output files. An + # output directory is allowed to be a parent of another output directory. # Directories leading up to the output directories (but not the output - # directories themselves) are created by the worker prior to execution, even - # if they are not explicitly part of the input root. - # DEPRECATED since 2.1: Use `output_paths` instead. + # directories themselves) are created by the worker prior to execution, even if + # they are not explicitly part of the input root. DEPRECATED since 2.1: Use ` + # output_paths` instead. # Corresponds to the JSON property `outputDirectories` # @return [Array] attr_accessor :output_directories - # A list of the output files that the client expects to retrieve from the - # action. Only the listed files, as well as directories listed in - # `output_directories`, will be returned to the client as output. - # Other files or directories that may be created during command execution - # are discarded. - # The paths are relative to the working directory of the action execution. - # The paths are specified using a single forward slash (`/`) as a path - # separator, even if the execution platform natively uses a different - # separator. The path MUST NOT include a trailing slash, nor a leading slash, - # being a relative path. - # In order to ensure consistent hashing of the same Action, the output paths - # MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 - # bytes). - # An output file cannot be duplicated, be a parent of another output file, or - # have the same path as any of the listed output directories. - # Directories leading up to the output files are created by the worker prior - # to execution, even if they are not explicitly part of the input root. - # DEPRECATED since v2.1: Use `output_paths` instead. + # A list of the output files that the client expects to retrieve from the action. + # Only the listed files, as well as directories listed in `output_directories`, + # will be returned to the client as output. Other files or directories that may + # be created during command execution are discarded. The paths are relative to + # the working directory of the action execution. The paths are specified using a + # single forward slash (`/`) as a path separator, even if the execution platform + # natively uses a different separator. The path MUST NOT include a trailing + # slash, nor a leading slash, being a relative path. In order to ensure + # consistent hashing of the same Action, the output paths MUST be sorted + # lexicographically by code point (or, equivalently, by UTF-8 bytes). An output + # file cannot be duplicated, be a parent of another output file, or have the + # same path as any of the listed output directories. Directories leading up to + # the output files are created by the worker prior to execution, even if they + # are not explicitly part of the input root. DEPRECATED since v2.1: Use ` + # output_paths` instead. # Corresponds to the JSON property `outputFiles` # @return [Array] attr_accessor :output_files - # A list of the output paths that the client expects to retrieve from the - # action. Only the listed paths will be returned to the client as output. - # The type of the output (file or directory) is not specified, and will be - # determined by the server after action execution. If the resulting path is - # a file, it will be returned in an - # OutputFile) typed field. - # If the path is a directory, the entire directory structure will be returned - # as a Tree message digest, see - # OutputDirectory) - # Other files or directories that may be created during command execution - # are discarded. - # The paths are relative to the working directory of the action execution. - # The paths are specified using a single forward slash (`/`) as a path - # separator, even if the execution platform natively uses a different - # separator. The path MUST NOT include a trailing slash, nor a leading slash, - # being a relative path. - # In order to ensure consistent hashing of the same Action, the output paths - # MUST be deduplicated and sorted lexicographically by code point (or, - # equivalently, by UTF-8 bytes). - # Directories leading up to the output paths are created by the worker prior - # to execution, even if they are not explicitly part of the input root. - # New in v2.1: this field supersedes the DEPRECATED `output_files` and - # `output_directories` fields. If `output_paths` is used, `output_files` and - # `output_directories` will be ignored! + # A list of the output paths that the client expects to retrieve from the action. + # Only the listed paths will be returned to the client as output. The type of + # the output (file or directory) is not specified, and will be determined by the + # server after action execution. If the resulting path is a file, it will be + # returned in an OutputFile) typed field. If the path is a directory, the entire + # directory structure will be returned as a Tree message digest, see + # OutputDirectory) Other files or directories that may be created during command + # execution are discarded. The paths are relative to the working directory of + # the action execution. The paths are specified using a single forward slash (`/` + # ) as a path separator, even if the execution platform natively uses a + # different separator. The path MUST NOT include a trailing slash, nor a leading + # slash, being a relative path. In order to ensure consistent hashing of the + # same Action, the output paths MUST be deduplicated and sorted + # lexicographically by code point (or, equivalently, by UTF-8 bytes). + # Directories leading up to the output paths are created by the worker prior to + # execution, even if they are not explicitly part of the input root. New in v2.1: + # this field supersedes the DEPRECATED `output_files` and `output_directories` + # fields. If `output_paths` is used, `output_files` and `output_directories` + # will be ignored! # Corresponds to the JSON property `outputPaths` # @return [Array] attr_accessor :output_paths # A `Platform` is a set of requirements, such as hardware, operating system, or - # compiler toolchain, for an - # Action's execution - # environment. A `Platform` is represented as a series of key-value pairs - # representing the properties that are required of the platform. + # compiler toolchain, for an Action's execution environment. A `Platform` is + # represented as a series of key-value pairs representing the properties that + # are required of the platform. # Corresponds to the JSON property `platform` # @return [Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Platform] attr_accessor :platform - # The working directory, relative to the input root, for the command to run - # in. It must be a directory which exists in the input tree. If it is left - # empty, then the action is run in the input root. + # The working directory, relative to the input root, for the command to run in. + # It must be a directory which exists in the input tree. If it is left empty, + # then the action is run in the input root. # Corresponds to the JSON property `workingDirectory` # @return [String] attr_accessor :working_directory @@ -571,31 +486,29 @@ module Google end # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. class BuildBazelRemoteExecutionV2Digest include Google::Apis::Core::Hashable @@ -622,75 +535,31 @@ module Google end # A `Directory` represents a directory node in a file tree, containing zero or - # more children FileNodes, - # DirectoryNodes and - # SymlinkNodes. - # Each `Node` contains its name in the directory, either the digest of its - # content (either a file blob or a `Directory` proto) or a symlink target, as - # well as possibly some metadata about the file or directory. - # In order to ensure that two equivalent directory trees hash to the same - # value, the following restrictions MUST be obeyed when constructing a - # a `Directory`: - # * Every child in the directory must have a path of exactly one segment. - # Multiple levels of directory hierarchy may not be collapsed. - # * Each child in the directory must have a unique path segment (file name). - # Note that while the API itself is case-sensitive, the environment where - # the Action is executed may or may not be case-sensitive. That is, it is - # legal to call the API with a Directory that has both "Foo" and "foo" as - # children, but the Action may be rejected by the remote system upon - # execution. - # * The files, directories and symlinks in the directory must each be sorted - # in lexicographical order by path. The path strings must be sorted by code - # point, equivalently, by UTF-8 bytes. - # * The NodeProperties of files, - # directories, and symlinks must be sorted in lexicographical order by - # property name. - # A `Directory` that obeys the restrictions is said to be in canonical form. - # As an example, the following could be used for a file named `bar` and a + # more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains + # its name in the directory, either the digest of its content (either a file + # blob or a `Directory` proto) or a symlink target, as well as possibly some + # metadata about the file or directory. In order to ensure that two equivalent + # directory trees hash to the same value, the following restrictions MUST be + # obeyed when constructing a a `Directory`: * Every child in the directory must + # have a path of exactly one segment. Multiple levels of directory hierarchy may + # not be collapsed. * Each child in the directory must have a unique path + # segment (file name). Note that while the API itself is case-sensitive, the + # environment where the Action is executed may or may not be case-sensitive. + # That is, it is legal to call the API with a Directory that has both "Foo" and " + # foo" as children, but the Action may be rejected by the remote system upon + # execution. * The files, directories and symlinks in the directory must each be + # sorted in lexicographical order by path. The path strings must be sorted by + # code point, equivalently, by UTF-8 bytes. * The NodeProperties of files, + # directories, and symlinks must be sorted in lexicographical order by property + # name. A `Directory` that obeys the restrictions is said to be in canonical + # form. As an example, the following could be used for a file named `bar` and a # directory named `foo` with an executable file named `baz` (hashes shortened - # for readability): - # ```json - # // (Directory proto) - # ` - # files: [ - # ` - # name: "bar", - # digest: ` - # hash: "4a73bc9d03...", - # size: 65534 - # `, - # node_properties: [ - # ` - # "name": "MTime", - # "value": "2017-01-15T01:30:15.01Z" - # ` - # ] - # ` - # ], - # directories: [ - # ` - # name: "foo", - # digest: ` - # hash: "4cf2eda940...", - # size: 43 - # ` - # ` - # ] - # ` - # // (Directory proto with hash "4cf2eda940..." and size 43) - # ` - # files: [ - # ` - # name: "baz", - # digest: ` - # hash: "b2c941073e...", - # size: 1294, - # `, - # is_executable: true - # ` - # ] - # ` - # ``` + # for readability): ```json // (Directory proto) ` files: [ ` name: "bar", + # digest: ` hash: "4a73bc9d03...", size: 65534 `, node_properties: [ ` "name": " + # MTime", "value": "2017-01-15T01:30:15.01Z" ` ] ` ], directories: [ ` name: " + # foo", digest: ` hash: "4cf2eda940...", size: 43 ` ` ] ` // (Directory proto + # with hash "4cf2eda940..." and size 43) ` files: [ ` name: "baz", digest: ` + # hash: "b2c941073e...", size: 1294, `, is_executable: true ` ] ` ``` class BuildBazelRemoteExecutionV2Directory include Google::Apis::Core::Hashable @@ -727,38 +596,35 @@ module Google end end - # A `DirectoryNode` represents a child of a - # Directory which is itself - # a `Directory` and its associated metadata. + # A `DirectoryNode` represents a child of a Directory which is itself a ` + # Directory` and its associated metadata. class BuildBazelRemoteExecutionV2DirectoryNode include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest] attr_accessor :digest @@ -779,40 +645,35 @@ module Google end end - # Metadata about an ongoing - # execution, which - # will be contained in the metadata - # field of the - # Operation. + # Metadata about an ongoing execution, which will be contained in the metadata + # field of the Operation. class BuildBazelRemoteExecutionV2ExecuteOperationMetadata include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `actionDigest` # @return [Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest] attr_accessor :action_digest @@ -822,15 +683,13 @@ module Google # @return [String] attr_accessor :stage - # If set, the client can use this name with - # ByteStream.Read to stream the + # If set, the client can use this name with ByteStream.Read to stream the # standard error. # Corresponds to the JSON property `stderrStreamName` # @return [String] attr_accessor :stderr_stream_name - # If set, the client can use this name with - # ByteStream.Read to stream the + # If set, the client can use this name with ByteStream.Read to stream the # standard output. # Corresponds to the JSON property `stdoutStreamName` # @return [String] @@ -849,11 +708,8 @@ module Google end end - # The response message for - # Execution.Execute, - # which will be contained in the response - # field of the - # Operation. + # The response message for Execution.Execute, which will be contained in the + # response field of the Operation. class BuildBazelRemoteExecutionV2ExecuteResponse include Google::Apis::Core::Hashable @@ -869,29 +725,27 @@ module Google # @return [String] attr_accessor :message - # An ActionResult represents the result of an - # Action being run. + # An ActionResult represents the result of an Action being run. # Corresponds to the JSON property `result` # @return [Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2ActionResult] attr_accessor :result # An optional list of additional log outputs the server wishes to provide. A - # server can use this to return execution-specific logs however it wishes. - # This is intended primarily to make it easier for users to debug issues that - # may be outside of the actual job execution, such as by identifying the - # worker executing the action or by providing logs from the worker's setup - # phase. The keys SHOULD be human readable so that a client can display them - # to a user. + # server can use this to return execution-specific logs however it wishes. This + # is intended primarily to make it easier for users to debug issues that may be + # outside of the actual job execution, such as by identifying the worker + # executing the action or by providing logs from the worker's setup phase. The + # keys SHOULD be human readable so that a client can display them to a user. # Corresponds to the JSON property `serverLogs` # @return [Hash] attr_accessor :server_logs - # 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::RemotebuildexecutionV1alpha::GoogleRpcStatus] attr_accessor :status @@ -988,31 +842,29 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest] attr_accessor :digest @@ -1051,40 +903,38 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest] attr_accessor :digest - # This is a hint as to the purpose of the log, and is set to true if the log - # is human-readable text that can be usefully displayed to a user, and false - # otherwise. For instance, if a command-line client wishes to print the - # server logs to the terminal for a failed action, this allows it to avoid - # displaying a binary file. + # This is a hint as to the purpose of the log, and is set to true if the log is + # human-readable text that can be usefully displayed to a user, and false + # otherwise. For instance, if a command-line client wishes to print the server + # logs to the terminal for a failed action, this allows it to avoid displaying a + # binary file. # Corresponds to the JSON property `humanReadable` # @return [Boolean] attr_accessor :human_readable @@ -1101,10 +951,8 @@ module Google end end - # A single property for FileNodes, - # DirectoryNodes, and - # SymlinkNodes. The server is - # responsible for specifying the property `name`s that it accepts. If + # A single property for FileNodes, DirectoryNodes, and SymlinkNodes. The server + # is responsible for specifying the property `name`s that it accepts. If # permitted by the server, the same `name` may occur multiple times. class BuildBazelRemoteExecutionV2NodeProperty include Google::Apis::Core::Hashable @@ -1136,39 +984,37 @@ module Google include Google::Apis::Core::Hashable # The full path of the directory relative to the working directory. The path - # separator is a forward slash `/`. Since this is a relative path, it MUST - # NOT begin with a leading forward slash. The empty string value is allowed, - # and it denotes the entire working directory. + # separator is a forward slash `/`. Since this is a relative path, it MUST NOT + # begin with a leading forward slash. The empty string value is allowed, and it + # denotes the entire working directory. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `treeDigest` # @return [Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest] attr_accessor :tree_digest @@ -1184,51 +1030,45 @@ module Google end end - # An `OutputFile` is similar to a - # FileNode, but it is used as an - # output in an `ActionResult`. It allows a full file path rather than - # only a name. + # An `OutputFile` is similar to a FileNode, but it is used as an output in an ` + # ActionResult`. It allows a full file path rather than only a name. class BuildBazelRemoteExecutionV2OutputFile include Google::Apis::Core::Hashable # The contents of the file if inlining was requested. The server SHOULD NOT - # inline - # file contents unless requested by the client in the - # GetActionResultRequest - # message. The server MAY omit inlining, even if requested, and MUST do so if - # inlining - # would cause the response to exceed message size limits. + # inline file contents unless requested by the client in the + # GetActionResultRequest message. The server MAY omit inlining, even if + # requested, and MUST do so if inlining would cause the response to exceed + # message size limits. # Corresponds to the JSON property `contents` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :contents # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest] attr_accessor :digest @@ -1245,8 +1085,8 @@ module Google attr_accessor :node_properties # The full path of the file relative to the working directory, including the - # filename. The path separator is a forward slash `/`. Since this is a - # relative path, it MUST NOT begin with a leading forward slash. + # filename. The path separator is a forward slash `/`. Since this is a relative + # path, it MUST NOT begin with a leading forward slash. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path @@ -1265,32 +1105,29 @@ module Google end end - # An `OutputSymlink` is similar to a - # Symlink, but it is used as an - # output in an `ActionResult`. - # `OutputSymlink` is binary-compatible with `SymlinkNode`. + # An `OutputSymlink` is similar to a Symlink, but it is used as an output in an ` + # ActionResult`. `OutputSymlink` is binary-compatible with `SymlinkNode`. class BuildBazelRemoteExecutionV2OutputSymlink include Google::Apis::Core::Hashable - # The supported node properties of the OutputSymlink, if requested by the - # Action. + # The supported node properties of the OutputSymlink, if requested by the Action. # Corresponds to the JSON property `nodeProperties` # @return [Array] attr_accessor :node_properties # The full path of the symlink relative to the working directory, including the - # filename. The path separator is a forward slash `/`. Since this is a - # relative path, it MUST NOT begin with a leading forward slash. + # filename. The path separator is a forward slash `/`. Since this is a relative + # path, it MUST NOT begin with a leading forward slash. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path - # The target path of the symlink. The path separator is a forward slash `/`. - # The target path can be relative to the parent directory of the symlink or - # it can be an absolute path starting with `/`. Support for absolute paths - # can be checked using the Capabilities - # API. The canonical form forbids the substrings `/./` and `//` in the target - # path. `..` components are allowed anywhere in the target path. + # The target path of the symlink. The path separator is a forward slash `/`. The + # target path can be relative to the parent directory of the symlink or it can + # be an absolute path starting with `/`. Support for absolute paths can be + # checked using the Capabilities API. The canonical form forbids the substrings ` + # /./` and `//` in the target path. `..` components are allowed anywhere in the + # target path. # Corresponds to the JSON property `target` # @return [String] attr_accessor :target @@ -1308,17 +1145,16 @@ module Google end # A `Platform` is a set of requirements, such as hardware, operating system, or - # compiler toolchain, for an - # Action's execution - # environment. A `Platform` is represented as a series of key-value pairs - # representing the properties that are required of the platform. + # compiler toolchain, for an Action's execution environment. A `Platform` is + # represented as a series of key-value pairs representing the properties that + # are required of the platform. class BuildBazelRemoteExecutionV2Platform include Google::Apis::Core::Hashable - # The properties that make up this platform. In order to ensure that - # equivalent `Platform`s always hash to the same value, the properties MUST - # be lexicographically sorted by name, and then by value. Sorting of strings - # is done by code point, equivalently, by the UTF-8 bytes. + # The properties that make up this platform. In order to ensure that equivalent ` + # Platform`s always hash to the same value, the properties MUST be + # lexicographically sorted by name, and then by value. Sorting of strings is + # done by code point, equivalently, by the UTF-8 bytes. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -1335,19 +1171,16 @@ module Google # A single property for the environment. The server is responsible for # specifying the property `name`s that it accepts. If an unknown `name` is - # provided in the requirements for an - # Action, the server SHOULD - # reject the execution request. If permitted by the server, the same `name` - # may occur multiple times. - # The server is also responsible for specifying the interpretation of - # property `value`s. For instance, a property describing how much RAM must be - # available may be interpreted as allowing a worker with 16GB to fulfill a - # request for 8GB, while a property describing the OS environment on which - # the action must be performed may require an exact match with the worker's - # OS. - # The server MAY use the `value` of one or more properties to determine how - # it sets up the execution environment, such as by making specific system - # files available to the worker. + # provided in the requirements for an Action, the server SHOULD reject the + # execution request. If permitted by the server, the same `name` may occur + # multiple times. The server is also responsible for specifying the + # interpretation of property `value`s. For instance, a property describing how + # much RAM must be available may be interpreted as allowing a worker with 16GB + # to fulfill a request for 8GB, while a property describing the OS environment + # on which the action must be performed may require an exact match with the + # worker's OS. The server MAY use the `value` of one or more properties to + # determine how it sets up the execution environment, such as by making specific + # system files available to the worker. class BuildBazelRemoteExecutionV2PlatformProperty include Google::Apis::Core::Hashable @@ -1375,27 +1208,25 @@ module Google # An optional Metadata to attach to any RPC request to tell the server about an # external context of the request. The server may use this for logging or other # purposes. To use it, the client attaches the header to the call using the - # canonical proto serialization: - # * name: `build.bazel.remote.execution.v2.requestmetadata-bin` - # * contents: the base64 encoded binary `RequestMetadata` message. - # Note: the gRPC library serializes binary headers encoded in base 64 by - # default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md# - # requests). - # Therefore, if the gRPC library is used to pass/retrieve this + # canonical proto serialization: * name: `build.bazel.remote.execution.v2. + # requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` + # message. Note: the gRPC library serializes binary headers encoded in base 64 + # by default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md# + # requests). Therefore, if the gRPC library is used to pass/retrieve this # metadata, the user may ignore the base64 encoding and assume it is simply # serialized as a binary message. class BuildBazelRemoteExecutionV2RequestMetadata include Google::Apis::Core::Hashable - # An identifier that ties multiple requests to the same action. - # For example, multiple requests to the CAS, Action Cache, and Execution - # API are used in order to compile foo.cc. + # An identifier that ties multiple requests to the same action. For example, + # multiple requests to the CAS, Action Cache, and Execution API are used in + # order to compile foo.cc. # Corresponds to the JSON property `actionId` # @return [String] attr_accessor :action_id - # An identifier to tie multiple tool invocations together. For example, - # runs of foo_test, bar_test and baz_test on a post-submit of a given patch. + # An identifier to tie multiple tool invocations together. For example, runs of + # foo_test, bar_test and baz_test on a post-submit of a given patch. # Corresponds to the JSON property `correlatedInvocationsId` # @return [String] attr_accessor :correlated_invocations_id @@ -1405,8 +1236,8 @@ module Google # @return [Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2ToolDetails] attr_accessor :tool_details - # An identifier that ties multiple actions together to a final result. - # For example, multiple actions are required to build and run foo_test. + # An identifier that ties multiple actions together to a final result. For + # example, multiple actions are required to build and run foo_test. # Corresponds to the JSON property `toolInvocationId` # @return [String] attr_accessor :tool_invocation_id @@ -1438,12 +1269,12 @@ module Google # @return [Array] attr_accessor :node_properties - # The target path of the symlink. The path separator is a forward slash `/`. - # The target path can be relative to the parent directory of the symlink or - # it can be an absolute path starting with `/`. Support for absolute paths - # can be checked using the Capabilities - # API. The canonical form forbids the substrings `/./` and `//` in the target - # path. `..` components are allowed anywhere in the target path. + # The target path of the symlink. The path separator is a forward slash `/`. The + # target path can be relative to the parent directory of the symlink or it can + # be an absolute path starting with `/`. Support for absolute paths can be + # checked using the Capabilities API. The canonical form forbids the substrings ` + # /./` and `//` in the target path. `..` components are allowed anywhere in the + # target path. # Corresponds to the JSON property `target` # @return [String] attr_accessor :target @@ -1485,90 +1316,45 @@ module Google end end - # A `Tree` contains all the - # Directory protos in a - # single directory Merkle tree, compressed into one message. + # A `Tree` contains all the Directory protos in a single directory Merkle tree, + # compressed into one message. class BuildBazelRemoteExecutionV2Tree include Google::Apis::Core::Hashable # All the child directories: the directories referred to by the root and, - # recursively, all its children. In order to reconstruct the directory tree, - # the client must take the digests of each of the child directories and then - # build up a tree starting from the `root`. + # recursively, all its children. In order to reconstruct the directory tree, the + # client must take the digests of each of the child directories and then build + # up a tree starting from the `root`. # Corresponds to the JSON property `children` # @return [Array] attr_accessor :children # A `Directory` represents a directory node in a file tree, containing zero or - # more children FileNodes, - # DirectoryNodes and - # SymlinkNodes. - # Each `Node` contains its name in the directory, either the digest of its - # content (either a file blob or a `Directory` proto) or a symlink target, as - # well as possibly some metadata about the file or directory. - # In order to ensure that two equivalent directory trees hash to the same - # value, the following restrictions MUST be obeyed when constructing a - # a `Directory`: - # * Every child in the directory must have a path of exactly one segment. - # Multiple levels of directory hierarchy may not be collapsed. - # * Each child in the directory must have a unique path segment (file name). - # Note that while the API itself is case-sensitive, the environment where - # the Action is executed may or may not be case-sensitive. That is, it is - # legal to call the API with a Directory that has both "Foo" and "foo" as - # children, but the Action may be rejected by the remote system upon - # execution. - # * The files, directories and symlinks in the directory must each be sorted - # in lexicographical order by path. The path strings must be sorted by code - # point, equivalently, by UTF-8 bytes. - # * The NodeProperties of files, - # directories, and symlinks must be sorted in lexicographical order by - # property name. - # A `Directory` that obeys the restrictions is said to be in canonical form. - # As an example, the following could be used for a file named `bar` and a + # more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains + # its name in the directory, either the digest of its content (either a file + # blob or a `Directory` proto) or a symlink target, as well as possibly some + # metadata about the file or directory. In order to ensure that two equivalent + # directory trees hash to the same value, the following restrictions MUST be + # obeyed when constructing a a `Directory`: * Every child in the directory must + # have a path of exactly one segment. Multiple levels of directory hierarchy may + # not be collapsed. * Each child in the directory must have a unique path + # segment (file name). Note that while the API itself is case-sensitive, the + # environment where the Action is executed may or may not be case-sensitive. + # That is, it is legal to call the API with a Directory that has both "Foo" and " + # foo" as children, but the Action may be rejected by the remote system upon + # execution. * The files, directories and symlinks in the directory must each be + # sorted in lexicographical order by path. The path strings must be sorted by + # code point, equivalently, by UTF-8 bytes. * The NodeProperties of files, + # directories, and symlinks must be sorted in lexicographical order by property + # name. A `Directory` that obeys the restrictions is said to be in canonical + # form. As an example, the following could be used for a file named `bar` and a # directory named `foo` with an executable file named `baz` (hashes shortened - # for readability): - # ```json - # // (Directory proto) - # ` - # files: [ - # ` - # name: "bar", - # digest: ` - # hash: "4a73bc9d03...", - # size: 65534 - # `, - # node_properties: [ - # ` - # "name": "MTime", - # "value": "2017-01-15T01:30:15.01Z" - # ` - # ] - # ` - # ], - # directories: [ - # ` - # name: "foo", - # digest: ` - # hash: "4cf2eda940...", - # size: 43 - # ` - # ` - # ] - # ` - # // (Directory proto with hash "4cf2eda940..." and size 43) - # ` - # files: [ - # ` - # name: "baz", - # digest: ` - # hash: "b2c941073e...", - # size: 1294, - # `, - # is_executable: true - # ` - # ] - # ` - # ``` + # for readability): ```json // (Directory proto) ` files: [ ` name: "bar", + # digest: ` hash: "4a73bc9d03...", size: 65534 `, node_properties: [ ` "name": " + # MTime", "value": "2017-01-15T01:30:15.01Z" ` ] ` ], directories: [ ` name: " + # foo", digest: ` hash: "4cf2eda940...", size: 43 ` ` ] ` // (Directory proto + # with hash "4cf2eda940..." and size 43) ` files: [ ` name: "baz", digest: ` + # hash: "b2c941073e...", size: 1294, `, is_executable: true ` ] ` ``` # Corresponds to the JSON property `root` # @return [Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Directory] attr_accessor :root @@ -1589,8 +1375,8 @@ module Google class GoogleDevtoolsRemotebuildbotCommandDurations include Google::Apis::Core::Hashable - # The time spent preparing the command to be run in a Docker container - # (includes pulling the Docker image, if necessary). + # The time spent preparing the command to be run in a Docker container (includes + # pulling the Docker image, if necessary). # Corresponds to the JSON property `dockerPrep` # @return [String] attr_accessor :docker_prep @@ -1666,13 +1452,13 @@ module Google end end - # CommandEvents contains counters for the number of warnings and errors - # that occurred during the execution of a command. + # CommandEvents contains counters for the number of warnings and errors that + # occurred during the execution of a command. class GoogleDevtoolsRemotebuildbotCommandEvents include Google::Apis::Core::Hashable - # Indicates whether we are using a cached Docker image (true) or had to pull - # the Docker image (false) for this command. + # Indicates whether we are using a cached Docker image (true) or had to pull the + # Docker image (false) for this command. # Corresponds to the JSON property `dockerCacheHit` # @return [Boolean] attr_accessor :docker_cache_hit @@ -1842,28 +1628,24 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest include Google::Apis::Core::Hashable - # Instance conceptually encapsulates all Remote Build Execution resources - # for remote builds. - # An instance consists of storage and compute resources (for example, - # `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for - # running remote builds. - # All Remote Build Execution API calls are scoped to an instance. + # Instance conceptually encapsulates all Remote Build Execution resources for + # remote builds. An instance consists of storage and compute resources (for + # example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for + # running remote builds. All Remote Build Execution API calls are scoped to an + # instance. # Corresponds to the JSON property `instance` # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance] attr_accessor :instance - # ID of the created instance. - # A valid `instance_id` must: - # be 6-50 characters long, - # contain only lowercase letters, digits, hyphens and underscores, - # start with a lowercase letter, and - # end with a lowercase letter or a digit. + # ID of the created instance. A valid `instance_id` must: be 6-50 characters + # long, contain only lowercase letters, digits, hyphens and underscores, start + # with a lowercase letter, and end with a lowercase letter or a digit. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id - # Resource name of the project containing the instance. - # Format: `projects/[PROJECT_ID]`. + # Resource name of the project containing the instance. Format: `projects/[ + # PROJECT_ID]`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -1884,18 +1666,15 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest include Google::Apis::Core::Hashable - # Resource name of the instance in which to create the new worker pool. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Resource name of the instance in which to create the new worker pool. Format: ` + # projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # ID of the created worker pool. - # A valid pool ID must: - # be 6-50 characters long, - # contain only lowercase letters, digits, hyphens and underscores, - # start with a lowercase letter, and - # end with a lowercase letter or a digit. + # ID of the created worker pool. A valid pool ID must: be 6-50 characters long, + # contain only lowercase letters, digits, hyphens and underscores, start with a + # lowercase letter, and end with a lowercase letter or a digit. # Corresponds to the JSON property `poolId` # @return [String] attr_accessor :pool_id @@ -1921,8 +1700,8 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest include Google::Apis::Core::Hashable - # Name of the instance to delete. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1941,9 +1720,8 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest include Google::Apis::Core::Hashable - # Name of the worker pool to delete. - # Format: - # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + # Name of the worker pool to delete. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]/workerpools/[POOL_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1958,12 +1736,107 @@ module Google end end + # FeaturePolicy defines features allowed to be used on RBE instances, as well as + # instance-wide behavior changes that take effect without opt-in or opt-out at + # usage time. + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy + include Google::Apis::Core::Hashable + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `containerImageSources` + # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :container_image_sources + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerAddCapabilities` + # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_add_capabilities + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerChrootPath` + # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_chroot_path + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerNetwork` + # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_network + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerPrivileged` + # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_privileged + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerRunAsRoot` + # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_run_as_root + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerRuntime` + # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_runtime + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerSiblingContainers` + # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_sibling_containers + + # linux_isolation allows overriding the docker runtime used for containers + # started on Linux. + # Corresponds to the JSON property `linuxIsolation` + # @return [String] + attr_accessor :linux_isolation + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @container_image_sources = args[:container_image_sources] if args.key?(:container_image_sources) + @docker_add_capabilities = args[:docker_add_capabilities] if args.key?(:docker_add_capabilities) + @docker_chroot_path = args[:docker_chroot_path] if args.key?(:docker_chroot_path) + @docker_network = args[:docker_network] if args.key?(:docker_network) + @docker_privileged = args[:docker_privileged] if args.key?(:docker_privileged) + @docker_run_as_root = args[:docker_run_as_root] if args.key?(:docker_run_as_root) + @docker_runtime = args[:docker_runtime] if args.key?(:docker_runtime) + @docker_sibling_containers = args[:docker_sibling_containers] if args.key?(:docker_sibling_containers) + @linux_isolation = args[:linux_isolation] if args.key?(:linux_isolation) + end + end + + # Defines whether a feature can be used or what values are accepted. + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature + include Google::Apis::Core::Hashable + + # A list of acceptable values. Only effective when the policy is `RESTRICTED`. + # Corresponds to the JSON property `allowedValues` + # @return [Array] + attr_accessor :allowed_values + + # The policy of the feature. + # Corresponds to the JSON property `policy` + # @return [String] + attr_accessor :policy + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allowed_values = args[:allowed_values] if args.key?(:allowed_values) + @policy = args[:policy] if args.key?(:policy) + end + end + # The request used for `GetInstance`. class GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest include Google::Apis::Core::Hashable - # Name of the instance to retrieve. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1982,9 +1855,8 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest include Google::Apis::Core::Hashable - # Name of the worker pool to retrieve. - # Format: - # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + # Name of the worker pool to retrieve. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]/workerpools/[POOL_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1999,15 +1871,21 @@ module Google end end - # Instance conceptually encapsulates all Remote Build Execution resources - # for remote builds. - # An instance consists of storage and compute resources (for example, - # `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for - # running remote builds. - # All Remote Build Execution API calls are scoped to an instance. + # Instance conceptually encapsulates all Remote Build Execution resources for + # remote builds. An instance consists of storage and compute resources (for + # example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for + # running remote builds. All Remote Build Execution API calls are scoped to an + # instance. class GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance include Google::Apis::Core::Hashable + # FeaturePolicy defines features allowed to be used on RBE instances, as well as + # instance-wide behavior changes that take effect without opt-in or opt-out at + # usage time. + # Corresponds to the JSON property `featurePolicy` + # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy] + attr_accessor :feature_policy + # The location is a GCP region. Currently only `us-central1` is supported. # Corresponds to the JSON property `location` # @return [String] @@ -2019,10 +1897,9 @@ module Google attr_accessor :logging_enabled alias_method :logging_enabled?, :logging_enabled - # Output only. Instance resource name formatted as: - # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. - # Name should not be populated when creating an instance since it is provided - # in the `instance_id` field. + # Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/ + # instances/[INSTANCE_ID]`. Name should not be populated when creating an + # instance since it is provided in the `instance_id` field. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2038,6 +1915,7 @@ module Google # Update properties of this object def update!(**args) + @feature_policy = args[:feature_policy] if args.key?(:feature_policy) @location = args[:location] if args.key?(:location) @logging_enabled = args[:logging_enabled] if args.key?(:logging_enabled) @name = args[:name] if args.key?(:name) @@ -2049,8 +1927,7 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesRequest include Google::Apis::Core::Hashable - # Resource name of the project. - # Format: `projects/[PROJECT_ID]`. + # Resource name of the project. Format: `projects/[PROJECT_ID]`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -2088,32 +1965,26 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest include Google::Apis::Core::Hashable - # Optional. A filter expression that filters resources listed in - # the response. The expression must specify the field name, a comparison - # operator, and the value that you want to use for filtering. The value - # must be a string, a number, or a boolean. String values are - # case-insensitive. - # The comparison operator must be either `:`, `=`, `!=`, `>`, `>=`, `<=` or - # `<`. - # The `:` operator can be used with string fields to match substrings. - # For non-string fields it is equivalent to the `=` operator. - # The `:*` comparison can be used to test whether a key has been defined. - # You can also filter on nested fields. - # To filter on multiple expressions, you can separate expression using - # `AND` and `OR` operators, using parentheses to specify precedence. If - # neither operator is specified, `AND` is assumed. - # Examples: - # Include only pools with more than 100 reserved workers: - # `(worker_count > 100) (worker_config.reserved = true)` - # Include only pools with a certain label or machines of the n1-standard - # family: + # Optional. A filter expression that filters resources listed in the response. + # The expression must specify the field name, a comparison operator, and the + # value that you want to use for filtering. The value must be a string, a number, + # or a boolean. String values are case-insensitive. The comparison operator + # must be either `:`, `=`, `!=`, `>`, `>=`, `<=` or `<`. The `:` operator can be + # used with string fields to match substrings. For non-string fields it is + # equivalent to the `=` operator. The `:*` comparison can be used to test + # whether a key has been defined. You can also filter on nested fields. To + # filter on multiple expressions, you can separate expression using `AND` and ` + # OR` operators, using parentheses to specify precedence. If neither operator is + # specified, `AND` is assumed. Examples: Include only pools with more than 100 + # reserved workers: `(worker_count > 100) (worker_config.reserved = true)` + # Include only pools with a certain label or machines of the n1-standard family: # `worker_config.labels.key1 : * OR worker_config.machine_type: n1-standard` # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter - # Resource name of the instance. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -2152,36 +2023,33 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest include Google::Apis::Core::Hashable - # Instance conceptually encapsulates all Remote Build Execution resources - # for remote builds. - # An instance consists of storage and compute resources (for example, - # `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for - # running remote builds. - # All Remote Build Execution API calls are scoped to an instance. + # Instance conceptually encapsulates all Remote Build Execution resources for + # remote builds. An instance consists of storage and compute resources (for + # example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for + # running remote builds. All Remote Build Execution API calls are scoped to an + # instance. # Corresponds to the JSON property `instance` # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance] attr_accessor :instance - # Deprecated, use instance.logging_enabled instead. - # Whether to enable Stackdriver logging for this instance. + # Deprecated, use instance.logging_enabled instead. Whether to enable + # Stackdriver logging for this instance. # Corresponds to the JSON property `loggingEnabled` # @return [Boolean] attr_accessor :logging_enabled alias_method :logging_enabled?, :logging_enabled - # Deprecated, use instance.Name instead. - # Name of the instance to update. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Deprecated, use instance.Name instead. Name of the instance to update. Format: + # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The update mask applies to instance. For the `FieldMask` definition, see - # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# - # fieldmask - # If an empty update_mask is provided, only the non-default valued field in - # the worker pool field will be updated. Note that in order to update a field - # to the default value (zero, false, empty string) an explicit update_mask + # The update mask applies to instance. For the `FieldMask` definition, see https: + # //developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask If an empty update_mask is provided, only the non-default valued + # field in the worker pool field will be updated. Note that in order to update a + # field to the default value (zero, false, empty string) an explicit update_mask # must be provided. # Corresponds to the JSON property `updateMask` # @return [String] @@ -2204,13 +2072,11 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest include Google::Apis::Core::Hashable - # The update mask applies to worker_pool. For the `FieldMask` definition, - # see + # The update mask applies to worker_pool. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# - # fieldmask - # If an empty update_mask is provided, only the non-default valued field in - # the worker pool field will be updated. Note that in order to update a field - # to the default value (zero, false, empty string) an explicit update_mask + # fieldmask If an empty update_mask is provided, only the non-default valued + # field in the worker pool field will be updated. Note that in order to update a + # field to the default value (zero, false, empty string) an explicit update_mask # must be provided. # Corresponds to the JSON property `updateMask` # @return [String] @@ -2232,8 +2098,7 @@ module Google end end - # Defines the configuration to be used for a creating workers in - # the worker pool. + # Defines the configuration to be used for a creating workers in the worker pool. class GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig include Google::Apis::Core::Hashable @@ -2242,34 +2107,31 @@ module Google # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig] attr_accessor :accelerator - # Required. Size of the disk attached to the worker, in GB. - # See https://cloud.google.com/compute/docs/disks/ + # Required. Size of the disk attached to the worker, in GB. See https://cloud. + # google.com/compute/docs/disks/ # Corresponds to the JSON property `diskSizeGb` # @return [Fixnum] attr_accessor :disk_size_gb - # Required. Disk Type to use for the worker. - # See [Storage - # options](https://cloud.google.com/compute/docs/disks/#introduction). - # Currently only `pd-standard` and `pd-ssd` are supported. + # Required. Disk Type to use for the worker. See [Storage options](https://cloud. + # google.com/compute/docs/disks/#introduction). Currently only `pd-standard` and + # `pd-ssd` are supported. # Corresponds to the JSON property `diskType` # @return [String] attr_accessor :disk_type - # Labels associated with the workers. - # Label keys and values can be no longer than 63 characters, can only contain - # lowercase letters, numeric characters, underscores and dashes. - # International letters are permitted. Label keys must start with a letter. - # Label values are optional. - # There can not be more than 64 labels per resource. + # Labels associated with the workers. Label keys and values can be no longer + # than 63 characters, can only contain lowercase letters, numeric characters, + # underscores and dashes. International letters are permitted. Label keys must + # start with a letter. Label values are optional. There can not be more than 64 + # labels per resource. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Required. Machine type of the worker, such as `n1-standard-2`. - # See https://cloud.google.com/compute/docs/machine-types for a list of - # supported machine types. Note that `f1-micro` and `g1-small` are not yet - # supported. + # Required. Machine type of the worker, such as `n1-standard-2`. See https:// + # cloud.google.com/compute/docs/machine-types for a list of supported machine + # types. Note that `f1-micro` and `g1-small` are not yet supported. # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type @@ -2279,25 +2141,24 @@ module Google # @return [Fixnum] attr_accessor :max_concurrent_actions - # Minimum CPU platform to use when creating the worker. - # See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms). + # Minimum CPU platform to use when creating the worker. See [CPU Platforms]( + # https://cloud.google.com/compute/docs/cpu-platforms). # Corresponds to the JSON property `minCpuPlatform` # @return [String] attr_accessor :min_cpu_platform - # Determines the type of network access granted to workers. Possible values: - # - "public": Workers can connect to the public internet. - # - "private": Workers can only connect to Google APIs and services. - # - "restricted-private": Workers can only connect to Google APIs that are - # reachable through `restricted.googleapis.com` (`199.36.153.4/30`). + # Determines the type of network access granted to workers. Possible values: - " + # public": Workers can connect to the public internet. - "private": Workers can + # only connect to Google APIs and services. - "restricted-private": Workers can + # only connect to Google APIs that are reachable through `restricted.googleapis. + # com` (`199.36.153.4/30`). # Corresponds to the JSON property `networkAccess` # @return [String] attr_accessor :network_access - # Determines whether the worker is reserved (equivalent to a Compute Engine - # on-demand VM and therefore won't be preempted). - # See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for more - # details. + # Determines whether the worker is reserved (equivalent to a Compute Engine on- + # demand VM and therefore won't be preempted). See [Preemptible VMs](https:// + # cloud.google.com/preemptible-vms/) for more details. # Corresponds to the JSON property `reserved` # @return [Boolean] attr_accessor :reserved @@ -2341,10 +2202,9 @@ module Google # @return [String] attr_accessor :channel - # WorkerPool resource name formatted as: - # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. - # name should not be populated when creating a worker pool since it is - # provided in the `poolId` field. + # WorkerPool resource name formatted as: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]/workerpools/[POOL_ID]`. name should not be populated when + # creating a worker pool since it is provided in the `poolId` field. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2354,14 +2214,13 @@ module Google # @return [String] attr_accessor :state - # Defines the configuration to be used for a creating workers in - # the worker pool. + # Defines the configuration to be used for a creating workers in the worker pool. # Corresponds to the JSON property `workerConfig` # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig] attr_accessor :worker_config - # The desired number of workers in the worker pool. Must be a value between - # 0 and 15000. + # The desired number of workers in the worker pool. Must be a value between 0 + # and 15000. # Corresponds to the JSON property `workerCount` # @return [Fixnum] attr_accessor :worker_count @@ -2383,14 +2242,13 @@ module Google # AdminTemp is a prelimiary set of administration tasks. It's called "Temp" # because we do not yet know the best way to represent admin tasks; it's - # possible that this will be entirely replaced in later versions of this API. - # If this message proves to be sufficient, it will be renamed in the alpha or - # beta release of this API. - # This message (suitably marshalled into a protobuf.Any) can be used as the - # inline_assignment field in a lease; the lease assignment field should simply - # be `"admin"` in these cases. - # This message is heavily based on Swarming administration tasks from the LUCI - # project (http://github.com/luci/luci-py/appengine/swarming). + # possible that this will be entirely replaced in later versions of this API. If + # this message proves to be sufficient, it will be renamed in the alpha or beta + # release of this API. This message (suitably marshalled into a protobuf.Any) + # can be used as the inline_assignment field in a lease; the lease assignment + # field should simply be `"admin"` in these cases. This message is heavily based + # on Swarming administration tasks from the LUCI project (http://github.com/luci/ + # luci-py/appengine/swarming). class GoogleDevtoolsRemoteworkersV1test2AdminTemp include Google::Apis::Core::Hashable @@ -2426,13 +2284,12 @@ module Google attr_accessor :contents # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemoteworkersV1test2Digest] attr_accessor :digest @@ -2448,27 +2305,26 @@ module Google end end - # DEPRECATED - use CommandResult instead. - # Describes the actual outputs from the task. + # DEPRECATED - use CommandResult instead. Describes the actual outputs from the + # task. class GoogleDevtoolsRemoteworkersV1test2CommandOutputs include Google::Apis::Core::Hashable # exit_code is only fully reliable if the status' code is OK. If the task - # exceeded its deadline or was cancelled, the process may still produce an - # exit code as it is cancelled, and this will be populated, but a successful - # (zero) is unlikely to be correct unless the status code is OK. + # exceeded its deadline or was cancelled, the process may still produce an exit + # code as it is cancelled, and this will be populated, but a successful (zero) + # is unlikely to be correct unless the status code is OK. # Corresponds to the JSON property `exitCode` # @return [Fixnum] attr_accessor :exit_code # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. # Corresponds to the JSON property `outputs` # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemoteworkersV1test2Digest] attr_accessor :outputs @@ -2484,9 +2340,8 @@ module Google end end - # DEPRECATED - use CommandResult instead. - # Can be used as part of CompleteRequest.metadata, or are part of a more - # sophisticated message. + # DEPRECATED - use CommandResult instead. Can be used as part of CompleteRequest. + # metadata, or are part of a more sophisticated message. class GoogleDevtoolsRemoteworkersV1test2CommandOverhead include Google::Apis::Core::Hashable @@ -2497,8 +2352,8 @@ module Google # @return [String] attr_accessor :duration - # The amount of time *not* spent executing the command (ie - # uploading/downloading files). + # The amount of time *not* spent executing the command (ie uploading/downloading + # files). # Corresponds to the JSON property `overhead` # @return [String] attr_accessor :overhead @@ -2526,46 +2381,44 @@ module Google # @return [String] attr_accessor :duration - # The exit code of the process. An exit code of "0" should only be trusted if - # `status` has a code of OK (otherwise it may simply be unset). + # The exit code of the process. An exit code of "0" should only be trusted if ` + # status` has a code of OK (otherwise it may simply be unset). # Corresponds to the JSON property `exitCode` # @return [Fixnum] attr_accessor :exit_code - # Implementation-dependent metadata about the task. Both servers and bots - # may define messages which can be encoded here; bots are free to provide - # metadata in multiple formats, and servers are free to choose one or more - # of the values to process and ignore others. In particular, it is *not* - # considered an error for the bot to provide the server with a field that it - # doesn't know about. + # Implementation-dependent metadata about the task. Both servers and bots may + # define messages which can be encoded here; bots are free to provide metadata + # in multiple formats, and servers are free to choose one or more of the values + # to process and ignore others. In particular, it is *not* considered an error + # for the bot to provide the server with a field that it doesn't know about. # Corresponds to the JSON property `metadata` # @return [Array>] attr_accessor :metadata # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. # Corresponds to the JSON property `outputs` # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemoteworkersV1test2Digest] attr_accessor :outputs - # The amount of time *not* spent executing the command (ie - # uploading/downloading files). + # The amount of time *not* spent executing the command (ie uploading/downloading + # files). # Corresponds to the JSON property `overhead` # @return [String] attr_accessor :overhead - # 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::RemotebuildexecutionV1alpha::GoogleRpcStatus] attr_accessor :status @@ -2621,14 +2474,13 @@ module Google class GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs include Google::Apis::Core::Hashable - # The command itself to run (e.g., argv). - # This field should be passed directly to the underlying operating system, - # and so it must be sensible to that operating system. For example, on - # Windows, the first argument might be "C:\Windows\System32\ping.exe" - - # that is, using drive letters and backslashes. A command for a *nix - # system, on the other hand, would use forward slashes. - # All other fields in the RWAPI must consistently use forward slashes, - # since those fields may be interpretted by both the service and the bot. + # The command itself to run (e.g., argv). This field should be passed directly + # to the underlying operating system, and so it must be sensible to that + # operating system. For example, on Windows, the first argument might be "C:\ + # Windows\System32\ping.exe" - that is, using drive letters and backslashes. A + # command for a *nix system, on the other hand, would use forward slashes. All + # other fields in the RWAPI must consistently use forward slashes, since those + # fields may be interpretted by both the service and the bot. # Corresponds to the JSON property `arguments` # @return [Array] attr_accessor :arguments @@ -2638,31 +2490,29 @@ module Google # @return [Array] attr_accessor :environment_variables - # The input filesystem to be set up prior to the task beginning. The - # contents should be a repeated set of FileMetadata messages though other - # formats are allowed if better for the implementation (eg, a LUCI-style - # .isolated file). - # This field is repeated since implementations might want to cache the - # metadata, in which case it may be useful to break up portions of the - # filesystem that change frequently (eg, specific input files) from those - # that don't (eg, standard header files). + # The input filesystem to be set up prior to the task beginning. The contents + # should be a repeated set of FileMetadata messages though other formats are + # allowed if better for the implementation (eg, a LUCI-style .isolated file). + # This field is repeated since implementations might want to cache the metadata, + # in which case it may be useful to break up portions of the filesystem that + # change frequently (eg, specific input files) from those that don't (eg, + # standard header files). # Corresponds to the JSON property `files` # @return [Array] attr_accessor :files - # Inline contents for blobs expected to be needed by the bot to execute the - # task. For example, contents of entries in `files` or blobs that are - # indirectly referenced by an entry there. - # The bot should check against this list before downloading required task - # inputs to reduce the number of communications between itself and the - # remote CAS server. + # Inline contents for blobs expected to be needed by the bot to execute the task. + # For example, contents of entries in `files` or blobs that are indirectly + # referenced by an entry there. The bot should check against this list before + # downloading required task inputs to reduce the number of communications + # between itself and the remote CAS server. # Corresponds to the JSON property `inlineBlobs` # @return [Array] attr_accessor :inline_blobs - # Directory from which a command is executed. It is a relative directory - # with respect to the bot's working directory (i.e., "./"). If it is - # non-empty, then it must exist under "./". Otherwise, "./" will be used. + # Directory from which a command is executed. It is a relative directory with + # respect to the bot's working directory (i.e., "./"). If it is non-empty, then + # it must exist under "./". Otherwise, "./" will be used. # Corresponds to the JSON property `workingDirectory` # @return [String] attr_accessor :working_directory @@ -2710,32 +2560,32 @@ module Google class GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs include Google::Apis::Core::Hashable - # A list of expected directories, relative to the execution root. All paths - # MUST be delimited by forward slashes. + # A list of expected directories, relative to the execution root. All paths MUST + # be delimited by forward slashes. # Corresponds to the JSON property `directories` # @return [Array] attr_accessor :directories - # A list of expected files, relative to the execution root. All paths - # MUST be delimited by forward slashes. + # A list of expected files, relative to the execution root. All paths MUST be + # delimited by forward slashes. # Corresponds to the JSON property `files` # @return [Array] attr_accessor :files - # The destination to which any stderr should be sent. The method by which - # the bot should send the stream contents to that destination is not - # defined in this API. As examples, the destination could be a file - # referenced in the `files` field in this message, or it could be a URI - # that must be written via the ByteStream API. + # The destination to which any stderr should be sent. The method by which the + # bot should send the stream contents to that destination is not defined in this + # API. As examples, the destination could be a file referenced in the `files` + # field in this message, or it could be a URI that must be written via the + # ByteStream API. # Corresponds to the JSON property `stderrDestination` # @return [String] attr_accessor :stderr_destination - # The destination to which any stdout should be sent. The method by which - # the bot should send the stream contents to that destination is not - # defined in this API. As examples, the destination could be a file - # referenced in the `files` field in this message, or it could be a URI - # that must be written via the ByteStream API. + # The destination to which any stdout should be sent. The method by which the + # bot should send the stream contents to that destination is not defined in this + # API. As examples, the destination could be a file referenced in the `files` + # field in this message, or it could be a URI that must be written via the + # ByteStream API. # Corresponds to the JSON property `stdoutDestination` # @return [String] attr_accessor :stdout_destination @@ -2757,27 +2607,26 @@ module Google class GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts include Google::Apis::Core::Hashable - # This specifies the maximum time that the task can run, excluding the - # time required to download inputs or upload outputs. That is, the worker - # will terminate the task if it runs longer than this. + # This specifies the maximum time that the task can run, excluding the time + # required to download inputs or upload outputs. That is, the worker will + # terminate the task if it runs longer than this. # Corresponds to the JSON property `execution` # @return [String] attr_accessor :execution - # This specifies the maximum amount of time the task can be idle - that is, - # go without generating some output in either stdout or stderr. If the - # process is silent for more than the specified time, the worker will - # terminate the task. + # This specifies the maximum amount of time the task can be idle - that is, go + # without generating some output in either stdout or stderr. If the process is + # silent for more than the specified time, the worker will terminate the task. # Corresponds to the JSON property `idle` # @return [String] attr_accessor :idle # If the execution or IO timeouts are exceeded, the worker will try to - # gracefully terminate the task and return any existing logs. However, - # tasks may be hard-frozen in which case this process will fail. This - # timeout specifies how long to wait for a terminated task to shut down - # gracefully (e.g. via SIGTERM) before we bring down the hammer (e.g. - # SIGKILL on *nix, CTRL_BREAK_EVENT on Windows). + # gracefully terminate the task and return any existing logs. However, tasks may + # be hard-frozen in which case this process will fail. This timeout specifies + # how long to wait for a terminated task to shut down gracefully (e.g. via + # SIGTERM) before we bring down the hammer (e.g. SIGKILL on *nix, + # CTRL_BREAK_EVENT on Windows). # Corresponds to the JSON property `shutdown` # @return [String] attr_accessor :shutdown @@ -2795,13 +2644,12 @@ module Google end # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. class GoogleDevtoolsRemoteworkersV1test2Digest include Google::Apis::Core::Hashable @@ -2812,9 +2660,9 @@ module Google attr_accessor :hash_prop # The size of the contents. While this is not strictly required as part of an - # identifier (after all, any given hash will have exactly one canonical - # size), it's useful in almost all cases when one might want to send or - # retrieve blobs of content and is included here for this reason. + # identifier (after all, any given hash will have exactly one canonical size), + # it's useful in almost all cases when one might want to send or retrieve blobs + # of content and is included here for this reason. # Corresponds to the JSON property `sizeBytes` # @return [Fixnum] attr_accessor :size_bytes @@ -2862,13 +2710,12 @@ module Google include Google::Apis::Core::Hashable # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemoteworkersV1test2Digest] attr_accessor :digest @@ -2894,21 +2741,20 @@ module Google class GoogleDevtoolsRemoteworkersV1test2FileMetadata include Google::Apis::Core::Hashable - # If the file is small enough, its contents may also or alternatively be - # listed here. + # If the file is small enough, its contents may also or alternatively be listed + # here. # Corresponds to the JSON property `contents` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :contents # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemoteworkersV1test2Digest] attr_accessor :digest @@ -2919,11 +2765,11 @@ module Google attr_accessor :is_executable alias_method :is_executable?, :is_executable - # The path of this file. If this message is part of the - # CommandOutputs.outputs fields, the path is relative to the execution root - # and must correspond to an entry in CommandTask.outputs.files. If this - # message is part of a Directory message, then the path is relative to the - # root of that directory. All paths MUST be delimited by forward slashes. + # The path of this file. If this message is part of the CommandOutputs.outputs + # fields, the path is relative to the execution root and must correspond to an + # entry in CommandTask.outputs.files. If this message is part of a Directory + # message, then the path is relative to the root of that directory. All paths + # MUST be delimited by forward slashes. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path @@ -2946,47 +2792,45 @@ module Google class GoogleLongrunningOperation 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::RemotebuildexecutionV1alpha::GoogleRpcStatus] 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] 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] attr_accessor :response @@ -3005,12 +2849,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 GoogleRpcStatus include Google::Apis::Core::Hashable @@ -3019,15 +2863,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>] 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 diff --git a/generated/google/apis/remotebuildexecution_v1alpha/representations.rb b/generated/google/apis/remotebuildexecution_v1alpha/representations.rb index 06aab34aa..a94c69464 100644 --- a/generated/google/apis/remotebuildexecution_v1alpha/representations.rb +++ b/generated/google/apis/remotebuildexecution_v1alpha/representations.rb @@ -220,6 +220,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -735,6 +747,37 @@ module Google end end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :container_image_sources, as: 'containerImageSources', class: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_add_capabilities, as: 'dockerAddCapabilities', class: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_chroot_path, as: 'dockerChrootPath', class: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_network, as: 'dockerNetwork', class: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_privileged, as: 'dockerPrivileged', class: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_run_as_root, as: 'dockerRunAsRoot', class: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_runtime, as: 'dockerRuntime', class: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_sibling_containers, as: 'dockerSiblingContainers', class: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :linux_isolation, as: 'linuxIsolation' + end + end + + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :allowed_values, as: 'allowedValues' + property :policy, as: 'policy' + end + end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -752,6 +795,8 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance # @private class Representation < Google::Apis::Core::JsonRepresentation + property :feature_policy, as: 'featurePolicy', class: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy, decorator: Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy::Representation + property :location, as: 'location' property :logging_enabled, as: 'loggingEnabled' property :name, as: 'name' diff --git a/generated/google/apis/remotebuildexecution_v1alpha/service.rb b/generated/google/apis/remotebuildexecution_v1alpha/service.rb index ce41cda46..a1a1fef42 100644 --- a/generated/google/apis/remotebuildexecution_v1alpha/service.rb +++ b/generated/google/apis/remotebuildexecution_v1alpha/service.rb @@ -47,13 +47,13 @@ module Google @batch_path = 'batch' end - # Creates a new instance in the specified region. - # Returns a long running operation which contains an instance on completion. - # While the long running operation is in progress, any call to `GetInstance` - # returns an instance in state `CREATING`. + # Creates a new instance in the specified region. Returns a long running + # operation which contains an instance on completion. While the long running + # operation is in progress, any call to `GetInstance` returns an instance in + # state `CREATING`. # @param [String] parent - # Resource name of the project containing the instance. - # Format: `projects/[PROJECT_ID]`. + # Resource name of the project containing the instance. Format: `projects/[ + # PROJECT_ID]`. # @param [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest] google_devtools_remotebuildexecution_admin_v1alpha_create_instance_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -84,14 +84,12 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified instance. - # Returns a long running operation which contains a `google.protobuf.Empty` - # response on completion. - # Deleting an instance with worker pools in it will delete these worker - # pools. + # Deletes the specified instance. Returns a long running operation which + # contains a `google.protobuf.Empty` response on completion. Deleting an + # instance with worker pools in it will delete these worker pools. # @param [String] name - # Name of the instance to delete. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -121,8 +119,8 @@ module Google # Returns the specified instance. # @param [String] name - # Name of the instance to retrieve. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -152,8 +150,7 @@ module Google # Lists instances in a project. # @param [String] parent - # Resource name of the project. - # Format: `projects/[PROJECT_ID]`. + # Resource name of the project. Format: `projects/[PROJECT_ID]`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -181,13 +178,65 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new worker pool with a specified size and configuration. - # Returns a long running operation which contains a worker pool on - # completion. While the long running operation is in progress, any call to - # `GetWorkerPool` returns a worker pool in state `CREATING`. + # Updates the specified instance. Returns a long running operation which + # contains the updated instance in the response on completion. + # @param [String] name + # Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/ + # instances/[INSTANCE_ID]`. Name should not be populated when creating an + # instance since it is provided in the `instance_id` field. + # @param [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance] google_devtools_remotebuildexecution_admin_v1alpha_instance_object + # @param [Boolean] logging_enabled + # Deprecated, use instance.logging_enabled instead. Whether to enable + # Stackdriver logging for this instance. + # @param [String] name1 + # Deprecated, use instance.Name instead. Name of the instance to update. Format: + # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # @param [String] update_mask + # The update mask applies to instance. For the `FieldMask` definition, see https: + # //developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask If an empty update_mask is provided, only the non-default valued + # field in the worker pool field will be updated. Note that in order to update a + # field to the default value (zero, false, empty string) an explicit update_mask + # must be provided. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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 + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RemotebuildexecutionV1alpha::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RemotebuildexecutionV1alpha::GoogleLongrunningOperation] + # + # @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_project_instance(name, google_devtools_remotebuildexecution_admin_v1alpha_instance_object = nil, logging_enabled: nil, name1: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1alpha/{+name}', options) + command.request_representation = Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance::Representation + command.request_object = google_devtools_remotebuildexecution_admin_v1alpha_instance_object + command.response_representation = Google::Apis::RemotebuildexecutionV1alpha::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::RemotebuildexecutionV1alpha::GoogleLongrunningOperation + command.params['name'] = name unless name.nil? + command.query['loggingEnabled'] = logging_enabled unless logging_enabled.nil? + command.query['name1'] = name1 unless name1.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new worker pool with a specified size and configuration. Returns a + # long running operation which contains a worker pool on completion. While the + # long running operation is in progress, any call to `GetWorkerPool` returns a + # worker pool in state `CREATING`. # @param [String] parent - # Resource name of the instance in which to create the new worker pool. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Resource name of the instance in which to create the new worker pool. Format: ` + # projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. # @param [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest] google_devtools_remotebuildexecution_admin_v1alpha_create_worker_pool_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -218,15 +267,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified worker pool. - # Returns a long running operation, which contains a `google.protobuf.Empty` - # response on completion. - # While the long running operation is in progress, any call to - # `GetWorkerPool` returns a worker pool in state `DELETING`. + # Deletes the specified worker pool. Returns a long running operation, which + # contains a `google.protobuf.Empty` response on completion. While the long + # running operation is in progress, any call to `GetWorkerPool` returns a worker + # pool in state `DELETING`. # @param [String] name - # Name of the worker pool to delete. - # Format: - # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + # Name of the worker pool to delete. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]/workerpools/[POOL_ID]`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -256,9 +303,8 @@ module Google # Returns the specified worker pool. # @param [String] name - # Name of the worker pool to retrieve. - # Format: - # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + # Name of the worker pool to retrieve. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]/workerpools/[POOL_ID]`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -288,28 +334,22 @@ module Google # Lists worker pools in an instance. # @param [String] parent - # Resource name of the instance. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]`. # @param [String] filter - # Optional. A filter expression that filters resources listed in - # the response. The expression must specify the field name, a comparison - # operator, and the value that you want to use for filtering. The value - # must be a string, a number, or a boolean. String values are - # case-insensitive. - # The comparison operator must be either `:`, `=`, `!=`, `>`, `>=`, `<=` or - # `<`. - # The `:` operator can be used with string fields to match substrings. - # For non-string fields it is equivalent to the `=` operator. - # The `:*` comparison can be used to test whether a key has been defined. - # You can also filter on nested fields. - # To filter on multiple expressions, you can separate expression using - # `AND` and `OR` operators, using parentheses to specify precedence. If - # neither operator is specified, `AND` is assumed. - # Examples: - # Include only pools with more than 100 reserved workers: - # `(worker_count > 100) (worker_config.reserved = true)` - # Include only pools with a certain label or machines of the n1-standard - # family: + # Optional. A filter expression that filters resources listed in the response. + # The expression must specify the field name, a comparison operator, and the + # value that you want to use for filtering. The value must be a string, a number, + # or a boolean. String values are case-insensitive. The comparison operator + # must be either `:`, `=`, `!=`, `>`, `>=`, `<=` or `<`. The `:` operator can be + # used with string fields to match substrings. For non-string fields it is + # equivalent to the `=` operator. The `:*` comparison can be used to test + # whether a key has been defined. You can also filter on nested fields. To + # filter on multiple expressions, you can separate expression using `AND` and ` + # OR` operators, using parentheses to specify precedence. If neither operator is + # specified, `AND` is assumed. Examples: Include only pools with more than 100 + # reserved workers: `(worker_count > 100) (worker_config.reserved = true)` + # Include only pools with a certain label or machines of the n1-standard family: # `worker_config.labels.key1 : * OR worker_config.machine_type: n1-standard` # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -340,14 +380,13 @@ module Google end # Updates an existing worker pool with a specified size and/or configuration. - # Returns a long running operation, which contains a worker pool on - # completion. While the long running operation is in progress, any call to - # `GetWorkerPool` returns a worker pool in state `UPDATING`. + # Returns a long running operation, which contains a worker pool on completion. + # While the long running operation is in progress, any call to `GetWorkerPool` + # returns a worker pool in state `UPDATING`. # @param [String] name - # WorkerPool resource name formatted as: - # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. - # name should not be populated when creating a worker pool since it is - # provided in the `poolId` field. + # WorkerPool resource name formatted as: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]/workerpools/[POOL_ID]`. name should not be populated when + # creating a worker pool since it is provided in the `poolId` field. # @param [Google::Apis::RemotebuildexecutionV1alpha::GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest] google_devtools_remotebuildexecution_admin_v1alpha_update_worker_pool_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -378,9 +417,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 diff --git a/generated/google/apis/remotebuildexecution_v2.rb b/generated/google/apis/remotebuildexecution_v2.rb index e7f497ba6..28040acce 100644 --- a/generated/google/apis/remotebuildexecution_v2.rb +++ b/generated/google/apis/remotebuildexecution_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/remote-build-execution/docs/ module RemotebuildexecutionV2 VERSION = 'V2' - REVISION = '20200721' + REVISION = '20200810' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/remotebuildexecution_v2/classes.rb b/generated/google/apis/remotebuildexecution_v2/classes.rb index 1015be21c..2f9aac3f9 100644 --- a/generated/google/apis/remotebuildexecution_v2/classes.rb +++ b/generated/google/apis/remotebuildexecution_v2/classes.rb @@ -23,120 +23,107 @@ module Google module RemotebuildexecutionV2 # An `Action` captures all the information about an execution which is required - # to reproduce it. - # `Action`s are the core component of the [Execution] service. A single - # `Action` represents a repeatable action that can be performed by the + # to reproduce it. `Action`s are the core component of the [Execution] service. + # A single `Action` represents a repeatable action that can be performed by the # execution service. `Action`s can be succinctly identified by the digest of # their wire format encoding and, once an `Action` has been executed, will be # cached in the action cache. Future requests can then use the cached result - # rather than needing to run afresh. - # When a server completes execution of an - # Action, it MAY choose to - # cache the result in - # the ActionCache unless - # `do_not_cache` is `true`. Clients SHOULD expect the server to do so. By - # default, future calls to - # Execute the same - # `Action` will also serve their results from the cache. Clients must take care - # to understand the caching behaviour. Ideally, all `Action`s will be - # reproducible so that serving a result from cache is always desirable and - # correct. + # rather than needing to run afresh. When a server completes execution of an + # Action, it MAY choose to cache the result in the ActionCache unless ` + # do_not_cache` is `true`. Clients SHOULD expect the server to do so. By default, + # future calls to Execute the same `Action` will also serve their results from + # the cache. Clients must take care to understand the caching behaviour. Ideally, + # all `Action`s will be reproducible so that serving a result from cache is + # always desirable and correct. class BuildBazelRemoteExecutionV2Action include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `commandDigest` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest] attr_accessor :command_digest - # If true, then the `Action`'s result cannot be cached, and in-flight - # requests for the same `Action` may not be merged. + # If true, then the `Action`'s result cannot be cached, and in-flight requests + # for the same `Action` may not be merged. # Corresponds to the JSON property `doNotCache` # @return [Boolean] attr_accessor :do_not_cache alias_method :do_not_cache?, :do_not_cache # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `inputRootDigest` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest] attr_accessor :input_root_digest - # List of required supported NodeProperty - # keys. In order to ensure that equivalent `Action`s always hash to the same - # value, the supported node properties MUST be lexicographically sorted by name. - # Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. - # The interpretation of these properties is server-dependent. If a property is - # not recognized by the server, the server will return an `INVALID_ARGUMENT` - # error. + # List of required supported NodeProperty keys. In order to ensure that + # equivalent `Action`s always hash to the same value, the supported node + # properties MUST be lexicographically sorted by name. Sorting of strings is + # done by code point, equivalently, by the UTF-8 bytes. The interpretation of + # these properties is server-dependent. If a property is not recognized by the + # server, the server will return an `INVALID_ARGUMENT` error. # Corresponds to the JSON property `outputNodeProperties` # @return [Array] attr_accessor :output_node_properties - # A timeout after which the execution should be killed. If the timeout is - # absent, then the client is specifying that the execution should continue - # as long as the server will let it. The server SHOULD impose a timeout if - # the client does not specify one, however, if the client does specify a - # timeout that is longer than the server's maximum timeout, the server MUST - # reject the request. - # The timeout is a part of the - # Action message, and - # therefore two `Actions` with different timeouts are different, even if they - # are otherwise identical. This is because, if they were not, running an - # `Action` with a lower timeout than is required might result in a cache hit - # from an execution run with a longer timeout, hiding the fact that the - # timeout is too short. By encoding it directly in the `Action`, a lower - # timeout will result in a cache miss and the execution timeout will fail - # immediately, rather than whenever the cache entry gets evicted. + # A timeout after which the execution should be killed. If the timeout is absent, + # then the client is specifying that the execution should continue as long as + # the server will let it. The server SHOULD impose a timeout if the client does + # not specify one, however, if the client does specify a timeout that is longer + # than the server's maximum timeout, the server MUST reject the request. The + # timeout is a part of the Action message, and therefore two `Actions` with + # different timeouts are different, even if they are otherwise identical. This + # is because, if they were not, running an `Action` with a lower timeout than is + # required might result in a cache hit from an execution run with a longer + # timeout, hiding the fact that the timeout is too short. By encoding it + # directly in the `Action`, a lower timeout will result in a cache miss and the + # execution timeout will fail immediately, rather than whenever the cache entry + # gets evicted. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout @@ -175,8 +162,7 @@ module Google end end - # An ActionResult represents the result of an - # Action being run. + # An ActionResult represents the result of an Action being run. class BuildBazelRemoteExecutionV2ActionResult include Google::Apis::Core::Hashable @@ -190,84 +176,41 @@ module Google # @return [Fixnum] attr_accessor :exit_code - # The output directories of the action. For each output directory requested - # in the `output_directories` or `output_paths` field of the Action, if the + # The output directories of the action. For each output directory requested in + # the `output_directories` or `output_paths` field of the Action, if the # corresponding directory existed after the action completed, a single entry - # will be present in the output list, which will contain the digest of a - # Tree message containing the - # directory tree, and the path equal exactly to the corresponding Action - # output_directories member. - # As an example, suppose the Action had an output directory `a/b/dir` and the - # execution produced the following contents in `a/b/dir`: a file named `bar` - # and a directory named `foo` with an executable file named `baz`. Then, - # output_directory will contain (hashes shortened for readability): - # ```json - # // OutputDirectory proto: - # ` - # path: "a/b/dir" - # tree_digest: ` - # hash: "4a73bc9d03...", - # size: 55 - # ` - # ` - # // Tree proto with hash "4a73bc9d03..." and size 55: - # ` - # root: ` - # files: [ - # ` - # name: "bar", - # digest: ` - # hash: "4a73bc9d03...", - # size: 65534 - # ` - # ` - # ], - # directories: [ - # ` - # name: "foo", - # digest: ` - # hash: "4cf2eda940...", - # size: 43 - # ` - # ` - # ] - # ` - # children : ` - # // (Directory proto with hash "4cf2eda940..." and size 43) - # files: [ - # ` - # name: "baz", - # digest: ` - # hash: "b2c941073e...", - # size: 1294, - # `, - # is_executable: true - # ` - # ] - # ` - # ` - # ``` - # If an output of the same name as listed in `output_files` of - # the Command was found in `output_directories`, but was not a directory, the - # server will return a FAILED_PRECONDITION. + # will be present in the output list, which will contain the digest of a Tree + # message containing the directory tree, and the path equal exactly to the + # corresponding Action output_directories member. As an example, suppose the + # Action had an output directory `a/b/dir` and the execution produced the + # following contents in `a/b/dir`: a file named `bar` and a directory named `foo` + # with an executable file named `baz`. Then, output_directory will contain ( + # hashes shortened for readability): ```json // OutputDirectory proto: ` path: " + # a/b/dir" tree_digest: ` hash: "4a73bc9d03...", size: 55 ` ` // Tree proto with + # hash "4a73bc9d03..." and size 55: ` root: ` files: [ ` name: "bar", digest: ` + # hash: "4a73bc9d03...", size: 65534 ` ` ], directories: [ ` name: "foo", digest: + # ` hash: "4cf2eda940...", size: 43 ` ` ] ` children : ` // (Directory proto + # with hash "4cf2eda940..." and size 43) files: [ ` name: "baz", digest: ` hash: + # "b2c941073e...", size: 1294, `, is_executable: true ` ] ` ` ``` If an output + # of the same name as listed in `output_files` of the Command was found in ` + # output_directories`, but was not a directory, the server will return a + # FAILED_PRECONDITION. # Corresponds to the JSON property `outputDirectories` # @return [Array] attr_accessor :output_directories # The output directories of the action that are symbolic links to other # directories. Those may be links to other output directories, or input - # directories, or even absolute paths outside of the working directory, - # if the server supports - # SymlinkAbsolutePathStrategy.ALLOWED. - # For each output directory requested in the `output_directories` field of - # the Action, if the directory existed after the action completed, a - # single entry will be present either in this field, or in the - # `output_directories` field, if the directory was not a symbolic link. - # If an output of the same name was found, but was a symbolic link to a file - # instead of a directory, the server will return a FAILED_PRECONDITION. - # If the action does not produce the requested output, then that output - # will be omitted from the list. The server is free to arrange the output - # list as desired; clients MUST NOT assume that the output list is sorted. + # directories, or even absolute paths outside of the working directory, if the + # server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output directory + # requested in the `output_directories` field of the Action, if the directory + # existed after the action completed, a single entry will be present either in + # this field, or in the `output_directories` field, if the directory was not a + # symbolic link. If an output of the same name was found, but was a symbolic + # link to a file instead of a directory, the server will return a + # FAILED_PRECONDITION. If the action does not produce the requested output, then + # that output will be omitted from the list. The server is free to arrange the + # output list as desired; clients MUST NOT assume that the output list is sorted. # DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API # should still populate this field in addition to `output_symlinks`. # Corresponds to the JSON property `outputDirectorySymlinks` @@ -277,131 +220,119 @@ module Google # The output files of the action that are symbolic links to other files. Those # may be links to other output files, or input files, or even absolute paths # outside of the working directory, if the server supports - # SymlinkAbsolutePathStrategy.ALLOWED. - # For each output file requested in the `output_files` or `output_paths` - # field of the Action, if the corresponding file existed after - # the action completed, a single entry will be present either in this field, - # or in the `output_files` field, if the file was not a symbolic link. - # If an output symbolic link of the same name as listed in `output_files` of - # the Command was found, but its target type was not a regular file, the - # server will return a FAILED_PRECONDITION. - # If the action does not produce the requested output, then that output - # will be omitted from the list. The server is free to arrange the output - # list as desired; clients MUST NOT assume that the output list is sorted. - # DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API - # should still populate this field in addition to `output_symlinks`. + # SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in the ` + # output_files` or `output_paths` field of the Action, if the corresponding file + # existed after the action completed, a single entry will be present either in + # this field, or in the `output_files` field, if the file was not a symbolic + # link. If an output symbolic link of the same name as listed in `output_files` + # of the Command was found, but its target type was not a regular file, the + # server will return a FAILED_PRECONDITION. If the action does not produce the + # requested output, then that output will be omitted from the list. The server + # is free to arrange the output list as desired; clients MUST NOT assume that + # the output list is sorted. DEPRECATED as of v2.1. Servers that wish to be + # compatible with v2.0 API should still populate this field in addition to ` + # output_symlinks`. # Corresponds to the JSON property `outputFileSymlinks` # @return [Array] attr_accessor :output_file_symlinks - # The output files of the action. For each output file requested in the - # `output_files` or `output_paths` field of the Action, if the corresponding - # file existed after the action completed, a single entry will be present - # either in this field, or the `output_file_symlinks` field if the file was - # a symbolic link to another file (`output_symlinks` field after v2.1). - # If an output listed in `output_files` was found, but was a directory rather - # than a regular file, the server will return a FAILED_PRECONDITION. - # If the action does not produce the requested output, then that output - # will be omitted from the list. The server is free to arrange the output - # list as desired; clients MUST NOT assume that the output list is sorted. + # The output files of the action. For each output file requested in the ` + # output_files` or `output_paths` field of the Action, if the corresponding file + # existed after the action completed, a single entry will be present either in + # this field, or the `output_file_symlinks` field if the file was a symbolic + # link to another file (`output_symlinks` field after v2.1). If an output listed + # in `output_files` was found, but was a directory rather than a regular file, + # the server will return a FAILED_PRECONDITION. If the action does not produce + # the requested output, then that output will be omitted from the list. The + # server is free to arrange the output list as desired; clients MUST NOT assume + # that the output list is sorted. # Corresponds to the JSON property `outputFiles` # @return [Array] attr_accessor :output_files - # New in v2.1: this field will only be populated if the command - # `output_paths` field was used, and not the pre v2.1 `output_files` or - # `output_directories` fields. - # The output paths of the action that are symbolic links to other paths. Those - # may be links to other outputs, or inputs, or even absolute paths - # outside of the working directory, if the server supports - # SymlinkAbsolutePathStrategy.ALLOWED. - # A single entry for each output requested in `output_paths` - # field of the Action, if the corresponding path existed after - # the action completed and was a symbolic link. - # If the action does not produce a requested output, then that output - # will be omitted from the list. The server is free to arrange the output - # list as desired; clients MUST NOT assume that the output list is sorted. + # New in v2.1: this field will only be populated if the command `output_paths` + # field was used, and not the pre v2.1 `output_files` or `output_directories` + # fields. The output paths of the action that are symbolic links to other paths. + # Those may be links to other outputs, or inputs, or even absolute paths outside + # of the working directory, if the server supports SymlinkAbsolutePathStrategy. + # ALLOWED. A single entry for each output requested in `output_paths` field of + # the Action, if the corresponding path existed after the action completed and + # was a symbolic link. If the action does not produce a requested output, then + # that output will be omitted from the list. The server is free to arrange the + # output list as desired; clients MUST NOT assume that the output list is sorted. # Corresponds to the JSON property `outputSymlinks` # @return [Array] attr_accessor :output_symlinks # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `stderrDigest` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest] attr_accessor :stderr_digest - # The standard error buffer of the action. The server SHOULD NOT inline - # stderr unless requested by the client in the - # GetActionResultRequest - # message. The server MAY omit inlining, even if requested, and MUST do so if - # inlining - # would cause the response to exceed message size limits. + # The standard error buffer of the action. The server SHOULD NOT inline stderr + # unless requested by the client in the GetActionResultRequest message. The + # server MAY omit inlining, even if requested, and MUST do so if inlining would + # cause the response to exceed message size limits. # Corresponds to the JSON property `stderrRaw` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :stderr_raw # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `stdoutDigest` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest] attr_accessor :stdout_digest - # The standard output buffer of the action. The server SHOULD NOT inline - # stdout unless requested by the client in the - # GetActionResultRequest - # message. The server MAY omit inlining, even if requested, and MUST do so if - # inlining - # would cause the response to exceed message size limits. + # The standard output buffer of the action. The server SHOULD NOT inline stdout + # unless requested by the client in the GetActionResultRequest message. The + # server MAY omit inlining, even if requested, and MUST do so if inlining would + # cause the response to exceed message size limits. # Corresponds to the JSON property `stdoutRaw` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -427,8 +358,7 @@ module Google end end - # A request message for - # ContentAddressableStorage.BatchReadBlobs. + # A request message for ContentAddressableStorage.BatchReadBlobs. class BuildBazelRemoteExecutionV2BatchReadBlobsRequest include Google::Apis::Core::Hashable @@ -447,8 +377,7 @@ module Google end end - # A response message for - # ContentAddressableStorage.BatchReadBlobs. + # A response message for ContentAddressableStorage.BatchReadBlobs. class BuildBazelRemoteExecutionV2BatchReadBlobsResponse include Google::Apis::Core::Hashable @@ -478,41 +407,39 @@ module Google attr_accessor :data # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest] attr_accessor :digest - # 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::RemotebuildexecutionV2::GoogleRpcStatus] attr_accessor :status @@ -529,8 +456,7 @@ module Google end end - # A request message for - # ContentAddressableStorage.BatchUpdateBlobs. + # A request message for ContentAddressableStorage.BatchUpdateBlobs. class BuildBazelRemoteExecutionV2BatchUpdateBlobsRequest include Google::Apis::Core::Hashable @@ -560,31 +486,29 @@ module Google attr_accessor :data # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest] attr_accessor :digest @@ -600,8 +524,7 @@ module Google end end - # A response message for - # ContentAddressableStorage.BatchUpdateBlobs. + # A response message for ContentAddressableStorage.BatchUpdateBlobs. class BuildBazelRemoteExecutionV2BatchUpdateBlobsResponse include Google::Apis::Core::Hashable @@ -625,41 +548,39 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest] attr_accessor :digest - # 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::RemotebuildexecutionV2::GoogleRpcStatus] attr_accessor :status @@ -684,23 +605,21 @@ module Google # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ActionCacheUpdateCapabilities] attr_accessor :action_cache_update_capabilities - # Allowed values for priority in - # ResultsCachePolicy - # Used for querying both cache and execution valid priority ranges. + # Allowed values for priority in ResultsCachePolicy Used for querying both cache + # and execution valid priority ranges. # Corresponds to the JSON property `cachePriorityCapabilities` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2PriorityCapabilities] attr_accessor :cache_priority_capabilities - # All the digest functions supported by the remote cache. - # Remote cache may support multiple digest functions simultaneously. + # All the digest functions supported by the remote cache. Remote cache may + # support multiple digest functions simultaneously. # Corresponds to the JSON property `digestFunction` # @return [Array] attr_accessor :digest_function - # Maximum total size of blobs to be uploaded/downloaded using - # batch methods. A value of 0 means no limit is set, although - # in practice there will always be a message size limitation - # of the protocol in use, e.g. GRPC. + # Maximum total size of blobs to be uploaded/downloaded using batch methods. A + # value of 0 means no limit is set, although in practice there will always be a + # message size limitation of the protocol in use, e.g. GRPC. # Corresponds to the JSON property `maxBatchTotalSizeBytes` # @return [Fixnum] attr_accessor :max_batch_total_size_bytes @@ -724,12 +643,11 @@ module Google end end - # A `Command` is the actual command executed by a worker running an - # Action and specifications of its - # environment. - # Except as otherwise required, the environment (such as which system - # libraries or binaries are available, and what filesystems are mounted where) - # is defined by and specific to the implementation of the remote execution API. + # A `Command` is the actual command executed by a worker running an Action and + # specifications of its environment. Except as otherwise required, the + # environment (such as which system libraries or binaries are available, and + # what filesystems are mounted where) is defined by and specific to the + # implementation of the remote execution API. class BuildBazelRemoteExecutionV2Command include Google::Apis::Core::Hashable @@ -742,105 +660,90 @@ module Google # The environment variables to set when running the program. The worker may # provide its own default environment variables; these defaults can be - # overridden using this field. Additional variables can also be specified. - # In order to ensure that equivalent - # Commands always hash to the same - # value, the environment variables MUST be lexicographically sorted by name. - # Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. + # overridden using this field. Additional variables can also be specified. In + # order to ensure that equivalent Commands always hash to the same value, the + # environment variables MUST be lexicographically sorted by name. Sorting of + # strings is done by code point, equivalently, by the UTF-8 bytes. # Corresponds to the JSON property `environmentVariables` # @return [Array] attr_accessor :environment_variables - # A list of the output directories that the client expects to retrieve from - # the action. Only the listed directories will be returned (an entire - # directory structure will be returned as a - # Tree message digest, see - # OutputDirectory), as - # well as files listed in `output_files`. Other files or directories that - # may be created during command execution are discarded. - # The paths are relative to the working directory of the action execution. - # The paths are specified using a single forward slash (`/`) as a path - # separator, even if the execution platform natively uses a different - # separator. The path MUST NOT include a trailing slash, nor a leading slash, - # being a relative path. The special value of empty string is allowed, - # although not recommended, and can be used to capture the entire working - # directory tree, including inputs. - # In order to ensure consistent hashing of the same Action, the output paths - # MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 - # bytes). - # An output directory cannot be duplicated or have the same path as any of - # the listed output files. An output directory is allowed to be a parent of - # another output directory. + # A list of the output directories that the client expects to retrieve from the + # action. Only the listed directories will be returned (an entire directory + # structure will be returned as a Tree message digest, see OutputDirectory), as + # well as files listed in `output_files`. Other files or directories that may be + # created during command execution are discarded. The paths are relative to the + # working directory of the action execution. The paths are specified using a + # single forward slash (`/`) as a path separator, even if the execution platform + # natively uses a different separator. The path MUST NOT include a trailing + # slash, nor a leading slash, being a relative path. The special value of empty + # string is allowed, although not recommended, and can be used to capture the + # entire working directory tree, including inputs. In order to ensure consistent + # hashing of the same Action, the output paths MUST be sorted lexicographically + # by code point (or, equivalently, by UTF-8 bytes). An output directory cannot + # be duplicated or have the same path as any of the listed output files. An + # output directory is allowed to be a parent of another output directory. # Directories leading up to the output directories (but not the output - # directories themselves) are created by the worker prior to execution, even - # if they are not explicitly part of the input root. - # DEPRECATED since 2.1: Use `output_paths` instead. + # directories themselves) are created by the worker prior to execution, even if + # they are not explicitly part of the input root. DEPRECATED since 2.1: Use ` + # output_paths` instead. # Corresponds to the JSON property `outputDirectories` # @return [Array] attr_accessor :output_directories - # A list of the output files that the client expects to retrieve from the - # action. Only the listed files, as well as directories listed in - # `output_directories`, will be returned to the client as output. - # Other files or directories that may be created during command execution - # are discarded. - # The paths are relative to the working directory of the action execution. - # The paths are specified using a single forward slash (`/`) as a path - # separator, even if the execution platform natively uses a different - # separator. The path MUST NOT include a trailing slash, nor a leading slash, - # being a relative path. - # In order to ensure consistent hashing of the same Action, the output paths - # MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 - # bytes). - # An output file cannot be duplicated, be a parent of another output file, or - # have the same path as any of the listed output directories. - # Directories leading up to the output files are created by the worker prior - # to execution, even if they are not explicitly part of the input root. - # DEPRECATED since v2.1: Use `output_paths` instead. + # A list of the output files that the client expects to retrieve from the action. + # Only the listed files, as well as directories listed in `output_directories`, + # will be returned to the client as output. Other files or directories that may + # be created during command execution are discarded. The paths are relative to + # the working directory of the action execution. The paths are specified using a + # single forward slash (`/`) as a path separator, even if the execution platform + # natively uses a different separator. The path MUST NOT include a trailing + # slash, nor a leading slash, being a relative path. In order to ensure + # consistent hashing of the same Action, the output paths MUST be sorted + # lexicographically by code point (or, equivalently, by UTF-8 bytes). An output + # file cannot be duplicated, be a parent of another output file, or have the + # same path as any of the listed output directories. Directories leading up to + # the output files are created by the worker prior to execution, even if they + # are not explicitly part of the input root. DEPRECATED since v2.1: Use ` + # output_paths` instead. # Corresponds to the JSON property `outputFiles` # @return [Array] attr_accessor :output_files - # A list of the output paths that the client expects to retrieve from the - # action. Only the listed paths will be returned to the client as output. - # The type of the output (file or directory) is not specified, and will be - # determined by the server after action execution. If the resulting path is - # a file, it will be returned in an - # OutputFile) typed field. - # If the path is a directory, the entire directory structure will be returned - # as a Tree message digest, see - # OutputDirectory) - # Other files or directories that may be created during command execution - # are discarded. - # The paths are relative to the working directory of the action execution. - # The paths are specified using a single forward slash (`/`) as a path - # separator, even if the execution platform natively uses a different - # separator. The path MUST NOT include a trailing slash, nor a leading slash, - # being a relative path. - # In order to ensure consistent hashing of the same Action, the output paths - # MUST be deduplicated and sorted lexicographically by code point (or, - # equivalently, by UTF-8 bytes). - # Directories leading up to the output paths are created by the worker prior - # to execution, even if they are not explicitly part of the input root. - # New in v2.1: this field supersedes the DEPRECATED `output_files` and - # `output_directories` fields. If `output_paths` is used, `output_files` and - # `output_directories` will be ignored! + # A list of the output paths that the client expects to retrieve from the action. + # Only the listed paths will be returned to the client as output. The type of + # the output (file or directory) is not specified, and will be determined by the + # server after action execution. If the resulting path is a file, it will be + # returned in an OutputFile) typed field. If the path is a directory, the entire + # directory structure will be returned as a Tree message digest, see + # OutputDirectory) Other files or directories that may be created during command + # execution are discarded. The paths are relative to the working directory of + # the action execution. The paths are specified using a single forward slash (`/` + # ) as a path separator, even if the execution platform natively uses a + # different separator. The path MUST NOT include a trailing slash, nor a leading + # slash, being a relative path. In order to ensure consistent hashing of the + # same Action, the output paths MUST be deduplicated and sorted + # lexicographically by code point (or, equivalently, by UTF-8 bytes). + # Directories leading up to the output paths are created by the worker prior to + # execution, even if they are not explicitly part of the input root. New in v2.1: + # this field supersedes the DEPRECATED `output_files` and `output_directories` + # fields. If `output_paths` is used, `output_files` and `output_directories` + # will be ignored! # Corresponds to the JSON property `outputPaths` # @return [Array] attr_accessor :output_paths # A `Platform` is a set of requirements, such as hardware, operating system, or - # compiler toolchain, for an - # Action's execution - # environment. A `Platform` is represented as a series of key-value pairs - # representing the properties that are required of the platform. + # compiler toolchain, for an Action's execution environment. A `Platform` is + # represented as a series of key-value pairs representing the properties that + # are required of the platform. # Corresponds to the JSON property `platform` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Platform] attr_accessor :platform - # The working directory, relative to the input root, for the command to run - # in. It must be a directory which exists in the input tree. If it is left - # empty, then the action is run in the input root. + # The working directory, relative to the input root, for the command to run in. + # It must be a directory which exists in the input tree. If it is left empty, + # then the action is run in the input root. # Corresponds to the JSON property `workingDirectory` # @return [String] attr_accessor :working_directory @@ -888,31 +791,29 @@ module Google end # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. class BuildBazelRemoteExecutionV2Digest include Google::Apis::Core::Hashable @@ -939,75 +840,31 @@ module Google end # A `Directory` represents a directory node in a file tree, containing zero or - # more children FileNodes, - # DirectoryNodes and - # SymlinkNodes. - # Each `Node` contains its name in the directory, either the digest of its - # content (either a file blob or a `Directory` proto) or a symlink target, as - # well as possibly some metadata about the file or directory. - # In order to ensure that two equivalent directory trees hash to the same - # value, the following restrictions MUST be obeyed when constructing a - # a `Directory`: - # * Every child in the directory must have a path of exactly one segment. - # Multiple levels of directory hierarchy may not be collapsed. - # * Each child in the directory must have a unique path segment (file name). - # Note that while the API itself is case-sensitive, the environment where - # the Action is executed may or may not be case-sensitive. That is, it is - # legal to call the API with a Directory that has both "Foo" and "foo" as - # children, but the Action may be rejected by the remote system upon - # execution. - # * The files, directories and symlinks in the directory must each be sorted - # in lexicographical order by path. The path strings must be sorted by code - # point, equivalently, by UTF-8 bytes. - # * The NodeProperties of files, - # directories, and symlinks must be sorted in lexicographical order by - # property name. - # A `Directory` that obeys the restrictions is said to be in canonical form. - # As an example, the following could be used for a file named `bar` and a + # more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains + # its name in the directory, either the digest of its content (either a file + # blob or a `Directory` proto) or a symlink target, as well as possibly some + # metadata about the file or directory. In order to ensure that two equivalent + # directory trees hash to the same value, the following restrictions MUST be + # obeyed when constructing a a `Directory`: * Every child in the directory must + # have a path of exactly one segment. Multiple levels of directory hierarchy may + # not be collapsed. * Each child in the directory must have a unique path + # segment (file name). Note that while the API itself is case-sensitive, the + # environment where the Action is executed may or may not be case-sensitive. + # That is, it is legal to call the API with a Directory that has both "Foo" and " + # foo" as children, but the Action may be rejected by the remote system upon + # execution. * The files, directories and symlinks in the directory must each be + # sorted in lexicographical order by path. The path strings must be sorted by + # code point, equivalently, by UTF-8 bytes. * The NodeProperties of files, + # directories, and symlinks must be sorted in lexicographical order by property + # name. A `Directory` that obeys the restrictions is said to be in canonical + # form. As an example, the following could be used for a file named `bar` and a # directory named `foo` with an executable file named `baz` (hashes shortened - # for readability): - # ```json - # // (Directory proto) - # ` - # files: [ - # ` - # name: "bar", - # digest: ` - # hash: "4a73bc9d03...", - # size: 65534 - # `, - # node_properties: [ - # ` - # "name": "MTime", - # "value": "2017-01-15T01:30:15.01Z" - # ` - # ] - # ` - # ], - # directories: [ - # ` - # name: "foo", - # digest: ` - # hash: "4cf2eda940...", - # size: 43 - # ` - # ` - # ] - # ` - # // (Directory proto with hash "4cf2eda940..." and size 43) - # ` - # files: [ - # ` - # name: "baz", - # digest: ` - # hash: "b2c941073e...", - # size: 1294, - # `, - # is_executable: true - # ` - # ] - # ` - # ``` + # for readability): ```json // (Directory proto) ` files: [ ` name: "bar", + # digest: ` hash: "4a73bc9d03...", size: 65534 `, node_properties: [ ` "name": " + # MTime", "value": "2017-01-15T01:30:15.01Z" ` ] ` ], directories: [ ` name: " + # foo", digest: ` hash: "4cf2eda940...", size: 43 ` ` ] ` // (Directory proto + # with hash "4cf2eda940..." and size 43) ` files: [ ` name: "baz", digest: ` + # hash: "b2c941073e...", size: 1294, `, is_executable: true ` ] ` ``` class BuildBazelRemoteExecutionV2Directory include Google::Apis::Core::Hashable @@ -1044,38 +901,35 @@ module Google end end - # A `DirectoryNode` represents a child of a - # Directory which is itself - # a `Directory` and its associated metadata. + # A `DirectoryNode` represents a child of a Directory which is itself a ` + # Directory` and its associated metadata. class BuildBazelRemoteExecutionV2DirectoryNode include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest] attr_accessor :digest @@ -1096,40 +950,35 @@ module Google end end - # Metadata about an ongoing - # execution, which - # will be contained in the metadata - # field of the - # Operation. + # Metadata about an ongoing execution, which will be contained in the metadata + # field of the Operation. class BuildBazelRemoteExecutionV2ExecuteOperationMetadata include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `actionDigest` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest] attr_accessor :action_digest @@ -1139,15 +988,13 @@ module Google # @return [String] attr_accessor :stage - # If set, the client can use this name with - # ByteStream.Read to stream the + # If set, the client can use this name with ByteStream.Read to stream the # standard error. # Corresponds to the JSON property `stderrStreamName` # @return [String] attr_accessor :stderr_stream_name - # If set, the client can use this name with - # ByteStream.Read to stream the + # If set, the client can use this name with ByteStream.Read to stream the # standard output. # Corresponds to the JSON property `stdoutStreamName` # @return [String] @@ -1166,37 +1013,34 @@ module Google end end - # A request message for - # Execution.Execute. + # A request message for Execution.Execute. class BuildBazelRemoteExecutionV2ExecuteRequest include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `actionDigest` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest] attr_accessor :action_digest @@ -1212,19 +1056,17 @@ module Google # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ResultsCachePolicy] attr_accessor :results_cache_policy - # If true, the action will be executed even if its result is already - # present in the ActionCache. - # The execution is still allowed to be merged with other in-flight executions - # of the same action, however - semantically, the service MUST only guarantee - # that the results of an execution with this field set were not visible - # before the corresponding execution request was sent. - # Note that actions from execution requests setting this field set are still - # eligible to be entered into the action cache upon completion, and services - # SHOULD overwrite any existing entries that may exist. This allows - # skip_cache_lookup requests to be used as a mechanism for replacing action - # cache entries that reference outputs no longer available or that are - # poisoned in any way. - # If false, the result may be served from the action cache. + # If true, the action will be executed even if its result is already present in + # the ActionCache. The execution is still allowed to be merged with other in- + # flight executions of the same action, however - semantically, the service MUST + # only guarantee that the results of an execution with this field set were not + # visible before the corresponding execution request was sent. Note that actions + # from execution requests setting this field set are still eligible to be + # entered into the action cache upon completion, and services SHOULD overwrite + # any existing entries that may exist. This allows skip_cache_lookup requests to + # be used as a mechanism for replacing action cache entries that reference + # outputs no longer available or that are poisoned in any way. If false, the + # result may be served from the action cache. # Corresponds to the JSON property `skipCacheLookup` # @return [Boolean] attr_accessor :skip_cache_lookup @@ -1243,11 +1085,8 @@ module Google end end - # The response message for - # Execution.Execute, - # which will be contained in the response - # field of the - # Operation. + # The response message for Execution.Execute, which will be contained in the + # response field of the Operation. class BuildBazelRemoteExecutionV2ExecuteResponse include Google::Apis::Core::Hashable @@ -1263,29 +1102,27 @@ module Google # @return [String] attr_accessor :message - # An ActionResult represents the result of an - # Action being run. + # An ActionResult represents the result of an Action being run. # Corresponds to the JSON property `result` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ActionResult] attr_accessor :result # An optional list of additional log outputs the server wishes to provide. A - # server can use this to return execution-specific logs however it wishes. - # This is intended primarily to make it easier for users to debug issues that - # may be outside of the actual job execution, such as by identifying the - # worker executing the action or by providing logs from the worker's setup - # phase. The keys SHOULD be human readable so that a client can display them - # to a user. + # server can use this to return execution-specific logs however it wishes. This + # is intended primarily to make it easier for users to debug issues that may be + # outside of the actual job execution, such as by identifying the worker + # executing the action or by providing logs from the worker's setup phase. The + # keys SHOULD be human readable so that a client can display them to a user. # Corresponds to the JSON property `serverLogs` # @return [Hash] attr_accessor :server_logs - # 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::RemotebuildexecutionV2::GoogleRpcStatus] attr_accessor :status @@ -1392,9 +1229,8 @@ module Google attr_accessor :exec_enabled alias_method :exec_enabled?, :exec_enabled - # Allowed values for priority in - # ResultsCachePolicy - # Used for querying both cache and execution valid priority ranges. + # Allowed values for priority in ResultsCachePolicy Used for querying both cache + # and execution valid priority ranges. # Corresponds to the JSON property `executionPriorityCapabilities` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2PriorityCapabilities] attr_accessor :execution_priority_capabilities @@ -1423,13 +1259,12 @@ module Google # The priority (relative importance) of this action. Generally, a lower value # means that the action should be run sooner than actions having a greater - # priority value, but the interpretation of a given value is server- - # dependent. A priority of 0 means the *default* priority. Priorities may be - # positive or negative, and such actions should run later or sooner than - # actions having the default priority, respectively. The particular semantics - # of this field is up to the server. In particular, every server will have - # their own supported range of priorities, and will decide how these map into - # scheduling policy. + # priority value, but the interpretation of a given value is server- dependent. + # A priority of 0 means the *default* priority. Priorities may be positive or + # negative, and such actions should run later or sooner than actions having the + # default priority, respectively. The particular semantics of this field is up + # to the server. In particular, every server will have their own supported range + # of priorities, and will decide how these map into scheduling policy. # Corresponds to the JSON property `priority` # @return [Fixnum] attr_accessor :priority @@ -1449,31 +1284,29 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest] attr_accessor :digest @@ -1507,8 +1340,7 @@ module Google end end - # A request message for - # ContentAddressableStorage.FindMissingBlobs. + # A request message for ContentAddressableStorage.FindMissingBlobs. class BuildBazelRemoteExecutionV2FindMissingBlobsRequest include Google::Apis::Core::Hashable @@ -1527,8 +1359,7 @@ module Google end end - # A response message for - # ContentAddressableStorage.FindMissingBlobs. + # A response message for ContentAddressableStorage.FindMissingBlobs. class BuildBazelRemoteExecutionV2FindMissingBlobsResponse include Google::Apis::Core::Hashable @@ -1547,8 +1378,7 @@ module Google end end - # A response message for - # ContentAddressableStorage.GetTree. + # A response message for ContentAddressableStorage.GetTree. class BuildBazelRemoteExecutionV2GetTreeResponse include Google::Apis::Core::Hashable @@ -1558,9 +1388,8 @@ module Google attr_accessor :directories # If present, signifies that there are more results which the client can - # retrieve by passing this as the page_token in a subsequent - # request. - # If empty, signifies that this is the last page of results. + # retrieve by passing this as the page_token in a subsequent request. If empty, + # signifies that this is the last page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1581,40 +1410,38 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest] attr_accessor :digest - # This is a hint as to the purpose of the log, and is set to true if the log - # is human-readable text that can be usefully displayed to a user, and false - # otherwise. For instance, if a command-line client wishes to print the - # server logs to the terminal for a failed action, this allows it to avoid - # displaying a binary file. + # This is a hint as to the purpose of the log, and is set to true if the log is + # human-readable text that can be usefully displayed to a user, and false + # otherwise. For instance, if a command-line client wishes to print the server + # logs to the terminal for a failed action, this allows it to avoid displaying a + # binary file. # Corresponds to the JSON property `humanReadable` # @return [Boolean] attr_accessor :human_readable @@ -1631,10 +1458,8 @@ module Google end end - # A single property for FileNodes, - # DirectoryNodes, and - # SymlinkNodes. The server is - # responsible for specifying the property `name`s that it accepts. If + # A single property for FileNodes, DirectoryNodes, and SymlinkNodes. The server + # is responsible for specifying the property `name`s that it accepts. If # permitted by the server, the same `name` may occur multiple times. class BuildBazelRemoteExecutionV2NodeProperty include Google::Apis::Core::Hashable @@ -1666,39 +1491,37 @@ module Google include Google::Apis::Core::Hashable # The full path of the directory relative to the working directory. The path - # separator is a forward slash `/`. Since this is a relative path, it MUST - # NOT begin with a leading forward slash. The empty string value is allowed, - # and it denotes the entire working directory. + # separator is a forward slash `/`. Since this is a relative path, it MUST NOT + # begin with a leading forward slash. The empty string value is allowed, and it + # denotes the entire working directory. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `treeDigest` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest] attr_accessor :tree_digest @@ -1714,51 +1537,45 @@ module Google end end - # An `OutputFile` is similar to a - # FileNode, but it is used as an - # output in an `ActionResult`. It allows a full file path rather than - # only a name. + # An `OutputFile` is similar to a FileNode, but it is used as an output in an ` + # ActionResult`. It allows a full file path rather than only a name. class BuildBazelRemoteExecutionV2OutputFile include Google::Apis::Core::Hashable # The contents of the file if inlining was requested. The server SHOULD NOT - # inline - # file contents unless requested by the client in the - # GetActionResultRequest - # message. The server MAY omit inlining, even if requested, and MUST do so if - # inlining - # would cause the response to exceed message size limits. + # inline file contents unless requested by the client in the + # GetActionResultRequest message. The server MAY omit inlining, even if + # requested, and MUST do so if inlining would cause the response to exceed + # message size limits. # Corresponds to the JSON property `contents` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :contents # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server. - # The size is considered to be an integral part of the digest and cannot be - # separated. That is, even if the `hash` field is correctly specified but - # `size_bytes` is not, the server MUST reject the request. - # The reason for including the size in the digest is as follows: in a great - # many cases, the server needs to know the size of the blob it is about to work - # with prior to starting an operation with it, such as flattening Merkle tree - # structures or streaming it to a worker. Technically, the server could - # implement a separate metadata store, but this results in a significantly more - # complicated implementation as opposed to having the client specify the size - # up-front (or storing the size along with the digest in every message where - # digests are embedded). This does mean that the API leaks some implementation - # details of (what we consider to be) a reasonable server implementation, but - # we consider this to be a worthwhile tradeoff. - # When a `Digest` is used to refer to a proto message, it always refers to the - # message in binary encoded form. To ensure consistent hashing, clients and - # servers MUST ensure that they serialize messages according to the following - # rules, even if there are alternate valid encodings for the same message: - # * Fields are serialized in tag order. - # * There are no unknown fields. - # * There are no duplicate fields. - # * Fields are serialized according to the default semantics for their type. - # Most protocol buffer implementations will always follow these rules when - # serializing, but care should be taken to avoid shortcuts. For instance, - # concatenating two messages to merge them may produce duplicate fields. + # and its hash. The hash algorithm to use is defined by the server. The size is + # considered to be an integral part of the digest and cannot be separated. That + # is, even if the `hash` field is correctly specified but `size_bytes` is not, + # the server MUST reject the request. The reason for including the size in the + # digest is as follows: in a great many cases, the server needs to know the size + # of the blob it is about to work with prior to starting an operation with it, + # such as flattening Merkle tree structures or streaming it to a worker. + # Technically, the server could implement a separate metadata store, but this + # results in a significantly more complicated implementation as opposed to + # having the client specify the size up-front (or storing the size along with + # the digest in every message where digests are embedded). This does mean that + # the API leaks some implementation details of (what we consider to be) a + # reasonable server implementation, but we consider this to be a worthwhile + # tradeoff. When a `Digest` is used to refer to a proto message, it always + # refers to the message in binary encoded form. To ensure consistent hashing, + # clients and servers MUST ensure that they serialize messages according to the + # following rules, even if there are alternate valid encodings for the same + # message: * Fields are serialized in tag order. * There are no unknown fields. * + # There are no duplicate fields. * Fields are serialized according to the + # default semantics for their type. Most protocol buffer implementations will + # always follow these rules when serializing, but care should be taken to avoid + # shortcuts. For instance, concatenating two messages to merge them may produce + # duplicate fields. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest] attr_accessor :digest @@ -1775,8 +1592,8 @@ module Google attr_accessor :node_properties # The full path of the file relative to the working directory, including the - # filename. The path separator is a forward slash `/`. Since this is a - # relative path, it MUST NOT begin with a leading forward slash. + # filename. The path separator is a forward slash `/`. Since this is a relative + # path, it MUST NOT begin with a leading forward slash. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path @@ -1795,32 +1612,29 @@ module Google end end - # An `OutputSymlink` is similar to a - # Symlink, but it is used as an - # output in an `ActionResult`. - # `OutputSymlink` is binary-compatible with `SymlinkNode`. + # An `OutputSymlink` is similar to a Symlink, but it is used as an output in an ` + # ActionResult`. `OutputSymlink` is binary-compatible with `SymlinkNode`. class BuildBazelRemoteExecutionV2OutputSymlink include Google::Apis::Core::Hashable - # The supported node properties of the OutputSymlink, if requested by the - # Action. + # The supported node properties of the OutputSymlink, if requested by the Action. # Corresponds to the JSON property `nodeProperties` # @return [Array] attr_accessor :node_properties # The full path of the symlink relative to the working directory, including the - # filename. The path separator is a forward slash `/`. Since this is a - # relative path, it MUST NOT begin with a leading forward slash. + # filename. The path separator is a forward slash `/`. Since this is a relative + # path, it MUST NOT begin with a leading forward slash. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path - # The target path of the symlink. The path separator is a forward slash `/`. - # The target path can be relative to the parent directory of the symlink or - # it can be an absolute path starting with `/`. Support for absolute paths - # can be checked using the Capabilities - # API. The canonical form forbids the substrings `/./` and `//` in the target - # path. `..` components are allowed anywhere in the target path. + # The target path of the symlink. The path separator is a forward slash `/`. The + # target path can be relative to the parent directory of the symlink or it can + # be an absolute path starting with `/`. Support for absolute paths can be + # checked using the Capabilities API. The canonical form forbids the substrings ` + # /./` and `//` in the target path. `..` components are allowed anywhere in the + # target path. # Corresponds to the JSON property `target` # @return [String] attr_accessor :target @@ -1838,17 +1652,16 @@ module Google end # A `Platform` is a set of requirements, such as hardware, operating system, or - # compiler toolchain, for an - # Action's execution - # environment. A `Platform` is represented as a series of key-value pairs - # representing the properties that are required of the platform. + # compiler toolchain, for an Action's execution environment. A `Platform` is + # represented as a series of key-value pairs representing the properties that + # are required of the platform. class BuildBazelRemoteExecutionV2Platform include Google::Apis::Core::Hashable - # The properties that make up this platform. In order to ensure that - # equivalent `Platform`s always hash to the same value, the properties MUST - # be lexicographically sorted by name, and then by value. Sorting of strings - # is done by code point, equivalently, by the UTF-8 bytes. + # The properties that make up this platform. In order to ensure that equivalent ` + # Platform`s always hash to the same value, the properties MUST be + # lexicographically sorted by name, and then by value. Sorting of strings is + # done by code point, equivalently, by the UTF-8 bytes. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -1865,19 +1678,16 @@ module Google # A single property for the environment. The server is responsible for # specifying the property `name`s that it accepts. If an unknown `name` is - # provided in the requirements for an - # Action, the server SHOULD - # reject the execution request. If permitted by the server, the same `name` - # may occur multiple times. - # The server is also responsible for specifying the interpretation of - # property `value`s. For instance, a property describing how much RAM must be - # available may be interpreted as allowing a worker with 16GB to fulfill a - # request for 8GB, while a property describing the OS environment on which - # the action must be performed may require an exact match with the worker's - # OS. - # The server MAY use the `value` of one or more properties to determine how - # it sets up the execution environment, such as by making specific system - # files available to the worker. + # provided in the requirements for an Action, the server SHOULD reject the + # execution request. If permitted by the server, the same `name` may occur + # multiple times. The server is also responsible for specifying the + # interpretation of property `value`s. For instance, a property describing how + # much RAM must be available may be interpreted as allowing a worker with 16GB + # to fulfill a request for 8GB, while a property describing the OS environment + # on which the action must be performed may require an exact match with the + # worker's OS. The server MAY use the `value` of one or more properties to + # determine how it sets up the execution environment, such as by making specific + # system files available to the worker. class BuildBazelRemoteExecutionV2PlatformProperty include Google::Apis::Core::Hashable @@ -1902,9 +1712,8 @@ module Google end end - # Allowed values for priority in - # ResultsCachePolicy - # Used for querying both cache and execution valid priority ranges. + # Allowed values for priority in ResultsCachePolicy Used for querying both cache + # and execution valid priority ranges. class BuildBazelRemoteExecutionV2PriorityCapabilities include Google::Apis::Core::Hashable @@ -1951,27 +1760,25 @@ module Google # An optional Metadata to attach to any RPC request to tell the server about an # external context of the request. The server may use this for logging or other # purposes. To use it, the client attaches the header to the call using the - # canonical proto serialization: - # * name: `build.bazel.remote.execution.v2.requestmetadata-bin` - # * contents: the base64 encoded binary `RequestMetadata` message. - # Note: the gRPC library serializes binary headers encoded in base 64 by - # default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md# - # requests). - # Therefore, if the gRPC library is used to pass/retrieve this + # canonical proto serialization: * name: `build.bazel.remote.execution.v2. + # requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` + # message. Note: the gRPC library serializes binary headers encoded in base 64 + # by default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md# + # requests). Therefore, if the gRPC library is used to pass/retrieve this # metadata, the user may ignore the base64 encoding and assume it is simply # serialized as a binary message. class BuildBazelRemoteExecutionV2RequestMetadata include Google::Apis::Core::Hashable - # An identifier that ties multiple requests to the same action. - # For example, multiple requests to the CAS, Action Cache, and Execution - # API are used in order to compile foo.cc. + # An identifier that ties multiple requests to the same action. For example, + # multiple requests to the CAS, Action Cache, and Execution API are used in + # order to compile foo.cc. # Corresponds to the JSON property `actionId` # @return [String] attr_accessor :action_id - # An identifier to tie multiple tool invocations together. For example, - # runs of foo_test, bar_test and baz_test on a post-submit of a given patch. + # An identifier to tie multiple tool invocations together. For example, runs of + # foo_test, bar_test and baz_test on a post-submit of a given patch. # Corresponds to the JSON property `correlatedInvocationsId` # @return [String] attr_accessor :correlated_invocations_id @@ -1981,8 +1788,8 @@ module Google # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ToolDetails] attr_accessor :tool_details - # An identifier that ties multiple actions together to a final result. - # For example, multiple actions are required to build and run foo_test. + # An identifier that ties multiple actions together to a final result. For + # example, multiple actions are required to build and run foo_test. # Corresponds to the JSON property `toolInvocationId` # @return [String] attr_accessor :tool_invocation_id @@ -2006,12 +1813,12 @@ module Google include Google::Apis::Core::Hashable # The priority (relative importance) of this content in the overall cache. - # Generally, a lower value means a longer retention time or other advantage, - # but the interpretation of a given value is server-dependent. A priority of - # 0 means a *default* value, decided by the server. - # The particular semantics of this field is up to the server. In particular, - # every server will have their own supported range of priorities, and will - # decide how these map into retention/eviction policy. + # Generally, a lower value means a longer retention time or other advantage, but + # the interpretation of a given value is server-dependent. A priority of 0 means + # a *default* value, decided by the server. The particular semantics of this + # field is up to the server. In particular, every server will have their own + # supported range of priorities, and will decide how these map into retention/ + # eviction policy. # Corresponds to the JSON property `priority` # @return [Fixnum] attr_accessor :priority @@ -2026,8 +1833,7 @@ module Google end end - # A response message for - # Capabilities.GetCapabilities. + # A response message for Capabilities.GetCapabilities. class BuildBazelRemoteExecutionV2ServerCapabilities include Google::Apis::Core::Hashable @@ -2084,12 +1890,12 @@ module Google # @return [Array] attr_accessor :node_properties - # The target path of the symlink. The path separator is a forward slash `/`. - # The target path can be relative to the parent directory of the symlink or - # it can be an absolute path starting with `/`. Support for absolute paths - # can be checked using the Capabilities - # API. The canonical form forbids the substrings `/./` and `//` in the target - # path. `..` components are allowed anywhere in the target path. + # The target path of the symlink. The path separator is a forward slash `/`. The + # target path can be relative to the parent directory of the symlink or it can + # be an absolute path starting with `/`. Support for absolute paths can be + # checked using the Capabilities API. The canonical form forbids the substrings ` + # /./` and `//` in the target path. `..` components are allowed anywhere in the + # target path. # Corresponds to the JSON property `target` # @return [String] attr_accessor :target @@ -2131,90 +1937,45 @@ module Google end end - # A `Tree` contains all the - # Directory protos in a - # single directory Merkle tree, compressed into one message. + # A `Tree` contains all the Directory protos in a single directory Merkle tree, + # compressed into one message. class BuildBazelRemoteExecutionV2Tree include Google::Apis::Core::Hashable # All the child directories: the directories referred to by the root and, - # recursively, all its children. In order to reconstruct the directory tree, - # the client must take the digests of each of the child directories and then - # build up a tree starting from the `root`. + # recursively, all its children. In order to reconstruct the directory tree, the + # client must take the digests of each of the child directories and then build + # up a tree starting from the `root`. # Corresponds to the JSON property `children` # @return [Array] attr_accessor :children # A `Directory` represents a directory node in a file tree, containing zero or - # more children FileNodes, - # DirectoryNodes and - # SymlinkNodes. - # Each `Node` contains its name in the directory, either the digest of its - # content (either a file blob or a `Directory` proto) or a symlink target, as - # well as possibly some metadata about the file or directory. - # In order to ensure that two equivalent directory trees hash to the same - # value, the following restrictions MUST be obeyed when constructing a - # a `Directory`: - # * Every child in the directory must have a path of exactly one segment. - # Multiple levels of directory hierarchy may not be collapsed. - # * Each child in the directory must have a unique path segment (file name). - # Note that while the API itself is case-sensitive, the environment where - # the Action is executed may or may not be case-sensitive. That is, it is - # legal to call the API with a Directory that has both "Foo" and "foo" as - # children, but the Action may be rejected by the remote system upon - # execution. - # * The files, directories and symlinks in the directory must each be sorted - # in lexicographical order by path. The path strings must be sorted by code - # point, equivalently, by UTF-8 bytes. - # * The NodeProperties of files, - # directories, and symlinks must be sorted in lexicographical order by - # property name. - # A `Directory` that obeys the restrictions is said to be in canonical form. - # As an example, the following could be used for a file named `bar` and a + # more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains + # its name in the directory, either the digest of its content (either a file + # blob or a `Directory` proto) or a symlink target, as well as possibly some + # metadata about the file or directory. In order to ensure that two equivalent + # directory trees hash to the same value, the following restrictions MUST be + # obeyed when constructing a a `Directory`: * Every child in the directory must + # have a path of exactly one segment. Multiple levels of directory hierarchy may + # not be collapsed. * Each child in the directory must have a unique path + # segment (file name). Note that while the API itself is case-sensitive, the + # environment where the Action is executed may or may not be case-sensitive. + # That is, it is legal to call the API with a Directory that has both "Foo" and " + # foo" as children, but the Action may be rejected by the remote system upon + # execution. * The files, directories and symlinks in the directory must each be + # sorted in lexicographical order by path. The path strings must be sorted by + # code point, equivalently, by UTF-8 bytes. * The NodeProperties of files, + # directories, and symlinks must be sorted in lexicographical order by property + # name. A `Directory` that obeys the restrictions is said to be in canonical + # form. As an example, the following could be used for a file named `bar` and a # directory named `foo` with an executable file named `baz` (hashes shortened - # for readability): - # ```json - # // (Directory proto) - # ` - # files: [ - # ` - # name: "bar", - # digest: ` - # hash: "4a73bc9d03...", - # size: 65534 - # `, - # node_properties: [ - # ` - # "name": "MTime", - # "value": "2017-01-15T01:30:15.01Z" - # ` - # ] - # ` - # ], - # directories: [ - # ` - # name: "foo", - # digest: ` - # hash: "4cf2eda940...", - # size: 43 - # ` - # ` - # ] - # ` - # // (Directory proto with hash "4cf2eda940..." and size 43) - # ` - # files: [ - # ` - # name: "baz", - # digest: ` - # hash: "b2c941073e...", - # size: 1294, - # `, - # is_executable: true - # ` - # ] - # ` - # ``` + # for readability): ```json // (Directory proto) ` files: [ ` name: "bar", + # digest: ` hash: "4a73bc9d03...", size: 65534 `, node_properties: [ ` "name": " + # MTime", "value": "2017-01-15T01:30:15.01Z" ` ] ` ], directories: [ ` name: " + # foo", digest: ` hash: "4cf2eda940...", size: 43 ` ` ] ` // (Directory proto + # with hash "4cf2eda940..." and size 43) ` files: [ ` name: "baz", digest: ` + # hash: "b2c941073e...", size: 1294, `, is_executable: true ` ] ` ``` # Corresponds to the JSON property `root` # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Directory] attr_accessor :root @@ -2230,8 +1991,7 @@ module Google end end - # A request message for - # WaitExecution. + # A request message for WaitExecution. class BuildBazelRemoteExecutionV2WaitExecutionRequest include Google::Apis::Core::Hashable @@ -2263,9 +2023,9 @@ module Google # @return [Fixnum] attr_accessor :patch - # The pre-release version. Either this field or major/minor/patch fields - # must be filled. They are mutually exclusive. Pre-release versions are - # assumed to be earlier than any released versions. + # The pre-release version. Either this field or major/minor/patch fields must be + # filled. They are mutually exclusive. Pre-release versions are assumed to be + # earlier than any released versions. # Corresponds to the JSON property `prerelease` # @return [String] attr_accessor :prerelease @@ -2288,8 +2048,8 @@ module Google class GoogleDevtoolsRemotebuildbotCommandDurations include Google::Apis::Core::Hashable - # The time spent preparing the command to be run in a Docker container - # (includes pulling the Docker image, if necessary). + # The time spent preparing the command to be run in a Docker container (includes + # pulling the Docker image, if necessary). # Corresponds to the JSON property `dockerPrep` # @return [String] attr_accessor :docker_prep @@ -2365,13 +2125,13 @@ module Google end end - # CommandEvents contains counters for the number of warnings and errors - # that occurred during the execution of a command. + # CommandEvents contains counters for the number of warnings and errors that + # occurred during the execution of a command. class GoogleDevtoolsRemotebuildbotCommandEvents include Google::Apis::Core::Hashable - # Indicates whether we are using a cached Docker image (true) or had to pull - # the Docker image (false) for this command. + # Indicates whether we are using a cached Docker image (true) or had to pull the + # Docker image (false) for this command. # Corresponds to the JSON property `dockerCacheHit` # @return [Boolean] attr_accessor :docker_cache_hit @@ -2541,28 +2301,24 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest include Google::Apis::Core::Hashable - # Instance conceptually encapsulates all Remote Build Execution resources - # for remote builds. - # An instance consists of storage and compute resources (for example, - # `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for - # running remote builds. - # All Remote Build Execution API calls are scoped to an instance. + # Instance conceptually encapsulates all Remote Build Execution resources for + # remote builds. An instance consists of storage and compute resources (for + # example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for + # running remote builds. All Remote Build Execution API calls are scoped to an + # instance. # Corresponds to the JSON property `instance` # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance] attr_accessor :instance - # ID of the created instance. - # A valid `instance_id` must: - # be 6-50 characters long, - # contain only lowercase letters, digits, hyphens and underscores, - # start with a lowercase letter, and - # end with a lowercase letter or a digit. + # ID of the created instance. A valid `instance_id` must: be 6-50 characters + # long, contain only lowercase letters, digits, hyphens and underscores, start + # with a lowercase letter, and end with a lowercase letter or a digit. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id - # Resource name of the project containing the instance. - # Format: `projects/[PROJECT_ID]`. + # Resource name of the project containing the instance. Format: `projects/[ + # PROJECT_ID]`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -2583,18 +2339,15 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest include Google::Apis::Core::Hashable - # Resource name of the instance in which to create the new worker pool. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Resource name of the instance in which to create the new worker pool. Format: ` + # projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # ID of the created worker pool. - # A valid pool ID must: - # be 6-50 characters long, - # contain only lowercase letters, digits, hyphens and underscores, - # start with a lowercase letter, and - # end with a lowercase letter or a digit. + # ID of the created worker pool. A valid pool ID must: be 6-50 characters long, + # contain only lowercase letters, digits, hyphens and underscores, start with a + # lowercase letter, and end with a lowercase letter or a digit. # Corresponds to the JSON property `poolId` # @return [String] attr_accessor :pool_id @@ -2620,8 +2373,8 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest include Google::Apis::Core::Hashable - # Name of the instance to delete. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2640,9 +2393,8 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest include Google::Apis::Core::Hashable - # Name of the worker pool to delete. - # Format: - # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + # Name of the worker pool to delete. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]/workerpools/[POOL_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2657,12 +2409,107 @@ module Google end end + # FeaturePolicy defines features allowed to be used on RBE instances, as well as + # instance-wide behavior changes that take effect without opt-in or opt-out at + # usage time. + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy + include Google::Apis::Core::Hashable + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `containerImageSources` + # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :container_image_sources + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerAddCapabilities` + # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_add_capabilities + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerChrootPath` + # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_chroot_path + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerNetwork` + # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_network + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerPrivileged` + # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_privileged + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerRunAsRoot` + # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_run_as_root + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerRuntime` + # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_runtime + + # Defines whether a feature can be used or what values are accepted. + # Corresponds to the JSON property `dockerSiblingContainers` + # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature] + attr_accessor :docker_sibling_containers + + # linux_isolation allows overriding the docker runtime used for containers + # started on Linux. + # Corresponds to the JSON property `linuxIsolation` + # @return [String] + attr_accessor :linux_isolation + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @container_image_sources = args[:container_image_sources] if args.key?(:container_image_sources) + @docker_add_capabilities = args[:docker_add_capabilities] if args.key?(:docker_add_capabilities) + @docker_chroot_path = args[:docker_chroot_path] if args.key?(:docker_chroot_path) + @docker_network = args[:docker_network] if args.key?(:docker_network) + @docker_privileged = args[:docker_privileged] if args.key?(:docker_privileged) + @docker_run_as_root = args[:docker_run_as_root] if args.key?(:docker_run_as_root) + @docker_runtime = args[:docker_runtime] if args.key?(:docker_runtime) + @docker_sibling_containers = args[:docker_sibling_containers] if args.key?(:docker_sibling_containers) + @linux_isolation = args[:linux_isolation] if args.key?(:linux_isolation) + end + end + + # Defines whether a feature can be used or what values are accepted. + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature + include Google::Apis::Core::Hashable + + # A list of acceptable values. Only effective when the policy is `RESTRICTED`. + # Corresponds to the JSON property `allowedValues` + # @return [Array] + attr_accessor :allowed_values + + # The policy of the feature. + # Corresponds to the JSON property `policy` + # @return [String] + attr_accessor :policy + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allowed_values = args[:allowed_values] if args.key?(:allowed_values) + @policy = args[:policy] if args.key?(:policy) + end + end + # The request used for `GetInstance`. class GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest include Google::Apis::Core::Hashable - # Name of the instance to retrieve. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2681,9 +2528,8 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest include Google::Apis::Core::Hashable - # Name of the worker pool to retrieve. - # Format: - # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. + # Name of the worker pool to retrieve. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]/workerpools/[POOL_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2698,15 +2544,21 @@ module Google end end - # Instance conceptually encapsulates all Remote Build Execution resources - # for remote builds. - # An instance consists of storage and compute resources (for example, - # `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for - # running remote builds. - # All Remote Build Execution API calls are scoped to an instance. + # Instance conceptually encapsulates all Remote Build Execution resources for + # remote builds. An instance consists of storage and compute resources (for + # example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for + # running remote builds. All Remote Build Execution API calls are scoped to an + # instance. class GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance include Google::Apis::Core::Hashable + # FeaturePolicy defines features allowed to be used on RBE instances, as well as + # instance-wide behavior changes that take effect without opt-in or opt-out at + # usage time. + # Corresponds to the JSON property `featurePolicy` + # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy] + attr_accessor :feature_policy + # The location is a GCP region. Currently only `us-central1` is supported. # Corresponds to the JSON property `location` # @return [String] @@ -2718,10 +2570,9 @@ module Google attr_accessor :logging_enabled alias_method :logging_enabled?, :logging_enabled - # Output only. Instance resource name formatted as: - # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. - # Name should not be populated when creating an instance since it is provided - # in the `instance_id` field. + # Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/ + # instances/[INSTANCE_ID]`. Name should not be populated when creating an + # instance since it is provided in the `instance_id` field. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2737,6 +2588,7 @@ module Google # Update properties of this object def update!(**args) + @feature_policy = args[:feature_policy] if args.key?(:feature_policy) @location = args[:location] if args.key?(:location) @logging_enabled = args[:logging_enabled] if args.key?(:logging_enabled) @name = args[:name] if args.key?(:name) @@ -2748,8 +2600,7 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesRequest include Google::Apis::Core::Hashable - # Resource name of the project. - # Format: `projects/[PROJECT_ID]`. + # Resource name of the project. Format: `projects/[PROJECT_ID]`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -2787,32 +2638,26 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest include Google::Apis::Core::Hashable - # Optional. A filter expression that filters resources listed in - # the response. The expression must specify the field name, a comparison - # operator, and the value that you want to use for filtering. The value - # must be a string, a number, or a boolean. String values are - # case-insensitive. - # The comparison operator must be either `:`, `=`, `!=`, `>`, `>=`, `<=` or - # `<`. - # The `:` operator can be used with string fields to match substrings. - # For non-string fields it is equivalent to the `=` operator. - # The `:*` comparison can be used to test whether a key has been defined. - # You can also filter on nested fields. - # To filter on multiple expressions, you can separate expression using - # `AND` and `OR` operators, using parentheses to specify precedence. If - # neither operator is specified, `AND` is assumed. - # Examples: - # Include only pools with more than 100 reserved workers: - # `(worker_count > 100) (worker_config.reserved = true)` - # Include only pools with a certain label or machines of the n1-standard - # family: + # Optional. A filter expression that filters resources listed in the response. + # The expression must specify the field name, a comparison operator, and the + # value that you want to use for filtering. The value must be a string, a number, + # or a boolean. String values are case-insensitive. The comparison operator + # must be either `:`, `=`, `!=`, `>`, `>=`, `<=` or `<`. The `:` operator can be + # used with string fields to match substrings. For non-string fields it is + # equivalent to the `=` operator. The `:*` comparison can be used to test + # whether a key has been defined. You can also filter on nested fields. To + # filter on multiple expressions, you can separate expression using `AND` and ` + # OR` operators, using parentheses to specify precedence. If neither operator is + # specified, `AND` is assumed. Examples: Include only pools with more than 100 + # reserved workers: `(worker_count > 100) (worker_config.reserved = true)` + # Include only pools with a certain label or machines of the n1-standard family: # `worker_config.labels.key1 : * OR worker_config.machine_type: n1-standard` # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter - # Resource name of the instance. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -2851,36 +2696,33 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest include Google::Apis::Core::Hashable - # Instance conceptually encapsulates all Remote Build Execution resources - # for remote builds. - # An instance consists of storage and compute resources (for example, - # `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for - # running remote builds. - # All Remote Build Execution API calls are scoped to an instance. + # Instance conceptually encapsulates all Remote Build Execution resources for + # remote builds. An instance consists of storage and compute resources (for + # example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for + # running remote builds. All Remote Build Execution API calls are scoped to an + # instance. # Corresponds to the JSON property `instance` # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance] attr_accessor :instance - # Deprecated, use instance.logging_enabled instead. - # Whether to enable Stackdriver logging for this instance. + # Deprecated, use instance.logging_enabled instead. Whether to enable + # Stackdriver logging for this instance. # Corresponds to the JSON property `loggingEnabled` # @return [Boolean] attr_accessor :logging_enabled alias_method :logging_enabled?, :logging_enabled - # Deprecated, use instance.Name instead. - # Name of the instance to update. - # Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + # Deprecated, use instance.Name instead. Name of the instance to update. Format: + # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The update mask applies to instance. For the `FieldMask` definition, see - # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# - # fieldmask - # If an empty update_mask is provided, only the non-default valued field in - # the worker pool field will be updated. Note that in order to update a field - # to the default value (zero, false, empty string) an explicit update_mask + # The update mask applies to instance. For the `FieldMask` definition, see https: + # //developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask If an empty update_mask is provided, only the non-default valued + # field in the worker pool field will be updated. Note that in order to update a + # field to the default value (zero, false, empty string) an explicit update_mask # must be provided. # Corresponds to the JSON property `updateMask` # @return [String] @@ -2903,13 +2745,11 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest include Google::Apis::Core::Hashable - # The update mask applies to worker_pool. For the `FieldMask` definition, - # see + # The update mask applies to worker_pool. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# - # fieldmask - # If an empty update_mask is provided, only the non-default valued field in - # the worker pool field will be updated. Note that in order to update a field - # to the default value (zero, false, empty string) an explicit update_mask + # fieldmask If an empty update_mask is provided, only the non-default valued + # field in the worker pool field will be updated. Note that in order to update a + # field to the default value (zero, false, empty string) an explicit update_mask # must be provided. # Corresponds to the JSON property `updateMask` # @return [String] @@ -2931,8 +2771,7 @@ module Google end end - # Defines the configuration to be used for a creating workers in - # the worker pool. + # Defines the configuration to be used for a creating workers in the worker pool. class GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig include Google::Apis::Core::Hashable @@ -2941,34 +2780,31 @@ module Google # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig] attr_accessor :accelerator - # Required. Size of the disk attached to the worker, in GB. - # See https://cloud.google.com/compute/docs/disks/ + # Required. Size of the disk attached to the worker, in GB. See https://cloud. + # google.com/compute/docs/disks/ # Corresponds to the JSON property `diskSizeGb` # @return [Fixnum] attr_accessor :disk_size_gb - # Required. Disk Type to use for the worker. - # See [Storage - # options](https://cloud.google.com/compute/docs/disks/#introduction). - # Currently only `pd-standard` and `pd-ssd` are supported. + # Required. Disk Type to use for the worker. See [Storage options](https://cloud. + # google.com/compute/docs/disks/#introduction). Currently only `pd-standard` and + # `pd-ssd` are supported. # Corresponds to the JSON property `diskType` # @return [String] attr_accessor :disk_type - # Labels associated with the workers. - # Label keys and values can be no longer than 63 characters, can only contain - # lowercase letters, numeric characters, underscores and dashes. - # International letters are permitted. Label keys must start with a letter. - # Label values are optional. - # There can not be more than 64 labels per resource. + # Labels associated with the workers. Label keys and values can be no longer + # than 63 characters, can only contain lowercase letters, numeric characters, + # underscores and dashes. International letters are permitted. Label keys must + # start with a letter. Label values are optional. There can not be more than 64 + # labels per resource. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Required. Machine type of the worker, such as `n1-standard-2`. - # See https://cloud.google.com/compute/docs/machine-types for a list of - # supported machine types. Note that `f1-micro` and `g1-small` are not yet - # supported. + # Required. Machine type of the worker, such as `n1-standard-2`. See https:// + # cloud.google.com/compute/docs/machine-types for a list of supported machine + # types. Note that `f1-micro` and `g1-small` are not yet supported. # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type @@ -2978,25 +2814,24 @@ module Google # @return [Fixnum] attr_accessor :max_concurrent_actions - # Minimum CPU platform to use when creating the worker. - # See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms). + # Minimum CPU platform to use when creating the worker. See [CPU Platforms]( + # https://cloud.google.com/compute/docs/cpu-platforms). # Corresponds to the JSON property `minCpuPlatform` # @return [String] attr_accessor :min_cpu_platform - # Determines the type of network access granted to workers. Possible values: - # - "public": Workers can connect to the public internet. - # - "private": Workers can only connect to Google APIs and services. - # - "restricted-private": Workers can only connect to Google APIs that are - # reachable through `restricted.googleapis.com` (`199.36.153.4/30`). + # Determines the type of network access granted to workers. Possible values: - " + # public": Workers can connect to the public internet. - "private": Workers can + # only connect to Google APIs and services. - "restricted-private": Workers can + # only connect to Google APIs that are reachable through `restricted.googleapis. + # com` (`199.36.153.4/30`). # Corresponds to the JSON property `networkAccess` # @return [String] attr_accessor :network_access - # Determines whether the worker is reserved (equivalent to a Compute Engine - # on-demand VM and therefore won't be preempted). - # See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for more - # details. + # Determines whether the worker is reserved (equivalent to a Compute Engine on- + # demand VM and therefore won't be preempted). See [Preemptible VMs](https:// + # cloud.google.com/preemptible-vms/) for more details. # Corresponds to the JSON property `reserved` # @return [Boolean] attr_accessor :reserved @@ -3040,10 +2875,9 @@ module Google # @return [String] attr_accessor :channel - # WorkerPool resource name formatted as: - # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. - # name should not be populated when creating a worker pool since it is - # provided in the `poolId` field. + # WorkerPool resource name formatted as: `projects/[PROJECT_ID]/instances/[ + # INSTANCE_ID]/workerpools/[POOL_ID]`. name should not be populated when + # creating a worker pool since it is provided in the `poolId` field. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3053,14 +2887,13 @@ module Google # @return [String] attr_accessor :state - # Defines the configuration to be used for a creating workers in - # the worker pool. + # Defines the configuration to be used for a creating workers in the worker pool. # Corresponds to the JSON property `workerConfig` # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig] attr_accessor :worker_config - # The desired number of workers in the worker pool. Must be a value between - # 0 and 15000. + # The desired number of workers in the worker pool. Must be a value between 0 + # and 15000. # Corresponds to the JSON property `workerCount` # @return [Fixnum] attr_accessor :worker_count @@ -3082,14 +2915,13 @@ module Google # AdminTemp is a prelimiary set of administration tasks. It's called "Temp" # because we do not yet know the best way to represent admin tasks; it's - # possible that this will be entirely replaced in later versions of this API. - # If this message proves to be sufficient, it will be renamed in the alpha or - # beta release of this API. - # This message (suitably marshalled into a protobuf.Any) can be used as the - # inline_assignment field in a lease; the lease assignment field should simply - # be `"admin"` in these cases. - # This message is heavily based on Swarming administration tasks from the LUCI - # project (http://github.com/luci/luci-py/appengine/swarming). + # possible that this will be entirely replaced in later versions of this API. If + # this message proves to be sufficient, it will be renamed in the alpha or beta + # release of this API. This message (suitably marshalled into a protobuf.Any) + # can be used as the inline_assignment field in a lease; the lease assignment + # field should simply be `"admin"` in these cases. This message is heavily based + # on Swarming administration tasks from the LUCI project (http://github.com/luci/ + # luci-py/appengine/swarming). class GoogleDevtoolsRemoteworkersV1test2AdminTemp include Google::Apis::Core::Hashable @@ -3125,13 +2957,12 @@ module Google attr_accessor :contents # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemoteworkersV1test2Digest] attr_accessor :digest @@ -3147,27 +2978,26 @@ module Google end end - # DEPRECATED - use CommandResult instead. - # Describes the actual outputs from the task. + # DEPRECATED - use CommandResult instead. Describes the actual outputs from the + # task. class GoogleDevtoolsRemoteworkersV1test2CommandOutputs include Google::Apis::Core::Hashable # exit_code is only fully reliable if the status' code is OK. If the task - # exceeded its deadline or was cancelled, the process may still produce an - # exit code as it is cancelled, and this will be populated, but a successful - # (zero) is unlikely to be correct unless the status code is OK. + # exceeded its deadline or was cancelled, the process may still produce an exit + # code as it is cancelled, and this will be populated, but a successful (zero) + # is unlikely to be correct unless the status code is OK. # Corresponds to the JSON property `exitCode` # @return [Fixnum] attr_accessor :exit_code # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. # Corresponds to the JSON property `outputs` # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemoteworkersV1test2Digest] attr_accessor :outputs @@ -3183,9 +3013,8 @@ module Google end end - # DEPRECATED - use CommandResult instead. - # Can be used as part of CompleteRequest.metadata, or are part of a more - # sophisticated message. + # DEPRECATED - use CommandResult instead. Can be used as part of CompleteRequest. + # metadata, or are part of a more sophisticated message. class GoogleDevtoolsRemoteworkersV1test2CommandOverhead include Google::Apis::Core::Hashable @@ -3196,8 +3025,8 @@ module Google # @return [String] attr_accessor :duration - # The amount of time *not* spent executing the command (ie - # uploading/downloading files). + # The amount of time *not* spent executing the command (ie uploading/downloading + # files). # Corresponds to the JSON property `overhead` # @return [String] attr_accessor :overhead @@ -3225,46 +3054,44 @@ module Google # @return [String] attr_accessor :duration - # The exit code of the process. An exit code of "0" should only be trusted if - # `status` has a code of OK (otherwise it may simply be unset). + # The exit code of the process. An exit code of "0" should only be trusted if ` + # status` has a code of OK (otherwise it may simply be unset). # Corresponds to the JSON property `exitCode` # @return [Fixnum] attr_accessor :exit_code - # Implementation-dependent metadata about the task. Both servers and bots - # may define messages which can be encoded here; bots are free to provide - # metadata in multiple formats, and servers are free to choose one or more - # of the values to process and ignore others. In particular, it is *not* - # considered an error for the bot to provide the server with a field that it - # doesn't know about. + # Implementation-dependent metadata about the task. Both servers and bots may + # define messages which can be encoded here; bots are free to provide metadata + # in multiple formats, and servers are free to choose one or more of the values + # to process and ignore others. In particular, it is *not* considered an error + # for the bot to provide the server with a field that it doesn't know about. # Corresponds to the JSON property `metadata` # @return [Array>] attr_accessor :metadata # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. # Corresponds to the JSON property `outputs` # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemoteworkersV1test2Digest] attr_accessor :outputs - # The amount of time *not* spent executing the command (ie - # uploading/downloading files). + # The amount of time *not* spent executing the command (ie uploading/downloading + # files). # Corresponds to the JSON property `overhead` # @return [String] attr_accessor :overhead - # 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::RemotebuildexecutionV2::GoogleRpcStatus] attr_accessor :status @@ -3320,14 +3147,13 @@ module Google class GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs include Google::Apis::Core::Hashable - # The command itself to run (e.g., argv). - # This field should be passed directly to the underlying operating system, - # and so it must be sensible to that operating system. For example, on - # Windows, the first argument might be "C:\Windows\System32\ping.exe" - - # that is, using drive letters and backslashes. A command for a *nix - # system, on the other hand, would use forward slashes. - # All other fields in the RWAPI must consistently use forward slashes, - # since those fields may be interpretted by both the service and the bot. + # The command itself to run (e.g., argv). This field should be passed directly + # to the underlying operating system, and so it must be sensible to that + # operating system. For example, on Windows, the first argument might be "C:\ + # Windows\System32\ping.exe" - that is, using drive letters and backslashes. A + # command for a *nix system, on the other hand, would use forward slashes. All + # other fields in the RWAPI must consistently use forward slashes, since those + # fields may be interpretted by both the service and the bot. # Corresponds to the JSON property `arguments` # @return [Array] attr_accessor :arguments @@ -3337,31 +3163,29 @@ module Google # @return [Array] attr_accessor :environment_variables - # The input filesystem to be set up prior to the task beginning. The - # contents should be a repeated set of FileMetadata messages though other - # formats are allowed if better for the implementation (eg, a LUCI-style - # .isolated file). - # This field is repeated since implementations might want to cache the - # metadata, in which case it may be useful to break up portions of the - # filesystem that change frequently (eg, specific input files) from those - # that don't (eg, standard header files). + # The input filesystem to be set up prior to the task beginning. The contents + # should be a repeated set of FileMetadata messages though other formats are + # allowed if better for the implementation (eg, a LUCI-style .isolated file). + # This field is repeated since implementations might want to cache the metadata, + # in which case it may be useful to break up portions of the filesystem that + # change frequently (eg, specific input files) from those that don't (eg, + # standard header files). # Corresponds to the JSON property `files` # @return [Array] attr_accessor :files - # Inline contents for blobs expected to be needed by the bot to execute the - # task. For example, contents of entries in `files` or blobs that are - # indirectly referenced by an entry there. - # The bot should check against this list before downloading required task - # inputs to reduce the number of communications between itself and the - # remote CAS server. + # Inline contents for blobs expected to be needed by the bot to execute the task. + # For example, contents of entries in `files` or blobs that are indirectly + # referenced by an entry there. The bot should check against this list before + # downloading required task inputs to reduce the number of communications + # between itself and the remote CAS server. # Corresponds to the JSON property `inlineBlobs` # @return [Array] attr_accessor :inline_blobs - # Directory from which a command is executed. It is a relative directory - # with respect to the bot's working directory (i.e., "./"). If it is - # non-empty, then it must exist under "./". Otherwise, "./" will be used. + # Directory from which a command is executed. It is a relative directory with + # respect to the bot's working directory (i.e., "./"). If it is non-empty, then + # it must exist under "./". Otherwise, "./" will be used. # Corresponds to the JSON property `workingDirectory` # @return [String] attr_accessor :working_directory @@ -3409,32 +3233,32 @@ module Google class GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs include Google::Apis::Core::Hashable - # A list of expected directories, relative to the execution root. All paths - # MUST be delimited by forward slashes. + # A list of expected directories, relative to the execution root. All paths MUST + # be delimited by forward slashes. # Corresponds to the JSON property `directories` # @return [Array] attr_accessor :directories - # A list of expected files, relative to the execution root. All paths - # MUST be delimited by forward slashes. + # A list of expected files, relative to the execution root. All paths MUST be + # delimited by forward slashes. # Corresponds to the JSON property `files` # @return [Array] attr_accessor :files - # The destination to which any stderr should be sent. The method by which - # the bot should send the stream contents to that destination is not - # defined in this API. As examples, the destination could be a file - # referenced in the `files` field in this message, or it could be a URI - # that must be written via the ByteStream API. + # The destination to which any stderr should be sent. The method by which the + # bot should send the stream contents to that destination is not defined in this + # API. As examples, the destination could be a file referenced in the `files` + # field in this message, or it could be a URI that must be written via the + # ByteStream API. # Corresponds to the JSON property `stderrDestination` # @return [String] attr_accessor :stderr_destination - # The destination to which any stdout should be sent. The method by which - # the bot should send the stream contents to that destination is not - # defined in this API. As examples, the destination could be a file - # referenced in the `files` field in this message, or it could be a URI - # that must be written via the ByteStream API. + # The destination to which any stdout should be sent. The method by which the + # bot should send the stream contents to that destination is not defined in this + # API. As examples, the destination could be a file referenced in the `files` + # field in this message, or it could be a URI that must be written via the + # ByteStream API. # Corresponds to the JSON property `stdoutDestination` # @return [String] attr_accessor :stdout_destination @@ -3456,27 +3280,26 @@ module Google class GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts include Google::Apis::Core::Hashable - # This specifies the maximum time that the task can run, excluding the - # time required to download inputs or upload outputs. That is, the worker - # will terminate the task if it runs longer than this. + # This specifies the maximum time that the task can run, excluding the time + # required to download inputs or upload outputs. That is, the worker will + # terminate the task if it runs longer than this. # Corresponds to the JSON property `execution` # @return [String] attr_accessor :execution - # This specifies the maximum amount of time the task can be idle - that is, - # go without generating some output in either stdout or stderr. If the - # process is silent for more than the specified time, the worker will - # terminate the task. + # This specifies the maximum amount of time the task can be idle - that is, go + # without generating some output in either stdout or stderr. If the process is + # silent for more than the specified time, the worker will terminate the task. # Corresponds to the JSON property `idle` # @return [String] attr_accessor :idle # If the execution or IO timeouts are exceeded, the worker will try to - # gracefully terminate the task and return any existing logs. However, - # tasks may be hard-frozen in which case this process will fail. This - # timeout specifies how long to wait for a terminated task to shut down - # gracefully (e.g. via SIGTERM) before we bring down the hammer (e.g. - # SIGKILL on *nix, CTRL_BREAK_EVENT on Windows). + # gracefully terminate the task and return any existing logs. However, tasks may + # be hard-frozen in which case this process will fail. This timeout specifies + # how long to wait for a terminated task to shut down gracefully (e.g. via + # SIGTERM) before we bring down the hammer (e.g. SIGKILL on *nix, + # CTRL_BREAK_EVENT on Windows). # Corresponds to the JSON property `shutdown` # @return [String] attr_accessor :shutdown @@ -3494,13 +3317,12 @@ module Google end # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. class GoogleDevtoolsRemoteworkersV1test2Digest include Google::Apis::Core::Hashable @@ -3511,9 +3333,9 @@ module Google attr_accessor :hash_prop # The size of the contents. While this is not strictly required as part of an - # identifier (after all, any given hash will have exactly one canonical - # size), it's useful in almost all cases when one might want to send or - # retrieve blobs of content and is included here for this reason. + # identifier (after all, any given hash will have exactly one canonical size), + # it's useful in almost all cases when one might want to send or retrieve blobs + # of content and is included here for this reason. # Corresponds to the JSON property `sizeBytes` # @return [Fixnum] attr_accessor :size_bytes @@ -3561,13 +3383,12 @@ module Google include Google::Apis::Core::Hashable # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemoteworkersV1test2Digest] attr_accessor :digest @@ -3593,21 +3414,20 @@ module Google class GoogleDevtoolsRemoteworkersV1test2FileMetadata include Google::Apis::Core::Hashable - # If the file is small enough, its contents may also or alternatively be - # listed here. + # If the file is small enough, its contents may also or alternatively be listed + # here. # Corresponds to the JSON property `contents` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :contents # The CommandTask and CommandResult messages assume the existence of a service - # that can serve blobs of content, identified by a hash and size known as a - # "digest." The method by which these blobs may be retrieved is not specified - # here, but a model implementation is in the Remote Execution API's - # "ContentAddressibleStorage" interface. - # In the context of the RWAPI, a Digest will virtually always refer to the - # contents of a file or a directory. The latter is represented by the - # byte-encoded Directory message. + # that can serve blobs of content, identified by a hash and size known as a " + # digest." The method by which these blobs may be retrieved is not specified + # here, but a model implementation is in the Remote Execution API's " + # ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest + # will virtually always refer to the contents of a file or a directory. The + # latter is represented by the byte-encoded Directory message. # Corresponds to the JSON property `digest` # @return [Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemoteworkersV1test2Digest] attr_accessor :digest @@ -3618,11 +3438,11 @@ module Google attr_accessor :is_executable alias_method :is_executable?, :is_executable - # The path of this file. If this message is part of the - # CommandOutputs.outputs fields, the path is relative to the execution root - # and must correspond to an entry in CommandTask.outputs.files. If this - # message is part of a Directory message, then the path is relative to the - # root of that directory. All paths MUST be delimited by forward slashes. + # The path of this file. If this message is part of the CommandOutputs.outputs + # fields, the path is relative to the execution root and must correspond to an + # entry in CommandTask.outputs.files. If this message is part of a Directory + # message, then the path is relative to the root of that directory. All paths + # MUST be delimited by forward slashes. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path @@ -3645,47 +3465,45 @@ module Google class GoogleLongrunningOperation 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::RemotebuildexecutionV2::GoogleRpcStatus] 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] 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] attr_accessor :response @@ -3704,12 +3522,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 GoogleRpcStatus include Google::Apis::Core::Hashable @@ -3718,15 +3536,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>] 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 diff --git a/generated/google/apis/remotebuildexecution_v2/representations.rb b/generated/google/apis/remotebuildexecution_v2/representations.rb index e4674916f..02f9564cb 100644 --- a/generated/google/apis/remotebuildexecution_v2/representations.rb +++ b/generated/google/apis/remotebuildexecution_v2/representations.rb @@ -346,6 +346,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1054,6 +1066,37 @@ module Google end end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :container_image_sources, as: 'containerImageSources', class: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_add_capabilities, as: 'dockerAddCapabilities', class: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_chroot_path, as: 'dockerChrootPath', class: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_network, as: 'dockerNetwork', class: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_privileged, as: 'dockerPrivileged', class: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_run_as_root, as: 'dockerRunAsRoot', class: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_runtime, as: 'dockerRuntime', class: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :docker_sibling_containers, as: 'dockerSiblingContainers', class: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature, decorator: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature::Representation + + property :linux_isolation, as: 'linuxIsolation' + end + end + + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicyFeature + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :allowed_values, as: 'allowedValues' + property :policy, as: 'policy' + end + end + class GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1071,6 +1114,8 @@ module Google class GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance # @private class Representation < Google::Apis::Core::JsonRepresentation + property :feature_policy, as: 'featurePolicy', class: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy, decorator: Google::Apis::RemotebuildexecutionV2::GoogleDevtoolsRemotebuildexecutionAdminV1alphaFeaturePolicy::Representation + property :location, as: 'location' property :logging_enabled, as: 'loggingEnabled' property :name, as: 'name' diff --git a/generated/google/apis/remotebuildexecution_v2/service.rb b/generated/google/apis/remotebuildexecution_v2/service.rb index f96a46bc7..1cf5deb1f 100644 --- a/generated/google/apis/remotebuildexecution_v2/service.rb +++ b/generated/google/apis/remotebuildexecution_v2/service.rb @@ -47,37 +47,29 @@ module Google @batch_path = 'batch' end - # Retrieve a cached execution result. - # Implementations SHOULD ensure that any blobs referenced from the - # ContentAddressableStorage - # are available at the time of returning the - # ActionResult and will be - # for some period of time afterwards. The TTLs of the referenced blobs SHOULD be - # increased - # if necessary and applicable. - # Errors: - # * `NOT_FOUND`: The requested `ActionResult` is not in the cache. + # Retrieve a cached execution result. Implementations SHOULD ensure that any + # blobs referenced from the ContentAddressableStorage are available at the time + # of returning the ActionResult and will be for some period of time afterwards. + # The TTLs of the referenced blobs SHOULD be increased if necessary and + # applicable. Errors: * `NOT_FOUND`: The requested `ActionResult` is not in the + # cache. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [String] hash_ # The hash. In the case of SHA-256, it will always be a lowercase hex string # exactly 64 characters long. # @param [Fixnum] size_bytes # The size of the blob, in bytes. # @param [Array, String] inline_output_files - # A hint to the server to inline the contents of the listed output files. - # Each path needs to exactly match one path in `output_files` in the - # Command message. + # A hint to the server to inline the contents of the listed output files. Each + # path needs to exactly match one path in `output_files` in the Command message. # @param [Boolean] inline_stderr - # A hint to the server to request inlining stderr in the - # ActionResult message. + # A hint to the server to request inlining stderr in the ActionResult message. # @param [Boolean] inline_stdout - # A hint to the server to request inlining stdout in the - # ActionResult message. + # A hint to the server to request inlining stdout in the ActionResult message. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -110,25 +102,19 @@ module Google execute_or_queue_command(command, &block) end - # Upload a new execution result. - # In order to allow the server to perform access control based on the type of - # action, and to assist with client debugging, the client MUST first upload - # the Action that produced the - # result, along with its - # Command, into the - # `ContentAddressableStorage`. - # Errors: - # * `INVALID_ARGUMENT`: One or more arguments are invalid. - # * `FAILED_PRECONDITION`: One or more errors occurred in updating the - # action result, such as a missing command or action. - # * `RESOURCE_EXHAUSTED`: There is insufficient storage space to add the - # entry to the cache. + # Upload a new execution result. In order to allow the server to perform access + # control based on the type of action, and to assist with client debugging, the + # client MUST first upload the Action that produced the result, along with its + # Command, into the `ContentAddressableStorage`. Errors: * `INVALID_ARGUMENT`: + # One or more arguments are invalid. * `FAILED_PRECONDITION`: One or more errors + # occurred in updating the action result, such as a missing command or action. * + # `RESOURCE_EXHAUSTED`: There is insufficient storage space to add the entry to + # the cache. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [String] hash_ # The hash. In the case of SHA-256, it will always be a lowercase hex string # exactly 64 characters long. @@ -137,12 +123,12 @@ module Google # @param [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ActionResult] build_bazel_remote_execution_v2_action_result_object # @param [Fixnum] results_cache_policy_priority # The priority (relative importance) of this content in the overall cache. - # Generally, a lower value means a longer retention time or other advantage, - # but the interpretation of a given value is server-dependent. A priority of - # 0 means a *default* value, decided by the server. - # The particular semantics of this field is up to the server. In particular, - # every server will have their own supported range of priorities, and will - # decide how these map into retention/eviction policy. + # Generally, a lower value means a longer retention time or other advantage, but + # the interpretation of a given value is server-dependent. A priority of 0 means + # a *default* value, decided by the server. The particular semantics of this + # field is up to the server. In particular, every server will have their own + # supported range of priorities, and will decide how these map into retention/ + # eviction policy. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -175,67 +161,50 @@ module Google execute_or_queue_command(command, &block) end - # Execute an action remotely. - # In order to execute an action, the client must first upload all of the - # inputs, the - # Command to run, and the - # Action into the - # ContentAddressableStorage. - # It then calls `Execute` with an `action_digest` referring to them. The - # server will run the action and eventually return the result. - # The input `Action`'s fields MUST meet the various canonicalization - # requirements specified in the documentation for their types so that it has - # the same digest as other logically equivalent `Action`s. The server MAY - # enforce the requirements and return errors if a non-canonical input is - # received. It MAY also proceed without verifying some or all of the - # requirements, such as for performance reasons. If the server does not - # verify the requirement, then it will treat the `Action` as distinct from - # another logically equivalent action if they hash differently. - # Returns a stream of - # google.longrunning.Operation messages - # describing the resulting execution, with eventual `response` - # ExecuteResponse. The - # `metadata` on the operation is of type - # ExecuteOperationMetadata. - # If the client remains connected after the first response is returned after - # the server, then updates are streamed as if the client had called - # WaitExecution - # until the execution completes or the request reaches an error. The - # operation can also be queried using Operations - # API. - # The server NEED NOT implement other methods or functionality of the - # Operations API. - # Errors discovered during creation of the `Operation` will be reported - # as gRPC Status errors, while errors that occurred while running the - # action will be reported in the `status` field of the `ExecuteResponse`. The - # server MUST NOT set the `error` field of the `Operation` proto. - # The possible errors include: - # * `INVALID_ARGUMENT`: One or more arguments are invalid. - # * `FAILED_PRECONDITION`: One or more errors occurred in setting up the - # action requested, such as a missing input or command or no worker being - # available. The client may be able to fix the errors and retry. - # * `RESOURCE_EXHAUSTED`: There is insufficient quota of some resource to run - # the action. - # * `UNAVAILABLE`: Due to a transient condition, such as all workers being - # occupied (and the server does not support a queue), the action could not - # be started. The client should retry. - # * `INTERNAL`: An internal error occurred in the execution engine or the - # worker. - # * `DEADLINE_EXCEEDED`: The execution timed out. - # * `CANCELLED`: The operation was cancelled by the client. This status is - # only possible if the server implements the Operations API CancelOperation - # method, and it was called for the current execution. - # In the case of a missing input or command, the server SHOULD additionally - # send a PreconditionFailure error detail - # where, for each requested blob not present in the CAS, there is a - # `Violation` with a `type` of `MISSING` and a `subject` of - # `"blobs/`hash`/`size`"` indicating the digest of the missing blob. + # Execute an action remotely. In order to execute an action, the client must + # first upload all of the inputs, the Command to run, and the Action into the + # ContentAddressableStorage. It then calls `Execute` with an `action_digest` + # referring to them. The server will run the action and eventually return the + # result. The input `Action`'s fields MUST meet the various canonicalization + # requirements specified in the documentation for their types so that it has the + # same digest as other logically equivalent `Action`s. The server MAY enforce + # the requirements and return errors if a non-canonical input is received. It + # MAY also proceed without verifying some or all of the requirements, such as + # for performance reasons. If the server does not verify the requirement, then + # it will treat the `Action` as distinct from another logically equivalent + # action if they hash differently. Returns a stream of google.longrunning. + # Operation messages describing the resulting execution, with eventual `response` + # ExecuteResponse. The `metadata` on the operation is of type + # ExecuteOperationMetadata. If the client remains connected after the first + # response is returned after the server, then updates are streamed as if the + # client had called WaitExecution until the execution completes or the request + # reaches an error. The operation can also be queried using Operations API. The + # server NEED NOT implement other methods or functionality of the Operations API. + # Errors discovered during creation of the `Operation` will be reported as gRPC + # Status errors, while errors that occurred while running the action will be + # reported in the `status` field of the `ExecuteResponse`. The server MUST NOT + # set the `error` field of the `Operation` proto. The possible errors include: * + # `INVALID_ARGUMENT`: One or more arguments are invalid. * `FAILED_PRECONDITION`: + # One or more errors occurred in setting up the action requested, such as a + # missing input or command or no worker being available. The client may be able + # to fix the errors and retry. * `RESOURCE_EXHAUSTED`: There is insufficient + # quota of some resource to run the action. * `UNAVAILABLE`: Due to a transient + # condition, such as all workers being occupied (and the server does not support + # a queue), the action could not be started. The client should retry. * ` + # INTERNAL`: An internal error occurred in the execution engine or the worker. * + # `DEADLINE_EXCEEDED`: The execution timed out. * `CANCELLED`: The operation was + # cancelled by the client. This status is only possible if the server implements + # the Operations API CancelOperation method, and it was called for the current + # execution. In the case of a missing input or command, the server SHOULD + # additionally send a PreconditionFailure error detail where, for each requested + # blob not present in the CAS, there is a `Violation` with a `type` of `MISSING` + # and a `subject` of `"blobs/`hash`/`size`"` indicating the digest of the + # missing blob. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2ExecuteRequest] build_bazel_remote_execution_v2_execute_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -266,27 +235,20 @@ module Google execute_or_queue_command(command, &block) end - # Download many blobs at once. - # The server may enforce a limit of the combined total size of blobs - # to be downloaded using this API. This limit may be obtained using the - # Capabilities API. - # Requests exceeding the limit should either be split into smaller - # chunks or downloaded using the - # ByteStream API, as appropriate. - # This request is equivalent to calling a Bytestream `Read` request + # Download many blobs at once. The server may enforce a limit of the combined + # total size of blobs to be downloaded using this API. This limit may be + # obtained using the Capabilities API. Requests exceeding the limit should + # either be split into smaller chunks or downloaded using the ByteStream API, as + # appropriate. This request is equivalent to calling a Bytestream `Read` request # on each individual blob, in parallel. The requests may succeed or fail - # independently. - # Errors: - # * `INVALID_ARGUMENT`: The client attempted to read more than the - # server supported limit. - # Every error on individual read will be returned in the corresponding digest - # status. + # independently. Errors: * `INVALID_ARGUMENT`: The client attempted to read more + # than the server supported limit. Every error on individual read will be + # returned in the corresponding digest status. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2BatchReadBlobsRequest] build_bazel_remote_execution_v2_batch_read_blobs_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -317,30 +279,22 @@ module Google execute_or_queue_command(command, &block) end - # Upload many blobs at once. - # The server may enforce a limit of the combined total size of blobs - # to be uploaded using this API. This limit may be obtained using the - # Capabilities API. - # Requests exceeding the limit should either be split into smaller - # chunks or uploaded using the - # ByteStream API, as appropriate. - # This request is equivalent to calling a Bytestream `Write` request - # on each individual blob, in parallel. The requests may succeed or fail - # independently. - # Errors: - # * `INVALID_ARGUMENT`: The client attempted to upload more than the - # server supported limit. - # Individual requests may return the following errors, additionally: - # * `RESOURCE_EXHAUSTED`: There is insufficient disk quota to store the blob. - # * `INVALID_ARGUMENT`: The - # Digest does not match the - # provided data. + # Upload many blobs at once. The server may enforce a limit of the combined + # total size of blobs to be uploaded using this API. This limit may be obtained + # using the Capabilities API. Requests exceeding the limit should either be + # split into smaller chunks or uploaded using the ByteStream API, as appropriate. + # This request is equivalent to calling a Bytestream `Write` request on each + # individual blob, in parallel. The requests may succeed or fail independently. + # Errors: * `INVALID_ARGUMENT`: The client attempted to upload more than the + # server supported limit. Individual requests may return the following errors, + # additionally: * `RESOURCE_EXHAUSTED`: There is insufficient disk quota to + # store the blob. * `INVALID_ARGUMENT`: The Digest does not match the provided + # data. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2BatchUpdateBlobsRequest] build_bazel_remote_execution_v2_batch_update_blobs_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -371,18 +325,16 @@ module Google execute_or_queue_command(command, &block) end - # Determine if blobs are present in the CAS. - # Clients can use this API before uploading blobs to determine which ones are - # already present in the CAS and do not need to be uploaded again. - # Servers SHOULD increase the TTLs of the referenced blobs if necessary and - # applicable. - # There are no method-specific errors. + # Determine if blobs are present in the CAS. Clients can use this API before + # uploading blobs to determine which ones are already present in the CAS and do + # not need to be uploaded again. Servers SHOULD increase the TTLs of the + # referenced blobs if necessary and applicable. There are no method-specific + # errors. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2FindMissingBlobsRequest] build_bazel_remote_execution_v2_find_missing_blobs_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -413,29 +365,23 @@ module Google execute_or_queue_command(command, &block) end - # Fetch the entire directory tree rooted at a node. - # This request must be targeted at a - # Directory stored in the - # ContentAddressableStorage - # (CAS). The server will enumerate the `Directory` tree recursively and - # return every node descended from the root. - # The GetTreeRequest.page_token parameter can be used to skip ahead in - # the stream (e.g. when retrying a partially completed and aborted request), - # by setting it to a value taken from GetTreeResponse.next_page_token of the - # last successfully processed GetTreeResponse). - # The exact traversal order is unspecified and, unless retrieving subsequent - # pages from an earlier request, is not guaranteed to be stable across - # multiple invocations of `GetTree`. - # If part of the tree is missing from the CAS, the server will return the - # portion present and omit the rest. - # Errors: - # * `NOT_FOUND`: The requested tree root is not present in the CAS. + # Fetch the entire directory tree rooted at a node. This request must be + # targeted at a Directory stored in the ContentAddressableStorage (CAS). The + # server will enumerate the `Directory` tree recursively and return every node + # descended from the root. The GetTreeRequest.page_token parameter can be used + # to skip ahead in the stream (e.g. when retrying a partially completed and + # aborted request), by setting it to a value taken from GetTreeResponse. + # next_page_token of the last successfully processed GetTreeResponse). The exact + # traversal order is unspecified and, unless retrieving subsequent pages from an + # earlier request, is not guaranteed to be stable across multiple invocations of + # `GetTree`. If part of the tree is missing from the CAS, the server will return + # the portion present and omit the rest. Errors: * `NOT_FOUND`: The requested + # tree root is not present in the CAS. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [String] hash_ # The hash. In the case of SHA-256, it will always be a lowercase hex string # exactly 64 characters long. @@ -447,10 +393,9 @@ module Google # server may place its own limit on the number of items to be returned and # require the client to retrieve more items using a subsequent request. # @param [String] page_token - # A page token, which must be a value received in a previous - # GetTreeResponse. - # If present, the server will use that token as an offset, returning only - # that page and the ones that succeed it. + # A page token, which must be a value received in a previous GetTreeResponse. If + # present, the server will use that token as an offset, returning only that page + # and the ones that succeed it. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -482,15 +427,14 @@ module Google execute_or_queue_command(command, &block) end - # Wait for an execution operation to complete. When the client initially - # makes the request, the server immediately responds with the current status - # of the execution. The server will leave the request stream open until the - # operation completes, and then respond with the completed operation. The - # server MAY choose to stream additional updates as execution progresses, - # such as to provide an update as to the state of the execution. + # Wait for an execution operation to complete. When the client initially makes + # the request, the server immediately responds with the current status of the + # execution. The server will leave the request stream open until the operation + # completes, and then respond with the completed operation. The server MAY + # choose to stream additional updates as execution progresses, such as to + # provide an update as to the state of the execution. # @param [String] name - # The name of the Operation - # returned by Execute. + # The name of the Operation returned by Execute. # @param [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2WaitExecutionRequest] build_bazel_remote_execution_v2_wait_execution_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -521,20 +465,17 @@ module Google execute_or_queue_command(command, &block) end - # GetCapabilities returns the server capabilities configuration of the - # remote endpoint. - # Only the capabilities of the services supported by the endpoint will - # be returned: - # * Execution + CAS + Action Cache endpoints should return both - # CacheCapabilities and ExecutionCapabilities. - # * Execution only endpoints should return ExecutionCapabilities. - # * CAS + Action Cache only endpoints should return CacheCapabilities. + # GetCapabilities returns the server capabilities configuration of the remote + # endpoint. Only the capabilities of the services supported by the endpoint will + # be returned: * Execution + CAS + Action Cache endpoints should return both + # CacheCapabilities and ExecutionCapabilities. * Execution only endpoints should + # return ExecutionCapabilities. * CAS + Action Cache only endpoints should + # return CacheCapabilities. # @param [String] instance_name - # The instance of the execution system to operate against. A server may - # support multiple instances of the execution system (with their own workers, - # storage, caches, etc.). The server MAY require use of this field to select - # between them in an implementation-defined fashion, otherwise it can be - # omitted. + # The instance of the execution system to operate against. A server may support + # multiple instances of the execution system (with their own workers, storage, + # caches, etc.). The server MAY require use of this field to select between them + # in an implementation-defined fashion, otherwise it can be omitted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/secretmanager_v1.rb b/generated/google/apis/secretmanager_v1.rb index 48435ce78..d3b68dd17 100644 --- a/generated/google/apis/secretmanager_v1.rb +++ b/generated/google/apis/secretmanager_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/secret-manager/ module SecretmanagerV1 VERSION = 'V1' - REVISION = '20200619' + REVISION = '20200807' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/secretmanager_v1/classes.rb b/generated/google/apis/secretmanager_v1/classes.rb index eb06b6d55..955b04d93 100644 --- a/generated/google/apis/secretmanager_v1/classes.rb +++ b/generated/google/apis/secretmanager_v1/classes.rb @@ -26,8 +26,8 @@ module Google class AccessSecretVersionResponse include Google::Apis::Core::Hashable - # The resource name of the SecretVersion in the format - # `projects/*/secrets/*/versions/*`. + # The resource name of the SecretVersion in the format `projects/*/secrets/*/ + # versions/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -69,53 +69,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 @@ -124,9 +92,9 @@ module Google # @return [Array] 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 @@ -142,28 +110,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] @@ -203,69 +158,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::SecretmanagerV1::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] 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 @@ -308,13 +251,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 @@ -340,52 +281,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 @@ -443,8 +375,7 @@ module Google # @return [Fixnum] attr_accessor :total_size - # The list of SecretVersions sorted in reverse by - # create_time (newest first). + # The list of SecretVersions sorted in reverse by create_time (newest first). # Corresponds to the JSON property `versions` # @return [Array] attr_accessor :versions @@ -471,8 +402,7 @@ module Google # @return [String] attr_accessor :next_page_token - # The list of Secrets sorted in reverse by create_time (newest - # first). + # The list of Secrets sorted in reverse by create_time (newest first). # Corresponds to the JSON property `secrets` # @return [Array] attr_accessor :secrets @@ -498,14 +428,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] attr_accessor :labels @@ -521,8 +451,8 @@ module Google # @return [Hash] 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 @@ -542,66 +472,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 @@ -610,48 +506,44 @@ module Google # @return [Array] 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] 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 @@ -673,8 +565,7 @@ module Google class Replica include Google::Apis::Core::Hashable - # The canonical IDs of the location to replicate data. - # For example: `"us-east1"`. + # The canonical IDs of the location to replicate data. For example: `"us-east1"`. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location @@ -699,8 +590,8 @@ module Google # @return [Google::Apis::SecretmanagerV1::Automatic] attr_accessor :automatic - # A replication policy that replicates the Secret payload into the - # locations specified in Secret.replication.user_managed.replicas + # A replication policy that replicates the Secret payload into the locations + # specified in Secret.replication.user_managed.replicas # Corresponds to the JSON property `userManaged` # @return [Google::Apis::SecretmanagerV1::UserManaged] attr_accessor :user_managed @@ -716,10 +607,9 @@ module Google end end - # A Secret is a logical secret whose value and versions can - # be accessed. - # A Secret is made up of zero or more SecretVersions that - # represent the secret data. + # A Secret is a logical secret whose value and versions can be accessed. A + # Secret is made up of zero or more SecretVersions that represent the secret + # data. class Secret include Google::Apis::Core::Hashable @@ -728,14 +618,12 @@ module Google # @return [String] attr_accessor :create_time - # The labels assigned to this Secret. - # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding - # of maximum 128 bytes, and must conform to the following PCRE regular - # expression: `\p`Ll`\p`Lo``0,62`` - # Label values must be between 0 and 63 characters long, have a UTF-8 - # encoding of maximum 128 bytes, and must conform to the following PCRE - # regular expression: `[\p`Ll`\p`Lo`\p`N`_-]`0,63`` - # No more than 64 labels can be assigned to a given resource. + # The labels assigned to this Secret. Label keys must be between 1 and 63 + # characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform + # to the following PCRE regular expression: `\p`Ll`\p`Lo``0,62`` Label values + # must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 + # bytes, and must conform to the following PCRE regular expression: `[\p`Ll`\p` + # Lo`\p`N`_-]`0,63`` No more than 64 labels can be assigned to a given resource. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -794,17 +682,15 @@ module Google # @return [String] attr_accessor :create_time - # Output only. The time this SecretVersion was destroyed. - # Only present if state is - # DESTROYED. + # Output only. The time this SecretVersion was destroyed. Only present if state + # is DESTROYED. # Corresponds to the JSON property `destroyTime` # @return [String] attr_accessor :destroy_time - # Output only. The resource name of the SecretVersion in the - # format `projects/*/secrets/*/versions/*`. - # SecretVersion IDs in a Secret start at 1 and - # are incremented for each subsequent version of the secret. + # Output only. The resource name of the SecretVersion in the format `projects/*/ + # secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are + # incremented for each subsequent version of the secret. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -832,74 +718,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::SecretmanagerV1::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 @@ -919,10 +770,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] attr_accessor :permissions @@ -941,8 +791,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] attr_accessor :permissions @@ -957,13 +806,12 @@ module Google end end - # A replication policy that replicates the Secret payload into the - # locations specified in Secret.replication.user_managed.replicas + # A replication policy that replicates the Secret payload into the locations + # specified in Secret.replication.user_managed.replicas class UserManaged include Google::Apis::Core::Hashable - # Required. The list of Replicas for this Secret. - # Cannot be empty. + # Required. The list of Replicas for this Secret. Cannot be empty. # Corresponds to the JSON property `replicas` # @return [Array] attr_accessor :replicas diff --git a/generated/google/apis/secretmanager_v1/service.rb b/generated/google/apis/secretmanager_v1/service.rb index bde70857f..08aceab43 100644 --- a/generated/google/apis/secretmanager_v1/service.rb +++ b/generated/google/apis/secretmanager_v1/service.rb @@ -117,11 +117,11 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new SecretVersion containing secret data and attaches - # it to an existing Secret. + # Creates a new SecretVersion containing secret data and attaches it to an + # existing Secret. # @param [String] parent - # Required. The resource name of the Secret to associate with the - # SecretVersion in the format `projects/*/secrets/*`. + # Required. The resource name of the Secret to associate with the SecretVersion + # in the format `projects/*/secrets/*`. # @param [Google::Apis::SecretmanagerV1::AddSecretVersionRequest] add_secret_version_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -154,14 +154,13 @@ module Google # Creates a new Secret containing no SecretVersions. # @param [String] parent - # Required. The resource name of the project to associate with the - # Secret, in the format `projects/*`. + # Required. The resource name of the project to associate with the Secret, in + # the format `projects/*`. # @param [Google::Apis::SecretmanagerV1::Secret] secret_object # @param [String] secret_id - # Required. This must be unique within the project. - # A secret ID is a string with a maximum length of 255 characters and can - # contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and - # underscore (`_`) characters. + # Required. This must be unique within the project. A secret ID is a string with + # a maximum length of 255 characters and can contain uppercase and lowercase + # letters, numerals, and the hyphen (`-`) and underscore (`_`) characters. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -194,8 +193,8 @@ module Google # Deletes a Secret. # @param [String] name - # Required. The resource name of the Secret to delete in the format - # `projects/*/secrets/*`. + # Required. The resource name of the Secret to delete in the format `projects/*/ + # secrets/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -254,21 +253,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a secret. - # Returns empty policy if the secret exists and does not have a policy set. + # Gets the access control policy for a secret. Returns empty policy if the + # secret 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 @@ -299,15 +296,15 @@ module Google # Lists Secrets. # @param [String] parent - # Required. The resource name of the project associated with the - # Secrets, in the format `projects/*`. + # Required. The resource name of the project associated with the Secrets, in the + # format `projects/*`. # @param [Fixnum] page_size # Optional. The maximum number of results to be returned in a single page. If - # set to 0, the server decides the number of results to return. If the - # number is greater than 25000, it is capped at 25000. + # set to 0, the server decides the number of results to return. If the number is + # greater than 25000, it is capped at 25000. # @param [String] page_token - # Optional. Pagination token, returned earlier via - # ListSecretsResponse.next_page_token. + # Optional. Pagination token, returned earlier via ListSecretsResponse. + # next_page_token. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -374,13 +371,12 @@ module Google execute_or_queue_command(command, &block) end - # Sets the access control policy on the specified secret. Replaces any - # existing policy. - # Permissions on SecretVersions are enforced according - # to the policy set on the associated Secret. + # Sets the access control policy on the specified secret. Replaces any existing + # policy. Permissions on SecretVersions are enforced according to the policy set + # on the associated Secret. # @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::SecretmanagerV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -411,15 +407,14 @@ module Google execute_or_queue_command(command, &block) end - # Returns permissions that a caller has for the specified secret. - # If the secret does not exist, this call returns an empty set of - # permissions, not a NOT_FOUND error. - # Note: This operation is designed to be used for building permission-aware - # UIs and command-line tools, not for authorization checking. This operation - # may "fail open" without warning. + # Returns permissions that a caller has for the specified secret. If the secret + # does not exist, this call returns an empty set of permissions, not a NOT_FOUND + # error. Note: This operation is designed to be used for building permission- + # aware UIs and command-line tools, not for authorization checking. This + # operation may "fail open" without warning. # @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::SecretmanagerV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -450,12 +445,11 @@ module Google execute_or_queue_command(command, &block) end - # Accesses a SecretVersion. This call returns the secret data. - # `projects/*/secrets/*/versions/latest` is an alias to the `latest` - # SecretVersion. + # Accesses a SecretVersion. This call returns the secret data. `projects/*/ + # secrets/*/versions/latest` is an alias to the `latest` SecretVersion. # @param [String] name - # Required. The resource name of the SecretVersion in the format - # `projects/*/secrets/*/versions/*`. + # Required. The resource name of the SecretVersion in the format `projects/*/ + # secrets/*/versions/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -483,13 +477,11 @@ module Google execute_or_queue_command(command, &block) end - # Destroys a SecretVersion. - # Sets the state of the SecretVersion to - # DESTROYED and irrevocably destroys the - # secret data. + # Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and + # irrevocably destroys the secret data. # @param [String] name - # Required. The resource name of the SecretVersion to destroy in the format - # `projects/*/secrets/*/versions/*`. + # Required. The resource name of the SecretVersion to destroy in the format ` + # projects/*/secrets/*/versions/*`. # @param [Google::Apis::SecretmanagerV1::DestroySecretVersionRequest] destroy_secret_version_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -520,12 +512,10 @@ module Google execute_or_queue_command(command, &block) end - # Disables a SecretVersion. - # Sets the state of the SecretVersion to - # DISABLED. + # Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED. # @param [String] name - # Required. The resource name of the SecretVersion to disable in the format - # `projects/*/secrets/*/versions/*`. + # Required. The resource name of the SecretVersion to disable in the format ` + # projects/*/secrets/*/versions/*`. # @param [Google::Apis::SecretmanagerV1::DisableSecretVersionRequest] disable_secret_version_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -556,12 +546,10 @@ module Google execute_or_queue_command(command, &block) end - # Enables a SecretVersion. - # Sets the state of the SecretVersion to - # ENABLED. + # Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED. # @param [String] name - # Required. The resource name of the SecretVersion to enable in the format - # `projects/*/secrets/*/versions/*`. + # Required. The resource name of the SecretVersion to enable in the format ` + # projects/*/secrets/*/versions/*`. # @param [Google::Apis::SecretmanagerV1::EnableSecretVersionRequest] enable_secret_version_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -592,14 +580,12 @@ module Google execute_or_queue_command(command, &block) end - # Gets metadata for a SecretVersion. - # `projects/*/secrets/*/versions/latest` is an alias to the `latest` - # SecretVersion. + # Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is + # an alias to the `latest` SecretVersion. # @param [String] name - # Required. The resource name of the SecretVersion in the format - # `projects/*/secrets/*/versions/*`. - # `projects/*/secrets/*/versions/latest` is an alias to the `latest` - # SecretVersion. + # Required. The resource name of the SecretVersion in the format `projects/*/ + # secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to + # the `latest` SecretVersion. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -627,19 +613,17 @@ module Google execute_or_queue_command(command, &block) end - # Lists SecretVersions. This call does not return secret - # data. + # Lists SecretVersions. This call does not return secret data. # @param [String] parent - # Required. The resource name of the Secret associated with the - # SecretVersions to list, in the format - # `projects/*/secrets/*`. + # Required. The resource name of the Secret associated with the SecretVersions + # to list, in the format `projects/*/secrets/*`. # @param [Fixnum] page_size # Optional. The maximum number of results to be returned in a single page. If - # set to 0, the server decides the number of results to return. If the - # number is greater than 25000, it is capped at 25000. + # set to 0, the server decides the number of results to return. If the number is + # greater than 25000, it is capped at 25000. # @param [String] page_token - # Optional. Pagination token, returned earlier via - # ListSecretVersionsResponse.next_page_token][]. + # Optional. Pagination token, returned earlier via ListSecretVersionsResponse. + # next_page_token][]. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/secretmanager_v1beta1.rb b/generated/google/apis/secretmanager_v1beta1.rb index 422b835bf..eebe88e81 100644 --- a/generated/google/apis/secretmanager_v1beta1.rb +++ b/generated/google/apis/secretmanager_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/secret-manager/ module SecretmanagerV1beta1 VERSION = 'V1beta1' - REVISION = '20200619' + REVISION = '20200807' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/secretmanager_v1beta1/classes.rb b/generated/google/apis/secretmanager_v1beta1/classes.rb index 32f115a28..decec5fca 100644 --- a/generated/google/apis/secretmanager_v1beta1/classes.rb +++ b/generated/google/apis/secretmanager_v1beta1/classes.rb @@ -26,8 +26,8 @@ module Google class AccessSecretVersionResponse include Google::Apis::Core::Hashable - # The resource name of the SecretVersion in the format - # `projects/*/secrets/*/versions/*`. + # The resource name of the SecretVersion in the format `projects/*/secrets/*/ + # versions/*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -69,53 +69,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 @@ -124,9 +92,9 @@ module Google # @return [Array] 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 @@ -142,28 +110,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] @@ -203,69 +158,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::SecretmanagerV1beta1::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] 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 @@ -308,13 +251,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 @@ -340,52 +281,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 @@ -443,8 +375,7 @@ module Google # @return [Fixnum] attr_accessor :total_size - # The list of SecretVersions sorted in reverse by - # create_time (newest first). + # The list of SecretVersions sorted in reverse by create_time (newest first). # Corresponds to the JSON property `versions` # @return [Array] attr_accessor :versions @@ -471,8 +402,7 @@ module Google # @return [String] attr_accessor :next_page_token - # The list of Secrets sorted in reverse by create_time (newest - # first). + # The list of Secrets sorted in reverse by create_time (newest first). # Corresponds to the JSON property `secrets` # @return [Array] attr_accessor :secrets @@ -498,14 +428,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] attr_accessor :labels @@ -521,8 +451,8 @@ module Google # @return [Hash] 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 @@ -542,66 +472,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 @@ -610,48 +506,44 @@ module Google # @return [Array] 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] 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 @@ -673,8 +565,7 @@ module Google class Replica include Google::Apis::Core::Hashable - # The canonical IDs of the location to replicate data. - # For example: `"us-east1"`. + # The canonical IDs of the location to replicate data. For example: `"us-east1"`. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location @@ -699,8 +590,8 @@ module Google # @return [Google::Apis::SecretmanagerV1beta1::Automatic] attr_accessor :automatic - # A replication policy that replicates the Secret payload into the - # locations specified in Secret.replication.user_managed.replicas + # A replication policy that replicates the Secret payload into the locations + # specified in Secret.replication.user_managed.replicas # Corresponds to the JSON property `userManaged` # @return [Google::Apis::SecretmanagerV1beta1::UserManaged] attr_accessor :user_managed @@ -716,10 +607,9 @@ module Google end end - # A Secret is a logical secret whose value and versions can - # be accessed. - # A Secret is made up of zero or more SecretVersions that - # represent the secret data. + # A Secret is a logical secret whose value and versions can be accessed. A + # Secret is made up of zero or more SecretVersions that represent the secret + # data. class Secret include Google::Apis::Core::Hashable @@ -728,14 +618,12 @@ module Google # @return [String] attr_accessor :create_time - # The labels assigned to this Secret. - # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding - # of maximum 128 bytes, and must conform to the following PCRE regular - # expression: `\p`Ll`\p`Lo``0,62`` - # Label values must be between 0 and 63 characters long, have a UTF-8 - # encoding of maximum 128 bytes, and must conform to the following PCRE - # regular expression: `[\p`Ll`\p`Lo`\p`N`_-]`0,63`` - # No more than 64 labels can be assigned to a given resource. + # The labels assigned to this Secret. Label keys must be between 1 and 63 + # characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform + # to the following PCRE regular expression: `\p`Ll`\p`Lo``0,62`` Label values + # must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 + # bytes, and must conform to the following PCRE regular expression: `[\p`Ll`\p` + # Lo`\p`N`_-]`0,63`` No more than 64 labels can be assigned to a given resource. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -794,17 +682,15 @@ module Google # @return [String] attr_accessor :create_time - # Output only. The time this SecretVersion was destroyed. - # Only present if state is - # DESTROYED. + # Output only. The time this SecretVersion was destroyed. Only present if state + # is DESTROYED. # Corresponds to the JSON property `destroyTime` # @return [String] attr_accessor :destroy_time - # Output only. The resource name of the SecretVersion in the - # format `projects/*/secrets/*/versions/*`. - # SecretVersion IDs in a Secret start at 1 and - # are incremented for each subsequent version of the secret. + # Output only. The resource name of the SecretVersion in the format `projects/*/ + # secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are + # incremented for each subsequent version of the secret. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -832,74 +718,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::SecretmanagerV1beta1::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 @@ -919,10 +770,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] attr_accessor :permissions @@ -941,8 +791,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] attr_accessor :permissions @@ -957,13 +806,12 @@ module Google end end - # A replication policy that replicates the Secret payload into the - # locations specified in Secret.replication.user_managed.replicas + # A replication policy that replicates the Secret payload into the locations + # specified in Secret.replication.user_managed.replicas class UserManaged include Google::Apis::Core::Hashable - # Required. The list of Replicas for this Secret. - # Cannot be empty. + # Required. The list of Replicas for this Secret. Cannot be empty. # Corresponds to the JSON property `replicas` # @return [Array] attr_accessor :replicas diff --git a/generated/google/apis/secretmanager_v1beta1/service.rb b/generated/google/apis/secretmanager_v1beta1/service.rb index 4004ae760..24aa9242f 100644 --- a/generated/google/apis/secretmanager_v1beta1/service.rb +++ b/generated/google/apis/secretmanager_v1beta1/service.rb @@ -117,11 +117,11 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new SecretVersion containing secret data and attaches - # it to an existing Secret. + # Creates a new SecretVersion containing secret data and attaches it to an + # existing Secret. # @param [String] parent - # Required. The resource name of the Secret to associate with the - # SecretVersion in the format `projects/*/secrets/*`. + # Required. The resource name of the Secret to associate with the SecretVersion + # in the format `projects/*/secrets/*`. # @param [Google::Apis::SecretmanagerV1beta1::AddSecretVersionRequest] add_secret_version_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -154,14 +154,13 @@ module Google # Creates a new Secret containing no SecretVersions. # @param [String] parent - # Required. The resource name of the project to associate with the - # Secret, in the format `projects/*`. + # Required. The resource name of the project to associate with the Secret, in + # the format `projects/*`. # @param [Google::Apis::SecretmanagerV1beta1::Secret] secret_object # @param [String] secret_id - # Required. This must be unique within the project. - # A secret ID is a string with a maximum length of 255 characters and can - # contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and - # underscore (`_`) characters. + # Required. This must be unique within the project. A secret ID is a string with + # a maximum length of 255 characters and can contain uppercase and lowercase + # letters, numerals, and the hyphen (`-`) and underscore (`_`) characters. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -194,8 +193,8 @@ module Google # Deletes a Secret. # @param [String] name - # Required. The resource name of the Secret to delete in the format - # `projects/*/secrets/*`. + # Required. The resource name of the Secret to delete in the format `projects/*/ + # secrets/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -254,21 +253,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a secret. - # Returns empty policy if the secret exists and does not have a policy set. + # Gets the access control policy for a secret. Returns empty policy if the + # secret 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 @@ -299,15 +296,15 @@ module Google # Lists Secrets. # @param [String] parent - # Required. The resource name of the project associated with the - # Secrets, in the format `projects/*`. + # Required. The resource name of the project associated with the Secrets, in the + # format `projects/*`. # @param [Fixnum] page_size # Optional. The maximum number of results to be returned in a single page. If - # set to 0, the server decides the number of results to return. If the - # number is greater than 25000, it is capped at 25000. + # set to 0, the server decides the number of results to return. If the number is + # greater than 25000, it is capped at 25000. # @param [String] page_token - # Optional. Pagination token, returned earlier via - # ListSecretsResponse.next_page_token. + # Optional. Pagination token, returned earlier via ListSecretsResponse. + # next_page_token. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -374,13 +371,12 @@ module Google execute_or_queue_command(command, &block) end - # Sets the access control policy on the specified secret. Replaces any - # existing policy. - # Permissions on SecretVersions are enforced according - # to the policy set on the associated Secret. + # Sets the access control policy on the specified secret. Replaces any existing + # policy. Permissions on SecretVersions are enforced according to the policy set + # on the associated Secret. # @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::SecretmanagerV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -411,15 +407,14 @@ module Google execute_or_queue_command(command, &block) end - # Returns permissions that a caller has for the specified secret. - # If the secret does not exist, this call returns an empty set of - # permissions, not a NOT_FOUND error. - # Note: This operation is designed to be used for building permission-aware - # UIs and command-line tools, not for authorization checking. This operation - # may "fail open" without warning. + # Returns permissions that a caller has for the specified secret. If the secret + # does not exist, this call returns an empty set of permissions, not a NOT_FOUND + # error. Note: This operation is designed to be used for building permission- + # aware UIs and command-line tools, not for authorization checking. This + # operation may "fail open" without warning. # @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::SecretmanagerV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -450,12 +445,11 @@ module Google execute_or_queue_command(command, &block) end - # Accesses a SecretVersion. This call returns the secret data. - # `projects/*/secrets/*/versions/latest` is an alias to the `latest` - # SecretVersion. + # Accesses a SecretVersion. This call returns the secret data. `projects/*/ + # secrets/*/versions/latest` is an alias to the `latest` SecretVersion. # @param [String] name - # Required. The resource name of the SecretVersion in the format - # `projects/*/secrets/*/versions/*`. + # Required. The resource name of the SecretVersion in the format `projects/*/ + # secrets/*/versions/*`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -483,13 +477,11 @@ module Google execute_or_queue_command(command, &block) end - # Destroys a SecretVersion. - # Sets the state of the SecretVersion to - # DESTROYED and irrevocably destroys the - # secret data. + # Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and + # irrevocably destroys the secret data. # @param [String] name - # Required. The resource name of the SecretVersion to destroy in the format - # `projects/*/secrets/*/versions/*`. + # Required. The resource name of the SecretVersion to destroy in the format ` + # projects/*/secrets/*/versions/*`. # @param [Google::Apis::SecretmanagerV1beta1::DestroySecretVersionRequest] destroy_secret_version_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -520,12 +512,10 @@ module Google execute_or_queue_command(command, &block) end - # Disables a SecretVersion. - # Sets the state of the SecretVersion to - # DISABLED. + # Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED. # @param [String] name - # Required. The resource name of the SecretVersion to disable in the format - # `projects/*/secrets/*/versions/*`. + # Required. The resource name of the SecretVersion to disable in the format ` + # projects/*/secrets/*/versions/*`. # @param [Google::Apis::SecretmanagerV1beta1::DisableSecretVersionRequest] disable_secret_version_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -556,12 +546,10 @@ module Google execute_or_queue_command(command, &block) end - # Enables a SecretVersion. - # Sets the state of the SecretVersion to - # ENABLED. + # Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED. # @param [String] name - # Required. The resource name of the SecretVersion to enable in the format - # `projects/*/secrets/*/versions/*`. + # Required. The resource name of the SecretVersion to enable in the format ` + # projects/*/secrets/*/versions/*`. # @param [Google::Apis::SecretmanagerV1beta1::EnableSecretVersionRequest] enable_secret_version_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -592,14 +580,12 @@ module Google execute_or_queue_command(command, &block) end - # Gets metadata for a SecretVersion. - # `projects/*/secrets/*/versions/latest` is an alias to the `latest` - # SecretVersion. + # Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is + # an alias to the `latest` SecretVersion. # @param [String] name - # Required. The resource name of the SecretVersion in the format - # `projects/*/secrets/*/versions/*`. - # `projects/*/secrets/*/versions/latest` is an alias to the `latest` - # SecretVersion. + # Required. The resource name of the SecretVersion in the format `projects/*/ + # secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to + # the `latest` SecretVersion. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -627,19 +613,17 @@ module Google execute_or_queue_command(command, &block) end - # Lists SecretVersions. This call does not return secret - # data. + # Lists SecretVersions. This call does not return secret data. # @param [String] parent - # Required. The resource name of the Secret associated with the - # SecretVersions to list, in the format - # `projects/*/secrets/*`. + # Required. The resource name of the Secret associated with the SecretVersions + # to list, in the format `projects/*/secrets/*`. # @param [Fixnum] page_size # Optional. The maximum number of results to be returned in a single page. If - # set to 0, the server decides the number of results to return. If the - # number is greater than 25000, it is capped at 25000. + # set to 0, the server decides the number of results to return. If the number is + # greater than 25000, it is capped at 25000. # @param [String] page_token - # Optional. Pagination token, returned earlier via - # ListSecretVersionsResponse.next_page_token][]. + # Optional. Pagination token, returned earlier via ListSecretVersionsResponse. + # next_page_token][]. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/servicedirectory_v1beta1.rb b/generated/google/apis/servicedirectory_v1beta1.rb index 51155ff71..d25a0da10 100644 --- a/generated/google/apis/servicedirectory_v1beta1.rb +++ b/generated/google/apis/servicedirectory_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/service-directory module ServicedirectoryV1beta1 VERSION = 'V1beta1' - REVISION = '20200429' + REVISION = '20200803' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicedirectory_v1beta1/classes.rb b/generated/google/apis/servicedirectory_v1beta1/classes.rb index 1dd3a9355..c9788831c 100644 --- a/generated/google/apis/servicedirectory_v1beta1/classes.rb +++ b/generated/google/apis/servicedirectory_v1beta1/classes.rb @@ -26,69 +26,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::ServicedirectoryV1beta1::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] 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 @@ -105,13 +93,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 @@ -124,34 +110,28 @@ module Google end end - # An individual endpoint that provides a - # service. The service must - # already exist to create an endpoint. + # An individual endpoint that provides a service. The service must already exist + # to create an endpoint. class Endpoint include Google::Apis::Core::Hashable - # Optional. An IPv4 or IPv6 address. Service Directory will reject bad - # addresses like: - # "8.8.8" - # "8.8.8.8:53" - # "test:bad:address" - # "[::1]" - # "[::1]:8080" - # Limited to 45 characters. + # Optional. An IPv4 or IPv6 address. Service Directory will reject bad addresses + # like: "8.8.8" "8.8.8.8:53" "test:bad:address" "[::1]" "[::1]:8080" Limited to + # 45 characters. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address # Optional. Metadata for the endpoint. This data can be consumed by service - # clients. The entire metadata dictionary may contain up to 512 characters, - # spread accoss all key-value pairs. Metadata that goes beyond any these - # limits will be rejected. + # clients. The entire metadata dictionary may contain up to 512 characters, + # spread accoss all key-value pairs. Metadata that goes beyond any these limits + # will be rejected. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata - # Immutable. The resource name for the endpoint in the format - # 'projects/*/locations/*/namespaces/*/services/*/endpoints/*'. + # Immutable. The resource name for the endpoint in the format 'projects/*/ + # locations/*/namespaces/*/services/*/endpoints/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -174,52 +154,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 @@ -260,15 +231,13 @@ module Google class GetPolicyOptions include Google::Apis::Core::Hashable - # 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). # Corresponds to the JSON property `requestedPolicyVersion` # @return [Fixnum] attr_accessor :requested_policy_version @@ -292,8 +261,8 @@ module Google # @return [Array] attr_accessor :endpoints - # 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 @@ -343,8 +312,8 @@ module Google # @return [Array] attr_accessor :namespaces - # 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 @@ -364,8 +333,8 @@ module Google class ListServicesResponse 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 @@ -390,14 +359,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] attr_accessor :labels @@ -413,8 +382,8 @@ module Google # @return [Hash] 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 @@ -433,21 +402,20 @@ module Google end end - # A container for services. - # Namespaces allow administrators to group services together and define - # permissions for a collection of services. + # A container for services. Namespaces allow administrators to group services + # together and define permissions for a collection of services. class Namespace include Google::Apis::Core::Hashable - # Optional. Resource labels associated with this Namespace. - # No more than 64 user labels can be associated with a given resource. Label - # keys and values can be no longer than 63 characters. + # Optional. Resource labels associated with this Namespace. No more than 64 user + # labels can be associated with a given resource. Label keys and values can be + # no longer than 63 characters. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Immutable. The resource name for the namespace in the format - # 'projects/*/locations/*/namespaces/*'. + # Immutable. The resource name for the namespace in the format 'projects/*/ + # locations/*/namespaces/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -464,111 +432,73 @@ 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 - # 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] 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 @@ -585,35 +515,27 @@ module Google end end - # The request message for LookupService.ResolveService. - # Looks up a service by its name, returns the service and its endpoints. + # The request message for LookupService.ResolveService. Looks up a service by + # its name, returns the service and its endpoints. class ResolveServiceRequest include Google::Apis::Core::Hashable - # Optional. The filter applied to the endpoints of the resolved service. - # General filter string syntax: - # () - # can be "name" or "metadata." for map field. - # can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS and is - # roughly the same as "=". - # must be the same data type as the field. - # can be "AND, OR, NOT". - # Examples of valid filters: - # * "metadata.owner" returns Endpoints that have a label with the - # key "owner", this is the same as "metadata:owner" - # * "metadata.protocol=gRPC" returns Endpoints that have key/value - # "protocol=gRPC" - # * "metadata.owner!=sd AND metadata.foo=bar" returns - # Endpoints that have "owner" field in metadata with a value that is not - # "sd" AND have the key/value foo=bar. + # Optional. The filter applied to the endpoints of the resolved service. General + # filter string syntax: () can be "name" or "metadata." for map field. can be "<, + # >, <=, >=, !=, =, :". Of which ":" means HAS and is roughly the same as "=". + # must be the same data type as the field. can be "AND, OR, NOT". Examples of + # valid filters: * "metadata.owner" returns Endpoints that have a label with the + # key "owner", this is the same as "metadata:owner" * "metadata.protocol=gRPC" + # returns Endpoints that have key/value "protocol=gRPC" * "metadata.owner!=sd + # AND metadata.foo=bar" returns Endpoints that have "owner" field in metadata + # with a value that is not "sd" AND have the key/value foo=bar. # Corresponds to the JSON property `endpointFilter` # @return [String] attr_accessor :endpoint_filter # Optional. The maximum number of endpoints to return. Defaults to 25. Maximum - # is 100. - # If a value less than one is specified, the Default is used. - # If a value greater than the Maximum is specified, the Maximum is used. + # is 100. If a value less than one is specified, the Default is used. If a value + # greater than the Maximum is specified, the Maximum is used. # Corresponds to the JSON property `maxEndpoints` # @return [Fixnum] attr_accessor :max_endpoints @@ -633,10 +555,8 @@ module Google class ResolveServiceResponse include Google::Apis::Core::Hashable - # An individual service. A service contains a name and optional metadata. - # A service must exist before - # endpoints can be - # added to it. + # An individual service. A service contains a name and optional metadata. A + # service must exist before endpoints can be added to it. # Corresponds to the JSON property `service` # @return [Google::Apis::ServicedirectoryV1beta1::Service] attr_accessor :service @@ -651,30 +571,27 @@ module Google end end - # An individual service. A service contains a name and optional metadata. - # A service must exist before - # endpoints can be - # added to it. + # An individual service. A service contains a name and optional metadata. A + # service must exist before endpoints can be added to it. class Service include Google::Apis::Core::Hashable # Output only. Endpoints associated with this service. Returned on LookupService. - # Resolve. - # Control plane clients should use RegistrationService.ListEndpoints. + # Resolve. Control plane clients should use RegistrationService.ListEndpoints. # Corresponds to the JSON property `endpoints` # @return [Array] attr_accessor :endpoints # Optional. Metadata for the service. This data can be consumed by service - # clients. The entire metadata dictionary may contain up to 2000 characters, - # spread across all key-value pairs. Metadata that goes beyond any these - # limits will be rejected. + # clients. The entire metadata dictionary may contain up to 2000 characters, + # spread across all key-value pairs. Metadata that goes beyond any these limits + # will be rejected. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata - # Immutable. The resource name for the service in the format - # 'projects/*/locations/*/namespaces/*/services/*'. + # Immutable. The resource name for the service in the format 'projects/*/ + # locations/*/namespaces/*/services/*'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -696,66 +613,32 @@ 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::ServicedirectoryV1beta1::Policy] attr_accessor :policy @@ -774,10 +657,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] attr_accessor :permissions @@ -796,8 +678,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] attr_accessor :permissions diff --git a/generated/google/apis/servicedirectory_v1beta1/service.rb b/generated/google/apis/servicedirectory_v1beta1/service.rb index de0c23193..cc2d39725 100644 --- a/generated/google/apis/servicedirectory_v1beta1/service.rb +++ b/generated/google/apis/servicedirectory_v1beta1/service.rb @@ -119,17 +119,16 @@ module Google # Creates a namespace, and returns the new Namespace. # @param [String] parent - # Required. The resource name of the project and location the namespace - # will be created in. + # Required. The resource name of the project and location the namespace will be + # created in. # @param [Google::Apis::ServicedirectoryV1beta1::Namespace] namespace_object # @param [String] namespace_id # Required. The Resource ID must be 1-63 characters long, and comply with - # RFC1035. - # Specifically, the name must be 1-63 characters long and match the regular - # expression `[a-z](?:[-a-z0-9]`0,61`[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. + # RFC1035. Specifically, the name must be 1-63 characters long and match the + # regular expression `[a-z](?:[-a-z0-9]`0,61`[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. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -160,8 +159,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a namespace. This also deletes all services and endpoints in - # the namespace. + # Deletes a namespace. This also deletes all services and endpoints in the + # namespace. # @param [String] name # Required. The name of the namespace to delete. # @param [String] fields @@ -223,8 +222,8 @@ module Google # Gets the IAM Policy for a resource (namespace or service only). # @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 [Google::Apis::ServicedirectoryV1beta1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -258,39 +257,27 @@ module Google # Lists all namespaces. # @param [String] parent # Required. The resource name of the project and location whose namespaces we'd - # like to - # list. + # like to list. # @param [String] filter - # Optional. The filter to list result by. - # General filter string syntax: - # () - # can be "name", or "labels." for map field. - # can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and - # is roughly the same as "=". - # must be the same data type as field. - # can be "AND, OR, NOT". - # Examples of valid filters: - # * "labels.owner" returns Namespaces that have a label with the key "owner" - # this is the same as "labels:owner". - # * "labels.protocol=gRPC" returns Namespaces that have key/value - # "protocol=gRPC". - # * "name>projects/my-project/locations/us-east/namespaces/namespace-c" - # returns Namespaces that have name that is alphabetically later than the - # string, so "namespace-e" will be returned but "namespace-a" will not be. - # * "labels.owner!=sd AND labels.foo=bar" returns Namespaces that have - # "owner" in label key but value is not "sd" AND have key/value foo=bar. - # * "doesnotexist.foo=bar" returns an empty list. Note that Namespace doesn't - # have a field called "doesnotexist". Since the filter does not match any - # Namespaces, it returns no results. + # Optional. The filter to list result by. General filter string syntax: () can + # be "name", or "labels." for map field. can be "<, >, <=, >=, !=, =, :". Of + # which ":" means HAS, and is roughly the same as "=". must be the same data + # type as field. can be "AND, OR, NOT". Examples of valid filters: * "labels. + # owner" returns Namespaces that have a label with the key "owner" this is the + # same as "labels:owner". * "labels.protocol=gRPC" returns Namespaces that have + # key/value "protocol=gRPC". * "name>projects/my-project/locations/us-east/ + # namespaces/namespace-c" returns Namespaces that have name that is + # alphabetically later than the string, so "namespace-e" will be returned but " + # namespace-a" will not be. * "labels.owner!=sd AND labels.foo=bar" returns + # Namespaces that have "owner" in label key but value is not "sd" AND have key/ + # value foo=bar. * "doesnotexist.foo=bar" returns an empty list. Note that + # Namespace doesn't have a field called "doesnotexist". Since the filter does + # not match any Namespaces, it returns no results. # @param [String] order_by - # Optional. The order to list result by. - # General order by string syntax: - # () (,) - # allows values `"name"` - # ascending or descending order by . If this is left - # blank, "asc" is used. - # Note that an empty order_by string result in default order, which is order - # by name in ascending order. + # Optional. The order to list result by. General order by string syntax: () (,) + # allows values `"name"` ascending or descending order by . If this is left + # blank, "asc" is used. Note that an empty order_by string result in default + # order, which is order by name in ascending order. # @param [Fixnum] page_size # Optional. The maximum number of items to return. # @param [String] page_token @@ -329,8 +316,8 @@ module Google # Updates a namespace. # @param [String] name - # Immutable. The resource name for the namespace in the format - # 'projects/*/locations/*/namespaces/*'. + # Immutable. The resource name for the namespace in the format 'projects/*/ + # locations/*/namespaces/*'. # @param [Google::Apis::ServicedirectoryV1beta1::Namespace] namespace_object # @param [String] update_mask # Required. List of fields to be updated in this request. @@ -366,8 +353,8 @@ module Google # Sets the IAM Policy for a resource (namespace or service only). # @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::ServicedirectoryV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -400,8 +387,8 @@ module Google # Tests IAM permissions for a resource (namespace or service only). # @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::ServicedirectoryV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -438,12 +425,11 @@ module Google # @param [Google::Apis::ServicedirectoryV1beta1::Service] service_object # @param [String] service_id # Required. The Resource ID must be 1-63 characters long, and comply with - # RFC1035. - # Specifically, the name must be 1-63 characters long and match the regular - # expression `[a-z](?:[-a-z0-9]`0,61`[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. + # RFC1035. Specifically, the name must be 1-63 characters long and match the + # regular expression `[a-z](?:[-a-z0-9]`0,61`[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. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -474,8 +460,7 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a service. This also deletes all endpoints associated with - # the service. + # Deletes a service. This also deletes all endpoints associated with the service. # @param [String] name # Required. The name of the service to delete. # @param [String] fields @@ -537,8 +522,8 @@ module Google # Gets the IAM Policy for a resource (namespace or service only). # @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 [Google::Apis::ServicedirectoryV1beta1::GetIamPolicyRequest] get_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -571,38 +556,29 @@ module Google # Lists all services belonging to a namespace. # @param [String] parent - # Required. The resource name of the namespace whose services we'd - # like to list. + # Required. The resource name of the namespace whose services we'd like to list. # @param [String] filter - # Optional. The filter to list result by. - # General filter string syntax: - # () - # can be "name", or "metadata." for map field. - # can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and - # is roughly the same as "=". - # must be the same data type as field. - # can be "AND, OR, NOT". - # Examples of valid filters: - # * "metadata.owner" returns Services that have a label with the key "owner" - # this is the same as "metadata:owner". - # * "metadata.protocol=gRPC" returns Services that have key/value - # "protocol=gRPC". - # * "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/ - # service-c" - # returns Services that have name that is alphabetically later than the - # string, so "service-e" will be returned but "service-a" will not be. - # * "metadata.owner!=sd AND metadata.foo=bar" returns Services that have - # "owner" in label key but value is not "sd" AND have key/value foo=bar. - # * "doesnotexist.foo=bar" returns an empty list. Note that Service doesn't - # have a field called "doesnotexist". Since the filter does not match any - # Services, it returns no results. + # Optional. The filter to list result by. General filter string syntax: () can + # be "name", or "metadata." for map field. can be "<, >, <=, >=, !=, =, :". Of + # which ":" means HAS, and is roughly the same as "=". must be the same data + # type as field. can be "AND, OR, NOT". Examples of valid filters: * "metadata. + # owner" returns Services that have a label with the key "owner" this is the + # same as "metadata:owner". * "metadata.protocol=gRPC" returns Services that + # have key/value "protocol=gRPC". * "name>projects/my-project/locations/us-east/ + # namespaces/my-namespace/services/service-c" returns Services that have name + # that is alphabetically later than the string, so "service-e" will be returned + # but "service-a" will not be. * "metadata.owner!=sd AND metadata.foo=bar" + # returns Services that have "owner" in label key but value is not "sd" AND have + # key/value foo=bar. * "doesnotexist.foo=bar" returns an empty list. Note that + # Service doesn't have a field called "doesnotexist". Since the filter does not + # match any Services, it returns no results. # @param [String] order_by # Optional. The order to list result by. # @param [Fixnum] page_size # Optional. The maximum number of items to return. # @param [String] page_token - # Optional. The next_page_token value returned from a previous List request, - # if any. + # Optional. The next_page_token value returned from a previous List request, if + # any. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -636,8 +612,8 @@ module Google # Updates a service. # @param [String] name - # Immutable. The resource name for the service in the format - # 'projects/*/locations/*/namespaces/*/services/*'. + # Immutable. The resource name for the service in the format 'projects/*/ + # locations/*/namespaces/*/services/*'. # @param [Google::Apis::ServicedirectoryV1beta1::Service] service_object # @param [String] update_mask # Required. List of fields to be updated in this request. @@ -671,9 +647,8 @@ module Google execute_or_queue_command(command, &block) end - # Returns a service and its - # associated endpoints. - # Resolving a service is not considered an active developer method. + # Returns a service and its associated endpoints. Resolving a service is not + # considered an active developer method. # @param [String] name # Required. The name of the service to resolve. # @param [Google::Apis::ServicedirectoryV1beta1::ResolveServiceRequest] resolve_service_request_object @@ -708,8 +683,8 @@ module Google # Sets the IAM Policy for a resource (namespace or service only). # @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::ServicedirectoryV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -742,8 +717,8 @@ module Google # Tests IAM permissions for a resource (namespace or service only). # @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::ServicedirectoryV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -780,12 +755,11 @@ module Google # @param [Google::Apis::ServicedirectoryV1beta1::Endpoint] endpoint_object # @param [String] endpoint_id # Required. The Resource ID must be 1-63 characters long, and comply with - # RFC1035. - # Specifically, the name must be 1-63 characters long and match the regular - # expression `[a-z](?:[-a-z0-9]`0,61`[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. + # RFC1035. Specifically, the name must be 1-63 characters long and match the + # regular expression `[a-z](?:[-a-z0-9]`0,61`[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. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -878,40 +852,31 @@ module Google # Lists all endpoints. # @param [String] parent - # Required. The resource name of the service whose endpoints we'd like to - # list. + # Required. The resource name of the service whose endpoints we'd like to list. # @param [String] filter - # Optional. The filter to list result by. - # General filter string syntax: - # () - # can be "name", "address", "port" or "metadata." for map field. - # can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and - # is roughly the same as "=". - # must be the same data type as field. - # can be "AND, OR, NOT". - # Examples of valid filters: + # Optional. The filter to list result by. General filter string syntax: () can + # be "name", "address", "port" or "metadata." for map field. can be "<, >, <=, >= + # , !=, =, :". Of which ":" means HAS, and is roughly the same as "=". must be + # the same data type as field. can be "AND, OR, NOT". Examples of valid filters: # * "metadata.owner" returns Endpoints that have a label with the key "owner" - # this is the same as "metadata:owner". - # * "metadata.protocol=gRPC" returns Endpoints that have key/value - # "protocol=gRPC". - # * "address=192.108.1.105" returns Endpoints that have this address. - # * "port>8080" returns Endpoints that have port number larger than 8080. - # * "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/ - # my-service/endpoints/endpoint-c" - # returns Endpoints that have name that is alphabetically later than the - # string, so "endpoint-e" will be returned but "endpoint-a" will not be. - # * "metadata.owner!=sd AND metadata.foo=bar" returns Endpoints that have - # "owner" in label key but value is not "sd" AND have key/value foo=bar. - # * "doesnotexist.foo=bar" returns an empty list. Note that Endpoint doesn't - # have a field called "doesnotexist". Since the filter does not match any - # Endpoints, it returns no results. + # this is the same as "metadata:owner". * "metadata.protocol=gRPC" returns + # Endpoints that have key/value "protocol=gRPC". * "address=192.108.1.105" + # returns Endpoints that have this address. * "port>8080" returns Endpoints that + # have port number larger than 8080. * "name>projects/my-project/locations/us- + # east/namespaces/my-namespace/services/my-service/endpoints/endpoint-c" returns + # Endpoints that have name that is alphabetically later than the string, so " + # endpoint-e" will be returned but "endpoint-a" will not be. * "metadata.owner!= + # sd AND metadata.foo=bar" returns Endpoints that have "owner" in label key but + # value is not "sd" AND have key/value foo=bar. * "doesnotexist.foo=bar" returns + # an empty list. Note that Endpoint doesn't have a field called "doesnotexist". + # Since the filter does not match any Endpoints, it returns no results. # @param [String] order_by # Optional. The order to list result by. # @param [Fixnum] page_size # Optional. The maximum number of items to return. # @param [String] page_token - # Optional. The next_page_token value returned from a previous List request, - # if any. + # Optional. The next_page_token value returned from a previous List request, if + # any. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -945,8 +910,8 @@ module Google # Updates a endpoint. # @param [String] name - # Immutable. The resource name for the endpoint in the format - # 'projects/*/locations/*/namespaces/*/services/*/endpoints/*'. + # Immutable. The resource name for the endpoint in the format 'projects/*/ + # locations/*/namespaces/*/services/*/endpoints/*'. # @param [Google::Apis::ServicedirectoryV1beta1::Endpoint] endpoint_object # @param [String] update_mask # Required. List of fields to be updated in this request.