ApiHubPlugin

Struct ApiHubPlugin 

Source
pub struct ApiHubPlugin { /* private fields */ }
Expand description

Implements a client for the API hub API.

§Example

let client = ApiHubPlugin::builder().build().await?;
// use `client` to make requests to the API hub API.

§Service Description

This service is used for managing plugins inside the API Hub.

§Configuration

To configure ApiHubPlugin use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

  • with_endpoint(): by default this client uses the global default endpoint (https://apihub.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
  • with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

§Pooling and Cloning

ApiHubPlugin holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap ApiHubPlugin in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations§

Source§

impl ApiHubPlugin

Source

pub fn builder() -> ClientBuilder

Returns a builder for ApiHubPlugin.

let client = ApiHubPlugin::builder().build().await?;
Source

pub fn from_stub<T>(stub: T) -> Self
where T: ApiHubPlugin + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

Source

pub fn get_plugin(&self) -> GetPlugin

Get an API Hub plugin.

Source

pub fn enable_plugin(&self) -> EnablePlugin

Enables a plugin. The state of the plugin after enabling is ENABLED

Source

pub fn disable_plugin(&self) -> DisablePlugin

Disables a plugin. The state of the plugin after disabling is DISABLED

Source

pub fn create_plugin(&self) -> CreatePlugin

Create an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances.

Source

pub fn list_plugins(&self) -> ListPlugins

List all the plugins in a given project and location.

Source

pub fn delete_plugin(&self) -> DeletePlugin

Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn create_plugin_instance(&self) -> CreatePluginInstance

Creates a Plugin instance in the API hub.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn execute_plugin_instance_action(&self) -> ExecutePluginInstanceAction

Executes a plugin instance in the API hub.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn get_plugin_instance(&self) -> GetPluginInstance

Get an API Hub plugin instance.

Source

pub fn list_plugin_instances(&self) -> ListPluginInstances

List all the plugins in a given project and location. - can be used as wildcard value for {plugin_id}

Source

pub fn enable_plugin_instance_action(&self) -> EnablePluginInstanceAction

Enables a plugin instance in the API hub.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn disable_plugin_instance_action(&self) -> DisablePluginInstanceAction

Disables a plugin instance in the API hub.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn update_plugin_instance(&self) -> UpdatePluginInstance

Updates a plugin instance in the API hub. The following fields in the plugin_instance can be updated currently:

  • display_name
  • [schedule_cron_expression][PluginInstance.actions.schedule_cron_expression]

The update_mask should be used to specify the fields being updated.

To update the auth_config and additional_config of the plugin instance, use the [ApplyPluginInstanceConfig][google.cloud.apihub.v1.ApiHubPlugin.ApplyPluginInstanceConfig] method.

Source

pub fn delete_plugin_instance(&self) -> DeletePluginInstance

Deletes a plugin instance in the API hub.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

Source

pub fn get_location(&self) -> GetLocation

Gets information about a location.

Source

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

Source

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

Source

pub fn delete_operation(&self) -> DeleteOperation

Provides the Operations service functionality in this service.

Source

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

Trait Implementations§

Source§

impl Clone for ApiHubPlugin

Source§

fn clone(&self) -> ApiHubPlugin

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ApiHubPlugin

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more