gogol-digitalassetlinks-0.4.0: Google Digital Asset Links 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.DigitalAssetLinks.Assetlinks.Check

Contents

Description

Determines whether the specified (directional) relationship exists between the specified source and target assets. The relation describes the intent of the link between the two assets as claimed by the source asset. An example for such relationships is the delegation of privileges or permissions. This command is most often used by infrastructure systems to check preconditions for an action. For example, a client may want to know if it is OK to send a web URL to a particular mobile app instead. The client can check for the relevant asset link from the website to the mobile app to decide if the operation should be allowed. A note about security: if you specify a secure asset as the source, such as an HTTPS website or an Android app, the API will ensure that any statements used to generate the response have been made in a secure way by the owner of that asset. Conversely, if the source asset is an insecure HTTP website (that is, the URL starts with `http://` instead of `https://`), the API cannot verify its statements securely, and it is not possible to ensure that the website's statements have not been altered by a third party. For more information, see the Digital Asset Links technical design specification.

See: Digital Asset Links API Reference for digitalassetlinks.assetlinks.check.

Synopsis

REST Resource

type AssetlinksCheckResource = "v1" :> ("assetlinks:check" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "source.androidApp.certificate.sha256Fingerprint" Text :> (QueryParam "source.androidApp.packageName" Text :> (QueryParam "target.web.site" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "target.androidApp.certificate.sha256Fingerprint" Text :> (QueryParam "uploadType" Text :> (QueryParam "relation" Text :> (QueryParam "target.androidApp.packageName" Text :> (QueryParam "source.web.site" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] CheckResponse)))))))))))))) Source #

A resource alias for digitalassetlinks.assetlinks.check method which the AssetlinksCheck request conforms to.

Creating a Request

data AssetlinksCheck Source #

Determines whether the specified (directional) relationship exists between the specified source and target assets. The relation describes the intent of the link between the two assets as claimed by the source asset. An example for such relationships is the delegation of privileges or permissions. This command is most often used by infrastructure systems to check preconditions for an action. For example, a client may want to know if it is OK to send a web URL to a particular mobile app instead. The client can check for the relevant asset link from the website to the mobile app to decide if the operation should be allowed. A note about security: if you specify a secure asset as the source, such as an HTTPS website or an Android app, the API will ensure that any statements used to generate the response have been made in a secure way by the owner of that asset. Conversely, if the source asset is an insecure HTTP website (that is, the URL starts with `http://` instead of `https://`), the API cannot verify its statements securely, and it is not possible to ensure that the website's statements have not been altered by a third party. For more information, see the Digital Asset Links technical design specification.

See: assetlinksCheck smart constructor.

Instances
Eq AssetlinksCheck Source # 
Instance details

Defined in Network.Google.Resource.DigitalAssetLinks.Assetlinks.Check

Data AssetlinksCheck Source # 
Instance details

Defined in Network.Google.Resource.DigitalAssetLinks.Assetlinks.Check

Methods

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

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

toConstr :: AssetlinksCheck -> Constr #

dataTypeOf :: AssetlinksCheck -> DataType #

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

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

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

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

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

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

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

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

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

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

Show AssetlinksCheck Source # 
Instance details

Defined in Network.Google.Resource.DigitalAssetLinks.Assetlinks.Check

Generic AssetlinksCheck Source # 
Instance details

Defined in Network.Google.Resource.DigitalAssetLinks.Assetlinks.Check

Associated Types

type Rep AssetlinksCheck :: Type -> Type #

GoogleRequest AssetlinksCheck Source # 
Instance details

Defined in Network.Google.Resource.DigitalAssetLinks.Assetlinks.Check

Associated Types

type Rs AssetlinksCheck :: Type #

type Scopes AssetlinksCheck :: [Symbol] #

type Rep AssetlinksCheck Source # 
Instance details

Defined in Network.Google.Resource.DigitalAssetLinks.Assetlinks.Check

