Struct google_api_proto::google::cloud::datacatalog::v1::Entry

pub struct Entry {

    pub name: String,
    pub linked_resource: String,
    pub fully_qualified_name: String,
    pub display_name: String,
    pub description: String,
    pub business_context: Option<BusinessContext>,
    pub schema: Option<Schema>,
    pub source_system_timestamps: Option<SystemTimestamps>,
    pub usage_signal: Option<UsageSignal>,
    pub labels: BTreeMap<String, String>,
    pub data_source: Option<DataSource>,
    pub personal_details: Option<PersonalDetails>,
    pub entry_type: Option<EntryType>,
    pub system: Option<System>,
    pub system_spec: Option<SystemSpec>,
    pub type_spec: Option<TypeSpec>,
    pub spec: Option<Spec>,
}

Entry metadata. A Data Catalog entry represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of it. You can use the linked_resource field in the entry resource to refer to the original resource ID of the source system.

An entry resource contains resource details, for example, its schema. Additionally, you can attach flexible metadata to an entry in the form of a [Tag][google.cloud.datacatalog.v1.Tag].

Fields

name: String

Output only. The resource name of an entry in URL format.

Note: The entry itself and its child resources might not be stored in the location specified in its name.

linked_resource: String

The resource this metadata entry refers to.

For Google Cloud Platform resources, linked_resource is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the linked_resource for a table resource from BigQuery is:

//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}

Output only when the entry is one of the types in the EntryType enum.

For entries with a user_specified_type, this field is optional and defaults to an empty string.

The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8.

fully_qualified_name: String

Fully Qualified Name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries.

display_name: String

Display name of an entry.

The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.

description: String

Entry description that can consist of several sentences or paragraphs that describe entry contents.

The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string.

business_context: Option<BusinessContext>

Business Context of the entry. Not supported for BigQuery datasets

schema: Option<Schema>

Schema of the entry. An entry might not have any schema attached to it.

source_system_timestamps: Option<SystemTimestamps>

Timestamps from the underlying resource, not from the Data Catalog entry.

Output only when the entry has a system listed in the IntegratedSystem enum. For entries with user_specified_system, this field is optional and defaults to an empty timestamp.

usage_signal: Option<UsageSignal>

Resource usage statistics.

labels: BTreeMap<String, String>

Cloud labels attached to the entry.

In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.

data_source: Option<DataSource>

Output only. Physical location of the entry.

personal_details: Option<PersonalDetails>

Output only. Additional information related to the entry. Private to the current user.

entry_type: Option<EntryType>

Required. Entry type.

system: Option<System>

The source system of the entry.

system_spec: Option<SystemSpec>

System specification. Can be used as a complement for spec, when some metadata is relevant for all entries existing within given system

type_spec: Option<TypeSpec>

Type specification.

spec: Option<Spec>

Type- and system-specific information. Specifications for types contain fields common to all entries of a given type, and sub-specifications with fields specific to a given source system.

When extending the API with new types and systems, use this field instead of the legacy type_spec.

Trait Implementations

impl Clone for Entry

fn clone(&self) -> Entry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Entry

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

Formats the value using the given formatter.

impl Default for Entry

fn default() -> Self

Returns the “default value” for a type.

impl Message for Entry

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Entry

fn eq(&self, other: &Entry) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Entry