Version history

Version 2.13.0, released 2025-02-18

New features

• Promote cancel job API to GA ( commit 5f94220 )

Documentation improvements

• Fix broken references in comments ( commit 945b0e2 )
• Clarify options for logs ( commit e86bb14 )
• Clarify the custom instance template needs to be in the same project ( commit e86bb14 )
• Rephrase reservation field doc ( commit 1d9b15d )
• Update reservation field to include NO_RESERVATION ( commit 1735012 )
• Clarify that user provided labels will also be applied to Cloud Logging ( commit 1735012 )
• Clarify Batch only supports global custom instance template now ( commit a8f24e4 )

Version 2.12.0, released 2024-09-09

New features

• Promote block_project_ssh_keys support to batch v1 API ( commit 6030568 )

Documentation improvements

• Clarify tasks success criteria for background runnable ( commit 78ba76d )
• Batch CentOS images and HPC CentOS images are EOS ( commit f739754 )
• Clarify required fields for Runnable.Container ( commit f739754 )
• Clarify required oneof fields for Runnable.Script ( commit f739754 )
• Clarify TaskSpec requires one or more runnables ( commit f739754 )
• Refine usage scope for fields task_execution and task_state in StatusEvent ( commit fcfba8b )

Version 2.11.0, released 2024-07-01

New features

• Add a install_ops_agent field to InstancePolicyOrTemplate for Ops Agent support ( commit d8e69ab )

Documentation improvements

• Add instructions on how to configure cross-project pubsub publisher ( commit d8e69ab )
• Document default disk type: pd-standard for non boot disk, pd-balanced for boot disk ( commit d8e69ab )
• Update list of volume.mount_options field ( commit d8e69ab )
• Update GCS description of volume.mount_options field ( commit d8e69ab )
• Update links in the description of volume.mount_options field ( commit d8e69ab )
• Documentation improvements ( commit 5d53acd )
• Refine description for field task_execution ( commit 7115e29 )

Version 2.10.0, released 2024-05-08

New features

• Add IServiceCollection extension methods for client registration where an IServiceProvider is required. ( commit 022fab2 )

Documentation improvements

• Update description on allowed_locations in LocationPolicy field ( commit 28e0693 )
• Update comments on ServiceAccount email and scopes fields ( commit 64a9268 )
• State one Resource Allowance per region per project limitation on v1alpha ( commit 159689e )
• A comment for field max_run_duration in message .google.cloud.batch.v1alpha.TaskSpec and .google.cloud.batch.v1.TaskSpec is changed ( commit 159689e )
• Add non-negative restriction comment for usage_resource_allowance.spec.limit.limit exposed on v1alpha ( commit 159689e )

Version 2.9.0, released 2024-03-26

New features

• Change netstandard2.1 target to netstandard2.0 ( commit 82bea85 )

Version 2.8.0, released 2024-02-28

Documentation improvements

• Update description of Job uid field ( commit eaaff5e )
• Refine proto comment for run_as_non_root ( commit 354560a )
• Add caution messages for container runnable username and password fields ( commit 354560a )

Version 2.7.0, released 2024-02-08

New features

• Add run_as_non_root field to allow user's runnable be executed as non root ( commit 7529915 )
• Add tags field in Job's AllocationPolicy field in v1 ( commit 7529915 )
• Add Batch Image Streaming support for v1 ( commit 7529915 )

Documentation improvements

• Polish the field descriptions for enableImageStreaming and CloudLoggingOptions ( commit 7529915 )

Version 2.6.0, released 2023-12-05

New features

• Add a CloudLoggingOption and use_generic_task_monitored_resource fields for users to opt out new batch monitored resource in cloud logging ( commit 838c6df )

Documentation improvements

• Update comment for AllocationPolicy.network ( commit 838c6df )
• Update default max parallel tasks per job ( commit 06a26bf )

Version 2.5.0, released 2023-10-30

New features

• Expose display_name to batch v1 API ( commit 86e0579 )
• Add InstancePolicy.reservation field for restricting jobs to a specific reservation ( commit 10652c4 )

Documentation improvements

