Struct google_redis1::api::ProjectMethods

pub struct ProjectMethods<'a, S>
where
    S: 'a,
{ /* private fields */ }

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

Example

Instantiate a resource builder

extern crate hyper;
extern crate hyper_rustls;
extern crate google_redis1 as redis1;
 
use std::default::Default;
use redis1::{CloudRedis, oauth2, hyper, hyper_rustls, chrono, FieldMask};
 
let secret: oauth2::ApplicationSecret = Default::default();
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = CloudRedis::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `locations_clusters_create(...)`, `locations_clusters_delete(...)`, `locations_clusters_get(...)`, `locations_clusters_get_certificate_authority(...)`, `locations_clusters_list(...)`, `locations_clusters_patch(...)`, `locations_get(...)`, `locations_instances_create(...)`, `locations_instances_delete(...)`, `locations_instances_export(...)`, `locations_instances_failover(...)`, `locations_instances_get(...)`, `locations_instances_get_auth_string(...)`, `locations_instances_import(...)`, `locations_instances_list(...)`, `locations_instances_patch(...)`, `locations_instances_reschedule_maintenance(...)`, `locations_instances_upgrade(...)`, `locations_list(...)`, `locations_operations_cancel(...)`, `locations_operations_delete(...)`, `locations_operations_get(...)` and `locations_operations_list(...)`
// to build up your call.
let rb = hub.projects();

Implementations

impl<'a, S> ProjectMethods<'a, S>

pub fn locations_clusters_create( &self, request: Cluster, parent: &str ) -> ProjectLocationClusterCreateCall<'a, S>

Create a builder to help you perform the following task:

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Arguments

• request - No description provided.
• parent - Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

pub fn locations_clusters_delete( &self, name: &str ) -> ProjectLocationClusterDeleteCall<'a, S>

Create a builder to help you perform the following task:

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Arguments

• name - Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

pub fn locations_clusters_get( &self, name: &str ) -> ProjectLocationClusterGetCall<'a, S>

Create a builder to help you perform the following task:

Gets the details of a specific Redis cluster.

Arguments

• name - Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

pub fn locations_clusters_get_certificate_authority( &self, name: &str ) -> ProjectLocationClusterGetCertificateAuthorityCall<'a, S>

Create a builder to help you perform the following task:

Gets the details of certificate authority information for Redis cluster.

Arguments

• name - Required. Redis cluster certificate authority resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority where location_id refers to a GCP region.

pub fn locations_clusters_list( &self, parent: &str ) -> ProjectLocationClusterListCall<'a, S>

Create a builder to help you perform the following task:

Lists all Redis clusters owned by a project in either the specified location (region) or all locations. The location should have the following format: * projects/{project_id}/locations/{location_id} If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

Arguments

• parent - Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

pub fn locations_clusters_patch( &self, request: Cluster, name: &str ) -> ProjectLocationClusterPatchCall<'a, S>

Create a builder to help you perform the following task:

Updates the metadata and configuration of a specific Redis cluster. Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Arguments

• request - No description provided.
• name - Required. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}

pub fn locations_instances_create( &self, request: Instance, parent: &str ) -> ProjectLocationInstanceCreateCall<'a, S>

Create a builder to help you perform the following task:

Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project’s default network. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Arguments

• request - No description provided.
• parent - Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

pub fn locations_instances_delete( &self, name: &str ) -> ProjectLocationInstanceDeleteCall<'a, S>

Create a builder to help you perform the following task:

Deletes a specific Redis instance. Instance stops serving and data is deleted.

Arguments

• name - Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

pub fn locations_instances_export( &self, request: ExportInstanceRequest, name: &str ) -> ProjectLocationInstanceExportCall<'a, S>

Create a builder to help you perform the following task:

Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Arguments

• request - No description provided.
• name - Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

pub fn locations_instances_failover( &self, request: FailoverInstanceRequest, name: &str ) -> ProjectLocationInstanceFailoverCall<'a, S>

Create a builder to help you perform the following task:

Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

Arguments

• request - No description provided.
• name - Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

pub fn locations_instances_get( &self, name: &str ) -> ProjectLocationInstanceGetCall<'a, S>

Create a builder to help you perform the following task:

Gets the details of a specific Redis instance.

Arguments

• name - Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

pub fn locations_instances_get_auth_string( &self, name: &str ) -> ProjectLocationInstanceGetAuthStringCall<'a, S>

Create a builder to help you perform the following task:

Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.

Arguments

• name - Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

pub fn locations_instances_import( &self, request: ImportInstanceRequest, name: &str ) -> ProjectLocationInstanceImportCall<'a, S>

Create a builder to help you perform the following task:

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Arguments

• request - No description provided.
• name - Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

pub fn locations_instances_list( &self, parent: &str ) -> ProjectLocationInstanceListCall<'a, S>

Create a builder to help you perform the following task:

Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * projects/{project_id}/locations/{location_id} If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

Arguments

• parent - Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

pub fn locations_instances_patch( &self, request: Instance, name: &str ) -> ProjectLocationInstancePatchCall<'a, S>

Create a builder to help you perform the following task:

Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Arguments

• request - No description provided.
• name - Required. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.

pub fn locations_instances_reschedule_maintenance( &self, request: RescheduleMaintenanceRequest, name: &str ) -> ProjectLocationInstanceRescheduleMaintenanceCall<'a, S>

Create a builder to help you perform the following task:

Reschedule maintenance for a given instance in a given project and location.

Arguments

• request - No description provided.
• name - Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

pub fn locations_instances_upgrade( &self, request: UpgradeInstanceRequest, name: &str ) -> ProjectLocationInstanceUpgradeCall<'a, S>

Create a builder to help you perform the following task:

Upgrades Redis instance to the newer Redis version specified in the request.

Arguments

• request - No description provided.
• name - Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

pub fn locations_operations_cancel( &self, name: &str ) -> ProjectLocationOperationCancelCall<'a, S>

Create a builder to help you perform the following task:

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.

Arguments

• name - The name of the operation resource to be cancelled.

pub fn locations_operations_delete( &self, name: &str ) -> ProjectLocationOperationDeleteCall<'a, S>

Create a builder to help you perform the following task:

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.

Arguments

• name - The name of the operation resource to be deleted.

pub fn locations_operations_get( &self, name: &str ) -> ProjectLocationOperationGetCall<'a, S>

Create a builder to help you perform the following task:

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.

Arguments

• name - The name of the operation resource.

pub fn locations_operations_list( &self, name: &str ) -> ProjectLocationOperationListCall<'a, S>

Create a builder to help you perform the following task:

Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.

Arguments

• name - The name of the operation’s parent resource.

pub fn locations_get(&self, name: &str) -> ProjectLocationGetCall<'a, S>

Create a builder to help you perform the following task:

Gets information about a location.

Arguments

• name - Resource name for the location.

pub fn locations_list(&self, name: &str) -> ProjectLocationListCall<'a, S>

Create a builder to help you perform the following task:

Lists information about the supported locations for this service.

Arguments

• name - The resource that owns the locations collection, if applicable.

Trait Implementations

impl<'a, S> MethodsBuilder for ProjectMethods<'a, S>