Skip to content

Commit

Permalink
docs: Revert HTML formats in comments
Browse files Browse the repository at this point in the history 
docs: Expand compute resource API docs to match with VM's machine type field

docs: Clarify Batch API proto doc about pubsub notifications
PiperOrigin-RevId: 558940776

Source-Link: googleapis/googleapis@a7ee700

Source-Link: googleapis/googleapis-gen@4f3a485
Copy-Tag: eyJwIjoiYXBpcy9Hb29nbGUuQ2xvdWQuQmF0Y2guVjEvLk93bEJvdC55YW1sIiwiaCI6IjRmM2E0ODVmM2NlYjEzYjY3ZTA1MjJiNzRhN2ZkOWNjZGUyYWE2YTEifQ==
  • Loading branch information
@gcf-owl-bot @anuragsrivstv
gcf-owl-bot[bot] authored and anuragsrivstv committed Aug 22, 2023
1 parent cbc6da1 commit 0700ba4
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 27 deletions.
45 changes: 19 additions & 26 deletions apis/Google.Cloud.Batch.V1/Google.Cloud.Batch.V1/Job.g.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3194,17 +3194,14 @@ public Disk Clone() {
/// <summary>Field number for the "image" field.</summary>
public const int ImageFieldNumber = 4;
/// <summary>
/// Name of an image used as the data source.
/// 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:
/// &lt;pre>&lt;code>projects/&lt;var
/// class="apiparam">project&lt;/var>/global/images/family/&lt;var
/// class="apiparam">image_family&lt;/var>&lt;/code>&lt;/pre>
/// projects/{project}/global/images/family/{image_family}
/// * Specify the image version:
/// &lt;pre>projects/&lt;var
/// class="apiparam">project&lt;/var>/global/images/&lt;var
/// class="apiparam">image_version&lt;/var>&lt;/code>&lt;/pre>
/// 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:
///
Expand Down Expand Up @@ -4379,6 +4376,9 @@ public string MinCpuPlatform {
/// <summary>
/// Non-boot disks to be attached for each VM created by this InstancePolicy.
/// New disks will be deleted when the VM is deleted.
/// A non-boot disk is a disk that can be of a device with a
/// file system or a raw storage drive that is not ready for data
/// storage and accessing.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -4629,7 +4629,10 @@ public void MergeFrom(pb::CodedInputStream input) {
}

/// <summary>
/// Either an InstancePolicy or an instance template.
/// 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.
/// </summary>
public sealed partial class InstancePolicyOrTemplate : pb::IMessage<InstancePolicyOrTemplate>
#if !GOOGLE_PROTOBUF_REFSTRUCT_COMPATIBILITY_MODE
Expand Down Expand Up @@ -5031,14 +5034,10 @@ public NetworkInterface Clone() {
/// You can specify the network as a full or partial URL.
///
/// For example, the following are all valid URLs:
/// &lt;pre>&lt;code>https://www.googleapis.com/compute/v1/projects/&lt;var
/// class="apiparam">project&lt;/var>/global/networks/&lt;var
/// class="apiparam">network&lt;/var>&lt;/code>&lt;/pre>
/// &lt;pre>&lt;code>projects/&lt;var
/// class="apiparam">project&lt;/var>/global/networks/&lt;var
/// class="apiparam">network&lt;/var>&lt;/code>&lt;/pre>
/// &lt;pre>&lt;code>global/networks/&lt;var
/// class="apiparam">network&lt;/var>&lt;/code>&lt;/pre>
///
/// * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
/// * projects/{project}/global/networks/{network}
/// * global/networks/{network}
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand All @@ -5057,16 +5056,10 @@ public string Network {
/// You can specify the subnetwork as a full or partial URL.
///
/// For example, the following are all valid URLs:
/// &lt;pre>&lt;code>https://www.googleapis.com/compute/v1/projects/&lt;var
/// class="apiparam">project&lt;/var>/regions/&lt;var
/// class="apiparam">region&lt;/var>/subnetworks/&lt;var
/// class="apiparam">subnetwork&lt;/var>&lt;/code>&lt;/pre>
/// &lt;pre>&lt;code>projects/&lt;var class="apiparam">project&lt;/var>/regions/&lt;var
/// class="apiparam">region&lt;/var>/subnetworks/&lt;var
/// class="apiparam">subnetwork&lt;/var>&lt;/code>&lt;/pre>
/// &lt;pre>&lt;code>regions/&lt;var
/// class="apiparam">region&lt;/var>/subnetworks/&lt;var
/// class="apiparam">subnetwork&lt;/var>&lt;/code>&lt;/pre>
///
/// * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork}
/// * projects/{project}/regions/{region}/subnetworks/{subnetwork}
/// * regions/{region}/subnetworks/{subnetwork}
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down
40 changes: 39 additions & 1 deletion apis/Google.Cloud.Batch.V1/Google.Cloud.Batch.V1/Task.g.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,13 @@ static TaskReflection() {
}
#region Messages
/// <summary>
/// Compute resource requirements
/// Compute resource requirements.
///
/// ComputeResource defines the amount of resources required for each task.
/// Make sure your tasks have enough resources to successfully run.
/// If you also define the types of resources for a job to use with the
/// [InstancePolicyOrTemplate](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate)
/// field, make sure both fields are compatible with each other.
/// </summary>
public sealed partial class ComputeResource : pb::IMessage<ComputeResource>
#if !GOOGLE_PROTOBUF_REFSTRUCT_COMPATIBILITY_MODE
Expand Down Expand Up @@ -169,6 +175,23 @@ public ComputeResource Clone() {
private long cpuMilli_;
/// <summary>
/// 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.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand All @@ -184,6 +207,21 @@ public long CpuMilli {
private long memoryMib_;
/// <summary>
/// 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.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down

0 comments on commit 0700ba4

Please sign in to comment.