Struct google_remotebuildexecution2::api::BlobGetTreeCall
source · pub struct BlobGetTreeCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
Fetch the entire directory tree rooted at a node. This request must be targeted at a Directory stored in the ContentAddressableStorage (CAS). The server will enumerate the Directory tree recursively and return every node descended from the root. The GetTreeRequest.page_token parameter can be used to skip ahead in the stream (e.g. when retrying a partially completed and aborted request), by setting it to a value taken from GetTreeResponse.next_page_token of the last successfully processed GetTreeResponse). The exact traversal order is unspecified and, unless retrieving subsequent pages from an earlier request, is not guaranteed to be stable across multiple invocations of GetTree. If part of the tree is missing from the CAS, the server will return the portion present and omit the rest. Errors: * NOT_FOUND: The requested tree root is not present in the CAS.
A builder for the getTree method supported by a blob resource.
It is not used directly, but through a BlobMethods instance.
§Example
Instantiate a resource method builder
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.blobs().get_tree("instanceName", "hash", -61)
.page_token("Stet")
.page_size(-13)
.doit().await;Implementations§
source§impl<'a, S> BlobGetTreeCall<'a, S>
impl<'a, S> BlobGetTreeCall<'a, S>
sourcepub async fn doit(
self
) -> Result<(Response<Body>, BuildBazelRemoteExecutionV2GetTreeResponse)>
pub async fn doit( self ) -> Result<(Response<Body>, BuildBazelRemoteExecutionV2GetTreeResponse)>
Perform the operation you have build so far.
sourcepub fn instance_name(self, new_value: &str) -> BlobGetTreeCall<'a, S>
pub fn instance_name(self, new_value: &str) -> BlobGetTreeCall<'a, S>
The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
Sets the instance name path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn hash(self, new_value: &str) -> BlobGetTreeCall<'a, S>
pub fn hash(self, new_value: &str) -> BlobGetTreeCall<'a, S>
The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.
Sets the hash path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn size_bytes(self, new_value: i64) -> BlobGetTreeCall<'a, S>
pub fn size_bytes(self, new_value: i64) -> BlobGetTreeCall<'a, S>
The size of the blob, in bytes.
Sets the size bytes path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn page_token(self, new_value: &str) -> BlobGetTreeCall<'a, S>
pub fn page_token(self, new_value: &str) -> BlobGetTreeCall<'a, S>
A page token, which must be a value received in a previous GetTreeResponse. If present, the server will use that token as an offset, returning only that page and the ones that succeed it.
Sets the page token query property to the given value.
sourcepub fn page_size(self, new_value: i32) -> BlobGetTreeCall<'a, S>
pub fn page_size(self, new_value: i32) -> BlobGetTreeCall<'a, S>
A maximum page size to request. If present, the server will request no more than this many items. Regardless of whether a page size is specified, the server may place its own limit on the number of items to be returned and require the client to retrieve more items using a subsequent request.
Sets the page size query property to the given value.
sourcepub fn delegate(self, new_value: &'a mut dyn Delegate) -> BlobGetTreeCall<'a, S>
pub fn delegate(self, new_value: &'a mut dyn Delegate) -> BlobGetTreeCall<'a, S>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
sourcepub fn param<T>(self, name: T, value: T) -> BlobGetTreeCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> BlobGetTreeCall<'a, S>
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
§Additional Parameters
- $.xgafv (query-string) - V1 error format.
- access_token (query-string) - OAuth access token.
- alt (query-string) - Data format for response.
- callback (query-string) - JSONP
- fields (query-string) - Selector specifying which fields to include in a partial response.
- key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
- upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
sourcepub fn add_scope<St>(self, scope: St) -> BlobGetTreeCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> BlobGetTreeCall<'a, S>
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead of the default Scope variant
Scope::CloudPlatform.
The scope will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
sourcepub fn add_scopes<I, St>(self, scopes: I) -> BlobGetTreeCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> BlobGetTreeCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> BlobGetTreeCall<'a, S>
pub fn clear_scopes(self) -> BlobGetTreeCall<'a, S>
Removes all scopes, and no default scope will be used either.
In this case, you have to specify your API-key using the key parameter (see Self::param()
for details).