[][src]Crate google_firebasehosting1_beta1

This documentation was generated from Firebase Hosting crate version 1.0.14+20200709, where 20200709 is the exact revision of the firebasehosting:v1beta1 schema built by the mako code generator v1.0.14.

Everything else about the Firebase Hosting v1_beta1 API can be found at the official documentation site. The original source code is on github.

Features

Handle the following Resources with ease from the central hub ...

Not what you are looking for ? Find all other Google APIs in their Rust documentation index.

Structure of this Library

The API is structured into the following primary items:

  • Hub
    • a central object to maintain state and allow accessing all Activities
    • creates Method Builders which in turn allow access to individual Call Builders
  • Resources
    • primary types that you can apply Activities to
    • a collection of properties and Parts
    • Parts
      • a collection of properties
      • never directly used in Activities
  • Activities
    • operations to apply to Resources

All structures are marked with applicable traits to further categorize them and ease browsing.

Generally speaking, you can invoke Activities like this:

let r = hub.resource().activity(...).doit()

Or specifically ...

This example is not tested
let r = hub.sites().domains_create(...).doit()
let r = hub.projects().sites_domains_update(...).doit()
let r = hub.projects().sites_domains_create(...).doit()
let r = hub.sites().domains_update(...).doit()
let r = hub.sites().domains_get(...).doit()
let r = hub.projects().sites_domains_get(...).doit()

The resource() and activity(...) calls create builders. The second one dealing with Activities supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be specified right away (i.e. (...)), whereas all optional ones can be build up as desired. The doit() method performs the actual communication with the server and returns the respective result.

Usage

Setting up your Project

To use this library, you would put the following lines into your Cargo.toml file:

[dependencies]
google-firebasehosting1_beta1 = "*"
# This project intentionally uses an old version of Hyper. See
# https://github.com/Byron/google-apis-rs/issues/173 for more
# information.
hyper = "^0.10"
hyper-rustls = "^0.6"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^1.0"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_firebasehosting1_beta1 as firebasehosting1_beta1;
use firebasehosting1_beta1::Domain;
use firebasehosting1_beta1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use firebasehosting1_beta1::FirebaseHosting;
 
// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
                              <MemoryStorage as Default>::default(), None);
let mut hub = FirebaseHosting::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Domain::default();
 
// 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.sites().domains_create(req, "parent")
             .doit();
 
match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

Handling Errors

All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.

When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors.

Uploads and Downloads

If a method supports downloads, the response body, which is part of the Result, should be read by you to obtain the media. If such a method also supports a Response Result, it will return that by default. You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making this call: .param("alt", "media").

Methods supporting uploads can do so using up to 2 different protocols: simple and resumable. The distinctiveness of each is represented by customized doit(...) methods, which are then named upload(...) and upload_resumable(...) respectively.

Customization and Callbacks

You may alter the way an doit() method is called by providing a delegate to the Method Builder before making the final doit() call. Respective methods will be called to provide progress information, as well as determine whether the system should retry on failure.

The delegate trait is default-implemented, allowing you to customize it with minimal effort.

Optional Parts in Server-Requests

All structures provided by this library are made to be encodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response.

Builder Arguments

Using method builders, you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true.

Arguments will always be copied or cloned into the builder, to make them independent of their original life times.

Structs

ActingUser

Contains metadata about the user who performed an action, such as creating a release or finalizing a version.

CertDnsChallenge

Represents a DNS certificate challenge.

CertHttpChallenge

Represents an HTTP certificate challenge.

Chunk
CloudRunRewrite

A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a 404 error).

ContentRange

Implements the Content-Range header, for serialization only

DefaultDelegate

A delegate with a conservative default implementation, which is used if no other delegate is set.

Domain

The intended behavior and status information of a domain.

DomainProvisioning

The current certificate provisioning status information for a domain.

DomainRedirect

Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration.

DummyNetworkStream
Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

ErrorResponse

A utility to represent detailed errors we might see in case there are BadRequests. The latter happen if the sent parameters or request structures are unsound

FirebaseHosting

Central instance to access all FirebaseHosting related resource activities

Header

A header is an object that specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.

JsonServerError

A utility type which can decode a server response that indicates error

ListDomainsResponse

The response to listing Domains.

ListReleasesResponse

There is no detailed description.

ListVersionFilesResponse

There is no detailed description.

ListVersionsResponse

There is no detailed description.

MethodInfo

Contains information about an API request.

MultiPartReader

Provides a Read interface that converts multiple parts into the protocol identified by RFC2387. Note: This implementation is just as rich as it needs to be to perform uploads to google APIs, and might not be a fully-featured implementation.

Operation

This resource represents a long-running operation that is the result of a network API call.

PopulateVersionFilesRequest

The request to populate a Version's Files.

PopulateVersionFilesResponse

