- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
allocation_policyType: STRUCT
Provider name: allocationPolicy
Description: Compute resource allocation for all TaskGroups in the Job.
instancesUNORDERED_LIST_STRUCTinstancesblock_project_ssh_keysBOOLEANblockProjectSshKeystrue if you want Batch to block project-level SSH keys from accessing this job’s VMs. Alternatively, you can configure the job to specify a VM instance template that blocks project-level SSH keys. In either case, Batch blocks project-level SSH keys while creating the VMs for this job. Batch allows project-level SSH keys for a job’s VMs only if all the following are true: + This field is undefined or set to false. + The job’s VM instance template (if any) doesn’t block project-level SSH keys. Notably, you can override this behavior by manually updating a VM to block or allow project-level SSH keys. For more information about blocking project-level SSH keys, see the Compute Engine documentation: https://cloud.google.com/compute/docs/connect/restrict-ssh-keys#block-keysinstall_gpu_driversBOOLEANinstallGpuDriverspolicy.accelerators or instance_template on your behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.install_ops_agentBOOLEANinstallOpsAgentinstance_templateSTRINGinstanceTemplatepolicySTRUCTpolicyacceleratorsUNORDERED_LIST_STRUCTacceleratorscountINT64countdriver_versionSTRINGdriverVersioninstall_gpu_driversBOOLEANinstallGpuDriverstypeSTRINGtypegcloud compute accelerator-types list.boot_diskSTRUCTbootDiskdisk_interfaceSTRINGdiskInterfaceimageSTRINGimagebatch-debian: use Batch Debian images. * batch-cos: use Batch Container-Optimized images. * batch-hpc-rocky: use Batch HPC Rocky Linux images.size_gbINT64sizeGbtype specifies a persistent disk, this field is ignored if data_source is set as image or snapshot. If the type specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and the boot_disk_mib field in task spec’s compute_resource are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk’s size when the data_source is set as snapshot or image. For example, if you set an image as the data_source field and the image’s default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB.snapshotSTRINGsnapshottypeSTRINGtypegcloud compute disk-types list. For example, local SSD uses type “local-ssd”. Persistent disks and boot disks use “pd-balanced”, “pd-extreme”, “pd-ssd” or “pd-standard”. If not specified, “pd-standard” will be used as the default type for non-boot disks, “pd-balanced” will be used as the default type for boot disks.disksUNORDERED_LIST_STRUCTdisksdevice_nameSTRINGdeviceNameexisting_diskSTRINGexistingDisknew_diskSTRUCTnewDiskdisk_interfaceSTRINGdiskInterfaceimageSTRINGimagebatch-debian: use Batch Debian images. * batch-cos: use Batch Container-Optimized images. * batch-hpc-rocky: use Batch HPC Rocky Linux images.size_gbINT64sizeGbtype specifies a persistent disk, this field is ignored if data_source is set as image or snapshot. If the type specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and the boot_disk_mib field in task spec’s compute_resource are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk’s size when the data_source is set as snapshot or image. For example, if you set an image as the data_source field and the image’s default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB.snapshotSTRINGsnapshottypeSTRINGtypegcloud compute disk-types list. For example, local SSD uses type “local-ssd”. Persistent disks and boot disks use “pd-balanced”, “pd-extreme”, “pd-ssd” or “pd-standard”. If not specified, “pd-standard” will be used as the default type for non-boot disks, “pd-balanced” will be used as the default type for boot disks.machine_typeSTRINGmachineTypemin_cpu_platformSTRINGminCpuPlatformprovisioning_modelSTRINGprovisioningModelPROVISIONING_MODEL_UNSPECIFIED - Unspecified.STANDARD - Standard VM.SPOT - SPOT VM.PREEMPTIBLE - Preemptible VM (PVM). Above SPOT VM is the preferable model for preemptible VM instances: the old preemptible VM model (indicated by this field) is the older model, and has been migrated to use the SPOT model as the underlying technology. This old model will still be supported.reservationSTRINGreservationlocationSTRUCTlocationallowed_locationsUNORDERED_LIST_STRINGallowedLocationsnetworkSTRUCTnetworkInstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.network_interfacesUNORDERED_LIST_STRUCTnetworkInterfacesnetworkSTRINGnetworkno_external_ip_addressBOOLEANnoExternalIpAddresssubnetworkSTRINGsubnetworkplacementSTRUCTplacementcollocationSTRINGcollocationmax_distanceINT64maxDistanceservice_accountSTRUCTserviceAccountemailSTRINGemailscopesUNORDERED_LIST_STRINGscopesancestorsType: UNORDERED_LIST_STRING
create_timeType: TIMESTAMP
Provider name: createTime
Description: Output only. When the Job was created.
gcp_statusType: STRUCT
Provider name: status
Description: Output only. Job status. It is read only for users.
run_durationSTRINGrunDurationstateSTRINGstateSTATE_UNSPECIFIED - Job state unspecified.QUEUED - Job is admitted (validated and persisted) and waiting for resources.SCHEDULED - Job is scheduled to run as soon as resource allocation is ready. The resource allocation may happen at a later time but with a high chance to succeed.RUNNING - Resource allocation has been successful. At least one Task in the Job is RUNNING.SUCCEEDED - All Tasks in the Job have finished successfully.FAILED - At least one Task in the Job has failed.DELETION_IN_PROGRESS - The Job will be deleted, but has not been deleted yet. Typically this is because resources used by the Job are still being cleaned up.CANCELLATION_IN_PROGRESS - The Job cancellation is in progress, this is because the resources used by the Job are still being cleaned up.CANCELLED - The Job has been cancelled, the task executions were stopped and the resources were cleaned up.status_eventsUNORDERED_LIST_STRUCTstatusEventsdescriptionSTRINGdescriptionevent_timeTIMESTAMPeventTimetask_executionSTRUCTtaskExecutionexit_codeINT32exitCodetask_stateSTRINGtaskStateSTATE_UNSPECIFIED - Unknown state.PENDING - The Task is created and waiting for resources.ASSIGNED - The Task is assigned to at least one VM.RUNNING - The Task is running.FAILED - The Task has failed.SUCCEEDED - The Task has succeeded.UNEXECUTED - The Task has not been executed when the Job finishes.typeSTRINGtypelabelsType: UNORDERED_LIST_STRING
logs_policyType: STRUCT
Provider name: logsPolicy
Description: Log preservation policy for the Job.
cloud_logging_optionSTRUCTcloudLoggingOptiondestination is set to CLOUD_LOGGING, you can optionally set this field to configure additional settings for Cloud Logging.use_generic_task_monitored_resourceBOOLEANuseGenericTaskMonitoredResourcetrue to change the monitored resource type for Cloud Logging logs generated by this Batch job from the batch.googleapis.com/Job type to the formerly used generic_task type.destinationSTRINGdestinationDESTINATION_UNSPECIFIED - (Default) Logs are not preserved.CLOUD_LOGGING - Logs are streamed to Cloud Logging. Optionally, you can configure additional settings in the cloudLoggingOption field.PATH - Logs are saved to the file path specified in the logsPath field.logs_pathSTRINGlogsPathdestination is set to PATH, you must set this field to the path where you want logs to be saved. This path can point to a local directory on the VM or (if congifured) a directory under the mount path of any Cloud Storage bucket, network file system (NFS), or writable persistent disk that is mounted to the job. For example, if the job has a bucket with mountPath set to /mnt/disks/my-bucket, you can write logs to the root directory of the remotePath of that bucket by setting this field to /mnt/disks/my-bucket/.nameType: STRING
Provider name: name
Description: Output only. Job name. For example: “projects/123456/locations/us-central1/jobs/job01”.
notificationsType: UNORDERED_LIST_STRUCT
Provider name: notifications
Description: Notification configurations.
messageSTRUCTmessagenew_job_stateSTRINGnewJobStateSTATE_UNSPECIFIED - Job state unspecified.QUEUED - Job is admitted (validated and persisted) and waiting for resources.SCHEDULED - Job is scheduled to run as soon as resource allocation is ready. The resource allocation may happen at a later time but with a high chance to succeed.RUNNING - Resource allocation has been successful. At least one Task in the Job is RUNNING.SUCCEEDED - All Tasks in the Job have finished successfully.FAILED - At least one Task in the Job has failed.DELETION_IN_PROGRESS - The Job will be deleted, but has not been deleted yet. Typically this is because resources used by the Job are still being cleaned up.CANCELLATION_IN_PROGRESS - The Job cancellation is in progress, this is because the resources used by the Job are still being cleaned up.CANCELLED - The Job has been cancelled, the task executions were stopped and the resources were cleaned up.new_task_stateSTRINGnewTaskStateSTATE_UNSPECIFIED - Unknown state.PENDING - The Task is created and waiting for resources.ASSIGNED - The Task is assigned to at least one VM.RUNNING - The Task is running.FAILED - The Task has failed.SUCCEEDED - The Task has succeeded.UNEXECUTED - The Task has not been executed when the Job finishes.typeSTRINGtypeTYPE_UNSPECIFIED - Unspecified.JOB_STATE_CHANGED - Notify users that the job state has changed.TASK_STATE_CHANGED - Notify users that the task state has changed.pubsub_topicSTRINGpubsubTopicprojects/{project}/topics/{topic}. Notably, if you want to specify a Pub/Sub topic that is in a different project than the job, your administrator must grant your project’s Batch service agent permission to publish to that topic. For more information about configuring Pub/Sub notifications for a job, see https://cloud.google.com/batch/docs/enable-notifications.organization_idType: STRING
parentType: STRING
priorityType: INT64
Provider name: priority
Description: Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
project_idType: STRING
project_numberType: STRING
resource_nameType: STRING
tagsType: UNORDERED_LIST_STRING
task_groupsType: UNORDERED_LIST_STRUCT
Provider name: taskGroups
Description: Required. TaskGroups in the Job. Only one TaskGroup is supported now.
nameSTRINGnameparallelismINT64parallelismpermissive_sshBOOLEANpermissiveSshrequire_hosts_fileBOOLEANrequireHostsFilerun_as_non_rootBOOLEANrunAsNonRootscheduling_policySTRINGschedulingPolicySCHEDULING_POLICY_UNSPECIFIED - Unspecified.AS_SOON_AS_POSSIBLE - Run Tasks as soon as resources are available. Tasks might be executed in parallel depending on parallelism and task_count values.IN_ORDER - Run Tasks sequentially with increased task index.task_countINT64taskCounttask_count_per_nodeINT64taskCountPerNodetask_environmentsUNORDERED_LIST_STRUCTtaskEnvironmentsencrypted_variablesSTRUCTencryptedVariablescipher_textSTRINGcipherTextencrypt method.key_nameSTRINGkeyNametask_specSTRUCTtaskSpeccompute_resourceSTRUCTcomputeResourceboot_disk_mibINT64bootDiskMibcpu_milliINT64cpuMillicpuMilli defines the amount of CPU resources per task in milliCPU units. For example, 1000 corresponds to 1 vCPU per task. If undefined, the default value is 2000. If you also define the VM’s machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the n2-standard-2 machine type, which has 2 vCPUs each, you are recommended to set cpuMilli no more than 2000, or you are recommended to run two tasks on the same VM if you set cpuMilli to 1000 or less.memory_mibINT64memoryMibmemoryMib defines the amount of memory per task in MiB units. If undefined, the default value is 2000. If you also define the VM’s machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the n2-standard-2 machine type, which has 8 GiB each, you are recommended to set memoryMib to no more than 8192, or you are recommended to run two tasks on the same VM if you set memoryMib to 4096 or less.environmentSTRUCTenvironmentencrypted_variablesSTRUCTencryptedVariablescipher_textSTRINGcipherTextencrypt method.key_nameSTRINGkeyNamelifecycle_policiesUNORDERED_LIST_STRUCTlifecyclePoliciesactionSTRINGactionACTION_UNSPECIFIED - Action unspecified.RETRY_TASK - Action that tasks in the group will be scheduled to re-execute.FAIL_TASK - Action that tasks in the group will be stopped immediately.action_conditionSTRUCTactionConditionexit_codesUNORDERED_LIST_INT32exitCodesmax_retry_countINT32maxRetryCountmax_run_durationSTRINGmaxRunDurations—for example, 3600s for 1 hour. The field accepts any value between 0 and the maximum listed for the Duration field type at https://protobuf.dev/reference/protobuf/google.protobuf/#duration; however, the actual maximum run time for a job will be limited to the maximum run time for a job listed at https://cloud.google.com/batch/quotas#max-job-duration.runnablesUNORDERED_LIST_STRUCTrunnablesbackground subfield. + The runnable exited with a non-zero status, but you enabled its ignore_exit_status subfield.always_runBOOLEANalwaysRunbackgroundBOOLEANbackgroundtrue to configure a background runnable. Background runnables are allowed continue running in the background while the task executes subsequent runnables. For example, background runnables are useful for providing services to other runnables or providing debugging-support tools like SSH servers. Specifically, background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as task failures.barrierSTRUCTbarriernameSTRINGnamecontainerSTRUCTcontainerblock_external_networkBOOLEANblockExternalNetworkcontainer.options field.commandsUNORDERED_LIST_STRINGcommandsCMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then these commands are appended as arguments to the ENTRYPOINT.enable_image_streamingBOOLEANenableImageStreamingenableImageStreaming is set to true, the container runtime is containerd instead of Docker. Additionally, this container runnable only supports the following container subfields: imageUri, commands[], entrypoint, and volumes[]; any other container subfields are ignored. For more information about the requirements and limitations for using Image streaming with Batch, see the image-streaming sample on GitHub.entrypointSTRINGentrypointENTRYPOINT specified in the container.image_uriSTRINGimageUrioptionsSTRINGoptionsdocker run command when running this container—for example, --network host. For the --volume option, use the volumes field for the container.passwordSTRINGpasswordprojects/*/secrets/*/versions/*. Warning: If you specify the password using plain text, you risk the password being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the password instead. Learn more about Secret Manager and using Secret Manager with Batch.usernameSTRINGusernameprojects/*/secrets/*/versions/*. However, using a secret is recommended for enhanced security. Caution: If you specify the username using plain text, you risk the username being exposed to any users who can view the job or its logs. To avoid this risk, specify a secret that contains the username instead. Learn more about Secret Manager and using Secret Manager with Batch.volumesUNORDERED_LIST_STRINGvolumes--volume option for the docker run command—for example, /foo:/bar or /foo:/bar:ro. If the TaskSpec.Volumes field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in TaskSpec.Volumes. If you need different mount settings, you can explicitly configure them in this field.environmentSTRUCTenvironmentencrypted_variablesSTRUCTencryptedVariablescipher_textSTRINGcipherTextencrypt method.key_nameSTRINGkeyNamegcp_display_nameSTRINGdisplayNameignore_exit_statusBOOLEANignoreExitStatustrue to allow the task to continue executing its other runnables even if this runnable fails.scriptSTRUCTscriptpathSTRINGpath#!/bin/sh shell interpreter, you must specify an interpreter by including a [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) as the first line of the file. For example, to execute the script using bash, include #!/bin/bash as the first line of the file. Alternatively, to execute the script using Python3, include #!/usr/bin/env python3 as the first line of the file.textSTRINGtext#!/bin/sh shell interpreter, you must specify an interpreter by including a [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) at the beginning of the text. For example, to execute the script using bash, include #!/bin/bash\n at the beginning of the text. Alternatively, to execute the script using Python3, include #!/usr/bin/env python3\n at the beginning of the text.timeoutSTRINGtimeoutvolumesUNORDERED_LIST_STRUCTvolumesdevice_nameSTRINGdeviceNamegcsSTRUCTgcsremote_pathSTRINGremotePathmount_optionsUNORDERED_LIST_STRINGmountOptionsgcsfuse tool are supported. * For an existing persistent disk, all mount options provided by the mount command except writing are supported. This is due to restrictions of multi-writer mode. * For any other disk or a Network File System (NFS), all the mount options provided by the mount command are supported.mount_pathSTRINGmountPathnfsSTRUCTnfsremote_pathSTRINGremotePathserverSTRINGserveruidType: STRING
Provider name: uid
Description: Output only. A system generated unique ID for the Job.
update_timeType: TIMESTAMP
Provider name: updateTime
Description: Output only. The last time the Job was updated.
| |