Class: Google::Cloud::Dataplex::V1::DataScan

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/datascans.rb

Overview

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).

Defined Under Namespace

Classes: ExecutionSpec, ExecutionStatus, LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the scan was created.

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data ⇒ ::Google::Cloud::Dataplex::V1::DataSource

Returns Required. The data source for DataScan.

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_discovery_result ⇒ ::Google::Cloud::Dataplex::V1::DataDiscoveryResult (readonly)

Returns Output only. The result of a data discovery scan.

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_discovery_spec ⇒ ::Google::Cloud::Dataplex::V1::DataDiscoverySpec

Returns Settings for a data discovery scan.

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_profile_result ⇒ ::Google::Cloud::Dataplex::V1::DataProfileResult (readonly)

Returns Output only. The result of a data profile scan.

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_profile_spec ⇒ ::Google::Cloud::Dataplex::V1::DataProfileSpec

Returns Settings for a data profile scan.

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_quality_result ⇒ ::Google::Cloud::Dataplex::V1::DataQualityResult (readonly)

Returns Output only. The result of a data quality scan.

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_quality_spec ⇒ ::Google::Cloud::Dataplex::V1::DataQualitySpec

Returns Settings for a data quality scan.

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns Optional. Description of the scan.

  • Must be between 1-1024 characters.

Returns:

  • (::String) —

    Optional. Description of the scan.

    • Must be between 1-1024 characters.


359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Optional. User friendly display name.

  • Must be between 1-256 characters.

Returns:

  • (::String) —

    Optional. User friendly display name.

    • Must be between 1-256 characters.


359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#execution_spec ⇒ ::Google::Cloud::Dataplex::V1::DataScan::ExecutionSpec

Returns Optional. DataScan execution settings.

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

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#execution_status ⇒ ::Google::Cloud::Dataplex::V1::DataScan::ExecutionStatus (readonly)

Returns Output only. Status of the data scan execution.

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. User-defined labels for the scan.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. User-defined labels for the scan.



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

Returns 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.

Returns:

  • (::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.



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#state ⇒ ::Google::Cloud::Dataplex::V1::State (readonly)

Returns Output only. Current state of the DataScan.

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#type ⇒ ::Google::Cloud::Dataplex::V1::DataScanType (readonly)

Returns Output only. The type of DataScan.

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#uid ⇒ ::String (readonly)

Returns 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.

Returns:

  • (::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.



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 359

class DataScan
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # DataScan execution settings.
  # @!attribute [rw] trigger
  #   @return [::Google::Cloud::Dataplex::V1::Trigger]
  #     Optional. Spec related to how often and when a scan should be triggered.
  #
  #     If not specified, the default is `OnDemand`, which means the scan will
  #     not run until the user calls `RunDataScan` API.
  # @!attribute [rw] field
  #   @return [::String]
  #     Immutable. The unnested field (of type *Date* or *Timestamp*) that
  #     contains values which monotonically increase over time.
  #
  #     If not specified, a data scan will run for all data in the table.
  class ExecutionSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Status of the data scan execution.
  # @!attribute [rw] latest_job_start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob started.
  # @!attribute [rw] latest_job_end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time when the latest DataScanJob ended.
  # @!attribute [rw] latest_job_create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The time when the DataScanJob execution was created.
  class ExecutionStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end