Close httplib2 connections.
report(parent, body=None, x__xgafv=None)
Report agent's state, e.g. agent status and tasks information
close()
Close httplib2 connections.
report(parent, body=None, x__xgafv=None)
Report agent's state, e.g. agent status and tasks information
Args:
parent: string, Required. Format: projects/{project}/locations/{location} {project} should be a project number. (required)
body: object, The request body.
The object takes the form of:
{ # Request to report agent's state. The Request itself implies the agent is healthy.
"agentInfo": { # VM Agent Info. # Agent info.
"jobId": "A String", # Optional. The assigned Job ID
"reportTime": "A String", # When the AgentInfo is generated.
"state": "A String", # Agent state.
"taskGroupId": "A String", # The assigned task group ID.
"tasks": [ # Task Info.
{ # Task Info
"runnable": "A String", # The highest index of a runnable started by the agent for this task. The runnables are indexed from 1. Value 0 is undefined.
"taskId": "A String", # ID of the Task
"taskStatus": { # Status of a task. # The status of the Task. If we need agent specific fields we should fork the public TaskStatus into an agent specific one. Or add them below.
"state": "A String", # Task state.
"statusEvents": [ # Detailed info about why the state is reached.
{ # Status event.
"description": "A String", # Description of the event.
"eventTime": "A String", # The time this event occurred.
"taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails.
"exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error.
},
"taskState": "A String", # Task State. This field is only defined for task-level status events.
"type": "A String", # Type of the event.
},
],
},
},
],
},
"agentTimingInfo": { # VM timing information # Agent timing info.
"agentStartupTime": "A String", # Agent startup time
"bootTime": "A String", # Boot timestamp of the VM OS
"scriptStartupTime": "A String", # Startup time of the Batch VM script.
},
"metadata": { # VM Agent Metadata. # Agent metadata.
"creationTime": "A String", # When the VM agent started. Use agent_startup_time instead.
"creator": "A String", # Full name of the entity that created this vm. For MIG, this path is: projects/{project}/regions/{region}/InstanceGroupManagers/{igm} The value is retrieved from the vm metadata key of "created-by".
"imageVersion": "A String", # image version for the VM that this agent is installed on.
"instance": "A String", # GCP instance name (go/instance-name).
"instanceId": "A String", # GCP instance ID (go/instance-id).
"instancePreemptionNoticeReceived": True or False, # If the GCP instance has received preemption notice.
"machineType": "A String", # Optional. machine type of the VM
"osRelease": { # parsed contents of /etc/os-release
"a_key": "A String",
},
"version": "A String", # agent binary version running on VM
"zone": "A String", # Agent zone.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response to ReportAgentStateRequest.
"defaultReportInterval": "A String", # Default report interval override
"minReportInterval": "A String", # Minimum report interval override
"tasks": [ # Tasks assigned to the agent
{ # TODO(b/182501497) The message needs to be redefined when the Agent API server updates data in storage per the backend design.
"agentTaskSpec": { # AgentTaskSpec is the user's TaskSpec representation between Agent and CLH communication. # AgentTaskSpec is the taskSpec representation between Agent and CLH communication. This field will replace the TaskSpec field above in future to have a better separation between user-facaing API and internal API.
"environment": { # AgentEnvironment is the Environment representation between Agent and CLH communication. The environment is used in both task level and agent level. # Environment variables to set before running the Task.
"encryptedVariables": { # AgentKMSEnvMap contains the encrypted key/value pair to be used in the environment on the Agent side. # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
"cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
"keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
},
"secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
"a_key": "A String",
},
"variables": { # A map of environment variable names to values.
"a_key": "A String",
},
},
"loggingOption": { # AgentTaskLoggingOption contains the options for the logging of the task. # Logging option for the task.
"labels": { # Labels to be added to the log entry. Now only cloud logging is supported.
"a_key": "A String",
},
},
"maxRunDuration": "A String", # Maximum duration the task should run before being automatically retried (if enabled) or automatically failed. Format the value of this field as a time limit in seconds followed by `s`—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.
"runnables": [ # AgentTaskRunnable is runanbles that will be executed on the agent.
{ # AgentTaskRunnable is the Runnable representation between Agent and CLH communication.
"alwaysRun": True or False, # By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
"background": True or False, # This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
"container": { # Container runnable representation on the agent side. # Container runnable.
"commands": [ # Overrides the `CMD` specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.
"A String",
],
"entrypoint": "A String", # Overrides the `ENTRYPOINT` specified in the container.
"imageUri": "A String", # The URI to pull the container image from.
"options": "A String", # Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
"volumes": [ # Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro
"A String",
],
},
"environment": { # AgentEnvironment is the Environment representation between Agent and CLH communication. The environment is used in both task level and agent level. # Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
"encryptedVariables": { # AgentKMSEnvMap contains the encrypted key/value pair to be used in the environment on the Agent side. # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
"cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
"keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
},
"secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
"a_key": "A String",
},
"variables": { # A map of environment variable names to values.
"a_key": "A String",
},
},
"ignoreExitStatus": True or False, # Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
"script": { # Script runnable representation on the agent side. # Script runnable.
"path": "A String", # Script file path on the host VM. To specify an interpreter, please add a `#!`(also known as [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the first line of the file.(For example, to execute the script using bash, `#!/bin/bash` should be the first line of the file. To execute the script using`Python3`, `#!/usr/bin/env python3` should be the first line of the file.) Otherwise, the file will by default be executed by `/bin/sh`.
"text": "A String", # Shell script text. To specify an interpreter, please add a `#!\n` at the beginning of the text.(For example, to execute the script using bash, `#!/bin/bash\n` should be added. To execute the script using`Python3`, `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will by default be executed by `/bin/sh`.
},
"timeout": "A String", # Timeout for this Runnable.
},
],
"userAccount": { # AgentTaskUserAccount contains the information of a POSIX account on the guest os which is used to execute the runnables. # User account on the VM to run the runnables in the agentTaskSpec. If not set, the runnable will be run under root user.
"gid": "A String", # gid id an unique identifier of the POSIX account group corresponding to the user account.
"uid": "A String", # uid is an unique identifier of the POSIX account corresponding to the user account.
},
},
"intendedState": "A String", # The intended state of the task.
"reachedBarrier": "A String", # The highest barrier reached by all tasks in the task's TaskGroup.
"spec": { # Spec of a task # Task Spec. This field will be replaced by agent_task_spec below in future.
"computeResource": { # Compute resource requirements. ComputeResource defines the amount of resources required for each task. Make sure your tasks have enough resources to successfully run. If you also define the types of resources for a job to use with the [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) field, make sure both fields are compatible with each other. # ComputeResource requirements.
"bootDiskMib": "A String", # Extra boot disk size in MiB for each task.
"cpuMilli": "A String", # The milliCPU count. `cpuMilli` 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](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicy) field or inside the `instanceTemplate` in the [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#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.
"memoryMib": "A String", # Memory in MiB. `memoryMib` 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](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicy) field or inside the `instanceTemplate` in the [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#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.
},
"environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables to set before running the Task.
"encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
"cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
"keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
},
"secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
"a_key": "A String",
},
"variables": { # A map of environment variable names to values.
"a_key": "A String",
},
},
"environments": { # Deprecated: please use environment(non-plural) instead.
"a_key": "A String",
},
"lifecyclePolicies": [ # Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
{ # LifecyclePolicy describes how to deal with task failures based on different conditions.
"action": "A String", # Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
"actionCondition": { # Conditions for actions to deal with task failures. # Conditions that decide why a task failure is dealt with a specific action.
"exitCodes": [ # Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
42,
],
},
},
],
"maxRetryCount": 42, # Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
"maxRunDuration": "A String", # Maximum duration the task should run before being automatically retried (if enabled) or automatically failed. Format the value of this field as a time limit in seconds followed by `s`—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.
"runnables": [ # Required. The sequence of one or more runnables (executable scripts, executable containers, and/or barriers) for each task in this task group to run. Each task runs this list of runnables in order. For a task to succeed, all of its script and container runnables each must meet at least one of the following conditions: + The runnable exited with a zero status. + The runnable didn't finish, but you enabled its `background` subfield. + The runnable exited with a non-zero status, but you enabled its `ignore_exit_status` subfield.
{ # Runnable describes instructions for executing a specific script or container as part of a Task.
"alwaysRun": True or False, # By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
"background": True or False, # Normally, a runnable that doesn't exit causes its task to fail. However, you can set this field to `true` 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.
"barrier": { # A barrier runnable automatically blocks the execution of subsequent runnables until all the tasks in the task group reach the barrier. # Barrier runnable.
"name": "A String", # Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
},
"container": { # Container runnable. # Container runnable.
"blockExternalNetwork": True or False, # If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the `container.options` field.
"commands": [ # Required for some container images. Overrides the `CMD` 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`.
"A String",
],
"enableImageStreaming": True or False, # Optional. If set to true, this container runnable uses Image streaming. Use Image streaming to allow the runnable to initialize without waiting for the entire container image to download, which can significantly reduce startup time for large container images. When `enableImageStreaming` is set to true, the container runtime is [containerd](https://containerd.io/) 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](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming).
"entrypoint": "A String", # Required for some container images. Overrides the `ENTRYPOINT` specified in the container.
"imageUri": "A String", # Required. The URI to pull the container image from.
"options": "A String", # Required for some container images. Arbitrary additional options to include in the `docker run` command when running this container—for example, `--network host`. For the `--volume` option, use the `volumes` field for the container.
"password": "A String", # Required if the container image is from a private Docker registry. The password to login to the Docker registry that contains the image. For security, it is strongly recommended to specify an encrypted password by using a Secret Manager secret: `projects/*/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](https://cloud.google.com/secret-manager/docs/) and [using Secret Manager with Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
"username": "A String", # Required if the container image is from a private Docker registry. The username to login to the Docker registry that contains the image. You can either specify the username directly by using plain text or specify an encrypted username by using a Secret Manager secret: `projects/*/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](https://cloud.google.com/secret-manager/docs/) and [using Secret Manager with Batch](https://cloud.google.com/batch/docs/create-run-job-secret-manager).
"volumes": [ # Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match `--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.
"A String",
],
},
"displayName": "A String", # Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs.
"environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
"encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
"cipherText": "A String", # The value of the cipherText response from the `encrypt` method.
"keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text.
},
"secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
"a_key": "A String",
},
"variables": { # A map of environment variable names to values.
"a_key": "A String",
},
},
"ignoreExitStatus": True or False, # Normally, a runnable that returns a non-zero exit status fails and causes the task to fail. However, you can set this field to `true` to allow the task to continue executing its other runnables even if this runnable fails.
"labels": { # Labels for this Runnable.
"a_key": "A String",
},
"script": { # Script runnable. # Script runnable.
"path": "A String", # The path to a script file that is accessible from the host VM(s). Unless the script file supports the default `#!/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.
"text": "A String", # The text for a script. Unless the script text supports the default `#!/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.
},
"timeout": "A String", # Timeout for this Runnable.
},
],
"volumes": [ # Volumes to mount before running Tasks using this TaskSpec.
{ # Volume describes a volume and parameters for it to be mounted to a VM.
"deviceName": "A String", # Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
"gcs": { # Represents a Google Cloud Storage volume. # A Google Cloud Storage (GCS) volume.
"remotePath": "A String", # Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
},
"mountOptions": [ # Mount options vary based on the type of storage volume: * For a Cloud Storage bucket, all the mount options provided by the [`gcsfuse` tool](https://cloud.google.com/storage/docs/gcsfuse-cli) are supported. * For an existing persistent disk, all mount options provided by the [`mount` command](https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of [multi-writer mode](https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). * For any other disk or a Network File System (NFS), all the mount options provided by the `mount` command are supported.
"A String",
],
"mountPath": "A String", # The mount path for the volume, e.g. /mnt/disks/share.
"nfs": { # Represents an NFS volume. # A Network File System (NFS) volume. For example, a Filestore file share.
"remotePath": "A String", # Remote source path exported from the NFS, e.g., "/share".
"server": "A String", # The IP address of the NFS.
},
},
],
},
"status": { # Status of a task. # Task status.
"state": "A String", # Task state.
"statusEvents": [ # Detailed info about why the state is reached.
{ # Status event.
"description": "A String", # Description of the event.
"eventTime": "A String", # The time this event occurred.
"taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails.
"exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error.
},
"taskState": "A String", # Task State. This field is only defined for task-level status events.
"type": "A String", # Type of the event.
},
],
},
"task": "A String", # Task name.
"taskSource": "A String", # TaskSource represents the source of the task.
},
],
"useBatchMonitoredResource": True or False, # If true, the cloud logging for batch agent will use batch.googleapis.com/Job as monitored resource for Batch job related logging.
}