com.google.api.services.digitalassetlinks.v1

Class Digitalassetlinks.Assetlinks.Check

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.digitalassetlinks.v1.DigitalassetlinksRequest<CheckResponse>

com.google.api.services.digitalassetlinks.v1.Digitalassetlinks.Assetlinks.Check

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Digitalassetlinks.Assetlinks

public class Digitalassetlinks.Assetlinks.Check
extends DigitalassetlinksRequest<CheckResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Check() Determines whether the specified (directional) relationship exists between the specified source and target assets.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getRelation() Query string for the relation.
String	getSourceAndroidAppCertificateSha256Fingerprint() The uppercase SHA-265 fingerprint of the certificate.
String	getSourceAndroidAppPackageName() Android App assets are naturally identified by their Java package name.
String	getSourceWebSite() Web assets are identified by a URL that contains only the scheme, hostname and port parts.
String	getTargetAndroidAppCertificateSha256Fingerprint() The uppercase SHA-265 fingerprint of the certificate.
String	getTargetAndroidAppPackageName() Android App assets are naturally identified by their Java package name.
String	getTargetWebSite() Web assets are identified by a URL that contains only the scheme, hostname and port parts.
Digitalassetlinks.Assetlinks.Check	set(String parameterName, Object value)
Digitalassetlinks.Assetlinks.Check	set$Xgafv(String $Xgafv) V1 error format.
Digitalassetlinks.Assetlinks.Check	setAccessToken(String accessToken) OAuth access token.
Digitalassetlinks.Assetlinks.Check	setAlt(String alt) Data format for response.
Digitalassetlinks.Assetlinks.Check	setCallback(String callback) JSONP
Digitalassetlinks.Assetlinks.Check	setFields(String fields) Selector specifying which fields to include in a partial response.
Digitalassetlinks.Assetlinks.Check	setKey(String key) API key.
Digitalassetlinks.Assetlinks.Check	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Digitalassetlinks.Assetlinks.Check	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Digitalassetlinks.Assetlinks.Check	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Digitalassetlinks.Assetlinks.Check	setRelation(String relation) Query string for the relation.
Digitalassetlinks.Assetlinks.Check	setSourceAndroidAppCertificateSha256Fingerprint(String sourceAndroidAppCertificateSha256Fingerprint) The uppercase SHA-265 fingerprint of the certificate.
Digitalassetlinks.Assetlinks.Check	setSourceAndroidAppPackageName(String sourceAndroidAppPackageName) Android App assets are naturally identified by their Java package name.
Digitalassetlinks.Assetlinks.Check	setSourceWebSite(String sourceWebSite) Web assets are identified by a URL that contains only the scheme, hostname and port parts.
Digitalassetlinks.Assetlinks.Check	setTargetAndroidAppCertificateSha256Fingerprint(String targetAndroidAppCertificateSha256Fingerprint) The uppercase SHA-265 fingerprint of the certificate.
Digitalassetlinks.Assetlinks.Check	setTargetAndroidAppPackageName(String targetAndroidAppPackageName) Android App assets are naturally identified by their Java package name.
Digitalassetlinks.Assetlinks.Check	setTargetWebSite(String targetWebSite) Web assets are identified by a URL that contains only the scheme, hostname and port parts.
Digitalassetlinks.Assetlinks.Check	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Digitalassetlinks.Assetlinks.Check	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.digitalassetlinks.v1.DigitalassetlinksRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Check

