docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/remotebuildexecution_v2.actions.html b/docs/dyn/remotebuildexecution_v2.actions.html
index 53723d3..1d6c82b 100644
--- a/docs/dyn/remotebuildexecution_v2.actions.html
+++ b/docs/dyn/remotebuildexecution_v2.actions.html
@@ -90,7 +90,7 @@
It then calls `Execute` with an `action_digest` referring to them. The
server will run the action and eventually return the result.
-The input `Action`'s fields MUST meet the various canonicalization
+The input `Action`'s fields MUST meet the various canonicalization
requirements specified in the documentation for their types so that it has
the same digest as other logically equivalent `Action`s. The server MAY
enforce the requirements and return errors if a non-canonical input is
@@ -142,7 +142,7 @@
send a PreconditionFailure error detail
where, for each requested blob not present in the CAS, there is a
`Violation` with a `type` of `MISSING` and a `subject` of
-`"blobs/{hash}/{size}"` indicating the digest of the missing blob.
+`"blobs/{hash}/{size}"` indicating the digest of the missing blob.
Args:
instanceName: string, The instance of the execution system to operate against. A server may
@@ -155,7 +155,32 @@
{ # A request message for
# Execution.Execute.
- "skipCacheLookup": True or False, # If true, the action will be executed even if its result is already
+ "executionPolicy": { # An `ExecutionPolicy` can be used to control the scheduling of the action. # An optional policy for execution of the action.
+ # The server will have a default policy if this is not provided.
+ "priority": 42, # The priority (relative importance) of this action. Generally, a lower value
+ # means that the action should be run sooner than actions having a greater
+ # priority value, but the interpretation of a given value is server-
+ # dependent. A priority of 0 means the *default* priority. Priorities may be
+ # positive or negative, and such actions should run later or sooner than
+ # actions having the default priority, respectively. The particular semantics
+ # of this field is up to the server. In particular, every server will have
+ # their own supported range of priorities, and will decide how these map into
+ # scheduling policy.
+ },
+ "resultsCachePolicy": { # A `ResultsCachePolicy` is used for fine-grained control over how action # An optional policy for the results of this execution in the remote cache.
+ # The server will have a default policy if this is not provided.
+ # This may be applied to both the ActionResult and the associated blobs.
+ # outputs are stored in the CAS and Action Cache.
+ "priority": 42, # The priority (relative importance) of this content in the overall cache.
+ # Generally, a lower value means a longer retention time or other advantage,
+ # but the interpretation of a given value is server-dependent. A priority of
+ # 0 means a *default* value, decided by the server.
+ #
+ # The particular semantics of this field is up to the server. In particular,
+ # every server will have their own supported range of priorities, and will
+ # decide how these map into retention/eviction policy.
+ },
+ "skipCacheLookup": True or False, # If true, the action will be executed even if its result is already
# present in the ActionCache.
# The execution is still allowed to be merged with other in-flight executions
# of the same action, however - semantically, the service MUST only guarantee
@@ -168,20 +193,7 @@
# cache entries that reference outputs no longer available or that are
# poisoned in any way.
# If false, the result may be served from the action cache.
- "resultsCachePolicy": { # A `ResultsCachePolicy` is used for fine-grained control over how action # An optional policy for the results of this execution in the remote cache.
- # The server will have a default policy if this is not provided.
- # This may be applied to both the ActionResult and the associated blobs.
- # outputs are stored in the CAS and Action Cache.
- "priority": 42, # The priority (relative importance) of this content in the overall cache.
- # Generally, a lower value means a longer retention time or other advantage,
- # but the interpretation of a given value is server-dependent. A priority of
- # 0 means a *default* value, decided by the server.
- #
- # The particular semantics of this field is up to the server. In particular,
- # every server will have their own supported range of priorities, and will
- # decide how these map into retention/eviction policy.
- },
- "actionDigest": { # A content digest. A digest for a given blob consists of the size of the blob # The digest of the Action to
+ "actionDigest": { # A content digest. A digest for a given blob consists of the size of the blob # The digest of the Action to
# execute.
# and its hash. The hash algorithm to use is defined by the server.
#
@@ -213,22 +225,10 @@
# Most protocol buffer implementations will always follow these rules when
# serializing, but care should be taken to avoid shortcuts. For instance,
# concatenating two messages to merge them may produce duplicate fields.
- "sizeBytes": "A String", # The size of the blob, in bytes.
- "hash": "A String", # The hash. In the case of SHA-256, it will always be a lowercase hex string
+ "sizeBytes": "A String", # The size of the blob, in bytes.
+ "hash": "A String", # The hash. In the case of SHA-256, it will always be a lowercase hex string
# exactly 64 characters long.
},
- "executionPolicy": { # An `ExecutionPolicy` can be used to control the scheduling of the action. # An optional policy for execution of the action.
- # The server will have a default policy if this is not provided.
- "priority": 42, # The priority (relative importance) of this action. Generally, a lower value
- # means that the action should be run sooner than actions having a greater
- # priority value, but the interpretation of a given value is server-
- # dependent. A priority of 0 means the *default* priority. Priorities may be
- # positive or negative, and such actions should run later or sooner than
- # actions having the default priority, respectively. The particular semantics
- # of this field is up to the server. In particular, every server will have
- # their own supported range of priorities, and will decide how these map into
- # scheduling policy.
- },
}
x__xgafv: string, V1 error format.
@@ -241,7 +241,7 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -249,38 +249,38 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
}</pre>
</div>