Skip to content

Commit

Permalink
feat(batch): update the API
Browse files Browse the repository at this point in the history
#### batch:v1

The following keys were added:
- resources.projects.resources.locations.resources.jobs.methods.list.parameters.orderBy.description
- resources.projects.resources.locations.resources.jobs.methods.list.parameters.orderBy.location
- resources.projects.resources.locations.resources.jobs.methods.list.parameters.orderBy.type
- schemas.Accelerator.properties.driverVersion.description
- schemas.Accelerator.properties.driverVersion.type

The following keys were changed:
- schemas.AgentInfo.properties.jobId.description
- schemas.Disk.properties.image.description
- schemas.InstancePolicyOrTemplate.properties.installGpuDrivers.description
- schemas.NetworkInterface.properties.network.description
- schemas.NetworkInterface.properties.subnetwork.description
  • Loading branch information
yoshi-automation authored and sofisl committed Jul 15, 2023
1 parent 2579d7a commit 7aedd6e
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 11 deletions.
21 changes: 15 additions & 6 deletions discovery/batch-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,11 @@
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Sort results. Supported are \"name\", \"name desc\", \"create_time\", and \"create_time desc\".",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Page size.",
"format": "int32",
Expand Down Expand Up @@ -556,7 +561,7 @@
}
}
},
"revision": "20230621",
"revision": "20230705",
"rootUrl": "https://batch.googleapis.com/",
"schemas": {
"Accelerator": {
Expand All @@ -568,6 +573,10 @@
"format": "int64",
"type": "string"
},
"driverVersion": {
"description": "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.",
"type": "string"
},
"installGpuDrivers": {
"deprecated": true,
"description": "Deprecated: please use instances[0].install_gpu_drivers instead.",
Expand Down Expand Up @@ -658,7 +667,7 @@
"id": "AgentInfo",
"properties": {
"jobId": {
"description": "The assigned Job ID",
"description": "Optional. The assigned Job ID",
"type": "string"
},
"reportTime": {
Expand Down Expand Up @@ -1082,7 +1091,7 @@
"type": "string"
},
"image": {
"description": "Name of a public or custom image used as the data source. 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-centos\": use Batch CentOS images. * \"batch-cos\": use Batch Container-Optimized images. * \"batch-hpc-centos\": use Batch HPC CentOS images.",
"description": "Name of an image used as the data source. 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-centos`: use Batch CentOS images. * `batch-cos`: use Batch Container-Optimized images. * `batch-hpc-centos`: use Batch HPC CentOS images.",
"type": "string"
},
"sizeGb": {
Expand Down Expand Up @@ -1197,7 +1206,7 @@
"id": "InstancePolicyOrTemplate",
"properties": {
"installGpuDrivers": {
"description": "Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false.",
"description": "Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. 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.",
"type": "boolean"
},
"instanceTemplate": {
Expand Down Expand Up @@ -1660,15 +1669,15 @@
"id": "NetworkInterface",
"properties": {
"network": {
"description": "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}",
"description": "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 ",
"type": "string"
},
"noExternalIpAddress": {
"description": "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.",
"type": "boolean"
},
"subnetwork": {
"description": "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}",
"description": "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 ",
"type": "string"
}
},
Expand Down
20 changes: 15 additions & 5 deletions src/apis/batch/v1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,10 @@ export namespace batch_v1 {
* The number of accelerators of this type.
*/
count?: string | null;
/**
* 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 | null;
/**
* Deprecated: please use instances[0].install_gpu_drivers instead.
*/
Expand Down Expand Up @@ -197,7 +201,7 @@ export namespace batch_v1 {
*/
export interface Schema$AgentInfo {
/**
* The assigned Job ID
* Optional. The assigned Job ID
*/
jobId?: string | null;
/**
Expand Down Expand Up @@ -520,7 +524,7 @@ export namespace batch_v1 {
*/
diskInterface?: string | null;
/**
* Name of a public or custom image used as the data source. 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-centos": use Batch CentOS images. * "batch-cos": use Batch Container-Optimized images. * "batch-hpc-centos": use Batch HPC CentOS images.
* Name of an image used as the data source. 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-centos`: use Batch CentOS images. * `batch-cos`: use Batch Container-Optimized images. * `batch-hpc-centos`: use Batch HPC CentOS images.
*/
image?: string | null;
/**
Expand Down Expand Up @@ -600,7 +604,7 @@ export namespace batch_v1 {
*/
export interface Schema$InstancePolicyOrTemplate {
/**
* Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false.
* Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. 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?: boolean | null;
/**
Expand Down Expand Up @@ -865,15 +869,15 @@ export namespace batch_v1 {
*/
export interface Schema$NetworkInterface {
/**
* 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\}
* 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 | null;
/**
* Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
*/
noExternalIpAddress?: boolean | null;
/**
* The URL of 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\}
* 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 | null;
}
Expand Down Expand Up @@ -2054,6 +2058,8 @@ export namespace batch_v1 {
* const res = await batch.projects.locations.jobs.list({
* // List filter.
* filter: 'placeholder-value',
* // Optional. Sort results. Supported are "name", "name desc", "create_time", and "create_time desc".
* orderBy: 'placeholder-value',
* // Page size.
* pageSize: 'placeholder-value',
* // Page token.
Expand Down Expand Up @@ -2208,6 +2214,10 @@ export namespace batch_v1 {
* List filter.
*/
filter?: string;
/**
* Optional. Sort results. Supported are "name", "name desc", "create_time", and "create_time desc".
*/
orderBy?: string;
/**
* Page size.
*/
Expand Down

0 comments on commit 7aedd6e

Please sign in to comment.