gogol-remotebuildexecution-0.4.0: Google Remote Build Execution SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.RemoteBuildExecution.Blobs.GetTree

Contents

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. * `NOT_FOUND`: The requested tree root is not present in the CAS.

See: Remote Build Execution API Reference for remotebuildexecution.blobs.getTree.

Synopsis

REST Resource

type BlobsGetTreeResource = "v2" :> (Capture "instanceName" Text :> ("blobs" :> (Capture "hash" Text :> (CaptureMode "sizeBytes" "getTree" (Textual Int64) :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] BuildBazelRemoteExecutionV2GetTreeResponse)))))))))))) Source #

A resource alias for remotebuildexecution.blobs.getTree method which the BlobsGetTree request conforms to.

Creating a Request

blobsGetTree Source #

Creates a value of BlobsGetTree with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data BlobsGetTree Source #

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. * `NOT_FOUND`: The requested tree root is not present in the CAS.

See: blobsGetTree smart constructor.

Instances
Eq BlobsGetTree Source # 
Instance details

Defined in Network.Google.Resource.RemoteBuildExecution.Blobs.GetTree

Data BlobsGetTree Source # 
Instance details

Defined in Network.Google.Resource.RemoteBuildExecution.Blobs.GetTree

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BlobsGetTree -> c BlobsGetTree #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BlobsGetTree #

toConstr :: BlobsGetTree -> Constr #

dataTypeOf :: BlobsGetTree -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BlobsGetTree) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BlobsGetTree) #

gmapT :: (forall b. Data b => b -> b) -> BlobsGetTree -> BlobsGetTree #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BlobsGetTree -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BlobsGetTree -> r #

gmapQ :: (forall d. Data d => d -> u) -> BlobsGetTree -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BlobsGetTree -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BlobsGetTree -> m BlobsGetTree #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BlobsGetTree -> m BlobsGetTree #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BlobsGetTree -> m BlobsGetTree #

Show BlobsGetTree Source # 
Instance details

Defined in Network.Google.Resource.RemoteBuildExecution.Blobs.GetTree

Generic BlobsGetTree Source # 
Instance details

Defined in Network.Google.Resource.RemoteBuildExecution.Blobs.GetTree

Associated Types

type Rep BlobsGetTree :: Type -> Type #

GoogleRequest BlobsGetTree Source # 
Instance details

Defined in Network.Google.Resource.RemoteBuildExecution.Blobs.GetTree

Associated Types

type Rs BlobsGetTree :: Type #

type Scopes BlobsGetTree :: [Symbol] #

type Rep BlobsGetTree Source # 
Instance details

Defined in Network.Google.Resource.RemoteBuildExecution.Blobs.GetTree

type Scopes BlobsGetTree Source # 
Instance details

Defined in Network.Google.Resource.RemoteBuildExecution.Blobs.GetTree

type Scopes BlobsGetTree = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs BlobsGetTree Source # 
Instance details

Defined in Network.Google.Resource.RemoteBuildExecution.Blobs.GetTree

Request Lenses

bgtSizeBytes :: Lens' BlobsGetTree Int64 Source #

The size of the blob, in bytes.

bgtHash :: Lens' BlobsGetTree Text Source #

The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.

bgtUploadProtocol :: Lens' BlobsGetTree (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

bgtUploadType :: Lens' BlobsGetTree (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

bgtPageToken :: Lens' BlobsGetTree (Maybe Text) Source #

A page token, which must be a value received in a previous GetTreeResponse. If present, the server will use it to return the following page of results.

bgtPageSize :: Lens' BlobsGetTree (Maybe Int32) Source #

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.

bgtInstanceName :: Lens' BlobsGetTree Text Source #

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.