Crate google_gameservices1

This documentation was generated from Game Services crate version 1.0.14+20200630, where 20200630 is the exact revision of the gameservices:v1 schema built by the mako code generator v1.0.14.

Everything else about the Game Services v1 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 ...

• projects
• locations game server deployments configs create, locations game server deployments configs delete, locations game server deployments configs get, locations game server deployments configs list, locations game server deployments create, locations game server deployments delete, locations game server deployments fetch deployment state, locations game server deployments get, locations game server deployments get iam policy, locations game server deployments get rollout, locations game server deployments list, locations game server deployments patch, locations game server deployments preview rollout, locations game server deployments set iam policy, locations game server deployments test iam permissions, locations game server deployments update rollout, locations get, locations list, locations operations cancel, locations operations delete, locations operations get, locations operations list, locations realms create, locations realms delete, locations realms game server clusters create, locations realms game server clusters delete, locations realms game server clusters get, locations realms game server clusters list, locations realms game server clusters patch, locations realms game server clusters preview create, locations realms game server clusters preview delete, locations realms game server clusters preview update, locations realms get, locations realms list, locations realms patch and locations realms preview update

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.projects().locations_game_server_deployments_configs_create(...).doit()
let r = hub.projects().locations_game_server_deployments_delete(...).doit()
let r = hub.projects().locations_realms_game_server_clusters_create(...).doit()
let r = hub.projects().locations_operations_get(...).doit()
let r = hub.projects().locations_game_server_deployments_update_rollout(...).doit()
let r = hub.projects().locations_realms_game_server_clusters_patch(...).doit()
let r = hub.projects().locations_realms_game_server_clusters_delete(...).doit()
let r = hub.projects().locations_realms_delete(...).doit()
let r = hub.projects().locations_game_server_deployments_patch(...).doit()
let r = hub.projects().locations_realms_patch(...).doit()
let r = hub.projects().locations_game_server_deployments_configs_delete(...).doit()
let r = hub.projects().locations_realms_create(...).doit()
let r = hub.projects().locations_game_server_deployments_create(...).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-gameservices1 = "*"
# 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_gameservices1 as gameservices1;
use gameservices1::GameServerConfig;
use gameservices1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use gameservices1::GameServices;
 
