Crate google_prod_tt_sasportal1_alpha1

This documentation was generated from SAS Portal Testing crate version 1.0.14+20200708, where 20200708 is the exact revision of the prod_tt_sasportal:v1alpha1 schema built by the mako code generator v1.0.14.

Everything else about the SAS Portal Testing v1_alpha1 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 ...

• customers
• deployments create, deployments delete, deployments get, deployments list, deployments patch, devices bulk, devices create, devices create signed, devices delete, devices get, devices list, devices move, devices patch, devices sign device, devices update signed, get, list, nodes create, nodes delete, nodes deployments create, nodes deployments list, nodes get, nodes list, nodes move, nodes nodes create, nodes nodes list, nodes patch and patch
• deployments
• get
• installer
• generate secret and validate
• nodes
• deployments delete, deployments get, deployments list, deployments patch, devices bulk, devices create, devices create signed, devices delete, devices get, devices list, devices move, devices patch, devices sign device, devices update signed, get, nodes create, nodes delete, nodes deployments create, nodes deployments list, nodes devices bulk, nodes devices create, nodes devices create signed, nodes devices list, nodes get, nodes list, nodes move, nodes nodes create, nodes nodes list and nodes patch
• policies
• get, set and test

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

let r = hub.nodes().devices_create(...).doit()
let r = hub.nodes().devices_patch(...).doit()
let r = hub.nodes().devices_update_signed(...).doit()
let r = hub.nodes().nodes_devices_create(...).doit()
let r = hub.nodes().nodes_devices_create_signed(...).doit()
let r = hub.customers().devices_update_signed(...).doit()
let r = hub.customers().devices_get(...).doit()
let r = hub.customers().devices_patch(...).doit()
let r = hub.nodes().devices_get(...).doit()
let r = hub.customers().devices_create_signed(...).doit()
let r = hub.customers().devices_create(...).doit()
let r = hub.nodes().devices_create_signed(...).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-prod_tt_sasportal1_alpha1 = "*"
# 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_prod_tt_sasportal1_alpha1 as prod_tt_sasportal1_alpha1;
use prod_tt_sasportal1_alpha1::SasPortalDevice;
use prod_tt_sasportal1_alpha1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use prod_tt_sasportal1_alpha1::SASPortalTesting;
 
// 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 = SASPortalTesting::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 = SasPortalDevice::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.nodes().devices_patch(req, "name")
             .update_mask("sed")
             .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.

• PODs are handed by copy
• strings are passed as &str
• request values are moved

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

Structs

