Variables
LogsPolicy_Destination_name, LogsPolicy_Destination_value
var (
LogsPolicy_Destination_name = map[int32]string{
0: "DESTINATION_UNSPECIFIED",
1: "CLOUD_LOGGING",
2: "PATH",
}
LogsPolicy_Destination_value = map[string]int32{
"DESTINATION_UNSPECIFIED": 0,
"CLOUD_LOGGING": 1,
"PATH": 2,
}
)Enum value maps for LogsPolicy_Destination.
JobStatus_State_name, JobStatus_State_value
var (
JobStatus_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "QUEUED",
2: "SCHEDULED",
3: "RUNNING",
4: "SUCCEEDED",
5: "FAILED",
6: "DELETION_IN_PROGRESS",
}
JobStatus_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"QUEUED": 1,
"SCHEDULED": 2,
"RUNNING": 3,
"SUCCEEDED": 4,
"FAILED": 5,
"DELETION_IN_PROGRESS": 6,
}
)Enum value maps for JobStatus_State.
JobNotification_Type_name, JobNotification_Type_value
var (
JobNotification_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "JOB_STATE_CHANGED",
2: "TASK_STATE_CHANGED",
}
JobNotification_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"JOB_STATE_CHANGED": 1,
"TASK_STATE_CHANGED": 2,
}
)Enum value maps for JobNotification_Type.
AllocationPolicy_ProvisioningModel_name, AllocationPolicy_ProvisioningModel_value
var (
AllocationPolicy_ProvisioningModel_name = map[int32]string{
0: "PROVISIONING_MODEL_UNSPECIFIED",
1: "STANDARD",
2: "SPOT",
3: "PREEMPTIBLE",
}
AllocationPolicy_ProvisioningModel_value = map[string]int32{
"PROVISIONING_MODEL_UNSPECIFIED": 0,
"STANDARD": 1,
"SPOT": 2,
"PREEMPTIBLE": 3,
}
)Enum value maps for AllocationPolicy_ProvisioningModel.
TaskGroup_SchedulingPolicy_name, TaskGroup_SchedulingPolicy_value
var (
TaskGroup_SchedulingPolicy_name = map[int32]string{
0: "SCHEDULING_POLICY_UNSPECIFIED",
1: "AS_SOON_AS_POSSIBLE",
2: "IN_ORDER",
}
TaskGroup_SchedulingPolicy_value = map[string]int32{
"SCHEDULING_POLICY_UNSPECIFIED": 0,
"AS_SOON_AS_POSSIBLE": 1,
"IN_ORDER": 2,
}
)Enum value maps for TaskGroup_SchedulingPolicy.
TaskStatus_State_name, TaskStatus_State_value
var (
TaskStatus_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "PENDING",
2: "ASSIGNED",
3: "RUNNING",
4: "FAILED",
5: "SUCCEEDED",
6: "UNEXECUTED",
}
TaskStatus_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"PENDING": 1,
"ASSIGNED": 2,
"RUNNING": 3,
"FAILED": 4,
"SUCCEEDED": 5,
"UNEXECUTED": 6,
}
)Enum value maps for TaskStatus_State.
LifecyclePolicy_Action_name, LifecyclePolicy_Action_value
var (
LifecyclePolicy_Action_name = map[int32]string{
0: "ACTION_UNSPECIFIED",
1: "RETRY_TASK",
2: "FAIL_TASK",
}
LifecyclePolicy_Action_value = map[string]int32{
"ACTION_UNSPECIFIED": 0,
"RETRY_TASK": 1,
"FAIL_TASK": 2,
}
)Enum value maps for LifecyclePolicy_Action.
File_google_cloud_batch_v1_batch_proto
var File_google_cloud_batch_v1_batch_proto protoreflect.FileDescriptorFile_google_cloud_batch_v1_job_proto
var File_google_cloud_batch_v1_job_proto protoreflect.FileDescriptorFile_google_cloud_batch_v1_task_proto
var File_google_cloud_batch_v1_task_proto protoreflect.FileDescriptorFile_google_cloud_batch_v1_volume_proto
var File_google_cloud_batch_v1_volume_proto protoreflect.FileDescriptorFunctions
func RegisterBatchServiceServer
func RegisterBatchServiceServer(s *grpc.Server, srv BatchServiceServer)AllocationPolicy
type AllocationPolicy struct {
Location *AllocationPolicy_LocationPolicy `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
Instances []*AllocationPolicy_InstancePolicyOrTemplate `protobuf:"bytes,8,rep,name=instances,proto3" json:"instances,omitempty"`
ServiceAccount *ServiceAccount `protobuf:"bytes,9,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
Labels map[string]string "" /* 153 byte string literal not displayed */
Network *AllocationPolicy_NetworkPolicy `protobuf:"bytes,7,opt,name=network,proto3" json:"network,omitempty"`
Placement *AllocationPolicy_PlacementPolicy `protobuf:"bytes,10,opt,name=placement,proto3" json:"placement,omitempty"`
Tags []string `protobuf:"bytes,11,rep,name=tags,proto3" json:"tags,omitempty"`
}A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job.
func (*AllocationPolicy) Descriptor
func (*AllocationPolicy) Descriptor() ([]byte, []int)Deprecated: Use AllocationPolicy.ProtoReflect.Descriptor instead.
func (*AllocationPolicy) GetInstances
func (x *AllocationPolicy) GetInstances() []*AllocationPolicy_InstancePolicyOrTemplatefunc (*AllocationPolicy) GetLabels
func (x *AllocationPolicy) GetLabels() map[string]stringfunc (*AllocationPolicy) GetLocation
func (x *AllocationPolicy) GetLocation() *AllocationPolicy_LocationPolicyfunc (*AllocationPolicy) GetNetwork
func (x *AllocationPolicy) GetNetwork() *AllocationPolicy_NetworkPolicyfunc (*AllocationPolicy) GetPlacement
func (x *AllocationPolicy) GetPlacement() *AllocationPolicy_PlacementPolicyfunc (*AllocationPolicy) GetServiceAccount
func (x *AllocationPolicy) GetServiceAccount() *ServiceAccountfunc (*AllocationPolicy) GetTags
func (x *AllocationPolicy) GetTags() []stringfunc (*AllocationPolicy) ProtoMessage
func (*AllocationPolicy) ProtoMessage()func (*AllocationPolicy) ProtoReflect
func (x *AllocationPolicy) ProtoReflect() protoreflect.Messagefunc (*AllocationPolicy) Reset
func (x *AllocationPolicy) Reset()func (*AllocationPolicy) String
func (x *AllocationPolicy) String() stringAllocationPolicy_Accelerator
type AllocationPolicy_Accelerator struct {
// The accelerator type. For example, "nvidia-tesla-t4".
// See `gcloud compute accelerator-types list`.
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
// The number of accelerators of this type.
Count int64 `protobuf:"varint,2,opt,name=count,proto3" json:"count,omitempty"`
// Deprecated: please use instances[0].install_gpu_drivers instead.
//
// Deprecated: Marked as deprecated in google/cloud/batch/v1/job.proto.
InstallGpuDrivers bool `protobuf:"varint,3,opt,name=install_gpu_drivers,json=installGpuDrivers,proto3" json:"install_gpu_drivers,omitempty"`
// Optional. The NVIDIA GPU driver version that should be installed for this
// type.
//
// You can define the specific driver version such as "470.103.01",
// following the driver version requirements in
// https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver.
// Batch will install the specific accelerator driver if qualified.
DriverVersion string `protobuf:"bytes,4,opt,name=driver_version,json=driverVersion,proto3" json:"driver_version,omitempty"`
// contains filtered or unexported fields
}Accelerator describes Compute Engine accelerators to be attached to the VM.
func (*AllocationPolicy_Accelerator) Descriptor
func (*AllocationPolicy_Accelerator) Descriptor() ([]byte, []int)Deprecated: Use AllocationPolicy_Accelerator.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_Accelerator) GetCount
func (x *AllocationPolicy_Accelerator) GetCount() int64func (*AllocationPolicy_Accelerator) GetDriverVersion
func (x *AllocationPolicy_Accelerator) GetDriverVersion() stringfunc (*AllocationPolicy_Accelerator) GetInstallGpuDrivers
func (x *AllocationPolicy_Accelerator) GetInstallGpuDrivers() boolDeprecated: Marked as deprecated in google/cloud/batch/v1/job.proto.
func (*AllocationPolicy_Accelerator) GetType
func (x *AllocationPolicy_Accelerator) GetType() stringfunc (*AllocationPolicy_Accelerator) ProtoMessage
func (*AllocationPolicy_Accelerator) ProtoMessage()func (*AllocationPolicy_Accelerator) ProtoReflect
func (x *AllocationPolicy_Accelerator) ProtoReflect() protoreflect.Messagefunc (*AllocationPolicy_Accelerator) Reset
func (x *AllocationPolicy_Accelerator) Reset()func (*AllocationPolicy_Accelerator) String
func (x *AllocationPolicy_Accelerator) String() stringAllocationPolicy_AttachedDisk
type AllocationPolicy_AttachedDisk struct {
// Types that are assignable to Attached:
//
// *AllocationPolicy_AttachedDisk_NewDisk
// *AllocationPolicy_AttachedDisk_ExistingDisk
Attached isAllocationPolicy_AttachedDisk_Attached `protobuf_oneof:"attached"`
// 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 `protobuf:"bytes,3,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"`
// contains filtered or unexported fields
}A new or an existing persistent disk (PD) or a local ssd attached to a VM instance.
func (*AllocationPolicy_AttachedDisk) Descriptor
func (*AllocationPolicy_AttachedDisk) Descriptor() ([]byte, []int)Deprecated: Use AllocationPolicy_AttachedDisk.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_AttachedDisk) GetAttached
func (m *AllocationPolicy_AttachedDisk) GetAttached() isAllocationPolicy_AttachedDisk_Attachedfunc (*AllocationPolicy_AttachedDisk) GetDeviceName
func (x *AllocationPolicy_AttachedDisk) GetDeviceName() stringfunc (*AllocationPolicy_AttachedDisk) GetExistingDisk
func (x *AllocationPolicy_AttachedDisk) GetExistingDisk() stringfunc (*AllocationPolicy_AttachedDisk) GetNewDisk
func (x *AllocationPolicy_AttachedDisk) GetNewDisk() *AllocationPolicy_Diskfunc (*AllocationPolicy_AttachedDisk) ProtoMessage
func (*AllocationPolicy_AttachedDisk) ProtoMessage()func (*AllocationPolicy_AttachedDisk) ProtoReflect
func (x *AllocationPolicy_AttachedDisk) ProtoReflect() protoreflect.Messagefunc (*AllocationPolicy_AttachedDisk) Reset
func (x *AllocationPolicy_AttachedDisk) Reset()func (*AllocationPolicy_AttachedDisk) String
func (x *AllocationPolicy_AttachedDisk) String() stringAllocationPolicy_AttachedDisk_ExistingDisk
type AllocationPolicy_AttachedDisk_ExistingDisk struct {
// Name of an existing PD.
ExistingDisk string `protobuf:"bytes,2,opt,name=existing_disk,json=existingDisk,proto3,oneof"`
}AllocationPolicy_AttachedDisk_NewDisk
type AllocationPolicy_AttachedDisk_NewDisk struct {
NewDisk *AllocationPolicy_Disk `protobuf:"bytes,1,opt,name=new_disk,json=newDisk,proto3,oneof"`
}AllocationPolicy_Disk
type AllocationPolicy_Disk struct {
// A data source from which a PD will be created.
//
// Types that are assignable to DataSource:
//
// *AllocationPolicy_Disk_Image
// *AllocationPolicy_Disk_Snapshot
DataSource isAllocationPolicy_Disk_DataSource `protobuf_oneof:"data_source"`
// Disk type as shown in `gcloud 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.
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
// Disk size in GB.
//
// **Non-Boot Disk**:
// If the `type` 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.
SizeGb int64 `protobuf:"varint,2,opt,name=size_gb,json=sizeGb,proto3" json:"size_gb,omitempty"`
// Local SSDs are available through both "SCSI" and "NVMe" interfaces.
// If not indicated, "NVMe" will be the default one for local ssds.
// This field is ignored for persistent disks as the interface is chosen
// automatically. See
// https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
DiskInterface string `protobuf:"bytes,6,opt,name=disk_interface,json=diskInterface,proto3" json:"disk_interface,omitempty"`
// contains filtered or unexported fields
}A new persistent disk or a local ssd. A VM can only have one local SSD setting but multiple local SSD partitions. See https://cloud.google.com/compute/docs/disks#pdspecs and https://cloud.google.com/compute/docs/disks#localssds.
func (*AllocationPolicy_Disk) Descriptor
func (*AllocationPolicy_Disk) Descriptor() ([]byte, []int)Deprecated: Use AllocationPolicy_Disk.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_Disk) GetDataSource
func (m *AllocationPolicy_Disk) GetDataSource() isAllocationPolicy_Disk_DataSourcefunc (*AllocationPolicy_Disk) GetDiskInterface
func (x *AllocationPolicy_Disk) GetDiskInterface() stringfunc (*AllocationPolicy_Disk) GetImage
func (x *AllocationPolicy_Disk) GetImage() stringfunc (*AllocationPolicy_Disk) GetSizeGb
func (x *AllocationPolicy_Disk) GetSizeGb() int64func (*AllocationPolicy_Disk) GetSnapshot
func (x *AllocationPolicy_Disk) GetSnapshot() stringfunc (*AllocationPolicy_Disk) GetType
func (x *AllocationPolicy_Disk) GetType() stringfunc (*AllocationPolicy_Disk) ProtoMessage
func (*AllocationPolicy_Disk) ProtoMessage()func (*AllocationPolicy_Disk) ProtoReflect
func (x *AllocationPolicy_Disk) ProtoReflect() protoreflect.Messagefunc (*AllocationPolicy_Disk) Reset
func (x *AllocationPolicy_Disk) Reset()func (*AllocationPolicy_Disk) String
func (x *AllocationPolicy_Disk) String() stringAllocationPolicy_Disk_Image
type AllocationPolicy_Disk_Image struct {
// URL for a VM image to use as the data source for this disk.
// For example, the following are all valid URLs:
//
// * Specify the image by its family name:
// projects/{project}/global/images/family/{image_family}
// * Specify the image version:
// projects/{project}/global/images/{image_version}
//
// You can also use Batch customized image in short names.
// The following image values are supported for a boot disk:
//
// * `batch-debian`: use Batch Debian images.
// * `batch-cos`: use Batch Container-Optimized images.
// * `batch-hpc-rocky`: use Batch HPC Rocky Linux images.
Image string `protobuf:"bytes,4,opt,name=image,proto3,oneof"`
}AllocationPolicy_Disk_Snapshot
type AllocationPolicy_Disk_Snapshot struct {
// Name of a snapshot used as the data source.
// Snapshot is not supported as boot disk now.
Snapshot string `protobuf:"bytes,5,opt,name=snapshot,proto3,oneof"`
}AllocationPolicy_InstancePolicy
type AllocationPolicy_InstancePolicy struct {
MachineType string `protobuf:"bytes,2,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
MinCpuPlatform string `protobuf:"bytes,3,opt,name=min_cpu_platform,json=minCpuPlatform,proto3" json:"min_cpu_platform,omitempty"`
ProvisioningModel AllocationPolicy_ProvisioningModel "" /* 175 byte string literal not displayed */
Accelerators []*AllocationPolicy_Accelerator `protobuf:"bytes,5,rep,name=accelerators,proto3" json:"accelerators,omitempty"`
BootDisk *AllocationPolicy_Disk `protobuf:"bytes,8,opt,name=boot_disk,json=bootDisk,proto3" json:"boot_disk,omitempty"`
Disks []*AllocationPolicy_AttachedDisk `protobuf:"bytes,6,rep,name=disks,proto3" json:"disks,omitempty"`
Reservation string `protobuf:"bytes,7,opt,name=reservation,proto3" json:"reservation,omitempty"`
}InstancePolicy describes an instance type and resources attached to each VM created by this InstancePolicy.
func (*AllocationPolicy_InstancePolicy) Descriptor
func (*AllocationPolicy_InstancePolicy) Descriptor() ([]byte, []int)Deprecated: Use AllocationPolicy_InstancePolicy.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_InstancePolicy) GetAccelerators
func (x *AllocationPolicy_InstancePolicy) GetAccelerators() []*AllocationPolicy_Acceleratorfunc (*AllocationPolicy_InstancePolicy) GetBootDisk
func (x *AllocationPolicy_InstancePolicy) GetBootDisk() *AllocationPolicy_Diskfunc (*AllocationPolicy_InstancePolicy) GetDisks
func (x *AllocationPolicy_InstancePolicy) GetDisks() []*AllocationPolicy_AttachedDiskfunc (*AllocationPolicy_InstancePolicy) GetMachineType
func (x *AllocationPolicy_InstancePolicy) GetMachineType() stringfunc (*AllocationPolicy_InstancePolicy) GetMinCpuPlatform
func (x *AllocationPolicy_InstancePolicy) GetMinCpuPlatform() stringfunc (*AllocationPolicy_InstancePolicy) GetProvisioningModel
func (x *AllocationPolicy_InstancePolicy) GetProvisioningModel() AllocationPolicy_ProvisioningModelfunc (*AllocationPolicy_InstancePolicy) GetReservation
func (x *AllocationPolicy_InstancePolicy) GetReservation() stringfunc (*AllocationPolicy_InstancePolicy) ProtoMessage
func (*AllocationPolicy_InstancePolicy) ProtoMessage()func (*AllocationPolicy_InstancePolicy) ProtoReflect
func (x *AllocationPolicy_InstancePolicy) ProtoReflect() protoreflect.Messagefunc (*AllocationPolicy_InstancePolicy) Reset
func (x *AllocationPolicy_InstancePolicy) Reset()func (*AllocationPolicy_InstancePolicy) String
func (x *AllocationPolicy_InstancePolicy) String() stringAllocationPolicy_InstancePolicyOrTemplate
type AllocationPolicy_InstancePolicyOrTemplate struct {
// Types that are assignable to PolicyTemplate:
//
// *AllocationPolicy_InstancePolicyOrTemplate_Policy
// *AllocationPolicy_InstancePolicyOrTemplate_InstanceTemplate
PolicyTemplate isAllocationPolicy_InstancePolicyOrTemplate_PolicyTemplate `protobuf_oneof:"policy_template"`
// Set this field true if you want Batch to help fetch drivers from a third
// party location and install them for GPUs specified in
// `policy.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.
InstallGpuDrivers bool `protobuf:"varint,3,opt,name=install_gpu_drivers,json=installGpuDrivers,proto3" json:"install_gpu_drivers,omitempty"`
// Optional. Set this field true if you want Batch to install Ops Agent on
// your behalf. Default is false.
InstallOpsAgent bool `protobuf:"varint,4,opt,name=install_ops_agent,json=installOpsAgent,proto3" json:"install_ops_agent,omitempty"`
// Optional. Set this field to `true` 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-keys
BlockProjectSshKeys bool `protobuf:"varint,5,opt,name=block_project_ssh_keys,json=blockProjectSshKeys,proto3" json:"block_project_ssh_keys,omitempty"`
// contains filtered or unexported fields
}InstancePolicyOrTemplate lets you define the type of resources to use for this job either with an InstancePolicy or an instance template. If undefined, Batch picks the type of VM to use and doesn't include optional VM resources such as GPUs and extra disks.
func (*AllocationPolicy_InstancePolicyOrTemplate) Descriptor
func (*AllocationPolicy_InstancePolicyOrTemplate) Descriptor() ([]byte, []int)Deprecated: Use AllocationPolicy_InstancePolicyOrTemplate.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_InstancePolicyOrTemplate) GetBlockProjectSshKeys
func (x *AllocationPolicy_InstancePolicyOrTemplate) GetBlockProjectSshKeys() boolfunc (*AllocationPolicy_InstancePolicyOrTemplate) GetInstallGpuDrivers
func (x *AllocationPolicy_InstancePolicyOrTemplate) GetInstallGpuDrivers() boolfunc (*AllocationPolicy_InstancePolicyOrTemplate) GetInstallOpsAgent
func (x *AllocationPolicy_InstancePolicyOrTemplate) GetInstallOpsAgent() boolfunc (*AllocationPolicy_InstancePolicyOrTemplate) GetInstanceTemplate
func (x *AllocationPolicy_InstancePolicyOrTemplate) GetInstanceTemplate() stringfunc (*AllocationPolicy_InstancePolicyOrTemplate) GetPolicy
func (x *AllocationPolicy_InstancePolicyOrTemplate) GetPolicy() *AllocationPolicy_InstancePolicyfunc (*AllocationPolicy_InstancePolicyOrTemplate) GetPolicyTemplate
func (m *AllocationPolicy_InstancePolicyOrTemplate) GetPolicyTemplate() isAllocationPolicy_InstancePolicyOrTemplate_PolicyTemplatefunc (*AllocationPolicy_InstancePolicyOrTemplate) ProtoMessage
func (*AllocationPolicy_InstancePolicyOrTemplate) ProtoMessage()func (*AllocationPolicy_InstancePolicyOrTemplate) ProtoReflect
func (x *AllocationPolicy_InstancePolicyOrTemplate) ProtoReflect() protoreflect.Messagefunc (*AllocationPolicy_InstancePolicyOrTemplate) Reset
func (x *AllocationPolicy_InstancePolicyOrTemplate) Reset()func (*AllocationPolicy_InstancePolicyOrTemplate) String
func (x *AllocationPolicy_InstancePolicyOrTemplate) String() stringAllocationPolicy_InstancePolicyOrTemplate_InstanceTemplate
type AllocationPolicy_InstancePolicyOrTemplate_InstanceTemplate struct {
// Name of an instance template used to create VMs.
// Named the field as 'instance_template' instead of 'template' to avoid
// C++ keyword conflict.
//
// Batch only supports global instance templates from the same project as
// the job.
// You can specify the global instance template as a full or partial URL.
InstanceTemplate string `protobuf:"bytes,2,opt,name=instance_template,json=instanceTemplate,proto3,oneof"`
}AllocationPolicy_InstancePolicyOrTemplate_Policy
type AllocationPolicy_InstancePolicyOrTemplate_Policy struct {
// InstancePolicy.
Policy *AllocationPolicy_InstancePolicy `protobuf:"bytes,1,opt,name=policy,proto3,oneof"`
}AllocationPolicy_LocationPolicy
type AllocationPolicy_LocationPolicy struct {
// 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.
//
// Mixing locations from different regions would cause errors.
// For example,
// ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b",
// "zones/us-west1-a"] contains locations from two distinct regions:
// us-central1 and us-west1. This combination will trigger an error.
AllowedLocations []string `protobuf:"bytes,1,rep,name=allowed_locations,json=allowedLocations,proto3" json:"allowed_locations,omitempty"`
// contains filtered or unexported fields
}func (*AllocationPolicy_LocationPolicy) Descriptor
func (*AllocationPolicy_LocationPolicy) Descriptor() ([]byte, []int)Deprecated: Use AllocationPolicy_LocationPolicy.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_LocationPolicy) GetAllowedLocations
func (x *AllocationPolicy_LocationPolicy) GetAllowedLocations() []stringfunc (*AllocationPolicy_LocationPolicy) ProtoMessage
func (*AllocationPolicy_LocationPolicy) ProtoMessage()func (*AllocationPolicy_LocationPolicy) ProtoReflect
func (x *AllocationPolicy_LocationPolicy) ProtoReflect() protoreflect.Messagefunc (*AllocationPolicy_LocationPolicy) Reset
func (x *AllocationPolicy_LocationPolicy) Reset()func (*AllocationPolicy_LocationPolicy) String
func (x *AllocationPolicy_LocationPolicy) String() stringAllocationPolicy_NetworkInterface
type AllocationPolicy_NetworkInterface struct {
// The URL of an existing network resource.
// You can specify the network as a full or partial URL.
//
// For example, the following are all valid URLs:
//
// * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
// * projects/{project}/global/networks/{network}
// * global/networks/{network}
Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"`
// The URL of an existing subnetwork resource in the network.
// You can specify the subnetwork as a full or partial URL.
//
// For example, the following are all valid URLs:
//
// * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork}
// * projects/{project}/regions/{region}/subnetworks/{subnetwork}
// * regions/{region}/subnetworks/{subnetwork}
Subnetwork string `protobuf:"bytes,2,opt,name=subnetwork,proto3" json:"subnetwork,omitempty"`
// 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 bool `protobuf:"varint,3,opt,name=no_external_ip_address,json=noExternalIpAddress,proto3" json:"no_external_ip_address,omitempty"`
// contains filtered or unexported fields
}A network interface.
func (*AllocationPolicy_NetworkInterface) Descriptor
func (*AllocationPolicy_NetworkInterface) Descriptor() ([]byte, []int)Deprecated: Use AllocationPolicy_NetworkInterface.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_NetworkInterface) GetNetwork
func (x *AllocationPolicy_NetworkInterface) GetNetwork() stringfunc (*AllocationPolicy_NetworkInterface) GetNoExternalIpAddress
func (x *AllocationPolicy_NetworkInterface) GetNoExternalIpAddress() boolfunc (*AllocationPolicy_NetworkInterface) GetSubnetwork
func (x *AllocationPolicy_NetworkInterface) GetSubnetwork() stringfunc (*AllocationPolicy_NetworkInterface) ProtoMessage
func (*AllocationPolicy_NetworkInterface) ProtoMessage()func (*AllocationPolicy_NetworkInterface) ProtoReflect
func (x *AllocationPolicy_NetworkInterface) ProtoReflect() protoreflect.Messagefunc (*AllocationPolicy_NetworkInterface) Reset
func (x *AllocationPolicy_NetworkInterface) Reset()func (*AllocationPolicy_NetworkInterface) String
func (x *AllocationPolicy_NetworkInterface) String() stringAllocationPolicy_NetworkPolicy
type AllocationPolicy_NetworkPolicy struct {
// Network configurations.
NetworkInterfaces []*AllocationPolicy_NetworkInterface `protobuf:"bytes,1,rep,name=network_interfaces,json=networkInterfaces,proto3" json:"network_interfaces,omitempty"`
// contains filtered or unexported fields
}NetworkPolicy describes VM instance network configurations.
func (*AllocationPolicy_NetworkPolicy) Descriptor
func (*AllocationPolicy_NetworkPolicy) Descriptor() ([]byte, []int)Deprecated: Use AllocationPolicy_NetworkPolicy.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_NetworkPolicy) GetNetworkInterfaces
func (x *AllocationPolicy_NetworkPolicy) GetNetworkInterfaces() []*AllocationPolicy_NetworkInterfacefunc (*AllocationPolicy_NetworkPolicy) ProtoMessage
func (*AllocationPolicy_NetworkPolicy) ProtoMessage()func (*AllocationPolicy_NetworkPolicy) ProtoReflect
func (x *AllocationPolicy_NetworkPolicy) ProtoReflect() protoreflect.Messagefunc (*AllocationPolicy_NetworkPolicy) Reset
func (x *AllocationPolicy_NetworkPolicy) Reset()func (*AllocationPolicy_NetworkPolicy) String
func (x *AllocationPolicy_NetworkPolicy) String() stringAllocationPolicy_PlacementPolicy
type AllocationPolicy_PlacementPolicy struct {
// UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you
// want VMs to be located close to each other for low network latency
// between the VMs. No placement policy will be generated when collocation
// is UNSPECIFIED.
Collocation string `protobuf:"bytes,1,opt,name=collocation,proto3" json:"collocation,omitempty"`
// When specified, causes the job to fail if more than max_distance logical
// switches are required between VMs. Batch uses the most compact possible
// placement of VMs even when max_distance is not specified. An explicit
// max_distance makes that level of compactness a strict requirement.
// Not yet implemented
MaxDistance int64 `protobuf:"varint,2,opt,name=max_distance,json=maxDistance,proto3" json:"max_distance,omitempty"`
// contains filtered or unexported fields
}PlacementPolicy describes a group placement policy for the VMs controlled by this AllocationPolicy.
func (*AllocationPolicy_PlacementPolicy) Descriptor
func (*AllocationPolicy_PlacementPolicy) Descriptor() ([]byte, []int)Deprecated: Use AllocationPolicy_PlacementPolicy.ProtoReflect.Descriptor instead.
func (*AllocationPolicy_PlacementPolicy) GetCollocation
func (x *AllocationPolicy_PlacementPolicy) GetCollocation() stringfunc (*AllocationPolicy_PlacementPolicy) GetMaxDistance
func (x *AllocationPolicy_PlacementPolicy) GetMaxDistance() int64func (*AllocationPolicy_PlacementPolicy) ProtoMessage
func (*AllocationPolicy_PlacementPolicy) ProtoMessage()func (*AllocationPolicy_PlacementPolicy) ProtoReflect
func (x *AllocationPolicy_PlacementPolicy) ProtoReflect() protoreflect.Messagefunc (*AllocationPolicy_PlacementPolicy) Reset
func (x *AllocationPolicy_PlacementPolicy) Reset()func (*AllocationPolicy_PlacementPolicy) String
func (x *AllocationPolicy_PlacementPolicy) String() stringAllocationPolicy_ProvisioningModel
type AllocationPolicy_ProvisioningModel int32Compute Engine VM instance provisioning model.
AllocationPolicy_PROVISIONING_MODEL_UNSPECIFIED, AllocationPolicy_STANDARD, AllocationPolicy_SPOT, AllocationPolicy_PREEMPTIBLE
const (
// Unspecified.
AllocationPolicy_PROVISIONING_MODEL_UNSPECIFIED AllocationPolicy_ProvisioningModel = 0
// Standard VM.
AllocationPolicy_STANDARD AllocationPolicy_ProvisioningModel = 1
// SPOT VM.
AllocationPolicy_SPOT AllocationPolicy_ProvisioningModel = 2
// 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.
AllocationPolicy_PREEMPTIBLE AllocationPolicy_ProvisioningModel = 3
)func (AllocationPolicy_ProvisioningModel) Descriptor
func (AllocationPolicy_ProvisioningModel) Descriptor() protoreflect.EnumDescriptorfunc (AllocationPolicy_ProvisioningModel) Enum
func (x AllocationPolicy_ProvisioningModel) Enum() *AllocationPolicy_ProvisioningModelfunc (AllocationPolicy_ProvisioningModel) EnumDescriptor
func (AllocationPolicy_ProvisioningModel) EnumDescriptor() ([]byte, []int)Deprecated: Use AllocationPolicy_ProvisioningModel.Descriptor instead.
func (AllocationPolicy_ProvisioningModel) Number
func (x AllocationPolicy_ProvisioningModel) Number() protoreflect.EnumNumberfunc (AllocationPolicy_ProvisioningModel) String
func (x AllocationPolicy_ProvisioningModel) String() stringfunc (AllocationPolicy_ProvisioningModel) Type
func (AllocationPolicy_ProvisioningModel) Type() protoreflect.EnumTypeBatchServiceClient
type BatchServiceClient interface {
// Create a Job.
CreateJob(ctx context.Context, in *CreateJobRequest, opts ...grpc.CallOption) (*Job, error)
// Get a Job specified by its resource name.
GetJob(ctx context.Context, in *GetJobRequest, opts ...grpc.CallOption) (*Job, error)
// Delete a Job.
DeleteJob(ctx context.Context, in *DeleteJobRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// List all Jobs for a project within a region.
ListJobs(ctx context.Context, in *ListJobsRequest, opts ...grpc.CallOption) (*ListJobsResponse, error)
// Return a single Task.
GetTask(ctx context.Context, in *GetTaskRequest, opts ...grpc.CallOption) (*Task, error)
// List Tasks associated with a job.
ListTasks(ctx context.Context, in *ListTasksRequest, opts ...grpc.CallOption) (*ListTasksResponse, error)
}BatchServiceClient is the client API for BatchService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewBatchServiceClient
func NewBatchServiceClient(cc grpc.ClientConnInterface) BatchServiceClientBatchServiceServer
type BatchServiceServer interface {
// Create a Job.
CreateJob(context.Context, *CreateJobRequest) (*Job, error)
// Get a Job specified by its resource name.
GetJob(context.Context, *GetJobRequest) (*Job, error)
// Delete a Job.
DeleteJob(context.Context, *DeleteJobRequest) (*longrunningpb.Operation, error)
// List all Jobs for a project within a region.
ListJobs(context.Context, *ListJobsRequest) (*ListJobsResponse, error)
// Return a single Task.
GetTask(context.Context, *GetTaskRequest) (*Task, error)
// List Tasks associated with a job.
ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)
}BatchServiceServer is the server API for BatchService service.
ComputeResource
type ComputeResource struct {
// 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.
CpuMilli int64 `protobuf:"varint,1,opt,name=cpu_milli,json=cpuMilli,proto3" json:"cpu_milli,omitempty"`
// 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.
MemoryMib int64 `protobuf:"varint,2,opt,name=memory_mib,json=memoryMib,proto3" json:"memory_mib,omitempty"`
// Extra boot disk size in MiB for each task.
BootDiskMib int64 `protobuf:"varint,4,opt,name=boot_disk_mib,json=bootDiskMib,proto3" json:"boot_disk_mib,omitempty"`
// contains filtered or unexported fields
}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 field, make sure both fields are compatible with each other.
func (*ComputeResource) Descriptor
func (*ComputeResource) Descriptor() ([]byte, []int)Deprecated: Use ComputeResource.ProtoReflect.Descriptor instead.
func (*ComputeResource) GetBootDiskMib
func (x *ComputeResource) GetBootDiskMib() int64func (*ComputeResource) GetCpuMilli
func (x *ComputeResource) GetCpuMilli() int64func (*ComputeResource) GetMemoryMib
func (x *ComputeResource) GetMemoryMib() int64func (*ComputeResource) ProtoMessage
func (*ComputeResource) ProtoMessage()func (*ComputeResource) ProtoReflect
func (x *ComputeResource) ProtoReflect() protoreflect.Messagefunc (*ComputeResource) Reset
func (x *ComputeResource) Reset()func (*ComputeResource) String
func (x *ComputeResource) String() stringCreateJobRequest
type CreateJobRequest struct {
// Required. The parent resource name where the Job will be created.
// Pattern: "projects/{project}/locations/{location}"
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// ID used to uniquely identify the Job within its parent scope.
// This field should contain at most 63 characters and must start with
// lowercase characters.
// Only lowercase characters, numbers and '-' are accepted.
// The '-' character cannot be the first or the last one.
// A system generated ID will be used if the field is not set.
//
// The job.name field in the request will be ignored and the created resource
// name of the Job will be "{parent}/jobs/{job_id}".
JobId string `protobuf:"bytes,2,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
// Required. The Job to create.
Job *Job `protobuf:"bytes,3,opt,name=job,proto3" json:"job,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server will
// guarantee that for at least 60 minutes since the first request.
//
// For example, consider a situation where you make an initial request and
// the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}CreateJob Request.
func (*CreateJobRequest) Descriptor
func (*CreateJobRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateJobRequest.ProtoReflect.Descriptor instead.
func (*CreateJobRequest) GetJob
func (x *CreateJobRequest) GetJob() *Jobfunc (*CreateJobRequest) GetJobId
func (x *CreateJobRequest) GetJobId() stringfunc (*CreateJobRequest) GetParent
func (x *CreateJobRequest) GetParent() stringfunc (*CreateJobRequest) GetRequestId
func (x *CreateJobRequest) GetRequestId() stringfunc (*CreateJobRequest) ProtoMessage
func (*CreateJobRequest) ProtoMessage()func (*CreateJobRequest) ProtoReflect
func (x *CreateJobRequest) ProtoReflect() protoreflect.Messagefunc (*CreateJobRequest) Reset
func (x *CreateJobRequest) Reset()func (*CreateJobRequest) String
func (x *CreateJobRequest) String() stringDeleteJobRequest
type DeleteJobRequest struct {
// Job name.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Reason for this deletion.
Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server will
// guarantee that for at least 60 minutes after the first request.
//
// For example, consider a situation where you make an initial request and
// the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}DeleteJob Request.
func (*DeleteJobRequest) Descriptor
func (*DeleteJobRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteJobRequest.ProtoReflect.Descriptor instead.
func (*DeleteJobRequest) GetName
func (x *DeleteJobRequest) GetName() stringfunc (*DeleteJobRequest) GetReason
func (x *DeleteJobRequest) GetReason() stringfunc (*DeleteJobRequest) GetRequestId
func (x *DeleteJobRequest) GetRequestId() stringfunc (*DeleteJobRequest) ProtoMessage
func (*DeleteJobRequest) ProtoMessage()func (*DeleteJobRequest) ProtoReflect
func (x *DeleteJobRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteJobRequest) Reset
func (x *DeleteJobRequest) Reset()func (*DeleteJobRequest) String
func (x *DeleteJobRequest) String() stringEnvironment
type Environment struct {
Variables map[string]string "" /* 159 byte string literal not displayed */
SecretVariables map[string]string "" /* 194 byte string literal not displayed */
EncryptedVariables *Environment_KMSEnvMap `protobuf:"bytes,3,opt,name=encrypted_variables,json=encryptedVariables,proto3" json:"encrypted_variables,omitempty"`
}An Environment describes a collection of environment variables to set when executing Tasks.
func (*Environment) Descriptor
func (*Environment) Descriptor() ([]byte, []int)Deprecated: Use Environment.ProtoReflect.Descriptor instead.
func (*Environment) GetEncryptedVariables
func (x *Environment) GetEncryptedVariables() *Environment_KMSEnvMapfunc (*Environment) GetSecretVariables
func (x *Environment) GetSecretVariables() map[string]stringfunc (*Environment) GetVariables
func (x *Environment) GetVariables() map[string]stringfunc (*Environment) ProtoMessage
func (*Environment) ProtoMessage()func (*Environment) ProtoReflect
func (x *Environment) ProtoReflect() protoreflect.Messagefunc (*Environment) Reset
func (x *Environment) Reset()func (*Environment) String
func (x *Environment) String() stringEnvironment_KMSEnvMap
type Environment_KMSEnvMap struct {
// The name of the KMS key that will be used to decrypt the cipher text.
KeyName string `protobuf:"bytes,1,opt,name=key_name,json=keyName,proto3" json:"key_name,omitempty"`
// The value of the cipherText response from the `encrypt` method.
CipherText string `protobuf:"bytes,2,opt,name=cipher_text,json=cipherText,proto3" json:"cipher_text,omitempty"`
// contains filtered or unexported fields
}func (*Environment_KMSEnvMap) Descriptor
func (*Environment_KMSEnvMap) Descriptor() ([]byte, []int)Deprecated: Use Environment_KMSEnvMap.ProtoReflect.Descriptor instead.
func (*Environment_KMSEnvMap) GetCipherText
func (x *Environment_KMSEnvMap) GetCipherText() stringfunc (*Environment_KMSEnvMap) GetKeyName
func (x *Environment_KMSEnvMap) GetKeyName() stringfunc (*Environment_KMSEnvMap) ProtoMessage
func (*Environment_KMSEnvMap) ProtoMessage()func (*Environment_KMSEnvMap) ProtoReflect
func (x *Environment_KMSEnvMap) ProtoReflect() protoreflect.Messagefunc (*Environment_KMSEnvMap) Reset
func (x *Environment_KMSEnvMap) Reset()func (*Environment_KMSEnvMap) String
func (x *Environment_KMSEnvMap) String() stringGCS
type GCS struct {
// Remote path, either a bucket name or a subdirectory of a bucket, e.g.:
// bucket_name, bucket_name/subdirectory/
RemotePath string `protobuf:"bytes,1,opt,name=remote_path,json=remotePath,proto3" json:"remote_path,omitempty"`
// contains filtered or unexported fields
}Represents a Google Cloud Storage volume.
func (*GCS) Descriptor
Deprecated: Use GCS.ProtoReflect.Descriptor instead.
func (*GCS) GetRemotePath
func (*GCS) ProtoMessage
func (*GCS) ProtoMessage()func (*GCS) ProtoReflect
func (x *GCS) ProtoReflect() protoreflect.Messagefunc (*GCS) Reset
func (x *GCS) Reset()func (*GCS) String
GetJobRequest
type GetJobRequest struct {
// Required. Job name.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}GetJob Request.
func (*GetJobRequest) Descriptor
func (*GetJobRequest) Descriptor() ([]byte, []int)Deprecated: Use GetJobRequest.ProtoReflect.Descriptor instead.
func (*GetJobRequest) GetName
func (x *GetJobRequest) GetName() stringfunc (*GetJobRequest) ProtoMessage
func (*GetJobRequest) ProtoMessage()func (*GetJobRequest) ProtoReflect
func (x *GetJobRequest) ProtoReflect() protoreflect.Messagefunc (*GetJobRequest) Reset
func (x *GetJobRequest) Reset()func (*GetJobRequest) String
func (x *GetJobRequest) String() stringGetTaskRequest
type GetTaskRequest struct {
// Required. Task name.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Request for a single Task by name.
func (*GetTaskRequest) Descriptor
func (*GetTaskRequest) Descriptor() ([]byte, []int)Deprecated: Use GetTaskRequest.ProtoReflect.Descriptor instead.
func (*GetTaskRequest) GetName
func (x *GetTaskRequest) GetName() stringfunc (*GetTaskRequest) ProtoMessage
func (*GetTaskRequest) ProtoMessage()func (*GetTaskRequest) ProtoReflect
func (x *GetTaskRequest) ProtoReflect() protoreflect.Messagefunc (*GetTaskRequest) Reset
func (x *GetTaskRequest) Reset()func (*GetTaskRequest) String
func (x *GetTaskRequest) String() stringJob
type Job struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Uid string `protobuf:"bytes,2,opt,name=uid,proto3" json:"uid,omitempty"`
Priority int64 `protobuf:"varint,3,opt,name=priority,proto3" json:"priority,omitempty"`
TaskGroups []*TaskGroup `protobuf:"bytes,4,rep,name=task_groups,json=taskGroups,proto3" json:"task_groups,omitempty"`
AllocationPolicy *AllocationPolicy `protobuf:"bytes,7,opt,name=allocation_policy,json=allocationPolicy,proto3" json:"allocation_policy,omitempty"`
Labels map[string]string "" /* 153 byte string literal not displayed */
Status *JobStatus `protobuf:"bytes,9,opt,name=status,proto3" json:"status,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
LogsPolicy *LogsPolicy `protobuf:"bytes,13,opt,name=logs_policy,json=logsPolicy,proto3" json:"logs_policy,omitempty"`
Notifications []*JobNotification `protobuf:"bytes,14,rep,name=notifications,proto3" json:"notifications,omitempty"`
}The Cloud Batch Job description.
func (*Job) Descriptor
Deprecated: Use Job.ProtoReflect.Descriptor instead.
func (*Job) GetAllocationPolicy
func (x *Job) GetAllocationPolicy() *AllocationPolicyfunc (*Job) GetCreateTime
func (x *Job) GetCreateTime() *timestamppb.Timestampfunc (*Job) GetLabels
func (*Job) GetLogsPolicy
func (x *Job) GetLogsPolicy() *LogsPolicyfunc (*Job) GetName
func (*Job) GetNotifications
func (x *Job) GetNotifications() []*JobNotificationfunc (*Job) GetPriority
func (*Job) GetStatus
func (*Job) GetTaskGroups
func (*Job) GetUid
func (*Job) GetUpdateTime
func (x *Job) GetUpdateTime() *timestamppb.Timestampfunc (*Job) ProtoMessage
func (*Job) ProtoMessage()func (*Job) ProtoReflect
func (x *Job) ProtoReflect() protoreflect.Messagefunc (*Job) Reset
func (x *Job) Reset()func (*Job) String
JobNotification
type JobNotification struct {
// The Pub/Sub topic where notifications for the job, like state
// changes, will be published. If undefined, no Pub/Sub notifications
// are sent for this job.
//
// Specify the topic using the following format:
// `projects/{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.
PubsubTopic string `protobuf:"bytes,1,opt,name=pubsub_topic,json=pubsubTopic,proto3" json:"pubsub_topic,omitempty"`
// The attribute requirements of messages to be sent to this Pub/Sub topic.
// Without this field, no message will be sent.
Message *JobNotification_Message `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
// contains filtered or unexported fields
}Notification configurations.
func (*JobNotification) Descriptor
func (*JobNotification) Descriptor() ([]byte, []int)Deprecated: Use JobNotification.ProtoReflect.Descriptor instead.
func (*JobNotification) GetMessage
func (x *JobNotification) GetMessage() *JobNotification_Messagefunc (*JobNotification) GetPubsubTopic
func (x *JobNotification) GetPubsubTopic() stringfunc (*JobNotification) ProtoMessage
func (*JobNotification) ProtoMessage()func (*JobNotification) ProtoReflect
func (x *JobNotification) ProtoReflect() protoreflect.Messagefunc (*JobNotification) Reset
func (x *JobNotification) Reset()func (*JobNotification) String
func (x *JobNotification) String() stringJobNotification_Message
type JobNotification_Message struct {
Type JobNotification_Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.cloud.batch.v1.JobNotification_Type" json:"type,omitempty"`
NewJobState JobStatus_State "" /* 140 byte string literal not displayed */
NewTaskState TaskStatus_State "" /* 144 byte string literal not displayed */
}Message details. Describe the conditions under which messages will be sent. If no attribute is defined, no message will be sent by default. One message should specify either the job or the task level attributes, but not both. For example, job level: JOB_STATE_CHANGED and/or a specified new_job_state; task level: TASK_STATE_CHANGED and/or a specified new_task_state.
func (*JobNotification_Message) Descriptor
func (*JobNotification_Message) Descriptor() ([]byte, []int)Deprecated: Use JobNotification_Message.ProtoReflect.Descriptor instead.
func (*JobNotification_Message) GetNewJobState
func (x *JobNotification_Message) GetNewJobState() JobStatus_Statefunc (*JobNotification_Message) GetNewTaskState
func (x *JobNotification_Message) GetNewTaskState() TaskStatus_Statefunc (*JobNotification_Message) GetType
func (x *JobNotification_Message) GetType() JobNotification_Typefunc (*JobNotification_Message) ProtoMessage
func (*JobNotification_Message) ProtoMessage()func (*JobNotification_Message) ProtoReflect
func (x *JobNotification_Message) ProtoReflect() protoreflect.Messagefunc (*JobNotification_Message) Reset
func (x *JobNotification_Message) Reset()func (*JobNotification_Message) String
func (x *JobNotification_Message) String() stringJobNotification_Type
type JobNotification_Type int32The message type.
JobNotification_TYPE_UNSPECIFIED, JobNotification_JOB_STATE_CHANGED, JobNotification_TASK_STATE_CHANGED
const (
// Unspecified.
JobNotification_TYPE_UNSPECIFIED JobNotification_Type = 0
// Notify users that the job state has changed.
JobNotification_JOB_STATE_CHANGED JobNotification_Type = 1
// Notify users that the task state has changed.
JobNotification_TASK_STATE_CHANGED JobNotification_Type = 2
)func (JobNotification_Type) Descriptor
func (JobNotification_Type) Descriptor() protoreflect.EnumDescriptorfunc (JobNotification_Type) Enum
func (x JobNotification_Type) Enum() *JobNotification_Typefunc (JobNotification_Type) EnumDescriptor
func (JobNotification_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use JobNotification_Type.Descriptor instead.
func (JobNotification_Type) Number
func (x JobNotification_Type) Number() protoreflect.EnumNumberfunc (JobNotification_Type) String
func (x JobNotification_Type) String() stringfunc (JobNotification_Type) Type
func (JobNotification_Type) Type() protoreflect.EnumTypeJobStatus
type JobStatus struct {
State JobStatus_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.batch.v1.JobStatus_State" json:"state,omitempty"`
StatusEvents []*StatusEvent `protobuf:"bytes,2,rep,name=status_events,json=statusEvents,proto3" json:"status_events,omitempty"`
TaskGroups map[string]*JobStatus_TaskGroupStatus "" /* 179 byte string literal not displayed */
RunDuration *durationpb.Duration `protobuf:"bytes,5,opt,name=run_duration,json=runDuration,proto3" json:"run_duration,omitempty"`
}Job status.
func (*JobStatus) Descriptor
Deprecated: Use JobStatus.ProtoReflect.Descriptor instead.
func (*JobStatus) GetRunDuration
func (x *JobStatus) GetRunDuration() *durationpb.Durationfunc (*JobStatus) GetState
func (x *JobStatus) GetState() JobStatus_Statefunc (*JobStatus) GetStatusEvents
func (x *JobStatus) GetStatusEvents() []*StatusEventfunc (*JobStatus) GetTaskGroups
func (x *JobStatus) GetTaskGroups() map[string]*JobStatus_TaskGroupStatusfunc (*JobStatus) ProtoMessage
func (*JobStatus) ProtoMessage()func (*JobStatus) ProtoReflect
func (x *JobStatus) ProtoReflect() protoreflect.Messagefunc (*JobStatus) Reset
func (x *JobStatus) Reset()func (*JobStatus) String
JobStatus_InstanceStatus
type JobStatus_InstanceStatus struct {
MachineType string `protobuf:"bytes,1,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
ProvisioningModel AllocationPolicy_ProvisioningModel "" /* 175 byte string literal not displayed */
TaskPack int64 `protobuf:"varint,3,opt,name=task_pack,json=taskPack,proto3" json:"task_pack,omitempty"`
BootDisk *AllocationPolicy_Disk `protobuf:"bytes,4,opt,name=boot_disk,json=bootDisk,proto3" json:"boot_disk,omitempty"`
}VM instance status.
func (*JobStatus_InstanceStatus) Descriptor
func (*JobStatus_InstanceStatus) Descriptor() ([]byte, []int)Deprecated: Use JobStatus_InstanceStatus.ProtoReflect.Descriptor instead.
func (*JobStatus_InstanceStatus) GetBootDisk
func (x *JobStatus_InstanceStatus) GetBootDisk() *AllocationPolicy_Diskfunc (*JobStatus_InstanceStatus) GetMachineType
func (x *JobStatus_InstanceStatus) GetMachineType() stringfunc (*JobStatus_InstanceStatus) GetProvisioningModel
func (x *JobStatus_InstanceStatus) GetProvisioningModel() AllocationPolicy_ProvisioningModelfunc (*JobStatus_InstanceStatus) GetTaskPack
func (x *JobStatus_InstanceStatus) GetTaskPack() int64func (*JobStatus_InstanceStatus) ProtoMessage
func (*JobStatus_InstanceStatus) ProtoMessage()func (*JobStatus_InstanceStatus) ProtoReflect
func (x *JobStatus_InstanceStatus) ProtoReflect() protoreflect.Messagefunc (*JobStatus_InstanceStatus) Reset
func (x *JobStatus_InstanceStatus) Reset()func (*JobStatus_InstanceStatus) String
func (x *JobStatus_InstanceStatus) String() stringJobStatus_State
type JobStatus_State int32Valid Job states.
JobStatus_STATE_UNSPECIFIED, JobStatus_QUEUED, JobStatus_SCHEDULED, JobStatus_RUNNING, JobStatus_SUCCEEDED, JobStatus_FAILED, JobStatus_DELETION_IN_PROGRESS
const (
// Job state unspecified.
JobStatus_STATE_UNSPECIFIED JobStatus_State = 0
// Job is admitted (validated and persisted) and waiting for resources.
JobStatus_QUEUED JobStatus_State = 1
// 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.
JobStatus_SCHEDULED JobStatus_State = 2
// Resource allocation has been successful. At least one Task in the Job is
// RUNNING.
JobStatus_RUNNING JobStatus_State = 3
// All Tasks in the Job have finished successfully.
JobStatus_SUCCEEDED JobStatus_State = 4
// At least one Task in the Job has failed.
JobStatus_FAILED JobStatus_State = 5
// 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.
JobStatus_DELETION_IN_PROGRESS JobStatus_State = 6
)func (JobStatus_State) Descriptor
func (JobStatus_State) Descriptor() protoreflect.EnumDescriptorfunc (JobStatus_State) Enum
func (x JobStatus_State) Enum() *JobStatus_Statefunc (JobStatus_State) EnumDescriptor
func (JobStatus_State) EnumDescriptor() ([]byte, []int)Deprecated: Use JobStatus_State.Descriptor instead.
func (JobStatus_State) Number
func (x JobStatus_State) Number() protoreflect.EnumNumberfunc (JobStatus_State) String
func (x JobStatus_State) String() stringfunc (JobStatus_State) Type
func (JobStatus_State) Type() protoreflect.EnumTypeJobStatus_TaskGroupStatus
type JobStatus_TaskGroupStatus struct {
Counts map[string]int64 "" /* 154 byte string literal not displayed */
Instances []*JobStatus_InstanceStatus `protobuf:"bytes,2,rep,name=instances,proto3" json:"instances,omitempty"`
}Aggregated task status for a TaskGroup.
func (*JobStatus_TaskGroupStatus) Descriptor
func (*JobStatus_TaskGroupStatus) Descriptor() ([]byte, []int)Deprecated: Use JobStatus_TaskGroupStatus.ProtoReflect.Descriptor instead.
func (*JobStatus_TaskGroupStatus) GetCounts
func (x *JobStatus_TaskGroupStatus) GetCounts() map[string]int64func (*JobStatus_TaskGroupStatus) GetInstances
func (x *JobStatus_TaskGroupStatus) GetInstances() []*JobStatus_InstanceStatusfunc (*JobStatus_TaskGroupStatus) ProtoMessage
func (*JobStatus_TaskGroupStatus) ProtoMessage()func (*JobStatus_TaskGroupStatus) ProtoReflect
func (x *JobStatus_TaskGroupStatus) ProtoReflect() protoreflect.Messagefunc (*JobStatus_TaskGroupStatus) Reset
func (x *JobStatus_TaskGroupStatus) Reset()func (*JobStatus_TaskGroupStatus) String
func (x *JobStatus_TaskGroupStatus) String() stringLifecyclePolicy
type LifecyclePolicy struct {
// 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.
Action LifecyclePolicy_Action `protobuf:"varint,1,opt,name=action,proto3,enum=google.cloud.batch.v1.LifecyclePolicy_Action" json:"action,omitempty"`
// Conditions that decide why a task failure is dealt with a specific action.
ActionCondition *LifecyclePolicy_ActionCondition `protobuf:"bytes,2,opt,name=action_condition,json=actionCondition,proto3" json:"action_condition,omitempty"`
// contains filtered or unexported fields
}LifecyclePolicy describes how to deal with task failures based on different conditions.
func (*LifecyclePolicy) Descriptor
func (*LifecyclePolicy) Descriptor() ([]byte, []int)Deprecated: Use LifecyclePolicy.ProtoReflect.Descriptor instead.
func (*LifecyclePolicy) GetAction
func (x *LifecyclePolicy) GetAction() LifecyclePolicy_Actionfunc (*LifecyclePolicy) GetActionCondition
func (x *LifecyclePolicy) GetActionCondition() *LifecyclePolicy_ActionConditionfunc (*LifecyclePolicy) ProtoMessage
func (*LifecyclePolicy) ProtoMessage()func (*LifecyclePolicy) ProtoReflect
func (x *LifecyclePolicy) ProtoReflect() protoreflect.Messagefunc (*LifecyclePolicy) Reset
func (x *LifecyclePolicy) Reset()func (*LifecyclePolicy) String
func (x *LifecyclePolicy) String() stringLifecyclePolicy_Action
type LifecyclePolicy_Action int32Action on task failures based on different conditions.
LifecyclePolicy_ACTION_UNSPECIFIED, LifecyclePolicy_RETRY_TASK, LifecyclePolicy_FAIL_TASK
const (
// Action unspecified.
LifecyclePolicy_ACTION_UNSPECIFIED LifecyclePolicy_Action = 0
// Action that tasks in the group will be scheduled to re-execute.
LifecyclePolicy_RETRY_TASK LifecyclePolicy_Action = 1
// Action that tasks in the group will be stopped immediately.
LifecyclePolicy_FAIL_TASK LifecyclePolicy_Action = 2
)func (LifecyclePolicy_Action) Descriptor
func (LifecyclePolicy_Action) Descriptor() protoreflect.EnumDescriptorfunc (LifecyclePolicy_Action) Enum
func (x LifecyclePolicy_Action) Enum() *LifecyclePolicy_Actionfunc (LifecyclePolicy_Action) EnumDescriptor
func (LifecyclePolicy_Action) EnumDescriptor() ([]byte, []int)Deprecated: Use LifecyclePolicy_Action.Descriptor instead.
func (LifecyclePolicy_Action) Number
func (x LifecyclePolicy_Action) Number() protoreflect.EnumNumberfunc (LifecyclePolicy_Action) String
func (x LifecyclePolicy_Action) String() stringfunc (LifecyclePolicy_Action) Type
func (LifecyclePolicy_Action) Type() protoreflect.EnumTypeLifecyclePolicy_ActionCondition
type LifecyclePolicy_ActionCondition struct {
// 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 []int32 `protobuf:"varint,1,rep,packed,name=exit_codes,json=exitCodes,proto3" json:"exit_codes,omitempty"`
// contains filtered or unexported fields
}Conditions for actions to deal with task failures.
func (*LifecyclePolicy_ActionCondition) Descriptor
func (*LifecyclePolicy_ActionCondition) Descriptor() ([]byte, []int)Deprecated: Use LifecyclePolicy_ActionCondition.ProtoReflect.Descriptor instead.
func (*LifecyclePolicy_ActionCondition) GetExitCodes
func (x *LifecyclePolicy_ActionCondition) GetExitCodes() []int32func (*LifecyclePolicy_ActionCondition) ProtoMessage
func (*LifecyclePolicy_ActionCondition) ProtoMessage()func (*LifecyclePolicy_ActionCondition) ProtoReflect
func (x *LifecyclePolicy_ActionCondition) ProtoReflect() protoreflect.Messagefunc (*LifecyclePolicy_ActionCondition) Reset
func (x *LifecyclePolicy_ActionCondition) Reset()func (*LifecyclePolicy_ActionCondition) String
func (x *LifecyclePolicy_ActionCondition) String() stringListJobsRequest
type ListJobsRequest struct {
// Parent path.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// List filter.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// Optional. Sort results. Supported are "name", "name desc", "create_time",
// and "create_time desc".
OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// Page size.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}ListJob Request.
func (*ListJobsRequest) Descriptor
func (*ListJobsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListJobsRequest.ProtoReflect.Descriptor instead.
func (*ListJobsRequest) GetFilter
func (x *ListJobsRequest) GetFilter() stringfunc (*ListJobsRequest) GetOrderBy
func (x *ListJobsRequest) GetOrderBy() stringfunc (*ListJobsRequest) GetPageSize
func (x *ListJobsRequest) GetPageSize() int32func (*ListJobsRequest) GetPageToken
func (x *ListJobsRequest) GetPageToken() stringfunc (*ListJobsRequest) GetParent
func (x *ListJobsRequest) GetParent() stringfunc (*ListJobsRequest) ProtoMessage
func (*ListJobsRequest) ProtoMessage()func (*ListJobsRequest) ProtoReflect
func (x *ListJobsRequest) ProtoReflect() protoreflect.Messagefunc (*ListJobsRequest) Reset
func (x *ListJobsRequest) Reset()func (*ListJobsRequest) String
func (x *ListJobsRequest) String() stringListJobsResponse
type ListJobsResponse struct {
// Jobs.
Jobs []*Job `protobuf:"bytes,1,rep,name=jobs,proto3" json:"jobs,omitempty"`
// Next page token.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Locations that could not be reached.
Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}ListJob Response.
func (*ListJobsResponse) Descriptor
func (*ListJobsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListJobsResponse.ProtoReflect.Descriptor instead.
func (*ListJobsResponse) GetJobs
func (x *ListJobsResponse) GetJobs() []*Jobfunc (*ListJobsResponse) GetNextPageToken
func (x *ListJobsResponse) GetNextPageToken() stringfunc (*ListJobsResponse) GetUnreachable
func (x *ListJobsResponse) GetUnreachable() []stringfunc (*ListJobsResponse) ProtoMessage
func (*ListJobsResponse) ProtoMessage()func (*ListJobsResponse) ProtoReflect
func (x *ListJobsResponse) ProtoReflect() protoreflect.Messagefunc (*ListJobsResponse) Reset
func (x *ListJobsResponse) Reset()func (*ListJobsResponse) String
func (x *ListJobsResponse) String() stringListTasksRequest
type ListTasksRequest struct {
// Required. Name of a TaskGroup from which Tasks are being requested.
// Pattern:
// "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}"
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Task filter, null filter matches all Tasks.
// Filter string should be of the format State=TaskStatus.State e.g.
// State=RUNNING
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// Page size.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Page token.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}ListTasks Request.
func (*ListTasksRequest) Descriptor
func (*ListTasksRequest) Descriptor() ([]byte, []int)Deprecated: Use ListTasksRequest.ProtoReflect.Descriptor instead.
func (*ListTasksRequest) GetFilter
func (x *ListTasksRequest) GetFilter() stringfunc (*ListTasksRequest) GetPageSize
func (x *ListTasksRequest) GetPageSize() int32func (*ListTasksRequest) GetPageToken
func (x *ListTasksRequest) GetPageToken() stringfunc (*ListTasksRequest) GetParent
func (x *ListTasksRequest) GetParent() stringfunc (*ListTasksRequest) ProtoMessage
func (*ListTasksRequest) ProtoMessage()func (*ListTasksRequest) ProtoReflect
func (x *ListTasksRequest) ProtoReflect() protoreflect.Messagefunc (*ListTasksRequest) Reset
func (x *ListTasksRequest) Reset()func (*ListTasksRequest) String
func (x *ListTasksRequest) String() stringListTasksResponse
type ListTasksResponse struct {
// Tasks.
Tasks []*Task `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`
// Next page token.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Locations that could not be reached.
Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
// contains filtered or unexported fields
}ListTasks Response.
func (*ListTasksResponse) Descriptor
func (*ListTasksResponse) Descriptor() ([]byte, []int)Deprecated: Use ListTasksResponse.ProtoReflect.Descriptor instead.
func (*ListTasksResponse) GetNextPageToken
func (x *ListTasksResponse) GetNextPageToken() stringfunc (*ListTasksResponse) GetTasks
func (x *ListTasksResponse) GetTasks() []*Taskfunc (*ListTasksResponse) GetUnreachable
func (x *ListTasksResponse) GetUnreachable() []stringfunc (*ListTasksResponse) ProtoMessage
func (*ListTasksResponse) ProtoMessage()func (*ListTasksResponse) ProtoReflect
func (x *ListTasksResponse) ProtoReflect() protoreflect.Messagefunc (*ListTasksResponse) Reset
func (x *ListTasksResponse) Reset()func (*ListTasksResponse) String
func (x *ListTasksResponse) String() stringLogsPolicy
type LogsPolicy struct {
// If and where logs should be saved.
Destination LogsPolicy_Destination `protobuf:"varint,1,opt,name=destination,proto3,enum=google.cloud.batch.v1.LogsPolicy_Destination" json:"destination,omitempty"`
// When `destination` 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/`.
LogsPath string `protobuf:"bytes,2,opt,name=logs_path,json=logsPath,proto3" json:"logs_path,omitempty"`
// Optional. When `destination` is set to `CLOUD_LOGGING`, you can optionally
// set this field to configure additional settings for Cloud Logging.
CloudLoggingOption *LogsPolicy_CloudLoggingOption `protobuf:"bytes,3,opt,name=cloud_logging_option,json=cloudLoggingOption,proto3" json:"cloud_logging_option,omitempty"`
// contains filtered or unexported fields
}LogsPolicy describes if and how a job's logs are preserved. Logs include
information that is automatically written by the Batch service agent and any
information that you configured the job's runnables to write to the stdout
or stderr streams.
func (*LogsPolicy) Descriptor
func (*LogsPolicy) Descriptor() ([]byte, []int)Deprecated: Use LogsPolicy.ProtoReflect.Descriptor instead.
func (*LogsPolicy) GetCloudLoggingOption
func (x *LogsPolicy) GetCloudLoggingOption() *LogsPolicy_CloudLoggingOptionfunc (*LogsPolicy) GetDestination
func (x *LogsPolicy) GetDestination() LogsPolicy_Destinationfunc (*LogsPolicy) GetLogsPath
func (x *LogsPolicy) GetLogsPath() stringfunc (*LogsPolicy) ProtoMessage
func (*LogsPolicy) ProtoMessage()func (*LogsPolicy) ProtoReflect
func (x *LogsPolicy) ProtoReflect() protoreflect.Messagefunc (*LogsPolicy) Reset
func (x *LogsPolicy) Reset()func (*LogsPolicy) String
func (x *LogsPolicy) String() stringLogsPolicy_CloudLoggingOption
type LogsPolicy_CloudLoggingOption struct {
UseGenericTaskMonitoredResource bool "" /* 161 byte string literal not displayed */
}CloudLoggingOption contains additional settings for Cloud Logging logs
generated by Batch job.
func (*LogsPolicy_CloudLoggingOption) Descriptor
func (*LogsPolicy_CloudLoggingOption) Descriptor() ([]byte, []int)Deprecated: Use LogsPolicy_CloudLoggingOption.ProtoReflect.Descriptor instead.
func (*LogsPolicy_CloudLoggingOption) GetUseGenericTaskMonitoredResource
func (x *LogsPolicy_CloudLoggingOption) GetUseGenericTaskMonitoredResource() boolfunc (*LogsPolicy_CloudLoggingOption) ProtoMessage
func (*LogsPolicy_CloudLoggingOption) ProtoMessage()func (*LogsPolicy_CloudLoggingOption) ProtoReflect
func (x *LogsPolicy_CloudLoggingOption) ProtoReflect() protoreflect.Messagefunc (*LogsPolicy_CloudLoggingOption) Reset
func (x *LogsPolicy_CloudLoggingOption) Reset()func (*LogsPolicy_CloudLoggingOption) String
func (x *LogsPolicy_CloudLoggingOption) String() stringLogsPolicy_Destination
type LogsPolicy_Destination int32The destination (if any) for logs.
LogsPolicy_DESTINATION_UNSPECIFIED, LogsPolicy_CLOUD_LOGGING, LogsPolicy_PATH
const (
// (Default) Logs are not preserved.
LogsPolicy_DESTINATION_UNSPECIFIED LogsPolicy_Destination = 0
// Logs are streamed to Cloud Logging. Optionally, you can configure
// additional settings in the `cloudLoggingOption` field.
LogsPolicy_CLOUD_LOGGING LogsPolicy_Destination = 1
// Logs are saved to the file path specified in the `logsPath` field.
LogsPolicy_PATH LogsPolicy_Destination = 2
)func (LogsPolicy_Destination) Descriptor
func (LogsPolicy_Destination) Descriptor() protoreflect.EnumDescriptorfunc (LogsPolicy_Destination) Enum
func (x LogsPolicy_Destination) Enum() *LogsPolicy_Destinationfunc (LogsPolicy_Destination) EnumDescriptor
func (LogsPolicy_Destination) EnumDescriptor() ([]byte, []int)Deprecated: Use LogsPolicy_Destination.Descriptor instead.
func (LogsPolicy_Destination) Number
func (x LogsPolicy_Destination) Number() protoreflect.EnumNumberfunc (LogsPolicy_Destination) String
func (x LogsPolicy_Destination) String() stringfunc (LogsPolicy_Destination) Type
func (LogsPolicy_Destination) Type() protoreflect.EnumTypeNFS
type NFS struct {
// The IP address of the NFS.
Server string `protobuf:"bytes,1,opt,name=server,proto3" json:"server,omitempty"`
// Remote source path exported from the NFS, e.g., "/share".
RemotePath string `protobuf:"bytes,2,opt,name=remote_path,json=remotePath,proto3" json:"remote_path,omitempty"`
// contains filtered or unexported fields
}Represents an NFS volume.
func (*NFS) Descriptor
Deprecated: Use NFS.ProtoReflect.Descriptor instead.
func (*NFS) GetRemotePath
func (*NFS) GetServer
func (*NFS) ProtoMessage
func (*NFS) ProtoMessage()func (*NFS) ProtoReflect
func (x *NFS) ProtoReflect() protoreflect.Messagefunc (*NFS) Reset
func (x *NFS) Reset()func (*NFS) String
OperationMetadata
type OperationMetadata struct {
// Output only. The time the operation was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time the operation finished running.
EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Output only. Server-defined resource path for the target of the operation.
Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
// Output only. Name of the verb executed by the operation.
Verb string `protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"`
// Output only. Human-readable status of the operation, if any.
StatusMessage string `protobuf:"bytes,5,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"`
// 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][google.rpc.Status.code] of 1, corresponding to
// `Code.CANCELLED`.
RequestedCancellation bool `protobuf:"varint,6,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"`
// Output only. API version used to start the operation.
ApiVersion string `protobuf:"bytes,7,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
// contains filtered or unexported fields
}Represents the metadata of the long-running operation.
func (*OperationMetadata) Descriptor
func (*OperationMetadata) Descriptor() ([]byte, []int)Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.
func (*OperationMetadata) GetApiVersion
func (x *OperationMetadata) GetApiVersion() stringfunc (*OperationMetadata) GetCreateTime
func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestampfunc (*OperationMetadata) GetEndTime
func (x *OperationMetadata) GetEndTime() *timestamppb.Timestampfunc (*OperationMetadata) GetRequestedCancellation
func (x *OperationMetadata) GetRequestedCancellation() boolfunc (*OperationMetadata) GetStatusMessage
func (x *OperationMetadata) GetStatusMessage() stringfunc (*OperationMetadata) GetTarget
func (x *OperationMetadata) GetTarget() stringfunc (*OperationMetadata) GetVerb
func (x *OperationMetadata) GetVerb() stringfunc (*OperationMetadata) ProtoMessage
func (*OperationMetadata) ProtoMessage()func (*OperationMetadata) ProtoReflect
func (x *OperationMetadata) ProtoReflect() protoreflect.Messagefunc (*OperationMetadata) Reset
func (x *OperationMetadata) Reset()func (*OperationMetadata) String
func (x *OperationMetadata) String() stringRunnable
type Runnable struct {
Executable isRunnable_Executable `protobuf_oneof:"executable"`
DisplayName string `protobuf:"bytes,10,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
IgnoreExitStatus bool `protobuf:"varint,3,opt,name=ignore_exit_status,json=ignoreExitStatus,proto3" json:"ignore_exit_status,omitempty"`
Background bool `protobuf:"varint,4,opt,name=background,proto3" json:"background,omitempty"`
AlwaysRun bool `protobuf:"varint,5,opt,name=always_run,json=alwaysRun,proto3" json:"always_run,omitempty"`
Environment *Environment `protobuf:"bytes,7,opt,name=environment,proto3" json:"environment,omitempty"`
Timeout *durationpb.Duration `protobuf:"bytes,8,opt,name=timeout,proto3" json:"timeout,omitempty"`
Labels map[string]string "" /* 153 byte string literal not displayed */
}Runnable describes instructions for executing a specific script or container as part of a Task.
func (*Runnable) Descriptor
Deprecated: Use Runnable.ProtoReflect.Descriptor instead.
func (*Runnable) GetAlwaysRun
func (*Runnable) GetBackground
func (*Runnable) GetBarrier
func (x *Runnable) GetBarrier() *Runnable_Barrierfunc (*Runnable) GetContainer
func (x *Runnable) GetContainer() *Runnable_Containerfunc (*Runnable) GetDisplayName
func (*Runnable) GetEnvironment
func (x *Runnable) GetEnvironment() *Environmentfunc (*Runnable) GetExecutable
func (m *Runnable) GetExecutable() isRunnable_Executablefunc (*Runnable) GetIgnoreExitStatus
func (*Runnable) GetLabels
func (*Runnable) GetScript
func (x *Runnable) GetScript() *Runnable_Scriptfunc (*Runnable) GetTimeout
func (x *Runnable) GetTimeout() *durationpb.Durationfunc (*Runnable) ProtoMessage
func (*Runnable) ProtoMessage()func (*Runnable) ProtoReflect
func (x *Runnable) ProtoReflect() protoreflect.Messagefunc (*Runnable) Reset
func (x *Runnable) Reset()func (*Runnable) String
Runnable_Barrier
type Runnable_Barrier struct {
// Barriers are identified by their index in runnable list.
// Names are not required, but if present should be an identifier.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}A barrier runnable automatically blocks the execution of subsequent runnables until all the tasks in the task group reach the barrier.
func (*Runnable_Barrier) Descriptor
func (*Runnable_Barrier) Descriptor() ([]byte, []int)Deprecated: Use Runnable_Barrier.ProtoReflect.Descriptor instead.
func (*Runnable_Barrier) GetName
func (x *Runnable_Barrier) GetName() stringfunc (*Runnable_Barrier) ProtoMessage
func (*Runnable_Barrier) ProtoMessage()func (*Runnable_Barrier) ProtoReflect
func (x *Runnable_Barrier) ProtoReflect() protoreflect.Messagefunc (*Runnable_Barrier) Reset
func (x *Runnable_Barrier) Reset()func (*Runnable_Barrier) String
func (x *Runnable_Barrier) String() stringRunnable_Barrier_
type Runnable_Barrier_ struct {
// Barrier runnable.
Barrier *Runnable_Barrier `protobuf:"bytes,6,opt,name=barrier,proto3,oneof"`
}Runnable_Container
type Runnable_Container struct {
// Required. The URI to pull the container image from.
ImageUri string `protobuf:"bytes,1,opt,name=image_uri,json=imageUri,proto3" json:"image_uri,omitempty"`
// 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`.
Commands []string `protobuf:"bytes,2,rep,name=commands,proto3" json:"commands,omitempty"`
// Required for some container images. Overrides the `ENTRYPOINT` specified
// in the container.
Entrypoint string `protobuf:"bytes,3,opt,name=entrypoint,proto3" json:"entrypoint,omitempty"`
// 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.
Volumes []string `protobuf:"bytes,7,rep,name=volumes,proto3" json:"volumes,omitempty"`
// 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.
Options string `protobuf:"bytes,8,opt,name=options,proto3" json:"options,omitempty"`
// 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.
BlockExternalNetwork bool `protobuf:"varint,9,opt,name=block_external_network,json=blockExternalNetwork,proto3" json:"block_external_network,omitempty"`
// 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).
Username string `protobuf:"bytes,10,opt,name=username,proto3" json:"username,omitempty"`
// 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).
Password string `protobuf:"bytes,11,opt,name=password,proto3" json:"password,omitempty"`
// 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).
EnableImageStreaming bool `protobuf:"varint,12,opt,name=enable_image_streaming,json=enableImageStreaming,proto3" json:"enable_image_streaming,omitempty"`
// contains filtered or unexported fields
}Container runnable.
func (*Runnable_Container) Descriptor
func (*Runnable_Container) Descriptor() ([]byte, []int)Deprecated: Use Runnable_Container.ProtoReflect.Descriptor instead.
func (*Runnable_Container) GetBlockExternalNetwork
func (x *Runnable_Container) GetBlockExternalNetwork() boolfunc (*Runnable_Container) GetCommands
func (x *Runnable_Container) GetCommands() []stringfunc (*Runnable_Container) GetEnableImageStreaming
func (x *Runnable_Container) GetEnableImageStreaming() boolfunc (*Runnable_Container) GetEntrypoint
func (x *Runnable_Container) GetEntrypoint() stringfunc (*Runnable_Container) GetImageUri
func (x *Runnable_Container) GetImageUri() stringfunc (*Runnable_Container) GetOptions
func (x *Runnable_Container) GetOptions() stringfunc (*Runnable_Container) GetPassword
func (x *Runnable_Container) GetPassword() stringfunc (*Runnable_Container) GetUsername
func (x *Runnable_Container) GetUsername() stringfunc (*Runnable_Container) GetVolumes
func (x *Runnable_Container) GetVolumes() []stringfunc (*Runnable_Container) ProtoMessage
func (*Runnable_Container) ProtoMessage()func (*Runnable_Container) ProtoReflect
func (x *Runnable_Container) ProtoReflect() protoreflect.Messagefunc (*Runnable_Container) Reset
func (x *Runnable_Container) Reset()func (*Runnable_Container) String
func (x *Runnable_Container) String() stringRunnable_Container_
type Runnable_Container_ struct {
// Container runnable.
Container *Runnable_Container `protobuf:"bytes,1,opt,name=container,proto3,oneof"`
}Runnable_Script
type Runnable_Script struct {
// Required. The source code for this script runnable.
//
// Types that are assignable to Command:
//
// *Runnable_Script_Path
// *Runnable_Script_Text
Command isRunnable_Script_Command `protobuf_oneof:"command"`
// contains filtered or unexported fields
}Script runnable.
func (*Runnable_Script) Descriptor
func (*Runnable_Script) Descriptor() ([]byte, []int)Deprecated: Use Runnable_Script.ProtoReflect.Descriptor instead.
func (*Runnable_Script) GetCommand
func (m *Runnable_Script) GetCommand() isRunnable_Script_Commandfunc (*Runnable_Script) GetPath
func (x *Runnable_Script) GetPath() stringfunc (*Runnable_Script) GetText
func (x *Runnable_Script) GetText() stringfunc (*Runnable_Script) ProtoMessage
func (*Runnable_Script) ProtoMessage()func (*Runnable_Script) ProtoReflect
func (x *Runnable_Script) ProtoReflect() protoreflect.Messagefunc (*Runnable_Script) Reset
func (x *Runnable_Script) Reset()func (*Runnable_Script) String
func (x *Runnable_Script) String() stringRunnable_Script_
type Runnable_Script_ struct {
// Script runnable.
Script *Runnable_Script `protobuf:"bytes,2,opt,name=script,proto3,oneof"`
}Runnable_Script_Path
type Runnable_Script_Path struct {
// 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.
Path string `protobuf:"bytes,1,opt,name=path,proto3,oneof"`
}Runnable_Script_Text
type Runnable_Script_Text struct {
// 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.
Text string `protobuf:"bytes,2,opt,name=text,proto3,oneof"`
}ServiceAccount
type ServiceAccount struct {
// Email address of the service account.
Email string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty"`
// List of scopes to be enabled for this service account.
Scopes []string `protobuf:"bytes,2,rep,name=scopes,proto3" json:"scopes,omitempty"`
// contains filtered or unexported fields
}Carries information about a Google Cloud service account.
func (*ServiceAccount) Descriptor
func (*ServiceAccount) Descriptor() ([]byte, []int)Deprecated: Use ServiceAccount.ProtoReflect.Descriptor instead.
func (*ServiceAccount) GetEmail
func (x *ServiceAccount) GetEmail() stringfunc (*ServiceAccount) GetScopes
func (x *ServiceAccount) GetScopes() []stringfunc (*ServiceAccount) ProtoMessage
func (*ServiceAccount) ProtoMessage()func (*ServiceAccount) ProtoReflect
func (x *ServiceAccount) ProtoReflect() protoreflect.Messagefunc (*ServiceAccount) Reset
func (x *ServiceAccount) Reset()func (*ServiceAccount) String
func (x *ServiceAccount) String() stringStatusEvent
type StatusEvent struct {
Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
EventTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`
TaskExecution *TaskExecution `protobuf:"bytes,4,opt,name=task_execution,json=taskExecution,proto3" json:"task_execution,omitempty"`
TaskState TaskStatus_State "" /* 133 byte string literal not displayed */
}Status event.
func (*StatusEvent) Descriptor
func (*StatusEvent) Descriptor() ([]byte, []int)Deprecated: Use StatusEvent.ProtoReflect.Descriptor instead.
func (*StatusEvent) GetDescription
func (x *StatusEvent) GetDescription() stringfunc (*StatusEvent) GetEventTime
func (x *StatusEvent) GetEventTime() *timestamppb.Timestampfunc (*StatusEvent) GetTaskExecution
func (x *StatusEvent) GetTaskExecution() *TaskExecutionfunc (*StatusEvent) GetTaskState
func (x *StatusEvent) GetTaskState() TaskStatus_Statefunc (*StatusEvent) GetType
func (x *StatusEvent) GetType() stringfunc (*StatusEvent) ProtoMessage
func (*StatusEvent) ProtoMessage()func (*StatusEvent) ProtoReflect
func (x *StatusEvent) ProtoReflect() protoreflect.Messagefunc (*StatusEvent) Reset
func (x *StatusEvent) Reset()func (*StatusEvent) String
func (x *StatusEvent) String() stringTask
type Task struct {
// 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 `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Task Status.
Status *TaskStatus `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
// contains filtered or unexported fields
}A Cloud Batch task.
func (*Task) Descriptor
Deprecated: Use Task.ProtoReflect.Descriptor instead.
func (*Task) GetName
func (*Task) GetStatus
func (x *Task) GetStatus() *TaskStatusfunc (*Task) ProtoMessage
func (*Task) ProtoMessage()func (*Task) ProtoReflect
func (x *Task) ProtoReflect() protoreflect.Messagefunc (*Task) Reset
func (x *Task) Reset()func (*Task) String
TaskExecution
type TaskExecution struct {
// 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.
ExitCode int32 `protobuf:"varint,1,opt,name=exit_code,json=exitCode,proto3" json:"exit_code,omitempty"`
// contains filtered or unexported fields
}This Task Execution field includes detail information for task execution procedures, based on StatusEvent types.
func (*TaskExecution) Descriptor
func (*TaskExecution) Descriptor() ([]byte, []int)Deprecated: Use TaskExecution.ProtoReflect.Descriptor instead.
func (*TaskExecution) GetExitCode
func (x *TaskExecution) GetExitCode() int32func (*TaskExecution) ProtoMessage
func (*TaskExecution) ProtoMessage()func (*TaskExecution) ProtoReflect
func (x *TaskExecution) ProtoReflect() protoreflect.Messagefunc (*TaskExecution) Reset
func (x *TaskExecution) Reset()func (*TaskExecution) String
func (x *TaskExecution) String() stringTaskGroup
type TaskGroup struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
TaskSpec *TaskSpec `protobuf:"bytes,3,opt,name=task_spec,json=taskSpec,proto3" json:"task_spec,omitempty"`
TaskCount int64 `protobuf:"varint,4,opt,name=task_count,json=taskCount,proto3" json:"task_count,omitempty"`
Parallelism int64 `protobuf:"varint,5,opt,name=parallelism,proto3" json:"parallelism,omitempty"`
SchedulingPolicy TaskGroup_SchedulingPolicy "" /* 164 byte string literal not displayed */
TaskEnvironments []*Environment `protobuf:"bytes,9,rep,name=task_environments,json=taskEnvironments,proto3" json:"task_environments,omitempty"`
TaskCountPerNode int64 `protobuf:"varint,10,opt,name=task_count_per_node,json=taskCountPerNode,proto3" json:"task_count_per_node,omitempty"`
RequireHostsFile bool `protobuf:"varint,11,opt,name=require_hosts_file,json=requireHostsFile,proto3" json:"require_hosts_file,omitempty"`
PermissiveSsh bool `protobuf:"varint,12,opt,name=permissive_ssh,json=permissiveSsh,proto3" json:"permissive_ssh,omitempty"`
RunAsNonRoot bool `protobuf:"varint,14,opt,name=run_as_non_root,json=runAsNonRoot,proto3" json:"run_as_non_root,omitempty"`
}A TaskGroup defines one or more Tasks that all share the same TaskSpec.
func (*TaskGroup) Descriptor
Deprecated: Use TaskGroup.ProtoReflect.Descriptor instead.
func (*TaskGroup) GetName
func (*TaskGroup) GetParallelism
func (*TaskGroup) GetPermissiveSsh
func (*TaskGroup) GetRequireHostsFile
func (*TaskGroup) GetRunAsNonRoot
func (*TaskGroup) GetSchedulingPolicy
func (x *TaskGroup) GetSchedulingPolicy() TaskGroup_SchedulingPolicyfunc (*TaskGroup) GetTaskCount
func (*TaskGroup) GetTaskCountPerNode
func (*TaskGroup) GetTaskEnvironments
func (x *TaskGroup) GetTaskEnvironments() []*Environmentfunc (*TaskGroup) GetTaskSpec
func (*TaskGroup) ProtoMessage
func (*TaskGroup) ProtoMessage()func (*TaskGroup) ProtoReflect
func (x *TaskGroup) ProtoReflect() protoreflect.Messagefunc (*TaskGroup) Reset
func (x *TaskGroup) Reset()func (*TaskGroup) String
TaskGroup_SchedulingPolicy
type TaskGroup_SchedulingPolicy int32How Tasks in the TaskGroup should be scheduled relative to each other.
TaskGroup_SCHEDULING_POLICY_UNSPECIFIED, TaskGroup_AS_SOON_AS_POSSIBLE, TaskGroup_IN_ORDER
const (
// Unspecified.
TaskGroup_SCHEDULING_POLICY_UNSPECIFIED TaskGroup_SchedulingPolicy = 0
// Run Tasks as soon as resources are available.
//
// Tasks might be executed in parallel depending on parallelism and
// task_count values.
TaskGroup_AS_SOON_AS_POSSIBLE TaskGroup_SchedulingPolicy = 1
// Run Tasks sequentially with increased task index.
TaskGroup_IN_ORDER TaskGroup_SchedulingPolicy = 2
)func (TaskGroup_SchedulingPolicy) Descriptor
func (TaskGroup_SchedulingPolicy) Descriptor() protoreflect.EnumDescriptorfunc (TaskGroup_SchedulingPolicy) Enum
func (x TaskGroup_SchedulingPolicy) Enum() *TaskGroup_SchedulingPolicyfunc (TaskGroup_SchedulingPolicy) EnumDescriptor
func (TaskGroup_SchedulingPolicy) EnumDescriptor() ([]byte, []int)Deprecated: Use TaskGroup_SchedulingPolicy.Descriptor instead.
func (TaskGroup_SchedulingPolicy) Number
func (x TaskGroup_SchedulingPolicy) Number() protoreflect.EnumNumberfunc (TaskGroup_SchedulingPolicy) String
func (x TaskGroup_SchedulingPolicy) String() stringfunc (TaskGroup_SchedulingPolicy) Type
func (TaskGroup_SchedulingPolicy) Type() protoreflect.EnumTypeTaskSpec
type TaskSpec struct {
Runnables []*Runnable `protobuf:"bytes,8,rep,name=runnables,proto3" json:"runnables,omitempty"`
ComputeResource *ComputeResource `protobuf:"bytes,3,opt,name=compute_resource,json=computeResource,proto3" json:"compute_resource,omitempty"`
MaxRunDuration *durationpb.Duration `protobuf:"bytes,4,opt,name=max_run_duration,json=maxRunDuration,proto3" json:"max_run_duration,omitempty"`
MaxRetryCount int32 `protobuf:"varint,5,opt,name=max_retry_count,json=maxRetryCount,proto3" json:"max_retry_count,omitempty"`
LifecyclePolicies []*LifecyclePolicy `protobuf:"bytes,9,rep,name=lifecycle_policies,json=lifecyclePolicies,proto3" json:"lifecycle_policies,omitempty"`
Environments map[string]string "" /* 165 byte string literal not displayed */
Volumes []*Volume `protobuf:"bytes,7,rep,name=volumes,proto3" json:"volumes,omitempty"`
Environment *Environment `protobuf:"bytes,10,opt,name=environment,proto3" json:"environment,omitempty"`
}Spec of a task
func (*TaskSpec) Descriptor
Deprecated: Use TaskSpec.ProtoReflect.Descriptor instead.
func (*TaskSpec) GetComputeResource
func (x *TaskSpec) GetComputeResource() *ComputeResourcefunc (*TaskSpec) GetEnvironment
func (x *TaskSpec) GetEnvironment() *Environmentfunc (*TaskSpec) GetEnvironments
Deprecated: Marked as deprecated in google/cloud/batch/v1/task.proto.
func (*TaskSpec) GetLifecyclePolicies
func (x *TaskSpec) GetLifecyclePolicies() []*LifecyclePolicyfunc (*TaskSpec) GetMaxRetryCount
func (*TaskSpec) GetMaxRunDuration
func (x *TaskSpec) GetMaxRunDuration() *durationpb.Durationfunc (*TaskSpec) GetRunnables
func (*TaskSpec) GetVolumes
func (*TaskSpec) ProtoMessage
func (*TaskSpec) ProtoMessage()func (*TaskSpec) ProtoReflect
func (x *TaskSpec) ProtoReflect() protoreflect.Messagefunc (*TaskSpec) Reset
func (x *TaskSpec) Reset()func (*TaskSpec) String
TaskStatus
type TaskStatus struct {
// Task state.
State TaskStatus_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.batch.v1.TaskStatus_State" json:"state,omitempty"`
// Detailed info about why the state is reached.
StatusEvents []*StatusEvent `protobuf:"bytes,2,rep,name=status_events,json=statusEvents,proto3" json:"status_events,omitempty"`
// contains filtered or unexported fields
}Status of a task.
func (*TaskStatus) Descriptor
func (*TaskStatus) Descriptor() ([]byte, []int)Deprecated: Use TaskStatus.ProtoReflect.Descriptor instead.
func (*TaskStatus) GetState
func (x *TaskStatus) GetState() TaskStatus_Statefunc (*TaskStatus) GetStatusEvents
func (x *TaskStatus) GetStatusEvents() []*StatusEventfunc (*TaskStatus) ProtoMessage
func (*TaskStatus) ProtoMessage()func (*TaskStatus) ProtoReflect
func (x *TaskStatus) ProtoReflect() protoreflect.Messagefunc (*TaskStatus) Reset
func (x *TaskStatus) Reset()func (*TaskStatus) String
func (x *TaskStatus) String() stringTaskStatus_State
type TaskStatus_State int32Task states.
TaskStatus_STATE_UNSPECIFIED, TaskStatus_PENDING, TaskStatus_ASSIGNED, TaskStatus_RUNNING, TaskStatus_FAILED, TaskStatus_SUCCEEDED, TaskStatus_UNEXECUTED
const (
// Unknown state.
TaskStatus_STATE_UNSPECIFIED TaskStatus_State = 0
// The Task is created and waiting for resources.
TaskStatus_PENDING TaskStatus_State = 1
// The Task is assigned to at least one VM.
TaskStatus_ASSIGNED TaskStatus_State = 2
// The Task is running.
TaskStatus_RUNNING TaskStatus_State = 3
// The Task has failed.
TaskStatus_FAILED TaskStatus_State = 4
// The Task has succeeded.
TaskStatus_SUCCEEDED TaskStatus_State = 5
// The Task has not been executed when the Job finishes.
TaskStatus_UNEXECUTED TaskStatus_State = 6
)func (TaskStatus_State) Descriptor
func (TaskStatus_State) Descriptor() protoreflect.EnumDescriptorfunc (TaskStatus_State) Enum
func (x TaskStatus_State) Enum() *TaskStatus_Statefunc (TaskStatus_State) EnumDescriptor
func (TaskStatus_State) EnumDescriptor() ([]byte, []int)Deprecated: Use TaskStatus_State.Descriptor instead.
func (TaskStatus_State) Number
func (x TaskStatus_State) Number() protoreflect.EnumNumberfunc (TaskStatus_State) String
func (x TaskStatus_State) String() stringfunc (TaskStatus_State) Type
func (TaskStatus_State) Type() protoreflect.EnumTypeUnimplementedBatchServiceServer
type UnimplementedBatchServiceServer struct {
}UnimplementedBatchServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedBatchServiceServer) CreateJob
func (*UnimplementedBatchServiceServer) CreateJob(context.Context, *CreateJobRequest) (*Job, error)func (*UnimplementedBatchServiceServer) DeleteJob
func (*UnimplementedBatchServiceServer) DeleteJob(context.Context, *DeleteJobRequest) (*longrunningpb.Operation, error)func (*UnimplementedBatchServiceServer) GetJob
func (*UnimplementedBatchServiceServer) GetJob(context.Context, *GetJobRequest) (*Job, error)func (*UnimplementedBatchServiceServer) GetTask
func (*UnimplementedBatchServiceServer) GetTask(context.Context, *GetTaskRequest) (*Task, error)func (*UnimplementedBatchServiceServer) ListJobs
func (*UnimplementedBatchServiceServer) ListJobs(context.Context, *ListJobsRequest) (*ListJobsResponse, error)func (*UnimplementedBatchServiceServer) ListTasks
func (*UnimplementedBatchServiceServer) ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)Volume
type Volume struct {
// The source for the volume.
//
// Types that are assignable to Source:
//
// *Volume_Nfs
// *Volume_Gcs
// *Volume_DeviceName
Source isVolume_Source `protobuf_oneof:"source"`
// The mount path for the volume, e.g. /mnt/disks/share.
MountPath string `protobuf:"bytes,4,opt,name=mount_path,json=mountPath,proto3" json:"mount_path,omitempty"`
// 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.
MountOptions []string `protobuf:"bytes,5,rep,name=mount_options,json=mountOptions,proto3" json:"mount_options,omitempty"`
// contains filtered or unexported fields
}Volume describes a volume and parameters for it to be mounted to a VM.
func (*Volume) Descriptor
Deprecated: Use Volume.ProtoReflect.Descriptor instead.
func (*Volume) GetDeviceName
func (*Volume) GetGcs
func (*Volume) GetMountOptions
func (*Volume) GetMountPath
func (*Volume) GetNfs
func (*Volume) GetSource
func (m *Volume) GetSource() isVolume_Sourcefunc (*Volume) ProtoMessage
func (*Volume) ProtoMessage()func (*Volume) ProtoReflect
func (x *Volume) ProtoReflect() protoreflect.Messagefunc (*Volume) Reset
func (x *Volume) Reset()func (*Volume) String
Volume_DeviceName
type Volume_DeviceName struct {
// 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.
DeviceName string `protobuf:"bytes,6,opt,name=device_name,json=deviceName,proto3,oneof"`
}Volume_Gcs
type Volume_Gcs struct {
// A Google Cloud Storage (GCS) volume.
Gcs *GCS `protobuf:"bytes,3,opt,name=gcs,proto3,oneof"`
}Volume_Nfs
type Volume_Nfs struct {
// A Network File System (NFS) volume. For example, a
// Filestore file share.
Nfs *NFS `protobuf:"bytes,1,opt,name=nfs,proto3,oneof"`
}