[−][src]Crate google_datacatalog1_beta1

This documentation was generated from Data Catalog crate version 1.0.14+20200528, where 20200528 is the exact revision of the datacatalog:v1beta1 schema built by the mako code generator v1.0.14.

Everything else about the Data Catalog v1_beta1 API can be found at the official documentation site. The original source code is on github.

Features

Handle the following Resources with ease from the central hub ...

catalog
search
entries
lookup
projects
locations entry groups create, locations entry groups delete, locations entry groups entries create, locations entry groups entries delete, locations entry groups entries get, locations entry groups entries get iam policy, locations entry groups entries list, locations entry groups entries patch, locations entry groups entries tags create, locations entry groups entries tags delete, locations entry groups entries tags list, locations entry groups entries tags patch, locations entry groups entries test iam permissions, locations entry groups get, locations entry groups get iam policy, locations entry groups list, locations entry groups patch, locations entry groups set iam policy, locations entry groups tags create, locations entry groups tags delete, locations entry groups tags list, locations entry groups tags patch, locations entry groups test iam permissions, locations tag templates create, locations tag templates delete, locations tag templates fields create, locations tag templates fields delete, locations tag templates fields patch, locations tag templates fields rename, locations tag templates get, locations tag templates get iam policy, locations tag templates patch, locations tag templates set iam policy, locations tag templates test iam permissions, locations taxonomies create, locations taxonomies delete, locations taxonomies export, locations taxonomies get, locations taxonomies get iam policy, locations taxonomies import, locations taxonomies list, locations taxonomies patch, locations taxonomies policy tags create, locations taxonomies policy tags delete, locations taxonomies policy tags get, locations taxonomies policy tags get iam policy, locations taxonomies policy tags list, locations taxonomies policy tags patch, locations taxonomies policy tags set iam policy, locations taxonomies policy tags test iam permissions, locations taxonomies set iam policy and locations taxonomies test iam permissions

Not what you are looking for ? Find all other Google APIs in their Rust documentation index.

Structure of this Library

The API is structured into the following primary items:

Hub
- a central object to maintain state and allow accessing all Activities
- creates Method Builders which in turn allow access to individual Call Builders
Resources
- primary types that you can apply Activities to
- a collection of properties and Parts
- Parts
  - a collection of properties
  - never directly used in Activities
Activities
- operations to apply to Resources

All structures are marked with applicable traits to further categorize them and ease browsing.

Generally speaking, you can invoke Activities like this:

let r = hub.resource().activity(...).doit()

Or specifically ...

let r = hub.projects().locations_tag_templates_get_iam_policy(...).doit()
let r = hub.projects().locations_tag_templates_set_iam_policy(...).doit()
let r = hub.projects().locations_entry_groups_entries_get_iam_policy(...).doit()
let r = hub.projects().locations_taxonomies_set_iam_policy(...).doit()
let r = hub.projects().locations_taxonomies_policy_tags_get_iam_policy(...).doit()
let r = hub.projects().locations_taxonomies_get_iam_policy(...).doit()
let r = hub.projects().locations_taxonomies_policy_tags_set_iam_policy(...).doit()
let r = hub.projects().locations_entry_groups_get_iam_policy(...).doit()
let r = hub.projects().locations_entry_groups_set_iam_policy(...).doit()

The resource() and activity(...) calls create builders. The second one dealing with Activities supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be specified right away (i.e. (...)), whereas all optional ones can be build up as desired. The doit() method performs the actual communication with the server and returns the respective result.

Usage

Setting up your Project

To use this library, you would put the following lines into your Cargo.toml file:

[dependencies]
google-datacatalog1_beta1 = "*"
# This project intentionally uses an old version of Hyper. See
# https://github.com/Byron/google-apis-rs/issues/173 for more
# information.
hyper = "^0.10"
hyper-rustls = "^0.6"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^1.0"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_datacatalog1_beta1 as datacatalog1_beta1;
use datacatalog1_beta1::GetIamPolicyRequest;
use datacatalog1_beta1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use datacatalog1_beta1::DataCatalog;
 
// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
                              <MemoryStorage as Default>::default(), None);
let mut hub = DataCatalog::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = GetIamPolicyRequest::default();
 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().locations_tag_templates_get_iam_policy(req, "resource")
             .doit();
 
match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

Handling Errors

All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.

When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors.

Uploads and Downloads

If a method supports downloads, the response body, which is part of the Result, should be read by you to obtain the media. If such a method also supports a Response Result, it will return that by default. You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making this call: .param("alt", "media").