Chunk
ContentRange	Implements the Content-Range header, for serialization only
CustomerDeploymentCreateCall	Creates a new deployment.
CustomerDeploymentDeleteCall	Deletes a deployment.
CustomerDeploymentGetCall	Returns a requested deployment.
CustomerDeploymentListCall	Lists deployments.
CustomerDeploymentPatchCall	Updates an existing deployment.
CustomerDeviceBulkCall	Creates a device under a node or customer. Returned devices are unordered.
CustomerDeviceCreateCall	Creates a device under a node or customer.
CustomerDeviceCreateSignedCall	Creates a signed device under a node or customer.
CustomerDeviceDeleteCall	Deletes a device.
CustomerDeviceGetCall	Gets details about a device.
CustomerDeviceListCall	Lists devices under a node or customer.
CustomerDeviceMoveCall	Moves a device under another node or customer.
CustomerDevicePatchCall	Updates a device.
CustomerDeviceSignDeviceCall	Signs a device.
CustomerDeviceUpdateSignedCall	Updates a signed device.
CustomerGetCall	Returns a requested customer.
CustomerListCall	Returns a list of requested customers.
CustomerMethods	A builder providing access to all methods supported on customer resources. It is not used directly, but through the SASPortalTesting hub.
CustomerNodeCreateCall	Creates a new node.
CustomerNodeDeleteCall	Deletes a node.
CustomerNodeDeploymentCreateCall	Creates a new deployment.
CustomerNodeDeploymentListCall	Lists deployments.
CustomerNodeGetCall	Returns a requested node.
CustomerNodeListCall	Lists nodes.
CustomerNodeMoveCall	Moves a node under another node or customer.
CustomerNodeNodeCreateCall	Creates a new node.
CustomerNodeNodeListCall	Lists nodes.
CustomerNodePatchCall	Updates an existing node.
CustomerPatchCall	Updates an existing customer.
DefaultDelegate	A delegate with a conservative default implementation, which is used if no other delegate is set.
DeploymentGetCall	Returns a requested deployment.
DeploymentMethods	A builder providing access to all methods supported on deployment resources. It is not used directly, but through the SASPortalTesting hub.
DummyNetworkStream
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
InstallerGenerateSecretCall	Generates a secret to be used with the ValidateInstaller method
InstallerMethods	A builder providing access to all methods supported on installer resources. It is not used directly, but through the SASPortalTesting hub.
InstallerValidateCall	Validates the identity of a Certified Professional Installer (CPI).
JsonServerError	A utility type which can decode a server response that indicates error
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.
NodeDeploymentDeleteCall	Deletes a deployment.
NodeDeploymentGetCall	Returns a requested deployment.
NodeDeploymentListCall	Lists deployments.
NodeDeploymentPatchCall	Updates an existing deployment.
NodeDeviceBulkCall	Creates a device under a node or customer. Returned devices are unordered.
NodeDeviceCreateCall	Creates a device under a node or customer.
NodeDeviceCreateSignedCall	Creates a signed device under a node or customer.
NodeDeviceDeleteCall	Deletes a device.
NodeDeviceGetCall	Gets details about a device.
NodeDeviceListCall	Lists devices under a node or customer.
NodeDeviceMoveCall	Moves a device under another node or customer.
NodeDevicePatchCall	Updates a device.
NodeDeviceSignDeviceCall	Signs a device.
NodeDeviceUpdateSignedCall	Updates a signed device.
NodeGetCall	Returns a requested node.
NodeMethods	A builder providing access to all methods supported on node resources. It is not used directly, but through the SASPortalTesting hub.
NodeNodeCreateCall	Creates a new node.
NodeNodeDeleteCall	Deletes a node.
NodeNodeDeploymentCreateCall	Creates a new deployment.
NodeNodeDeploymentListCall	Lists deployments.
NodeNodeDeviceBulkCall	Creates a device under a node or customer. Returned devices are unordered.
NodeNodeDeviceCreateCall	Creates a device under a node or customer.
NodeNodeDeviceCreateSignedCall	Creates a signed device under a node or customer.
NodeNodeDeviceListCall	Lists devices under a node or customer.
NodeNodeGetCall	Returns a requested node.
NodeNodeListCall	Lists nodes.
NodeNodeMoveCall	Moves a node under another node or customer.
NodeNodeNodeCreateCall	Creates a new node.
NodeNodeNodeListCall	Lists nodes.
NodeNodePatchCall	Updates an existing node.
PolicyGetCall	Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
PolicyMethods	A builder providing access to all methods supported on policy resources. It is not used directly, but through the SASPortalTesting hub.
PolicySetCall	Sets the access control policy on the specified resource. Replaces any existing policy.
PolicyTestCall	Returns permissions that a caller has on the specified resource.
RangeResponseHeader
ResumableUploadHelper	A utility type to perform a resumable upload from start to end.
SASPortalTesting	Central instance to access all SASPortalTesting related resource activities
SasPortalAssignment	Associates members with a role.
SasPortalBulkCreateDeviceRequest	Request for BulkCreateDevice method.
SasPortalBulkCreateDeviceResponse	Response for BulkCreateDevice method.
SasPortalCreateSignedDeviceRequest	Request for CreateSignedDevice method.
SasPortalCustomer	Entity representing a SAS customer.
SasPortalDeployment	The Deployment.
SasPortalDevice	There is no detailed description.
SasPortalDeviceAirInterface	Information about the device's air interface.
SasPortalDeviceConfig	Information about the device configuration.
SasPortalDeviceGrant	Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device.
SasPortalDeviceMetadata	Device data overridable by both SAS Portal and registration requests.
SasPortalDeviceModel	Information about the model of the device.
SasPortalDpaMoveList	An entry in a DPA's move list.
SasPortalEmpty	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:
SasPortalFrequencyRange	Frequency range from low_frequency to high_frequency.
SasPortalGenerateSecretRequest	Request for GenerateSecret method] [spectrum.sas.portal.v1alpha1.DeviceManager.GenerateSecret].
SasPortalGenerateSecretResponse	Response for GenerateSecret method.
SasPortalGetPolicyRequest	Request message for GetPolicy method.
SasPortalInstallationParams	Information about the device installation parameters.
SasPortalListCustomersResponse	Response for ListCustomers.
SasPortalListDeploymentsResponse	Response for ListDeployments method.
SasPortalListDevicesResponse	Response for ListDevices method.
SasPortalListNodesResponse	Response for ListNodes method.
SasPortalMoveDeviceRequest	Request for MoveDevice method.
SasPortalMoveNodeRequest	Request for MoveNode method.
SasPortalNode	The Node.
SasPortalOperation	This resource represents a long-running operation that is the result of a network API call.
SasPortalPolicy	Defines an access control policy to the resources.
SasPortalSetPolicyRequest	Request message for SetPolicy method.
SasPortalSignDeviceRequest	Request for SignDevice method.
SasPortalStatus	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.
SasPortalTestPermissionsRequest	Request message for TestPermissions method.
SasPortalTestPermissionsResponse	Response message for TestPermissions method.
SasPortalUpdateSignedDeviceRequest	Request for UpdateSignedDevice method.
SasPortalValidateInstallerRequest	Request for ValidateInstaller method.
SasPortalValidateInstallerResponse	Response for ValidateInstaller method] [spectrum.sas.portal.v1alpha1.DeviceManager.ValidateInstaller].
ServerError
ServerMessage
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.