Struct CatalogService 

pub struct CatalogService { /* private fields */ }

Implements a client for the Cloud Dataplex API.

Example

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

Service Description

The primary resources offered by this service are EntryGroups, EntryTypes, AspectTypes, Entries and EntryLinks. They collectively let data administrators organize, manage, secure, and catalog data located across cloud projects in their organization in a variety of storage systems, including Cloud Storage and BigQuery.

Configuration

To configure CatalogService 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://dataplex.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

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

Implementations

impl CatalogService

pub fn builder() -> ClientBuilder

Returns a builder for CatalogService.

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

pub fn from_stub<T>(stub: T) -> Self

where T: CatalogService + '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.

pub fn create_entry_type(&self) -> CreateEntryType

Creates an EntryType.

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.

pub fn update_entry_type(&self) -> UpdateEntryType

Updates an EntryType.

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.

pub fn delete_entry_type(&self) -> DeleteEntryType

Deletes an EntryType.

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.

pub fn list_entry_types(&self) -> ListEntryTypes

Lists EntryType resources in a project and location.

pub fn get_entry_type(&self) -> GetEntryType

Gets an EntryType.

pub fn create_aspect_type(&self) -> CreateAspectType

Creates an AspectType.

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.

pub fn update_aspect_type(&self) -> UpdateAspectType

Updates an AspectType.

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.

pub fn delete_aspect_type(&self) -> DeleteAspectType

Deletes an AspectType.

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.

pub fn list_aspect_types(&self) -> ListAspectTypes

Lists AspectType resources in a project and location.

pub fn get_aspect_type(&self) -> GetAspectType

Gets an AspectType.

pub fn create_entry_group(&self) -> CreateEntryGroup

Creates an EntryGroup.

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.

pub fn update_entry_group(&self) -> UpdateEntryGroup

Updates an EntryGroup.

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.

pub fn delete_entry_group(&self) -> DeleteEntryGroup

Deletes an EntryGroup.

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.

pub fn list_entry_groups(&self) -> ListEntryGroups

Lists EntryGroup resources in a project and location.

pub fn get_entry_group(&self) -> GetEntryGroup

Gets an EntryGroup.

pub fn create_entry(&self) -> CreateEntry

Creates an Entry.

pub fn update_entry(&self) -> UpdateEntry

Updates an Entry.

pub fn delete_entry(&self) -> DeleteEntry

Deletes an Entry.

pub fn list_entries(&self) -> ListEntries

Lists Entries within an EntryGroup. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog.

pub fn get_entry(&self) -> GetEntry

Gets an Entry. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog.

pub fn lookup_entry(&self) -> LookupEntry

Looks up an entry by name using the permission on the source system. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog.

pub fn search_entries(&self) -> SearchEntries

Searches for Entries matching the given query and scope.

pub fn create_metadata_job(&self) -> CreateMetadataJob

Creates a metadata job. For example, use a metadata job to import metadata from a third-party system into Dataplex Universal Catalog.

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.

pub fn get_metadata_job(&self) -> GetMetadataJob

Gets a metadata job.

pub fn list_metadata_jobs(&self) -> ListMetadataJobs

Lists metadata jobs.

pub fn cancel_metadata_job(&self) -> CancelMetadataJob

Cancels a metadata job.

If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.

pub fn create_entry_link(&self) -> CreateEntryLink

Creates an Entry Link.

pub fn delete_entry_link(&self) -> DeleteEntryLink

Deletes an Entry Link.

pub fn get_entry_link(&self) -> GetEntryLink

Gets an Entry Link.

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self) -> GetLocation

Gets information about a location.

pub fn set_iam_policy(&self) -> SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

pub fn get_iam_policy(&self) -> GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

pub fn test_iam_permissions(&self) -> TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

pub fn delete_operation(&self) -> DeleteOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for CatalogService

fn clone(&self) -> CatalogService

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CatalogService

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

Formats the value using the given formatter.