Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionRead

Contents

REST Resource
Creating a Request
Request Lenses

Description

Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning.

See: Cloud Spanner API Reference for spanner.projects.instances.databases.sessions.partitionRead.

Synopsis

type ProjectsInstancesDatabasesSessionsPartitionReadResource = "v1" :> (CaptureMode "session" "partitionRead" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] PartitionReadRequest :> Post '[JSON] PartitionResponse))))))))
projectsInstancesDatabasesSessionsPartitionRead :: PartitionReadRequest -> Text -> ProjectsInstancesDatabasesSessionsPartitionRead
data ProjectsInstancesDatabasesSessionsPartitionRead
pidsprXgafv :: Lens' ProjectsInstancesDatabasesSessionsPartitionRead (Maybe Xgafv)
pidsprUploadProtocol :: Lens' ProjectsInstancesDatabasesSessionsPartitionRead (Maybe Text)
pidsprAccessToken :: Lens' ProjectsInstancesDatabasesSessionsPartitionRead (Maybe Text)
pidsprUploadType :: Lens' ProjectsInstancesDatabasesSessionsPartitionRead (Maybe Text)
pidsprPayload :: Lens' ProjectsInstancesDatabasesSessionsPartitionRead PartitionReadRequest
pidsprSession :: Lens' ProjectsInstancesDatabasesSessionsPartitionRead Text
pidsprCallback :: Lens' ProjectsInstancesDatabasesSessionsPartitionRead (Maybe Text)

REST Resource

type ProjectsInstancesDatabasesSessionsPartitionReadResource = "v1" :> (CaptureMode "session" "partitionRead" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] PartitionReadRequest :> Post '[JSON] PartitionResponse)))))))) Source #

A resource alias for spanner.projects.instances.databases.sessions.partitionRead method which the ProjectsInstancesDatabasesSessionsPartitionRead request conforms to.

Creating a Request

projectsInstancesDatabasesSessionsPartitionRead Source #

Arguments

:: PartitionReadRequest	`pidsprPayload`
-> Text	`pidsprSession`
-> ProjectsInstancesDatabasesSessionsPartitionRead

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

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

data ProjectsInstancesDatabasesSessionsPartitionRead Source #

Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning.

See: projectsInstancesDatabasesSessionsPartitionRead smart constructor.

Instances

Eq ProjectsInstancesDatabasesSessionsPartitionRead Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionRead Methods (==) :: ProjectsInstancesDatabasesSessionsPartitionRead -> ProjectsInstancesDatabasesSessionsPartitionRead -> Bool # (/=) :: ProjectsInstancesDatabasesSessionsPartitionRead -> ProjectsInstancesDatabasesSessionsPartitionRead -> Bool #
Data ProjectsInstancesDatabasesSessionsPartitionRead Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionRead Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsInstancesDatabasesSessionsPartitionRead -> c ProjectsInstancesDatabasesSessionsPartitionRead # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsInstancesDatabasesSessionsPartitionRead # toConstr :: ProjectsInstancesDatabasesSessionsPartitionRead -> Constr # dataTypeOf :: ProjectsInstancesDatabasesSessionsPartitionRead -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsInstancesDatabasesSessionsPartitionRead) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsInstancesDatabasesSessionsPartitionRead) # gmapT :: (forall b. Data b => b -> b) -> ProjectsInstancesDatabasesSessionsPartitionRead -> ProjectsInstancesDatabasesSessionsPartitionRead # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsInstancesDatabasesSessionsPartitionRead -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsInstancesDatabasesSessionsPartitionRead -> r # gmapQ :: (forall d. Data d => d -> u) -> ProjectsInstancesDatabasesSessionsPartitionRead -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsInstancesDatabasesSessionsPartitionRead -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsInstancesDatabasesSessionsPartitionRead -> m ProjectsInstancesDatabasesSessionsPartitionRead # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsInstancesDatabasesSessionsPartitionRead -> m ProjectsInstancesDatabasesSessionsPartitionRead # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsInstancesDatabasesSessionsPartitionRead -> m ProjectsInstancesDatabasesSessionsPartitionRead #
Show ProjectsInstancesDatabasesSessionsPartitionRead Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionRead Methods showsPrec :: Int -> ProjectsInstancesDatabasesSessionsPartitionRead -> ShowS # show :: ProjectsInstancesDatabasesSessionsPartitionRead -> String # showList :: [ProjectsInstancesDatabasesSessionsPartitionRead] -> ShowS #
Generic ProjectsInstancesDatabasesSessionsPartitionRead Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionRead Associated Types type Rep ProjectsInstancesDatabasesSessionsPartitionRead :: Type -> Type # Methods from :: ProjectsInstancesDatabasesSessionsPartitionRead -> Rep ProjectsInstancesDatabasesSessionsPartitionRead x # to :: Rep ProjectsInstancesDatabasesSessionsPartitionRead x -> ProjectsInstancesDatabasesSessionsPartitionRead #
GoogleRequest ProjectsInstancesDatabasesSessionsPartitionRead Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionRead Associated Types type Rs ProjectsInstancesDatabasesSessionsPartitionRead :: Type # type Scopes ProjectsInstancesDatabasesSessionsPartitionRead :: [Symbol] # Methods requestClient :: ProjectsInstancesDatabasesSessionsPartitionRead -> GClient (Rs ProjectsInstancesDatabasesSessionsPartitionRead) #
type Rep ProjectsInstancesDatabasesSessionsPartitionRead Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionRead type Rep ProjectsInstancesDatabasesSessionsPartitionRead = D1 (MetaData "ProjectsInstancesDatabasesSessionsPartitionRead" "Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionRead" "gogol-spanner-0.4.0-Gx6Dlj0rchWGrfXCDHk4fo" False) (C1 (MetaCons "ProjectsInstancesDatabasesSessionsPartitionRead'" PrefixI True) ((S1 (MetaSel (Just "_pidsprXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_pidsprUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pidsprAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_pidsprUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pidsprPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PartitionReadRequest)) :: (S1 (MetaSel (Just "_pidsprSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_pidsprCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsInstancesDatabasesSessionsPartitionRead Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionRead type Scopes ProjectsInstancesDatabasesSessionsPartitionRead = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/spanner.data" ': ([] :: [Symbol]))
type Rs ProjectsInstancesDatabasesSessionsPartitionRead Source #
Instance details Defined in Network.Google.Resource.Spanner.Projects.Instances.Databases.Sessions.PartitionRead type Rs ProjectsInstancesDatabasesSessionsPartitionRead = PartitionResponse

Request Lenses

pidsprXgafv :: Lens' ProjectsInstancesDatabasesSessionsPartitionRead (Maybe Xgafv) Source #

V1 error format.

pidsprUploadProtocol :: Lens' ProjectsInstancesDatabasesSessionsPartitionRead (Maybe Text) Source #

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

pidsprAccessToken :: Lens' ProjectsInstancesDatabasesSessionsPartitionRead (Maybe Text) Source #

OAuth access token.

pidsprUploadType :: Lens' ProjectsInstancesDatabasesSessionsPartitionRead (Maybe Text) Source #

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

pidsprPayload :: Lens' ProjectsInstancesDatabasesSessionsPartitionRead PartitionReadRequest Source #

Multipart request metadata.

pidsprSession :: Lens' ProjectsInstancesDatabasesSessionsPartitionRead Text Source #

Required. The session used to create the partitions.

pidsprCallback :: Lens' ProjectsInstancesDatabasesSessionsPartitionRead (Maybe Text) Source #

JSONP