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

Creates a subscription to a given topic. See the resource name rules. 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, conforming to the resource name format. The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.

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

REST Resource

type ProjectsSubscriptionsCreateResource = "v1" :> (Capture "name" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" 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
• pscAccessToken
• pscUploadType
• pscPayload
• pscName
• pscCallback

data ProjectsSubscriptionsCreate

Creates a subscription to a given topic. See the resource name rules. 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, conforming to the resource name format. The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.

See: projectsSubscriptionsCreate smart constructor.

Instances

Eq ProjectsSubscriptionsCreate

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

Methods

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

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

Data ProjectsSubscriptionsCreate

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

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

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

Methods

showsPrec :: Int -> ProjectsSubscriptionsCreate -> ShowS

show :: ProjectsSubscriptionsCreate -> String

showList :: [ProjectsSubscriptionsCreate] -> ShowS

Generic ProjectsSubscriptionsCreate

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

Associated Types

type Rep ProjectsSubscriptionsCreate :: Type -> Type

Methods

from :: ProjectsSubscriptionsCreate -> Rep ProjectsSubscriptionsCreate x

to :: Rep ProjectsSubscriptionsCreate x -> ProjectsSubscriptionsCreate

GoogleRequest ProjectsSubscriptionsCreate

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

Associated Types

type Rs ProjectsSubscriptionsCreate :: Type

type Scopes ProjectsSubscriptionsCreate :: [Symbol]

Methods

requestClient :: ProjectsSubscriptionsCreate -> GClient (Rs ProjectsSubscriptionsCreate)

type Rep ProjectsSubscriptionsCreate

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

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

type Scopes ProjectsSubscriptionsCreate

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

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

type Rs ProjectsSubscriptionsCreate

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

type Rs ProjectsSubscriptionsCreate = Subscription

Request Lenses

pscXgafv :: Lens' ProjectsSubscriptionsCreate (Maybe Xgafv)

V1 error format.

pscUploadProtocol :: Lens' ProjectsSubscriptionsCreate (Maybe Text)

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

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.

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