Struct google_api_proto::google::api::apikeys::v2::api_keys_client::ApiKeysClient

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

Manages the API keys associated with projects.

Implementations

impl<T> ApiKeysClient<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 ) -> ApiKeysClient<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 create_key( &mut self, request: impl IntoRequest<CreateKeyRequest> ) -> Result<Response<Operation>, Status>

Creates a new API key.

NOTE: Key is a global resource; hence the only supported value for location is global.

pub async fn list_keys( &mut self, request: impl IntoRequest<ListKeysRequest> ) -> Result<Response<ListKeysResponse>, Status>

Lists the API keys owned by a project. The key string of the API key isn’t included in the response.

NOTE: Key is a global resource; hence the only supported value for location is global.

pub async fn get_key( &mut self, request: impl IntoRequest<GetKeyRequest> ) -> Result<Response<Key>, Status>

Gets the metadata for an API key. The key string of the API key isn’t included in the response.

NOTE: Key is a global resource; hence the only supported value for location is global.

pub async fn get_key_string( &mut self, request: impl IntoRequest<GetKeyStringRequest> ) -> Result<Response<GetKeyStringResponse>, Status>

Get the key string for an API key.

NOTE: Key is a global resource; hence the only supported value for location is global.

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

Patches the modifiable fields of an API key. The key string of the API key isn’t included in the response.

NOTE: Key is a global resource; hence the only supported value for location is global.

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

Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project.

NOTE: Key is a global resource; hence the only supported value for location is global.

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

Undeletes an API key which was deleted within 30 days.

NOTE: Key is a global resource; hence the only supported value for location is global.

pub async fn lookup_key( &mut self, request: impl IntoRequest<LookupKeyRequest> ) -> Result<Response<LookupKeyResponse>, Status>

Find the parent project and resource name of the API key that matches the key string in the request. If the API key has been purged, resource name will not be set. The service account must have the apikeys.keys.lookup permission on the parent project.

Trait Implementations

impl<T: Clone> Clone for ApiKeysClient<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ApiKeysClient<T>

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

Formats the value using the given formatter.