There is no detailed description.

PreviewConfig

Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version.

ProjectMethods

A builder providing access to all methods supported on project resources. It is not used directly, but through the FirebaseHosting hub.

ProjectOperationGetCall

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

ProjectSiteChannelReleaseCreateCall

Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).

ProjectSiteChannelReleaseListCall

Lists the releases that have been created on the specified site.

ProjectSiteDomainCreateCall

Creates a domain mapping on the specified site.

ProjectSiteDomainDeleteCall

Deletes the existing domain mapping on the specified site.

ProjectSiteDomainGetCall

Gets a domain mapping on the specified site.

ProjectSiteDomainListCall

Lists the domains for the specified site.

ProjectSiteDomainUpdateCall

Updates the specified domain mapping, creating the mapping as if it does not exist.

ProjectSiteGetConfigCall

Gets the Hosting metadata for a specific site.

ProjectSiteReleaseCreateCall

Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).

ProjectSiteReleaseListCall

Lists the releases that have been created on the specified site.

ProjectSiteUpdateConfigCall

Sets the Hosting metadata for a specific site.

ProjectSiteVersionCreateCall

Creates a new version for a site.

ProjectSiteVersionDeleteCall

Deletes the specified version.

ProjectSiteVersionFileListCall

Lists the remaining files to be uploaded for the specified version.

ProjectSiteVersionListCall

Lists the versions that have been created on the specified site. Will include filtering in the future.

ProjectSiteVersionPatchCall

Updates the specified metadata for a version. Note that this method will fail with FAILED_PRECONDITION in the event of an invalid state transition. The only valid transition for a version is currently from a CREATED status to a FINALIZED status. Use DeleteVersion to set the status of a version to DELETED.

ProjectSiteVersionPopulateFileCall

Adds content files to a version. Each file must be under 2 GB.

RangeResponseHeader
Redirect

A redirect object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.

Release

A Release is a particular collection of configurations and files that is set to be public at a particular time.

ResumableUploadHelper

A utility type to perform a resumable upload from start to end.

Rewrite

A rewrite object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.

ServerError
ServerMessage
ServingConfig

The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific priority order.

SiteChannelReleaseCreateCall

Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).

SiteChannelReleaseListCall

Lists the releases that have been created on the specified site.

SiteConfig

A SiteConfig contains metadata associated with a specific site that controls Firebase Hosting serving behavior

SiteDomainCreateCall

Creates a domain mapping on the specified site.

SiteDomainDeleteCall

Deletes the existing domain mapping on the specified site.

SiteDomainGetCall

Gets a domain mapping on the specified site.

SiteDomainListCall

Lists the domains for the specified site.

SiteDomainUpdateCall

Updates the specified domain mapping, creating the mapping as if it does not exist.

SiteGetConfigCall

Gets the Hosting metadata for a specific site.

SiteMethods

A builder providing access to all methods supported on site resources. It is not used directly, but through the FirebaseHosting hub.

SiteReleaseCreateCall

Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).

SiteReleaseListCall

Lists the releases that have been created on the specified site.

SiteUpdateConfigCall

Sets the Hosting metadata for a specific site.

SiteVersionCreateCall

Creates a new version for a site.

SiteVersionDeleteCall

Deletes the specified version.

SiteVersionFileListCall

Lists the remaining files to be uploaded for the specified version.

SiteVersionListCall

Lists the versions that have been created on the specified site. Will include filtering in the future.

SiteVersionPatchCall

Updates the specified metadata for a version. Note that this method will fail with FAILED_PRECONDITION in the event of an invalid state transition. The only valid transition for a version is currently from a CREATED status to a FINALIZED status. Use DeleteVersion to set the status of a version to DELETED.

SiteVersionPopulateFileCall

Adds content files to a version. Each file must be under 2 GB.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

Version

A Version is the collection of configuration and static files that determine how a site is displayed.

VersionFile

A static content file that is part of a version.

XUploadContentType

The X-Upload-Content-Type header.

Enums

Error
Scope

Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.

Traits

CallBuilder

Identifies types which represent builders for a particular resource method

Delegate

A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation.

Hub

Identifies the Hub. There is only one per library, this trait is supposed to make intended use more explicit. The hub allows to access all resource methods more easily.

MethodsBuilder

Identifies types for building methods of a particular resource type

NestedType

Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness.

Part

Identifies types which are only used as part of other types, which usually are carrying the Resource trait.

ReadSeek

A utility to specify reader types which provide seeking capabilities too

RequestValue

Identifies types which are used in API requests.

Resource

Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API.

ResponseResult

Identifies types which are used in API responses.

ToParts

A trait for all types that can convert themselves into a parts string

UnusedType

Identifies types which are not actually used by the API This might be a bug within the google API schema.

Functions

remove_json_null_values

Type Definitions

Result

A universal result type used as return for all calls.