[beam] 02/12: Add payload descriptions to resource hints urns.

[lo...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

lostluck pushed a commit to branch beam23893pipelinehint
in repository https://gitbox.apache.org/repos/asf/beam.git

commit fa2b7966911eef658cd7f02ca6a5eb501c175c28
Author: lostluck <13...@users.noreply.github.com>
AuthorDate: Fri Nov 4 12:16:14 2022 -0700

    Add payload descriptions to resource hints urns.
---
 .../proto/org/apache/beam/model/pipeline/v1/beam_runner_api.proto   | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/model/pipeline/src/main/proto/org/apache/beam/model/pipeline/v1/beam_runner_api.proto b/model/pipeline/src/main/proto/org/apache/beam/model/pipeline/v1/beam_runner_api.proto
index 5910a1032eb..4decd905a7d 100644
--- a/model/pipeline/src/main/proto/org/apache/beam/model/pipeline/v1/beam_runner_api.proto
+++ b/model/pipeline/src/main/proto/org/apache/beam/model/pipeline/v1/beam_runner_api.proto
@@ -1959,12 +1959,18 @@ message ExecutableStagePayload {
   }
 }
 
+// See https://beam.apache.org/documentation/runtime/resource-hints/ for additional documentation
+// on the behavior of StandardResourceHint.
 message StandardResourceHints {
   enum Enum {
     // Describes hardware accelerators that are desired to have in the execution environment.
+    // Payload: ASCII encoded string with the following format: "type:<type>;count:<n>;<options>" where type
+    // is an accelerator sku, count is the number of accelerators per worker, and options are
+    // related options flags.
     ACCELERATOR = 0 [(beam_urn) = "beam:resources:accelerator:v1"];
     // Describes desired minimal available RAM size in transform's execution environment.
     // SDKs should convert the size to bytes, but can allow users to specify human-friendly units (e.g. GiB).
+    // Payload: ASCII encoded string of the base 10 representation of an integer number of bytes.
     MIN_RAM_BYTES = 1 [(beam_urn) = "beam:resources:min_ram_bytes:v1"];
   }
 }