googleapis
Version:
Google APIs Client Library for Node.js
1,070 lines • 146 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace batch_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Batch API
*
* An API to manage the running of batch jobs on Google Cloud Platform.
*
* @example
* ```js
* const {google} = require('googleapis');
* const batch = google.batch('v1');
* ```
*/
export class Batch {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Accelerator describes Compute Engine accelerators to be attached to the VM.
*/
export interface Schema$Accelerator {
/**
* The number of accelerators of this type.
*/
count?: string | null;
/**
* Deprecated: please use instances[0].install_gpu_drivers instead.
*/
installGpuDrivers?: boolean | null;
/**
* The accelerator type. For example, "nvidia-tesla-t4". See `gcloud compute accelerator-types list`.
*/
type?: string | null;
}
/**
* Conditions for actions to deal with task failures.
*/
export interface Schema$ActionCondition {
/**
* 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.
*/
exitCodes?: number[] | null;
}
/**
* VM Agent Info.
*/
export interface Schema$AgentInfo {
/**
* The assigned Job ID
*/
jobId?: string | null;
/**
* When the AgentInfo is generated.
*/
reportTime?: string | null;
/**
* Agent state.
*/
state?: string | null;
/**
* The assigned task group ID.
*/
taskGroupId?: string | null;
/**
* Task Info.
*/
tasks?: Schema$AgentTaskInfo[];
}
/**
* AgentMetadata never changes for a single instance of VM agent.
*/
export interface Schema$AgentMetadata {
/**
* When the VM agent started.
*/
creationTime?: string | null;
/**
* 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".
*/
creator?: string | null;
/**
* GCP instance name (go/instance-name).
*/
instance?: string | null;
/**
* GCP instance ID (go/instance-id).
*/
instanceId?: string | null;
/**
* parsed contents of /etc/os-release
*/
osRelease?: {
[key: string]: string;
} | null;
/**
* agent binary version running on VM
*/
version?: string | null;
/**
* Agent zone.
*/
zone?: string | null;
}
/**
* TODO(b/182501497) The message needs to be redefined when the Agent API server updates data in storage per the backend design.
*/
export interface Schema$AgentTask {
/**
* The intended state of the task.
*/
intendedState?: string | null;
/**
* The highest barrier reached by all tasks in the task's TaskGroup.
*/
reachedBarrier?: string | null;
/**
* Task Spec.
*/
spec?: Schema$TaskSpec;
/**
* Task status.
*/
status?: Schema$TaskStatus;
/**
* Task name.
*/
task?: string | null;
}
/**
* Task Info
*/
export interface Schema$AgentTaskInfo {
/**
* The highest index of a runnable started by the agent for this task. The runnables are indexed from 1. Value 0 is undefined.
*/
runnable?: string | null;
/**
* ID of the Task
*/
taskId?: string | null;
/**
* 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.
*/
taskStatus?: Schema$TaskStatus;
}
/**
* A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.
*/
export interface Schema$AllocationPolicy {
/**
* Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
*/
instances?: Schema$InstancePolicyOrTemplate[];
/**
* Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Location where compute resources should be allocated for the Job.
*/
location?: Schema$LocationPolicy;
/**
* The network policy.
*/
network?: Schema$NetworkPolicy;
/**
* Service account that VMs will run as.
*/
serviceAccount?: Schema$ServiceAccount;
}
/**
* A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
*/
export interface Schema$AttachedDisk {
/**
* Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
*/
deviceName?: string | null;
/**
* Name of an existing PD.
*/
existingDisk?: string | null;
newDisk?: Schema$Disk;
}
/**
* 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.
*/
export interface Schema$AuditConfig {
/**
* The configuration for logging of each type of permission.
*/
auditLogConfigs?: Schema$AuditLogConfig[];
/**
* 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.
*/
service?: string | null;
}
/**
* 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.
*/
export interface Schema$AuditLogConfig {
/**
* Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
*/
exemptedMembers?: string[] | null;
/**
* The log type that this config enables.
*/
logType?: string | null;
}
/**
* Barrier runnable blocks until all tasks in a taskgroup reach it.
*/
export interface Schema$Barrier {
/**
* Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
*/
name?: string | null;
}
/**
* Associates `members`, or principals, with a `role`.
*/
export interface Schema$Binding {
/**
* The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
condition?: Schema$Expr;
/**
* Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `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`.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
*/
role?: string | null;
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
/**
* Compute resource requirements
*/
export interface Schema$ComputeResource {
/**
* Extra boot disk size in MiB for each task.
*/
bootDiskMib?: string | null;
/**
* The milliCPU count.
*/
cpuMilli?: string | null;
/**
* Memory in MiB.
*/
memoryMib?: string | null;
}
/**
* Container runnable.
*/
export interface Schema$Container {
/**
* If set to true, external network access to and from container will be blocked. The container will use the default internal network 'goog-internal'.
*/
blockExternalNetwork?: boolean | null;
/**
* 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.
*/
commands?: string[] | null;
/**
* Overrides the `ENTRYPOINT` specified in the container.
*/
entrypoint?: string | null;
/**
* The URI to pull the container image from.
*/
imageUri?: string | null;
/**
* Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
*/
options?: string | null;
/**
* Optional password for logging in to a docker registry. If password matches "projects/x/secrets/x/versions/x" then Batch will read the password from the Secret Manager;
*/
password?: string | null;
/**
* Optional username for logging in to a docker registry. If username matches "projects/x/secrets/x/versions/x" then Batch will read the username from the Secret Manager.
*/
username?: string | null;
/**
* 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
*/
volumes?: string[] | null;
}
/**
* A new persistent disk or a local ssd. A VM can only have one local SSD setting but multiple local SSD partitions. https://cloud.google.com/compute/docs/disks#pdspecs. https://cloud.google.com/compute/docs/disks#localssds.
*/
export interface Schema$Disk {
/**
* Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. We only support "SCSI" for persistent disks now.
*/
diskInterface?: string | null;
/**
* Name of a public or custom image used as the data source.
*/
image?: string | null;
/**
* Disk size in GB. This field is ignored if `data_source` is `disk` or `image`. If `type` is `local-ssd`, size_gb should be a multiple of 375GB, otherwise, the final size will be the next greater multiple of 375 GB.
*/
sizeGb?: string | null;
/**
* Name of a snapshot used as the data source.
*/
snapshot?: string | null;
/**
* Disk type as shown in `gcloud compute disk-types list` For example, "pd-ssd", "pd-standard", "pd-balanced", "local-ssd".
*/
type?: string | null;
}
/**
* 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); \}
*/
export interface Schema$Empty {
}
/**
* An Environment describes a collection of environment variables to set when executing Tasks.
*/
export interface Schema$Environment {
/**
* A map of environment variable names to values.
*/
variables?: {
[key: string]: string;
} | null;
}
/**
* 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.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* 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.
*/
title?: string | null;
}
/**
* Represents a Google Cloud Storage volume.
*/
export interface Schema$GCS {
/**
* Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
*/
remotePath?: string | null;
}
/**
* InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.
*/
export interface Schema$InstancePolicy {
/**
* The accelerators attached to each VM instance.
*/
accelerators?: Schema$Accelerator[];
/**
* Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted.
*/
disks?: Schema$AttachedDisk[];
/**
* The Compute Engine machine type.
*/
machineType?: string | null;
/**
* The minimum CPU platform. See `https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform`. Not yet implemented.
*/
minCpuPlatform?: string | null;
/**
* The provisioning model.
*/
provisioningModel?: string | null;
}
/**
* Either an InstancePolicy or an instance template.
*/
export interface Schema$InstancePolicyOrTemplate {
/**
* Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false.
*/
installGpuDrivers?: boolean | null;
/**
* Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
*/
instanceTemplate?: string | null;
/**
* InstancePolicy.
*/
policy?: Schema$InstancePolicy;
}
/**
* VM instance status.
*/
export interface Schema$InstanceStatus {
/**
* The Compute Engine machine type.
*/
machineType?: string | null;
/**
* The VM instance provisioning model.
*/
provisioningModel?: string | null;
/**
* The max number of tasks can be assigned to this instance type.
*/
taskPack?: string | null;
}
/**
* The Cloud Batch Job description.
*/
export interface Schema$Job {
/**
* Compute resource allocation for all TaskGroups in the Job.
*/
allocationPolicy?: Schema$AllocationPolicy;
/**
* Output only. When the Job was created.
*/
createTime?: string | null;
/**
* Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" \} You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Log preservation policy for the Job.
*/
logsPolicy?: Schema$LogsPolicy;
/**
* Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
*/
name?: string | null;
/**
* Notification configurations.
*/
notifications?: Schema$JobNotification[];
/**
* Priority of the Job. The valid value range is [0, 100). A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
*/
priority?: string | null;
/**
* Output only. Job status. It is read only for users.
*/
status?: Schema$JobStatus;
/**
* Required. TaskGroups in the Job. Only one TaskGroup is supported now.
*/
taskGroups?: Schema$TaskGroup[];
/**
* Output only. A system generated unique ID (in UUID4 format) for the Job.
*/
uid?: string | null;
/**
* Output only. The last time the Job was updated.
*/
updateTime?: string | null;
}
/**
* Notification configurations.
*/
export interface Schema$JobNotification {
/**
* The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
*/
message?: Schema$Message;
/**
* The Pub/Sub topic where notifications like the job state changes will be published. This topic exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format: `projects/{project\}/topics/{topic\}`.
*/
pubsubTopic?: string | null;
}
/**
* Job status.
*/
export interface Schema$JobStatus {
/**
* The duration of time that the Job spent in status RUNNING.
*/
runDuration?: string | null;
/**
* Job state
*/
state?: string | null;
/**
* Job status events
*/
statusEvents?: Schema$StatusEvent[];
/**
* Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
*/
taskGroups?: {
[key: string]: Schema$TaskGroupStatus;
} | null;
}
/**
* LifecyclePolicy describes how to deal with task failures based on different conditions.
*/
export interface Schema$LifecyclePolicy {
/**
* Action to execute when ActionCondition is true.
*/
action?: string | null;
/**
* Conditions that decide why a task failure is dealt with a specific action.
*/
actionCondition?: Schema$ActionCondition;
}
/**
* ListJob Response.
*/
export interface Schema$ListJobsResponse {
/**
* Jobs.
*/
jobs?: Schema$Job[];
/**
* Next page token.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* The response message for Locations.ListLocations.
*/
export interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
}
/**
* ListTasks Response.
*/
export interface Schema$ListTasksResponse {
/**
* Next page token.
*/
nextPageToken?: string | null;
/**
* Tasks.
*/
tasks?: Schema$Task[];
/**
* Locations that could not be reached.
*/
unreachable?: string[] | null;
}
/**
* A resource that represents Google Cloud Platform location.
*/
export interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string | null;
/**
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\}
*/
labels?: {
[key: string]: string;
} | null;
/**
* The canonical id for this location. For example: `"us-east1"`.
*/
locationId?: string | null;
/**
* Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
*/
name?: string | null;
}
export interface Schema$LocationPolicy {
/**
* A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
*/
allowedLocations?: string[] | null;
}
/**
* LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved.
*/
export interface Schema$LogsPolicy {
/**
* Where logs should be saved.
*/
destination?: string | null;
/**
* The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
*/
logsPath?: string | null;
}
/**
* Message details. Describe the attribute that a message should have. Without specified message attributes, no message will be sent by default.
*/
export interface Schema$Message {
/**
* The new job state.
*/
newJobState?: string | null;
/**
* The new task state.
*/
newTaskState?: string | null;
/**
* The message type.
*/
type?: string | null;
}
/**
* A network interface.
*/
export interface Schema$NetworkInterface {
/**
* The URL of the network resource.
*/
network?: string | null;
/**
* Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
*/
noExternalIpAddress?: boolean | null;
/**
* The URL of the Subnetwork resource.
*/
subnetwork?: string | null;
}
/**
* NetworkPolicy describes VM instance network configurations.
*/
export interface Schema$NetworkPolicy {
/**
* Network configurations.
*/
networkInterfaces?: Schema$NetworkInterface[];
}
/**
* Represents an NFS volume.
*/
export interface Schema$NFS {
/**
* Remote source path exported from the NFS, e.g., "/share".
*/
remotePath?: string | null;
/**
* The IP address of the NFS.
*/
server?: string | null;
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* 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.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* 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.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* 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\}`.
*/
name?: string | null;
/**
* 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`.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$OperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* 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`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
*/
export interface Schema$Policy {
/**
* Specifies cloud audit logging configuration for this policy.
*/
auditConfigs?: Schema$AuditConfig[];
/**
* Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
*/
bindings?: Schema$Binding[];
/**
* `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?: string | null;
/**
* 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).
*/
version?: number | null;
}
/**
* Request to report agent's state. The Request itself implies the agent is healthy.
*/
export interface Schema$ReportAgentStateRequest {
/**
* Agent info.
*/
agentInfo?: Schema$AgentInfo;
/**
* Agent metadata.
*/
metadata?: Schema$AgentMetadata;
}
/**
* Response to ReportAgentStateRequest.
*/
export interface Schema$ReportAgentStateResponse {
/**
* Tasks assigned to the agent
*/
tasks?: Schema$AgentTask[];
}
/**
* Runnable describes instructions for executing a specific script or container as part of a Task.
*/
export interface Schema$Runnable {
/**
* 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.
*/
alwaysRun?: boolean | null;
/**
* 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).
*/
background?: boolean | null;
/**
* Barrier runnable.
*/
barrier?: Schema$Barrier;
/**
* Container runnable.
*/
container?: Schema$Container;
/**
* Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
*/
environment?: Schema$Environment;
/**
* Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
*/
ignoreExitStatus?: boolean | null;
/**
* Script runnable.
*/
script?: Schema$Script;
/**
* Timeout for this Runnable.
*/
timeout?: string | null;
}
/**
* Script runnable.
*/
export interface Schema$Script {
/**
* Script file path on the host VM.
*/
path?: string | null;
/**
* Shell script text.
*/
text?: string | null;
}
/**
* Carries information about a Google Cloud service account.
*/
export interface Schema$ServiceAccount {
/**
* Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
*/
email?: string | null;
}
/**
* Request message for `SetIamPolicy` method.
*/
export interface Schema$SetIamPolicyRequest {
/**
* REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
*/
policy?: Schema$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"`
*/
updateMask?: string | null;
}
/**
* 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).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* 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.
*/
message?: string | null;
}
/**
* Status event
*/
export interface Schema$StatusEvent {
/**
* Description of the event.
*/
description?: string | null;
/**
* The time this event occurred.
*/
eventTime?: string | null;
/**
* Task Execution
*/
taskExecution?: Schema$TaskExecution;
/**
* Type of the event.
*/
type?: string | null;
}
/**
* A Cloud Batch task.
*/
export interface Schema$Task {
/**
* Task name. The name is generated from the parent TaskGroup name and 'id' field. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01".
*/
name?: string | null;
/**
* Task Status.
*/
status?: Schema$TaskStatus;
}
/**
* This Task Execution field includes detail information for task execution procedures, based on StatusEvent types.
*/
export interface Schema$TaskExecution {
/**
* When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
*/
exitCode?: number | null;
}
/**
* A TaskGroup contains one or multiple Tasks that share the same Runnable but with different runtime parameters.
*/
export interface Schema$TaskGroup {
/**
* Output only. TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
*/
name?: string | null;
/**
* Max number of tasks that can run in parallel. Default to min(task_count, 1000).
*/
parallelism?: string | null;
/**
* When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
*/
permissiveSsh?: boolean | null;
/**
* When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
*/
requireHostsFile?: boolean | null;
/**
* Number of Tasks in the TaskGroup. default is 1
*/
taskCount?: string | null;
/**
* Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
*/
taskCountPerNode?: string | null;
/**
* An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). task_environments supports up to 200 entries.
*/
taskEnvironments?: Schema$Environment[];
/**
* Required. Tasks in the group share the same task spec.
*/
taskSpec?: Schema$TaskSpec;
}
/**
* Aggregated task status for a TaskGroup.
*/
export interface Schema$TaskGroupStatus {
/**
* Count of task in each state in the TaskGroup. The map key is task state name.
*/
counts?: {
[key: string]: string;
} | null;
/**
* Status of instances allocated for the TaskGroup.
*/
instances?: Schema$InstanceStatus[];
}
/**
* Spec of a task
*/
export interface Schema$TaskSpec {
/**
* ComputeResource requirements.
*/
computeResource?: Schema$ComputeResource;
/**
* Environment variables to set before running the Task.
*/
environment?: Schema$Environment;
/**
* Environment variables to set before running the Task. You can set up to 100 environments.
*/
environments?: {
[key: string]: string;
} | null;
/**
* Lifecycle management schema when any task in a task group is failed. The valid size of lifecycle policies are [0, 10]. For each lifecycle policy, when the condition is met, the action in that policy will execute. If there are multiple policies that the task execution result matches, we use the action from the first matched policy. If task execution result does not meet with any of 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.
*/
lifecyclePolicies?: Schema$LifecyclePolicy[];
/**
* Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
*/
maxRetryCount?: number | null;
/**
* Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
*/
maxRunDuration?: string | null;
/**
* The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time