type Rep AssetlinksCheck = D1 (MetaData "AssetlinksCheck" "Network.Google.Resource.DigitalAssetLinks.Assetlinks.Check" "gogol-digitalassetlinks-0.4.0-DCLwbKsqgDdAIRSvydokZj" False) (C1 (MetaCons "AssetlinksCheck'" PrefixI True) (((S1 (MetaSel (Just "_acXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_acSourceAndroidAppCertificateSha256Fingerprint") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_acSourceAndroidAppPackageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_acTargetWebSite") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_acUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_acAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_acTargetAndroidAppCertificateSha256Fingerprint") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_acUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_acRelation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_acTargetAndroidAppPackageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_acSourceWebSite") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_acCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes AssetlinksCheck Source # 
Instance details

Defined in Network.Google.Resource.DigitalAssetLinks.Assetlinks.Check

type Scopes AssetlinksCheck = ([] :: [Symbol])
type Rs AssetlinksCheck Source # 
Instance details

Defined in Network.Google.Resource.DigitalAssetLinks.Assetlinks.Check

Request Lenses

acSourceAndroidAppPackageName :: Lens' AssetlinksCheck (Maybe Text) Source #

Android App assets are naturally identified by their Java package name. For example, the Google Maps app uses the package name `com.google.android.apps.maps`. REQUIRED

acTargetWebSite :: Lens' AssetlinksCheck (Maybe Text) Source #

Web assets are identified by a URL that contains only the scheme, hostname and port parts. The format is http[s]://[:] Hostnames must be fully qualified: they must end in a single period ("`.`"). Only the schemes "http" and "https" are currently allowed. Port numbers are given as a decimal number, and they must be omitted if the standard port numbers are used: 80 for http and 443 for https. We call this limited URL the "site". All URLs that share the same scheme, hostname and port are considered to be a part of the site and thus belong to the web asset. Example: the asset with the site `https://www.google.com` contains all these URLs: * `https://www.google.com/` * `https://www.google.com:443/` * `https://www.google.com/foo` * `https://www.google.com/foo?bar` * `https://www.google.com/foo#bar` * `https://user'password:www.google.com/` But it does not contain these URLs: * `http://www.google.com/` (wrong scheme) * `https://google.com/` (hostname does not match) * `https://www.google.com:444/` (port does not match) REQUIRED

acUploadProtocol :: Lens' AssetlinksCheck (Maybe Text) Source #

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

acUploadType :: Lens' AssetlinksCheck (Maybe Text) Source #

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

acRelation :: Lens' AssetlinksCheck (Maybe Text) Source #

Query string for the relation. We identify relations with strings of the format `/`, where `` must be one of a set of pre-defined purpose categories, and `` is a free-form lowercase alphanumeric string that describes the specific use case of the statement. Refer to our API documentation for the current list of supported relations. For a query to match an asset link, both the query's and the asset link's relation strings must match exactly. Example: A query with relation `delegate_permission/common.handle_all_urls` matches an asset link with relation `delegate_permission/common.handle_all_urls`.

acTargetAndroidAppPackageName :: Lens' AssetlinksCheck (Maybe Text) Source #

Android App assets are naturally identified by their Java package name. For example, the Google Maps app uses the package name `com.google.android.apps.maps`. REQUIRED

acSourceWebSite :: Lens' AssetlinksCheck (Maybe Text) Source #

Web assets are identified by a URL that contains only the scheme, hostname and port parts. The format is http[s]://[:] Hostnames must be fully qualified: they must end in a single period ("`.`"). Only the schemes "http" and "https" are currently allowed. Port numbers are given as a decimal number, and they must be omitted if the standard port numbers are used: 80 for http and 443 for https. We call this limited URL the "site". All URLs that share the same scheme, hostname and port are considered to be a part of the site and thus belong to the web asset. Example: the asset with the site `https://www.google.com` contains all these URLs: * `https://www.google.com/` * `https://www.google.com:443/` * `https://www.google.com/foo` * `https://www.google.com/foo?bar` * `https://www.google.com/foo#bar` * `https://user'password:www.google.com/` But it does not contain these URLs: * `http://www.google.com/` (wrong scheme) * `https://google.com/` (hostname does not match) * `https://www.google.com:444/` (port does not match) REQUIRED