// 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 = GameServices::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 = GameServerConfig::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.projects().locations_game_server_deployments_configs_create(req, "parent")
             .config_id("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

AuditConfig	Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.
AuditLogConfig	Provides the configuration for logging a type of permissions. Example:
AuthorizationLoggingOptions	Authorization-related information used by Cloud Audit Logging.
Binding	Associates members with a role.
CancelOperationRequest	The request message for Operations.CancelOperation.
Chunk
CloudAuditOptions	Write a Cloud Audit log
Condition	A condition to be met.
ContentRange	Implements the Content-Range header, for serialization only
CounterOptions	Increment a streamz counter with the specified metric and field names.
CustomField	Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
DataAccessOptions	Write a Data Access (Gin) log
DefaultDelegate	A delegate with a conservative default implementation, which is used if no other delegate is set.
DeployedClusterState	The game server cluster changes made by the game server deployment.
DeployedFleet	Agones fleet specification and details.
DeployedFleetAutoscaler	Details about the Agones autoscaler.
DeployedFleetDetails	Details of the deployed Agones fleet.
DeployedFleetStatus	DeployedFleetStatus has details about the Agones fleets such as how many are running, how many allocated, and so on.
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
Expr	Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.
FetchDeploymentStateRequest	Request message for GameServerDeploymentsService.FetchDeploymentState.
FetchDeploymentStateResponse	Response message for GameServerDeploymentsService.FetchDeploymentState.
FleetConfig	Fleet configs for Agones.
GameServerCluster	A game server cluster resource.
GameServerClusterConnectionInfo	The game server cluster connection information.
GameServerConfig	A game server config resource.
GameServerConfigOverride	A game server config override.
GameServerDeployment	A game server deployment resource.
GameServerDeploymentRollout	The game server deployment rollout which represents the desired rollout state.
GameServices	Central instance to access all GameServices related resource activities
GkeClusterReference	A reference to a GKE cluster.
JsonServerError	A utility type which can decode a server response that indicates error
LabelSelector	The label selector, used to group labels on the resources.
ListGameServerClustersResponse	Response message for GameServerClustersService.ListGameServerClusters.
ListGameServerConfigsResponse	Response message for GameServerConfigsService.ListGameServerConfigs.
ListGameServerDeploymentsResponse	Response message for GameServerDeploymentsService.ListGameServerDeployments.
ListLocationsResponse	The response message for Locations.ListLocations.
ListOperationsResponse	The response message for Operations.ListOperations.
ListRealmsResponse	Response message for RealmsService.ListRealms.
Location	A resource that represents Google Cloud Platform location.
LogConfig	Specifies what kind of log the caller must write
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.
Policy	An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
PreviewCreateGameServerClusterResponse	Response message for GameServerClustersService.PreviewCreateGameServerCluster.
PreviewDeleteGameServerClusterResponse	Response message for GameServerClustersService.PreviewDeleteGameServerCluster.
PreviewGameServerDeploymentRolloutResponse	Response message for PreviewGameServerDeploymentRollout. This has details about the Agones fleet and autoscaler to be actuated.
PreviewRealmUpdateResponse	Response message for RealmsService.PreviewRealmUpdate.
PreviewUpdateGameServerClusterResponse	Response message for GameServerClustersService.PreviewUpdateGameServerCluster
ProjectLocationGameServerDeploymentConfigCreateCall	Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.
ProjectLocationGameServerDeploymentConfigDeleteCall	Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.
ProjectLocationGameServerDeploymentConfigGetCall	Gets details of a single game server config.
ProjectLocationGameServerDeploymentConfigListCall	Lists game server configs in a given project, location, and game server deployment.
ProjectLocationGameServerDeploymentCreateCall	Creates a new game server deployment in a given project and location.
ProjectLocationGameServerDeploymentDeleteCall	Deletes a single game server deployment.
ProjectLocationGameServerDeploymentFetchDeploymentStateCall	Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment.
ProjectLocationGameServerDeploymentGetCall	Gets details of a single game server deployment.
ProjectLocationGameServerDeploymentGetIamPolicyCall	Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectLocationGameServerDeploymentGetRolloutCall	Gets details a single game server deployment rollout.
ProjectLocationGameServerDeploymentListCall	Lists game server deployments in a given project and location.
ProjectLocationGameServerDeploymentPatchCall	Patches a game server deployment.
ProjectLocationGameServerDeploymentPreviewRolloutCall	Previews the game server deployment rollout. This API does not mutate the rollout resource.
ProjectLocationGameServerDeploymentSetIamPolicyCall	Sets the access control policy on the specified resource. Replaces any existing policy.
ProjectLocationGameServerDeploymentTestIamPermissionCall	Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
ProjectLocationGameServerDeploymentUpdateRolloutCall	Patches a single game server deployment rollout. The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error.
ProjectLocationGetCall	Gets information about a location.
ProjectLocationListCall	Lists information about the supported locations for this service.
ProjectLocationOperationCancelCall	Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
ProjectLocationOperationDeleteCall	Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectLocationOperationGetCall	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.
ProjectLocationOperationListCall	Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
ProjectLocationRealmCreateCall	Creates a new realm in a given project and location.
ProjectLocationRealmDeleteCall	Deletes a single realm.
ProjectLocationRealmGameServerClusterCreateCall	Creates a new game server cluster in a given project and location.
ProjectLocationRealmGameServerClusterDeleteCall	Deletes a single game server cluster.
ProjectLocationRealmGameServerClusterGetCall	Gets details of a single game server cluster.
ProjectLocationRealmGameServerClusterListCall	Lists game server clusters in a given project and location.
ProjectLocationRealmGameServerClusterPatchCall	Patches a single game server cluster.
ProjectLocationRealmGameServerClusterPreviewCreateCall	Previews creation of a new game server cluster in a given project and location.
ProjectLocationRealmGameServerClusterPreviewDeleteCall	Previews deletion of a single game server cluster.
ProjectLocationRealmGameServerClusterPreviewUpdateCall	Previews updating a GameServerCluster.
ProjectLocationRealmGetCall	Gets details of a single realm.
ProjectLocationRealmListCall	Lists realms in a given project and location.
ProjectLocationRealmPatchCall	Patches a single realm.
ProjectLocationRealmPreviewUpdateCall	Previews patches to a single realm.
ProjectMethods	A builder providing access to all methods supported on project resources. It is not used directly, but through the GameServices hub.
RangeResponseHeader
Realm	A realm resource.
RealmSelector	The realm selector, used to match realm resources.
ResumableUploadHelper	A utility type to perform a resumable upload from start to end.
Rule	A rule to be applied in a Policy.
ScalingConfig	Autoscaling config for an Agones fleet.
Schedule	The schedule of a recurring or one time event. The event's time span is specified by start_time and end_time. If the scheduled event's timespan is larger than the cron_spec + cron_job_duration, the event will be recurring. If only cron_spec + cron_job_duration are specified, the event is effective starting at the local time specified by cron_spec, and is recurring.
ServerError
ServerMessage
SetIamPolicyRequest	Request message for SetIamPolicy method.
SpecSource	Encapsulates Agones fleet spec and Agones autoscaler spec sources.
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.
TargetDetails	Details about the Agones resources.
TargetFleet	Target Agones fleet specification.
TargetFleetAutoscaler	Target Agones autoscaler policy reference.
TargetFleetDetails	Details of the target Agones fleet.
TargetState	Encapsulates the Target state.
TestIamPermissionsRequest	Request message for TestIamPermissions method.
TestIamPermissionsResponse	Response message for TestIamPermissions method.
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.