Network.Google.Resource.CloudSearch.Media.Upload

Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be inlined during index requests. To index large content: 1. Call upload to begin a session and get the item reference. 1. Upload the content using the item reference's resource name. 1. Call index with the item reference as the content. For additional information, see Create a content connector using the REST API.

See: Cloud Search API Reference for cloudsearch.media.upload.

REST Resource

type MediaUploadResource = ("v1" :> ("media" :> (Capture "resourceName" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Media :> Post '[JSON] Media)))))))))) :<|> ("upload" :> ("v1" :> ("media" :> (Capture "resourceName" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (QueryParam "uploadType" Multipart :> (MultipartRelated '[JSON] Media :> Post '[JSON] Media))))))))))))

A resource alias for cloudsearch.media.upload method which the MediaUpload' request conforms to.

Creating a Request

mediaUpload

Arguments

:: Text

muResourceName

-> Media

muPayload

-> MediaUpload'

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

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

• muXgafv
• muUploadProtocol
• muResourceName
• muAccessToken
• muUploadType
• muPayload
• muCallback

data MediaUpload'

Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be inlined during index requests. To index large content: 1. Call upload to begin a session and get the item reference. 1. Upload the content using the item reference's resource name. 1. Call index with the item reference as the content. For additional information, see Create a content connector using the REST API.

See: mediaUpload smart constructor.

Instances

Eq MediaUpload'

Defined in Network.Google.Resource.CloudSearch.Media.Upload

Methods

(==) :: MediaUpload' -> MediaUpload' -> Bool

(/=) :: MediaUpload' -> MediaUpload' -> Bool

Data MediaUpload'

Defined in Network.Google.Resource.CloudSearch.Media.Upload

Methods

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

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

toConstr :: MediaUpload' -> Constr

dataTypeOf :: MediaUpload' -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MediaUpload')

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

gmapT :: (forall b. Data b => b -> b) -> MediaUpload' -> MediaUpload'

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

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

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

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

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

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

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

Show MediaUpload'

Defined in Network.Google.Resource.CloudSearch.Media.Upload

Methods

showsPrec :: Int -> MediaUpload' -> ShowS

show :: MediaUpload' -> String

showList :: [MediaUpload'] -> ShowS

Generic MediaUpload'

Defined in Network.Google.Resource.CloudSearch.Media.Upload

Associated Types

type Rep MediaUpload' :: Type -> Type

Methods

from :: MediaUpload' -> Rep MediaUpload' x

to :: Rep MediaUpload' x -> MediaUpload'

GoogleRequest MediaUpload'

Defined in Network.Google.Resource.CloudSearch.Media.Upload

Associated Types

type Rs MediaUpload' :: Type

type Scopes MediaUpload' :: [Symbol]

Methods

requestClient :: MediaUpload' -> GClient (Rs MediaUpload')

GoogleRequest (MediaUpload MediaUpload')

Defined in Network.Google.Resource.CloudSearch.Media.Upload

Associated Types

type Rs (MediaUpload MediaUpload') :: Type

type Scopes (MediaUpload MediaUpload') :: [Symbol]

Methods

requestClient :: MediaUpload MediaUpload' -> GClient (Rs (MediaUpload MediaUpload'))

type Rep MediaUpload'

Defined in Network.Google.Resource.CloudSearch.Media.Upload

type Rep MediaUpload' = D1 (MetaData "MediaUpload'" "Network.Google.Resource.CloudSearch.Media.Upload" "gogol-cloudsearch-0.4.0-5yB3RjcJJrULTqYmbhTTen" False) (C1 (MetaCons "MediaUpload''" PrefixI True) ((S1 (MetaSel (Just "_muXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_muUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_muResourceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_muAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_muUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_muPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Media) :*: S1 (MetaSel (Just "_muCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes MediaUpload'

Defined in Network.Google.Resource.CloudSearch.Media.Upload

type Scopes MediaUpload' = "https://www.googleapis.com/auth/cloud_search" ': ("https://www.googleapis.com/auth/cloud_search.indexing" ': ([] :: [Symbol]))

type Rs MediaUpload'

Defined in Network.Google.Resource.CloudSearch.Media.Upload

type Rs MediaUpload' = Media

type Scopes (MediaUpload MediaUpload')

Defined in Network.Google.Resource.CloudSearch.Media.Upload

type Scopes (MediaUpload MediaUpload') = Scopes MediaUpload'

type Rs (MediaUpload MediaUpload')

Defined in Network.Google.Resource.CloudSearch.Media.Upload

type Rs (MediaUpload MediaUpload') = Media

Request Lenses

muXgafv :: Lens' MediaUpload' (Maybe Xgafv)

V1 error format.

muUploadProtocol :: Lens' MediaUpload' (Maybe Text)

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

muResourceName :: Lens' MediaUpload' Text

Name of the media that is being downloaded. See ReadRequest.resource_name.

muAccessToken :: Lens' MediaUpload' (Maybe Text)

OAuth access token.

muUploadType :: Lens' MediaUpload' (Maybe Text)

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

muPayload :: Lens' MediaUpload' Media

Multipart request metadata.

muCallback :: Lens' MediaUpload' (Maybe Text)

JSONP