com.google.api.services.digitalassetlinks.v1

Class Digitalassetlinks.Statements.List

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<ListResponse>

com.google.api.services.digitalassetlinks.v1.Digitalassetlinks.Statements.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Digitalassetlinks.Statements

public class Digitalassetlinks.Statements.List
extends DigitalassetlinksRequest<ListResponse>

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	List() Retrieves a list of all statements from a given source that match the specified target and statement string.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getRelation() Use only associations that match the specified 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.
Digitalassetlinks.Statements.List	set(String parameterName, Object value)
Digitalassetlinks.Statements.List	set$Xgafv(String $Xgafv) V1 error format.
Digitalassetlinks.Statements.List	setAccessToken(String accessToken) OAuth access token.
Digitalassetlinks.Statements.List	setAlt(String alt) Data format for response.
Digitalassetlinks.Statements.List	setCallback(String callback) JSONP
Digitalassetlinks.Statements.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Digitalassetlinks.Statements.List	setKey(String key) API key.
Digitalassetlinks.Statements.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Digitalassetlinks.Statements.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Digitalassetlinks.Statements.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Digitalassetlinks.Statements.List	setRelation(String relation) Use only associations that match the specified relation.
Digitalassetlinks.Statements.List	setSourceAndroidAppCertificateSha256Fingerprint(String sourceAndroidAppCertificateSha256Fingerprint) The uppercase SHA-265 fingerprint of the certificate.
Digitalassetlinks.Statements.List	setSourceAndroidAppPackageName(String sourceAndroidAppPackageName) Android App assets are naturally identified by their Java package name.
Digitalassetlinks.Statements.List	setSourceWebSite(String sourceWebSite) Web assets are identified by a URL that contains only the scheme, hostname and port parts.
Digitalassetlinks.Statements.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Digitalassetlinks.Statements.List	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

List

protected List()

Retrieves a list of all statements from a given source that match the specified target and statement string. The API guarantees that all statements with secure source assets, such as HTTPS websites or Android apps, have been made in a secure way by the owner of those assets, as described in the [Digital Asset Links technical design specification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md). Specifically, you should consider that for insecure websites (that is, where the URL starts with `http://` instead of `https://`), this guarantee cannot be made. The `List` command is most useful in cases where the API client wants to know all the ways in which two assets are related, or enumerate all the relationships from a particular source asset. Example: a feature that helps users navigate to related items. When a mobile app is running on a device, the feature would make it easy to navigate to the corresponding web site or Google+ profile. Create a request for the method "statements.list". 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<ListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListResponse>

Throws:

IOException

set$Xgafv

public Digitalassetlinks.Statements.List set$Xgafv(String $Xgafv)

Description copied from class: DigitalassetlinksRequest

V1 error format.

Overrides:

set$Xgafv in class DigitalassetlinksRequest<ListResponse>

setAccessToken

public Digitalassetlinks.Statements.List setAccessToken(String accessToken)

Description copied from class: DigitalassetlinksRequest

OAuth access token.

Overrides:

setAccessToken in class DigitalassetlinksRequest<ListResponse>

setAlt

public Digitalassetlinks.Statements.List setAlt(String alt)

Description copied from class: DigitalassetlinksRequest

Data format for response.

Overrides:

setAlt in class DigitalassetlinksRequest<ListResponse>

setCallback

public Digitalassetlinks.Statements.List setCallback(String callback)

Description copied from class: DigitalassetlinksRequest

JSONP

Overrides:

setCallback in class DigitalassetlinksRequest<ListResponse>

setFields

public Digitalassetlinks.Statements.List setFields(String fields)

Description copied from class: DigitalassetlinksRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DigitalassetlinksRequest<ListResponse>

setKey

public Digitalassetlinks.Statements.List 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<ListResponse>

setOauthToken

public Digitalassetlinks.Statements.List setOauthToken(String oauthToken)

Description copied from class: DigitalassetlinksRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DigitalassetlinksRequest<ListResponse>

setPrettyPrint

public Digitalassetlinks.Statements.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DigitalassetlinksRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DigitalassetlinksRequest<ListResponse>

setQuotaUser

public Digitalassetlinks.Statements.List 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<ListResponse>

setUploadType

public Digitalassetlinks.Statements.List setUploadType(String uploadType)

Description copied from class: DigitalassetlinksRequest

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

Overrides:

setUploadType in class DigitalassetlinksRequest<ListResponse>

setUploadProtocol

public Digitalassetlinks.Statements.List setUploadProtocol(String uploadProtocol)

Description copied from class: DigitalassetlinksRequest

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

Overrides:

setUploadProtocol in class DigitalassetlinksRequest<ListResponse>

getRelation

public String getRelation()

Use only associations that match the specified relation. See the [`Statement`](#Statement) message for a detailed definition of relation strings. For a query to match a statement, one of the following must be true: * both the query's and the statement's relation strings match exactly, or * the query's relation string is empty or missing. 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.Statements.List setRelation(String relation)

Use only associations that match the specified relation. See the [`Statement`](#Statement) message for a detailed definition of relation strings. For a query to match a statement, one of the following must be true: * both the query's and the statement's relation strings match exactly, or * the query's relation string is empty or missing. 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.Statements.List 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.Statements.List 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.Statements.List 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

set

public Digitalassetlinks.Statements.List set(String parameterName,
                                             Object value)

Overrides:

set in class DigitalassetlinksRequest<ListResponse>