Methods supporting uploads can do so using up to 2 different protocols: simple and resumable. The distinctiveness of each is represented by customized doit(...) methods, which are then named upload(...) and upload_resumable(...) respectively.

Customization and Callbacks

You may alter the way an doit() method is called by providing a delegate to the Method Builder before making the final doit() call. Respective methods will be called to provide progress information, as well as determine whether the system should retry on failure.

The delegate trait is default-implemented, allowing you to customize it with minimal effort.

Optional Parts in Server-Requests

All structures provided by this library are made to be encodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response.

Builder Arguments

Using method builders, you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true.

PODs are handed by copy
strings are passed as &str
request values are moved

Arguments will always be copied or cloned into the builder, to make them independent of their original life times.

Structs

Binding	Associates `members` with a `role`.
CatalogMethods	A builder providing access to all methods supported on catalog resources. It is not used directly, but through the `DataCatalog` hub.
CatalogSearchCall	Searches Data Catalog for multiple resources like entries, tags that match a query.
Chunk
ContentRange	Implements the Content-Range header, for serialization only
DataCatalog	Central instance to access all DataCatalog related resource activities
DefaultDelegate	A delegate with a conservative default implementation, which is used if no other delegate is set.
DummyNetworkStream
Empty	A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
EntryLookupCall	Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Data Catalog Entry.
EntryMethods	A builder providing access to all methods supported on entry resources. It is not used directly, but through the `DataCatalog` hub.
ErrorResponse	A utility to represent detailed errors we might see in case there are BadRequests. The latter happen if the sent parameters or request structures are unsound
Expr	Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.
GetIamPolicyRequest	Request message for `GetIamPolicy` method.
GetPolicyOptions	Encapsulates settings provided to GetIamPolicy.
GoogleCloudDatacatalogV1beta1ExportTaxonomiesResponse	Response message for ExportTaxonomies.
GoogleCloudDatacatalogV1beta1Entry	Entry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic), or outside of Google Cloud Platform. Clients can use the `linked_resource` field in the Entry resource to refer to the original resource ID of the source system.
GoogleCloudDatacatalogV1beta1SerializedTaxonomy	Message capturing a taxonomy and its policy tag hierarchy as a nested proto. Used for taxonomy import/export and mutation.
GoogleCloudDatacatalogV1beta1SerializedPolicyTag	Message representing one policy tag when exported as a nested proto.
GoogleCloudDatacatalogV1beta1InlineSource	Inline source used for taxonomies import.
GoogleCloudDatacatalogV1beta1TagTemplate	A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to GCP resources. Tag template roles provide permissions to create, edit, and use the template. See, for example, the TagTemplate User role, which includes permission to use the tag template to tag resources.
GoogleCloudDatacatalogV1beta1TableSpec	Normal BigQuery table spec.
GoogleCloudDatacatalogV1beta1GcsFileSpec	Specifications of a single file in Cloud Storage.
GoogleCloudDatacatalogV1beta1Taxonomy	A taxonomy is a collection of policy tags that classify data along a common axis. For instance a data sensitivity taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data origin taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data.
GoogleCloudDatacatalogV1beta1ListEntriesResponse	Response message for ListEntries.
GoogleCloudDatacatalogV1beta1PolicyTag	Denotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined in a hierarchy. For example, consider the following hierarchy: Geolocation -> (LatLong, City, ZipCode). PolicyTag "Geolocation" contains three child policy tags: "LatLong", "City", and "ZipCode".
GoogleCloudDatacatalogV1beta1BigQueryDateShardedSpec	Spec for a group of BigQuery tables with name pattern `[prefix]YYYYMMDD`. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding
GoogleCloudDatacatalogV1beta1Schema	Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
GoogleCloudDatacatalogV1beta1BigQueryTableSpec	Describes a BigQuery table.
GoogleCloudDatacatalogV1beta1ListPolicyTagsResponse	Response message for ListPolicyTags.
GoogleCloudDatacatalogV1beta1ListTagsResponse	Response message for ListTags.
GoogleCloudDatacatalogV1beta1TagFieldEnumValue	Holds an enum value.
GoogleCloudDatacatalogV1beta1SearchCatalogRequest	Request message for SearchCatalog.
GoogleCloudDatacatalogV1beta1GcsFilesetSpec	Describes a Cloud Storage fileset entry.
GoogleCloudDatacatalogV1beta1ImportTaxonomiesResponse	Response message for ImportTaxonomies.
GoogleCloudDatacatalogV1beta1FieldTypeEnumTypeEnumValue	There is no detailed description.
GoogleCloudDatacatalogV1beta1Tag	Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template.
GoogleCloudDatacatalogV1beta1FieldTypeEnumType	There is no detailed description.
GoogleCloudDatacatalogV1beta1ListTaxonomiesResponse	Response message for ListTaxonomies.
GoogleCloudDatacatalogV1beta1TagField	Contains the value and supporting information for a field within a Tag.
GoogleCloudDatacatalogV1beta1SearchCatalogResponse	Response message for SearchCatalog.
GoogleCloudDatacatalogV1beta1SearchCatalogResult	A result that appears in the response of a search request. Each result captures details of one entry that matches the search.
GoogleCloudDatacatalogV1beta1ListEntryGroupsResponse	Response message for ListEntryGroups.
GoogleCloudDatacatalogV1beta1EntryGroup	EntryGroup Metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources.
GoogleCloudDatacatalogV1beta1SystemTimestamps	Timestamps about this resource according to a particular system.
GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope	The criteria that select the subspace used for query matching.
GoogleCloudDatacatalogV1beta1TagTemplateField	The template for an individual field within a tag template.
GoogleCloudDatacatalogV1beta1ViewSpec	Table view specification.
GoogleCloudDatacatalogV1beta1ColumnSchema	Representation of a column within a schema. Columns could be nested inside other columns.
GoogleCloudDatacatalogV1beta1ImportTaxonomiesRequest	Request message for ImportTaxonomies.
GoogleCloudDatacatalogV1beta1RenameTagTemplateFieldRequest	Request message for RenameTagTemplateField.
GoogleCloudDatacatalogV1beta1FieldType	There is no detailed description.
JsonServerError	A utility type which can decode a server response that indicates error
MethodInfo	Contains information about an API request.
MultiPartReader	Provides a `Read` interface that converts multiple parts into the protocol identified by RFC2387. Note: This implementation is just as rich as it needs to be to perform uploads to google APIs, and might not be a fully-featured implementation.
Policy	An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
ProjectLocationEntryGroupCreateCall	A maximum of 10,000 entry groups may be created per organization across all locations.
ProjectLocationEntryGroupDeleteCall	Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
ProjectLocationEntryGroupEntryCreateCall	Creates an entry. Only entries of 'FILESET' type or user-specified type can be created.
ProjectLocationEntryGroupEntryDeleteCall	Deletes an existing entry. Only entries created through CreateEntry method can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
ProjectLocationEntryGroupEntryGetCall	Gets an entry.
ProjectLocationEntryGroupEntryGetIamPolicyCall	Gets the access control policy for a resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
ProjectLocationEntryGroupEntryListCall	Lists entries.
ProjectLocationEntryGroupEntryPatchCall	Updates an existing entry. Users should enable the Data Catalog API in the project identified by the `entry.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
ProjectLocationEntryGroupEntryTagCreateCall	Creates a tag on an Entry. Note: The project identified by the `parent` parameter for the tag and the tag template used to create the tag must be from the same organization.
ProjectLocationEntryGroupEntryTagDeleteCall	Deletes a tag.
ProjectLocationEntryGroupEntryTagListCall	Lists the tags on an Entry.
ProjectLocationEntryGroupEntryTagPatchCall	Updates an existing tag.
ProjectLocationEntryGroupEntryTestIamPermissionCall	Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a `NOT_FOUND` error).
ProjectLocationEntryGroupGetCall	Gets an EntryGroup.
ProjectLocationEntryGroupGetIamPolicyCall	Gets the access control policy for a resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
ProjectLocationEntryGroupListCall	Lists entry groups.
ProjectLocationEntryGroupPatchCall	Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by the `entry_group.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
ProjectLocationEntryGroupSetIamPolicyCall	Sets the access control policy for a resource. Replaces any existing policy. Supported resources are:
ProjectLocationEntryGroupTagCreateCall	Creates a tag on an Entry. Note: The project identified by the `parent` parameter for the tag and the tag template used to create the tag must be from the same organization.
ProjectLocationEntryGroupTagDeleteCall	Deletes a tag.
ProjectLocationEntryGroupTagListCall	Lists the tags on an Entry.
ProjectLocationEntryGroupTagPatchCall	Updates an existing tag.
ProjectLocationEntryGroupTestIamPermissionCall	Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a `NOT_FOUND` error).
ProjectLocationTagTemplateCreateCall	Creates a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see Data Catalog Resource Project for more information).
ProjectLocationTagTemplateDeleteCall	Deletes a tag template and all tags using the template. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
ProjectLocationTagTemplateFieldCreateCall	Creates a field in a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see Data Catalog Resource Project for more information).
ProjectLocationTagTemplateFieldDeleteCall	Deletes a field in a tag template and all uses of that field. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
ProjectLocationTagTemplateFieldPatchCall	Updates a field in a tag template. This method cannot be used to update the field type. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
ProjectLocationTagTemplateFieldRenameCall	Renames a field in a tag template. The user should enable the Data Catalog API in the project identified by the `name` parameter (see Data Catalog Resource Project for more information).
ProjectLocationTagTemplateGetCall	Gets a tag template.
ProjectLocationTagTemplateGetIamPolicyCall	Gets the access control policy for a resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
ProjectLocationTagTemplatePatchCall	Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. Users should enable the Data Catalog API in the project identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).
ProjectLocationTagTemplateSetIamPolicyCall	Sets the access control policy for a resource. Replaces any existing policy. Supported resources are:
ProjectLocationTagTemplateTestIamPermissionCall	Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a `NOT_FOUND` error).
ProjectLocationTaxonomyCreateCall	Creates a taxonomy in the specified project.
ProjectLocationTaxonomyDeleteCall	Deletes a taxonomy. This operation will also delete all policy tags in this taxonomy along with their associated policies.
ProjectLocationTaxonomyExportCall	Exports all taxonomies and their policy tags in a project.
ProjectLocationTaxonomyGetCall	Gets a taxonomy.
ProjectLocationTaxonomyGetIamPolicyCall	Gets the IAM policy for a taxonomy or a policy tag.
ProjectLocationTaxonomyImportCall	Imports all taxonomies and their policy tags to a project as new taxonomies.
ProjectLocationTaxonomyListCall	Lists all taxonomies in a project in a particular location that the caller has permission to view.
ProjectLocationTaxonomyPatchCall	Updates a taxonomy.
ProjectLocationTaxonomyPolicyTagCreateCall	Creates a policy tag in the specified taxonomy.
ProjectLocationTaxonomyPolicyTagDeleteCall	Deletes a policy tag. Also deletes all of its descendant policy tags.
ProjectLocationTaxonomyPolicyTagGetCall	Gets a policy tag.
ProjectLocationTaxonomyPolicyTagGetIamPolicyCall	Gets the IAM policy for a taxonomy or a policy tag.
ProjectLocationTaxonomyPolicyTagListCall	Lists all policy tags in a taxonomy.
ProjectLocationTaxonomyPolicyTagPatchCall	Updates a policy tag.
ProjectLocationTaxonomyPolicyTagSetIamPolicyCall	Sets the IAM policy for a taxonomy or a policy tag.
ProjectLocationTaxonomyPolicyTagTestIamPermissionCall	Returns the permissions that a caller has on the specified taxonomy or policy tag.
ProjectLocationTaxonomySetIamPolicyCall	Sets the IAM policy for a taxonomy or a policy tag.
ProjectLocationTaxonomyTestIamPermissionCall	Returns the permissions that a caller has on the specified taxonomy or policy tag.
ProjectMethods	A builder providing access to all methods supported on project resources. It is not used directly, but through the `DataCatalog` hub.
RangeResponseHeader
ResumableUploadHelper	A utility type to perform a resumable upload from start to end.
ServerError
ServerMessage
SetIamPolicyRequest	Request message for `SetIamPolicy` method.
TestIamPermissionsRequest	Request message for `TestIamPermissions` method.
TestIamPermissionsResponse	Response message for `TestIamPermissions` method.
XUploadContentType	The `X-Upload-Content-Type` header.

Enums

Error
Scope	Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.

Traits

CallBuilder	Identifies types which represent builders for a particular resource method
Delegate	A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation.
Hub	Identifies the Hub. There is only one per library, this trait is supposed to make intended use more explicit. The hub allows to access all resource methods more easily.
MethodsBuilder	Identifies types for building methods of a particular resource type
NestedType	Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness.
Part	Identifies types which are only used as part of other types, which usually are carrying the `Resource` trait.
ReadSeek	A utility to specify reader types which provide seeking capabilities too
RequestValue	Identifies types which are used in API requests.
Resource	Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API.
ResponseResult	Identifies types which are used in API responses.
ToParts	A trait for all types that can convert themselves into a parts string
UnusedType	Identifies types which are not actually used by the API This might be a bug within the google API schema.

Functions

remove_json_null_values

Type Definitions

Result

A universal result type used as return for all calls.