Dataplex V1 API - Class Google::Cloud::Dataplex::V1::DataDocumentationSpec (v2.10.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::DataDocumentationSpec.

DataDocumentation scan related spec.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#catalog_publishing_enabled

def catalog_publishing_enabled() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether to publish result to Dataplex Catalog.

#catalog_publishing_enabled=

def catalog_publishing_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether to publish result to Dataplex Catalog.
Returns
  • (::Boolean) — Optional. Whether to publish result to Dataplex Catalog.

#generation_scopes

def generation_scopes() -> ::Array<::Google::Cloud::Dataplex::V1::DataDocumentationSpec::GenerationScope>
Returns
  • (::Array<::Google::Cloud::Dataplex::V1::DataDocumentationSpec::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.

#generation_scopes=

def generation_scopes=(value) -> ::Array<::Google::Cloud::Dataplex::V1::DataDocumentationSpec::GenerationScope>
Parameter
  • value (::Array<::Google::Cloud::Dataplex::V1::DataDocumentationSpec::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.
Returns
  • (::Array<::Google::Cloud::Dataplex::V1::DataDocumentationSpec::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.