protected Check()

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](https://github.com/google/digitalassetlinks/blob/master/well- known/details.md). Create a request for the method "assetlinks.check". This request holds the parameters needed by the the digitalassetlinks server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Digitalassetlinks.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<CheckResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<CheckResponse>

Throws:

IOException

set$Xgafv

public Digitalassetlinks.Assetlinks.Check set$Xgafv(String $Xgafv)

Description copied from class: DigitalassetlinksRequest

V1 error format.

Overrides:

set$Xgafv in class DigitalassetlinksRequest<CheckResponse>

setAccessToken

public Digitalassetlinks.Assetlinks.Check setAccessToken(String accessToken)

Description copied from class: DigitalassetlinksRequest

OAuth access token.

Overrides:

setAccessToken in class DigitalassetlinksRequest<CheckResponse>

setAlt

public Digitalassetlinks.Assetlinks.Check setAlt(String alt)

Description copied from class: DigitalassetlinksRequest

Data format for response.

Overrides:

setAlt in class DigitalassetlinksRequest<CheckResponse>

setCallback

public Digitalassetlinks.Assetlinks.Check setCallback(String callback)

Description copied from class: DigitalassetlinksRequest

JSONP

Overrides:

setCallback in class DigitalassetlinksRequest<CheckResponse>

setFields

public Digitalassetlinks.Assetlinks.Check setFields(String fields)

Description copied from class: DigitalassetlinksRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DigitalassetlinksRequest<CheckResponse>

setKey

public Digitalassetlinks.Assetlinks.Check setKey(String key)

Description copied from class: DigitalassetlinksRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class DigitalassetlinksRequest<CheckResponse>

setOauthToken

public Digitalassetlinks.Assetlinks.Check setOauthToken(String oauthToken)

Description copied from class: DigitalassetlinksRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DigitalassetlinksRequest<CheckResponse>

setPrettyPrint

public Digitalassetlinks.Assetlinks.Check setPrettyPrint(Boolean prettyPrint)

Description copied from class: DigitalassetlinksRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DigitalassetlinksRequest<CheckResponse>

setQuotaUser

public Digitalassetlinks.Assetlinks.Check setQuotaUser(String quotaUser)

Description copied from class: DigitalassetlinksRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class DigitalassetlinksRequest<CheckResponse>

setUploadType

public Digitalassetlinks.Assetlinks.Check setUploadType(String uploadType)

Description copied from class: DigitalassetlinksRequest

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

Overrides:

setUploadType in class DigitalassetlinksRequest<CheckResponse>

setUploadProtocol

public Digitalassetlinks.Assetlinks.Check setUploadProtocol(String uploadProtocol)

Description copied from class: DigitalassetlinksRequest

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

Overrides:

setUploadProtocol in class DigitalassetlinksRequest<CheckResponse>

getRelation

public String getRelation()

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 ](/digital-asset-links/v1/relation-strings) 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`.

setRelation

public Digitalassetlinks.Assetlinks.Check setRelation(String relation)

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](/digital-asset-links/v1/relation-strings) 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`.

getSourceAndroidAppCertificateSha256Fingerprint

public String getSourceAndroidAppCertificateSha256Fingerprint()

The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons).

setSourceAndroidAppCertificateSha256Fingerprint

public Digitalassetlinks.Assetlinks.Check setSourceAndroidAppCertificateSha256Fingerprint(String sourceAndroidAppCertificateSha256Fingerprint)

The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons).

getSourceAndroidAppPackageName

public String getSourceAndroidAppPackageName()

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

setSourceAndroidAppPackageName

public Digitalassetlinks.Assetlinks.Check setSourceAndroidAppPackageName(String sourceAndroidAppPackageName)

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

getSourceWebSite

public String getSourceWebSite()

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

setSourceWebSite

public Digitalassetlinks.Assetlinks.Check setSourceWebSite(String sourceWebSite)

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

getTargetAndroidAppCertificateSha256Fingerprint

public String getTargetAndroidAppCertificateSha256Fingerprint()

The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons).

setTargetAndroidAppCertificateSha256Fingerprint

public Digitalassetlinks.Assetlinks.Check setTargetAndroidAppCertificateSha256Fingerprint(String targetAndroidAppCertificateSha256Fingerprint)

The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons).

getTargetAndroidAppPackageName

public String getTargetAndroidAppPackageName()

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

setTargetAndroidAppPackageName

public Digitalassetlinks.Assetlinks.Check setTargetAndroidAppPackageName(String targetAndroidAppPackageName)

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

getTargetWebSite

public String getTargetWebSite()

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

setTargetWebSite

public Digitalassetlinks.Assetlinks.Check setTargetWebSite(String targetWebSite)

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

set

public Digitalassetlinks.Assetlinks.Check set(String parameterName,
                                              Object value)

Overrides:

set in class DigitalassetlinksRequest<CheckResponse>