Struct Entity 

#[non_exhaustive]
pub struct Entity {

    pub name: String,
    pub display_name: String,
    pub description: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub id: String,
    pub etag: String,
    pub type: Type,
    pub asset: String,
    pub data_path: String,
    pub data_path_pattern: String,
    pub catalog_entry: String,
    pub system: StorageSystem,
    pub format: Option<StorageFormat>,
    pub compatibility: Option<CompatibilityStatus>,
    pub access: Option<StorageAccess>,
    pub uid: String,
    pub schema: Option<Schema>,
    /* private fields */
}

Represents tables and fileset metadata contained within a zone.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}.

display_name: String

Optional. Display name must be shorter than or equal to 256 characters.

description: String

Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.

create_time: Option<Timestamp>

Output only. The time when the entity was created.

update_time: Option<Timestamp>

Output only. The time when the entity was last updated.

id: String

Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters.

etag: String

Optional. The etag associated with the entity, which can be retrieved with a [GetEntity][] request. Required for update and delete requests.

type: Type

Required. Immutable. The type of entity.

asset: String

Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.

data_path: String

Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.

data_path_pattern: String

Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv.

catalog_entry: String

Output only. The name of the associated Data Catalog entry.

system: StorageSystem

Required. Immutable. Identifies the storage system of the entity data.

format: Option<StorageFormat>

Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.

compatibility: Option<CompatibilityStatus>

Output only. Metadata stores that the entity is compatible with.

access: Option<StorageAccess>

Output only. Identifies the access mechanism to the entity. Not user settable.

uid: String

Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name.

schema: Option<Schema>

Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.

Implementations

impl Entity

pub fn new() -> Self

Creates a new default instance.

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = Entity::new().set_name(format!("projects/{project_id}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}"));

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

Example

let x = Entity::new().set_display_name("example");

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

Example

let x = Entity::new().set_description("example");

pub fn set_create_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = Entity::new().set_create_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = Entity::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = Entity::new().set_or_clear_create_time(None::<Timestamp>);

pub fn set_update_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of update_time.

Example

use wkt::Timestamp;
let x = Entity::new().set_update_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_update_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

use wkt::Timestamp;
let x = Entity::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = Entity::new().set_or_clear_update_time(None::<Timestamp>);

pub fn set_id<T: Into<String>>(self, v: T) -> Self

Sets the value of id.

Example

let x = Entity::new().set_id("example");

pub fn set_etag<T: Into<String>>(self, v: T) -> Self

Sets the value of etag.

Example

let x = Entity::new().set_etag("example");

pub fn set_type<T: Into<Type>>(self, v: T) -> Self

Sets the value of r#type.

Example

use google_cloud_dataplex_v1::model::entity::Type;
let x0 = Entity::new().set_type(Type::Table);
let x1 = Entity::new().set_type(Type::Fileset);

pub fn set_asset<T: Into<String>>(self, v: T) -> Self

Sets the value of asset.

Example

let x = Entity::new().set_asset("example");

pub fn set_data_path<T: Into<String>>(self, v: T) -> Self

Sets the value of data_path.

Example

let x = Entity::new().set_data_path("example");

pub fn set_data_path_pattern<T: Into<String>>(self, v: T) -> Self

Sets the value of data_path_pattern.

Example

let x = Entity::new().set_data_path_pattern("example");

pub fn set_catalog_entry<T: Into<String>>(self, v: T) -> Self

Sets the value of catalog_entry.

Example

let x = Entity::new().set_catalog_entry("example");

pub fn set_system<T: Into<StorageSystem>>(self, v: T) -> Self

Sets the value of system.

Example

use google_cloud_dataplex_v1::model::StorageSystem;
let x0 = Entity::new().set_system(StorageSystem::CloudStorage);
let x1 = Entity::new().set_system(StorageSystem::Bigquery);

pub fn set_format<T>(self, v: T) -> Self

where T: Into<StorageFormat>,

Sets the value of format.

Example

use google_cloud_dataplex_v1::model::StorageFormat;
let x = Entity::new().set_format(StorageFormat::default()/* use setters */);

pub fn set_or_clear_format<T>(self, v: Option<T>) -> Self

where T: Into<StorageFormat>,

Sets or clears the value of format.

Example

use google_cloud_dataplex_v1::model::StorageFormat;
let x = Entity::new().set_or_clear_format(Some(StorageFormat::default()/* use setters */));
let x = Entity::new().set_or_clear_format(None::<StorageFormat>);

pub fn set_compatibility<T>(self, v: T) -> Self

where T: Into<CompatibilityStatus>,

Sets the value of compatibility.

Example

use google_cloud_dataplex_v1::model::entity::CompatibilityStatus;
let x = Entity::new().set_compatibility(CompatibilityStatus::default()/* use setters */);

pub fn set_or_clear_compatibility<T>(self, v: Option<T>) -> Self

where T: Into<CompatibilityStatus>,

Sets or clears the value of compatibility.

Example

use google_cloud_dataplex_v1::model::entity::CompatibilityStatus;
let x = Entity::new().set_or_clear_compatibility(Some(CompatibilityStatus::default()/* use setters */));
let x = Entity::new().set_or_clear_compatibility(None::<CompatibilityStatus>);

pub fn set_access<T>(self, v: T) -> Self

where T: Into<StorageAccess>,

Sets the value of access.

Example

use google_cloud_dataplex_v1::model::StorageAccess;
let x = Entity::new().set_access(StorageAccess::default()/* use setters */);

pub fn set_or_clear_access<T>(self, v: Option<T>) -> Self

where T: Into<StorageAccess>,

Sets or clears the value of access.

Example

use google_cloud_dataplex_v1::model::StorageAccess;
let x = Entity::new().set_or_clear_access(Some(StorageAccess::default()/* use setters */));
let x = Entity::new().set_or_clear_access(None::<StorageAccess>);

pub fn set_uid<T: Into<String>>(self, v: T) -> Self

Sets the value of uid.

Example

let x = Entity::new().set_uid("example");

pub fn set_schema<T>(self, v: T) -> Self

where T: Into<Schema>,

Sets the value of schema.

Example

use google_cloud_dataplex_v1::model::Schema;
let x = Entity::new().set_schema(Schema::default()/* use setters */);

pub fn set_or_clear_schema<T>(self, v: Option<T>) -> Self

where T: Into<Schema>,

Sets or clears the value of schema.

Example

use google_cloud_dataplex_v1::model::Schema;
let x = Entity::new().set_or_clear_schema(Some(Schema::default()/* use setters */));
let x = Entity::new().set_or_clear_schema(None::<Schema>);

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl Default for Entity

fn default() -> Entity

Returns the “default value” for a type.

impl Message for Entity

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Entity

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Entity