Struct google_api_proto::google::cloud::dataplex::v1::DataScan

pub struct DataScan {

    pub name: String,
    pub uid: String,
    pub description: String,
    pub display_name: String,
    pub labels: BTreeMap<String, String>,
    pub state: i32,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub data: Option<DataSource>,
    pub execution_spec: Option<ExecutionSpec>,
    pub execution_status: Option<ExecutionStatus>,
    pub type: i32,
    pub spec: Option<Spec>,
    pub result: Option<Result>,
}

Represents a user-visible job which provides the insights for the related data source.

For example:

• Data Quality: generates queries based on the rules and runs against the data to get data quality check results.
• Data Profile: analyzes the data in table(s) and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc).

Fields

name: String

Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.

uid: String

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

description: String

Optional. Description of the scan.

• Must be between 1-1024 characters.

display_name: String

Optional. User friendly display name.

• Must be between 1-256 characters.

labels: BTreeMap<String, String>

Optional. User-defined labels for the scan.

state: i32

Output only. Current state of the DataScan.

create_time: Option<Timestamp>

Output only. The time when the scan was created.

update_time: Option<Timestamp>

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

data: Option<DataSource>

Required. The data source for DataScan.

execution_spec: Option<ExecutionSpec>

Optional. DataScan execution settings.

If not specified, the fields in it will use their default values.

execution_status: Option<ExecutionStatus>

Output only. Status of the data scan execution.

type: i32

Output only. The type of DataScan.

spec: Option<Spec>

Data Scan related setting. It is required and immutable which means once data_quality_spec is set, it cannot be changed to data_profile_spec.

result: Option<Result>

The result of the data scan.

Implementations

impl DataScan

pub fn state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

pub fn type(&self) -> DataScanType

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: DataScanType)

Sets type to the provided enum value.

Trait Implementations

impl Clone for DataScan

fn clone(&self) -> DataScan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataScan

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

Formats the value using the given formatter.

impl Default for DataScan

fn default() -> Self

Returns the “default value” for a type.

impl Message for DataScan

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 DataScan

fn eq(&self, other: &DataScan) -> 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 DataScan