Struct google_digitalassetlinks1::StatementListCall

pub struct StatementListCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

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

A builder for the list method supported by a statement resource. It is not used directly, but through a StatementMethods instance.

Example

Instantiate a resource method builder

 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.statements().list()
             .source_web_site("et")
             .source_android_app_package_name("duo")
             .source_android_app_certificate_sha256_fingerprint("aliquyam")
             .relation("sea")
             .doit();

Methods

impl<'a, C, A> StatementListCall<'a, C, A> where     C: BorrowMut<Client>,     A: GetToken,

pub fn doit(self) -> Result<(Response, ListResponse)>

Perform the operation you have build so far.

pub fn source_web_site(self, new_value: &str) -> StatementListCall<'a, C, A>

Web assets are identified by a URL that contains only the scheme, hostname and port parts. The format is

http[s]://<hostname>[:<port>]

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

Sets the source.web.site query property to the given value.

pub fn source_android_app_package_name(     self,     new_value: &str ) -> StatementListCall<'a, C, A>

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

Sets the source.android app.package name query property to the given value.

pub fn source_android_app_certificate_sha256_fingerprint(     self,     new_value: &str ) -> StatementListCall<'a, C, A>

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).

Sets the source.android app.certificate.sha256 fingerprint query property to the given value.

pub fn relation(self, new_value: &str) -> StatementListCall<'a, C, A>

Use only associations that match the specified relation.

See the 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.

Sets the relation query property to the given value.

pub fn delegate(     self,     new_value: &'a mut Delegate ) -> StatementListCall<'a, C, A>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

pub fn param<T>(self, name: T, value: T) -> StatementListCall<'a, C, A> where     T: AsRef<str>,

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known paramters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• access_token (query-string) - OAuth access token.
• uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
• quotaUser (query-string) - 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.
• callback (query-string) - JSONP
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• key (query-string) - 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.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for response.
• $.xgafv (query-string) - V1 error format.

Trait Implementations

impl<'a, C, A> CallBuilder for StatementListCall<'a, C, A>