Skip to main content

DataObjectService

Struct DataObjectService 

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

Implements a client for the Vector Search API.

§Example

    let client = DataObjectService::builder().build().await?;
    let name = "name_value";
    let response = client.get_data_object()
        .set_name(name)
        .send().await?;
    println!("response {:?}", response);

§Service Description

Service for creating and managing data objects.

§Configuration

To configure DataObjectService 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://vectorsearch.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

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

Implementations§

Source§

impl DataObjectService

Source

pub fn builder() -> ClientBuilder

Returns a builder for DataObjectService.

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

pub fn from_stub<T>(stub: T) -> Self
where T: DataObjectService + '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 create_data_object(&self) -> CreateDataObject

Creates a dataObject.

§Example
use google_cloud_vectorsearch_v1::model::DataObject;
use google_cloud_vectorsearch_v1::Result;
async fn sample(
   client: &DataObjectService, parent: &str
) -> Result<()> {
    let response = client.create_data_object()
        .set_parent(parent)
        .set_data_object(
            DataObject::new()/* set fields */
        )
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn batch_create_data_objects(&self) -> BatchCreateDataObjects

Creates a batch of dataObjects.

§Example
use google_cloud_vectorsearch_v1::Result;
async fn sample(
   client: &DataObjectService
) -> Result<()> {
    let response = client.batch_create_data_objects()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn get_data_object(&self) -> GetDataObject

Gets a data object.

§Example
use google_cloud_vectorsearch_v1::Result;
async fn sample(
   client: &DataObjectService, name: &str
) -> Result<()> {
    let response = client.get_data_object()
        .set_name(name)
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn update_data_object(&self) -> UpdateDataObject

Updates a dataObject.

§Example
use google_cloud_wkt::FieldMask;
use google_cloud_vectorsearch_v1::model::DataObject;
use google_cloud_vectorsearch_v1::Result;
async fn sample(
   client: &DataObjectService, name: &str
) -> Result<()> {
    let response = client.update_data_object()
        .set_data_object(
            DataObject::new().set_name(name)/* set fields */
        )
        .set_update_mask(FieldMask::default().set_paths(["updated.field.path1", "updated.field.path2"]))
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn batch_update_data_objects(&self) -> BatchUpdateDataObjects

Updates dataObjects in a batch.

§Example
use google_cloud_vectorsearch_v1::Result;
async fn sample(
   client: &DataObjectService
) -> Result<()> {
    let response = client.batch_update_data_objects()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn delete_data_object(&self) -> DeleteDataObject

Deletes a dataObject.

§Example
use google_cloud_vectorsearch_v1::Result;
async fn sample(
   client: &DataObjectService, name: &str
) -> Result<()> {
    client.delete_data_object()
        .set_name(name)
        .send().await?;
    Ok(())
}
Source

pub fn batch_delete_data_objects(&self) -> BatchDeleteDataObjects

Deletes dataObjects in a batch.

§Example
use google_cloud_vectorsearch_v1::Result;
async fn sample(
   client: &DataObjectService
) -> Result<()> {
    client.batch_delete_data_objects()
        /* set fields */
        .send().await?;
    Ok(())
}
Source

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service. This method can be called in two ways:

  • List all public locations: Use the path GET /v1/locations.
  • List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.
§Example
use google_cloud_gax::paginator::ItemPaginator as _;
use google_cloud_vectorsearch_v1::Result;
async fn sample(
   client: &DataObjectService
) -> Result<()> {
    let mut list = client.list_locations()
        /* set fields */
        .by_item();
    while let Some(item) = list.next().await.transpose()? {
        println!("{:?}", item);
    }
    Ok(())
}
Source

pub fn get_location(&self) -> GetLocation

Gets information about a location.

§Example
use google_cloud_vectorsearch_v1::Result;
async fn sample(
   client: &DataObjectService
) -> Result<()> {
    let response = client.get_location()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

§Example
use google_cloud_gax::paginator::ItemPaginator as _;
use google_cloud_vectorsearch_v1::Result;
async fn sample(
   client: &DataObjectService
) -> Result<()> {
    let mut list = client.list_operations()
        /* set fields */
        .by_item();
    while let Some(item) = list.next().await.transpose()? {
        println!("{:?}", item);
    }
    Ok(())
}
Source

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

§Example
use google_cloud_vectorsearch_v1::Result;
async fn sample(
   client: &DataObjectService
) -> Result<()> {
    let response = client.get_operation()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn delete_operation(&self) -> DeleteOperation

Provides the Operations service functionality in this service.

§Example
use google_cloud_vectorsearch_v1::Result;
async fn sample(
   client: &DataObjectService
) -> Result<()> {
    client.delete_operation()
        /* set fields */
        .send().await?;
    Ok(())
}
Source

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

§Example
use google_cloud_vectorsearch_v1::Result;
async fn sample(
   client: &DataObjectService
) -> Result<()> {
    client.cancel_operation()
        /* set fields */
        .send().await?;
    Ok(())
}

Trait Implementations§

Source§

impl Clone for DataObjectService

Source§

fn clone(&self) -> DataObjectService

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 DataObjectService

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> Same for T

Source§

type Output = T

Should always be Self
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<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