Struct DataDocumentationSpec 

#[non_exhaustive]
pub struct DataDocumentationSpec {
    pub catalog_publishing_enabled: bool,
    pub generation_scopes: Vec<GenerationScope>,
    /* private fields */
}

DataDocumentation scan related spec.

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.

catalog_publishing_enabled: bool

Optional. Whether to publish result to Dataplex Catalog.

generation_scopes: Vec<GenerationScope>

Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated.

Implementations

impl DataDocumentationSpec

pub fn new() -> Self

pub fn set_catalog_publishing_enabled<T: Into<bool>>(self, v: T) -> Self

Sets the value of catalog_publishing_enabled.

Example

let x = DataDocumentationSpec::new().set_catalog_publishing_enabled(true);

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

where T: IntoIterator<Item = V>, V: Into<GenerationScope>,

Sets the value of generation_scopes.

Example

use google_cloud_dataplex_v1::model::data_documentation_spec::GenerationScope;
let x = DataDocumentationSpec::new().set_generation_scopes([
    GenerationScope::All,
    GenerationScope::TableAndColumnDescriptions,
    GenerationScope::SqlQueries,
]);

Trait Implementations

impl Clone for DataDocumentationSpec

fn clone(&self) -> DataDocumentationSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataDocumentationSpec

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

Formats the value using the given formatter.

impl Default for DataDocumentationSpec

fn default() -> DataDocumentationSpec

Returns the “default value” for a type.

impl Message for DataDocumentationSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DataDocumentationSpec

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for DataDocumentationSpec