Network.Google.Resource.PubSub.Projects.Subscriptions.Create

Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic.

See: Google Cloud Pub/Sub API Reference for pubsub.projects.subscriptions.create.

REST Resource

type ProjectsSubscriptionsCreateResource = "v1" :> (Capture "name" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Subscription :> Put '[JSON] Subscription))))))))))

A resource alias for pubsub.projects.subscriptions.create method which the ProjectsSubscriptionsCreate request conforms to.

Creating a Request

projectsSubscriptionsCreate

Arguments

:: Subscription

pscPayload

-> Text

pscName

-> ProjectsSubscriptionsCreate

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

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

• pscXgafv
• pscUploadProtocol
• pscPp
• pscAccessToken
• pscUploadType
• pscPayload
• pscBearerToken
• pscName
• pscCallback

data ProjectsSubscriptionsCreate

Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic.

See: projectsSubscriptionsCreate smart constructor.

Instances

Eq ProjectsSubscriptionsCreate

Methods

(==) :: ProjectsSubscriptionsCreate -> ProjectsSubscriptionsCreate -> Bool

(/=) :: ProjectsSubscriptionsCreate -> ProjectsSubscriptionsCreate -> Bool

Data ProjectsSubscriptionsCreate

Methods

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

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

toConstr :: ProjectsSubscriptionsCreate -> Constr

dataTypeOf :: ProjectsSubscriptionsCreate -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsSubscriptionsCreate)

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

gmapT :: (forall b. Data b => b -> b) -> ProjectsSubscriptionsCreate -> ProjectsSubscriptionsCreate

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

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

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

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

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

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

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

Show ProjectsSubscriptionsCreate

Methods

showsPrec :: Int -> ProjectsSubscriptionsCreate -> ShowS

show :: ProjectsSubscriptionsCreate -> String

showList :: [ProjectsSubscriptionsCreate] -> ShowS

Generic ProjectsSubscriptionsCreate

Associated Types

type Rep ProjectsSubscriptionsCreate :: * -> *

Methods

from :: ProjectsSubscriptionsCreate -> Rep ProjectsSubscriptionsCreate x

to :: Rep ProjectsSubscriptionsCreate x -> ProjectsSubscriptionsCreate

GoogleRequest ProjectsSubscriptionsCreate

Associated Types

type Rs ProjectsSubscriptionsCreate :: *

type Scopes ProjectsSubscriptionsCreate :: [Symbol]

Methods

requestClient :: ProjectsSubscriptionsCreate -> Client (Rs ProjectsSubscriptionsCreate)

type Rep ProjectsSubscriptionsCreate

type Rep ProjectsSubscriptionsCreate = D1 (MetaData "ProjectsSubscriptionsCreate" "Network.Google.Resource.PubSub.Projects.Subscriptions.Create" "gogol-pubsub-0.1.0-9Kd2KbQ3UV47Z2LlhG2rxf" False) (C1 (MetaCons "ProjectsSubscriptionsCreate'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pscXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pscUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_pscPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_pscAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pscUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pscPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Subscription))) ((:*:) (S1 (MetaSel (Just Symbol "_pscBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_pscName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_pscCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes ProjectsSubscriptionsCreate

type Scopes ProjectsSubscriptionsCreate = (:) Symbol "https://www.googleapis.com/auth/cloud-platform" ((:) Symbol "https://www.googleapis.com/auth/pubsub" ([] Symbol))

type Rs ProjectsSubscriptionsCreate

type Rs ProjectsSubscriptionsCreate = Subscription

Request Lenses

pscXgafv :: Lens' ProjectsSubscriptionsCreate (Maybe Text)

V1 error format.

pscUploadProtocol :: Lens' ProjectsSubscriptionsCreate (Maybe Text)

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

pscPp :: Lens' ProjectsSubscriptionsCreate Bool

Pretty-print response.

pscAccessToken :: Lens' ProjectsSubscriptionsCreate (Maybe Text)

OAuth access token.

pscUploadType :: Lens' ProjectsSubscriptionsCreate (Maybe Text)

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

pscPayload :: Lens' ProjectsSubscriptionsCreate Subscription

Multipart request metadata.

pscBearerToken :: Lens' ProjectsSubscriptionsCreate (Maybe Text)

OAuth bearer token.

pscName :: Lens' ProjectsSubscriptionsCreate Text

The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.

pscCallback :: Lens' ProjectsSubscriptionsCreate (Maybe Text)

JSONP