• Elaborate the usage of Container.volumes proto field ( commit 10652c4 )
• Update batch PD interface support ( commit 0ab1964 )
• Update description on size_gb in disk field ( commit d78ee5c )
• Revert HTML formats in comments ( commit 0700ba4 )
• Expand compute resource API docs to match with VM's machine type field ( commit 0700ba4 )
• Clarify Batch API proto doc about pubsub notifications ( commit 0700ba4 )

Version 2.4.0, released 2023-08-16

New features

• Clarify Batch API proto doc about pubsub notifications ( commit 0d8755a )
• Add Batch Managed Container support for v1alpha ( commit 0d8755a )

Version 2.3.0, released 2023-08-04

New features

• Add comment to the unsupported order_by field of ListTasksRequest ( commit 036fc52 )
• Enable gpu driver version field on v1 ( commit 036fc52 )
• Allow order_by for v1 ListJobs ( commit 036fc52 )
• Improve url examples formats on Batch API comments ( commit 036fc52 )

Documentation improvements

• Add image shortcut example for Batch HPC CentOS Image ( commit 9b54ce0 )

Version 2.2.0, released 2023-06-20

New features

• Add support for scheduling_policy ( commit 051cc0d )

Documentation improvements

• Minor clarifications for TaskGroup and min_cpu_platform ( commit 051cc0d )

Version 2.1.0, released 2023-05-26

New features

• Add support for placement policies ( commit 173ed3d )
• Per-Runnable labels ( commit 173ed3d )
• Support order_by in ListJobs and ListTasks requests ( commit 87c14ef )
• Add support for placement policies ( commit 87c14ef )
• Per-Runnable labels ( commit 87c14ef )
• Support order_by in ListJobs and ListTasks requests ( commit dd462ce )
• Add support for placement policies ( commit dd462ce )
• Per-Runnable labels ( commit dd462ce )

Version 2.0.0, released 2023-03-09

BREAKING CHANGE

BatchServiceClient no longer exposes an IAMPolicyClient. This was only exposed unintentionally, and has never worked. However, this is still a breaking change as application code may have referred to it.

New features

• Added StatusEvent.task_state ( commit 25463ba )

Documentation improvements

• Updated comments ( commit 25463ba )

Version 1.3.0, released 2023-02-08

New features

• Support custom scopes for service account in v1 ( commit 60d746a )
• Add boot disk field in InstanceStatus ( commit 60d746a )
• Add boot disk and image source fields to v1 InstancePolicy ( commit 60d746a )

Version 1.2.0, released 2023-01-11

Bug fixes

• Remove unsupported HTTP bindings for IAMPolicy RPCs ( commit 9ca7a4b )

New features

• Support secret and encrypted environment variables in v1 ( commit f527507 )

Documentation improvements

• Updated documentation for message NetworkInterface ( commit 7c2ce96 )

Version 1.2.0-beta01, released 2022-12-08

New features

• Enable REST transport in selected APIs. Set GrpcAdapter=RestGrpcAdapter.Default in the client builder to use this transport ( commit 5008946 )

Version 1.1.0, released 2022-12-01

New features

• Adds named reservation to InstancePolicy ( commit ad603eb )

Documentation improvements

• Fix minor docstring formatting ( commit 48e5d7c )
• Remove "not yet implemented" for Accelerator & Refine Volume API docs ( commit ad603eb )
• Update the job id format requirement ( commit ad603eb )
• Fix minor docstring formatting ( commit 2069ee9 )

Version 1.0.0, released 2022-11-02

No API surface changes; just dependency updates and promotion to general availability.

Version 1.0.0-beta03, released 2022-10-17

New features

• Enable install_gpu_drivers flag in v1 proto ( commit 12c66f2 )

Documentation improvements

• Refine GPU drivers installation proto description ( commit 12c66f2 )
• Refine comments for deprecated proto fields ( commit 12c66f2 )
• Update the API comments about the device_name ( commit 12c66f2 )

Version 1.0.0-beta02, released 2022-08-26

New features

• Environment variables, disk interfaces ( commit 29e77e1 )

Version 1.0.0-beta01, released 2022-07-14

Initial release.