Struct google_api_proto::google::appengine::v1::instances_client::InstancesClient

pub struct InstancesClient<T> { /* private fields */ }

Manages instances of a version.

Implementations

impl<T> InstancesClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> InstancesClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn list_instances( &mut self, request: impl IntoRequest<ListInstancesRequest>, ) -> Result<Response<ListInstancesResponse>, Status>

Lists the instances of a version.

Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API.

pub async fn get_instance( &mut self, request: impl IntoRequest<GetInstanceRequest>, ) -> Result<Response<Instance>, Status>

Gets instance information.

pub async fn delete_instance( &mut self, request: impl IntoRequest<DeleteInstanceRequest>, ) -> Result<Response<Operation>, Status>

Stops a running instance.

The instance might be automatically recreated based on the scaling settings of the version. For more information, see “How Instances are Managed” (standard environment | flexible environment).

To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch method.

pub async fn debug_instance( &mut self, request: impl IntoRequest<DebugInstanceRequest>, ) -> Result<Response<Operation>, Status>

Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in “debug mode”, the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.

Only applicable for instances in App Engine flexible environment.

Trait Implementations

impl<T: Clone> Clone for InstancesClient<T>

fn clone(&self) -> InstancesClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for InstancesClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.