Class: Google::Cloud::Dataplex::V1::DataScanJob

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

Overview

A DataScanJob represents an instance of DataScan execution.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

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

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

Returns:



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 452

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

  # Execution state for the DataScanJob.
  module State
    # The DataScanJob state is unspecified.
    STATE_UNSPECIFIED = 0

    # The DataScanJob is running.
    RUNNING = 1

    # The DataScanJob is canceling.
    CANCELING = 2

    # The DataScanJob cancellation was successful.
    CANCELLED = 3

    # The DataScanJob completed successfully.
    SUCCEEDED = 4

    # The DataScanJob is no longer running due to an error.
    FAILED = 5

    # The DataScanJob has been created but not started to run yet.
    PENDING = 7
  end
end

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

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

Returns:



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 452

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

  # Execution state for the DataScanJob.
  module State
    # The DataScanJob state is unspecified.
    STATE_UNSPECIFIED = 0

    # The DataScanJob is running.
    RUNNING = 1

    # The DataScanJob is canceling.
    CANCELING = 2

    # The DataScanJob cancellation was successful.
    CANCELLED = 3

    # The DataScanJob completed successfully.
    SUCCEEDED = 4

    # The DataScanJob is no longer running due to an error.
    FAILED = 5

    # The DataScanJob has been created but not started to run yet.
    PENDING = 7
  end
end

#data_discovery_spec ⇒ ::Google::Cloud::Dataplex::V1::DataDiscoverySpec (readonly)

Returns Output only. Settings for a data discovery scan.

Returns:



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 452

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

  # Execution state for the DataScanJob.
  module State
    # The DataScanJob state is unspecified.
    STATE_UNSPECIFIED = 0

    # The DataScanJob is running.
    RUNNING = 1

    # The DataScanJob is canceling.
    CANCELING = 2

    # The DataScanJob cancellation was successful.
    CANCELLED = 3

    # The DataScanJob completed successfully.
    SUCCEEDED = 4

    # The DataScanJob is no longer running due to an error.
    FAILED = 5

    # The DataScanJob has been created but not started to run yet.
    PENDING = 7
  end
end

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

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

Returns:



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 452

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

  # Execution state for the DataScanJob.
  module State
    # The DataScanJob state is unspecified.
    STATE_UNSPECIFIED = 0

    # The DataScanJob is running.
    RUNNING = 1

    # The DataScanJob is canceling.
    CANCELING = 2

    # The DataScanJob cancellation was successful.
    CANCELLED = 3

    # The DataScanJob completed successfully.
    SUCCEEDED = 4

    # The DataScanJob is no longer running due to an error.
    FAILED = 5

    # The DataScanJob has been created but not started to run yet.
    PENDING = 7
  end
end

#data_profile_spec ⇒ ::Google::Cloud::Dataplex::V1::DataProfileSpec (readonly)

Returns Output only. Settings for a data profile scan.

Returns:



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 452

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

  # Execution state for the DataScanJob.
  module State
    # The DataScanJob state is unspecified.
    STATE_UNSPECIFIED = 0

    # The DataScanJob is running.
    RUNNING = 1

    # The DataScanJob is canceling.
    CANCELING = 2

    # The DataScanJob cancellation was successful.
    CANCELLED = 3

    # The DataScanJob completed successfully.
    SUCCEEDED = 4

    # The DataScanJob is no longer running due to an error.
    FAILED = 5

    # The DataScanJob has been created but not started to run yet.
    PENDING = 7
  end
end

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

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

Returns:



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 452

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

  # Execution state for the DataScanJob.
  module State
    # The DataScanJob state is unspecified.
    STATE_UNSPECIFIED = 0

    # The DataScanJob is running.
    RUNNING = 1

    # The DataScanJob is canceling.
    CANCELING = 2

    # The DataScanJob cancellation was successful.
    CANCELLED = 3

    # The DataScanJob completed successfully.
    SUCCEEDED = 4

    # The DataScanJob is no longer running due to an error.
    FAILED = 5

    # The DataScanJob has been created but not started to run yet.
    PENDING = 7
  end
end

#data_quality_spec ⇒ ::Google::Cloud::Dataplex::V1::DataQualitySpec (readonly)

Returns Output only. Settings for a data quality scan.

Returns:



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 452

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

  # Execution state for the DataScanJob.
  module State
    # The DataScanJob state is unspecified.
    STATE_UNSPECIFIED = 0

    # The DataScanJob is running.
    RUNNING = 1

    # The DataScanJob is canceling.
    CANCELING = 2

    # The DataScanJob cancellation was successful.
    CANCELLED = 3

    # The DataScanJob completed successfully.
    SUCCEEDED = 4

    # The DataScanJob is no longer running due to an error.
    FAILED = 5

    # The DataScanJob has been created but not started to run yet.
    PENDING = 7
  end
end

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

Returns Output only. The time when the DataScanJob ended.

Returns:



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 452

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

  # Execution state for the DataScanJob.
  module State
    # The DataScanJob state is unspecified.
    STATE_UNSPECIFIED = 0

    # The DataScanJob is running.
    RUNNING = 1

    # The DataScanJob is canceling.
    CANCELING = 2

    # The DataScanJob cancellation was successful.
    CANCELLED = 3

    # The DataScanJob completed successfully.
    SUCCEEDED = 4

    # The DataScanJob is no longer running due to an error.
    FAILED = 5

    # The DataScanJob has been created but not started to run yet.
    PENDING = 7
  end
end

#message ⇒ ::String (readonly)

Returns Output only. Additional information about the current state.

Returns:

  • (::String) —

    Output only. Additional information about the current state.



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 452

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

  # Execution state for the DataScanJob.
  module State
    # The DataScanJob state is unspecified.
    STATE_UNSPECIFIED = 0

    # The DataScanJob is running.
    RUNNING = 1

    # The DataScanJob is canceling.
    CANCELING = 2

    # The DataScanJob cancellation was successful.
    CANCELLED = 3

    # The DataScanJob completed successfully.
    SUCCEEDED = 4

    # The DataScanJob is no longer running due to an error.
    FAILED = 5

    # The DataScanJob has been created but not started to run yet.
    PENDING = 7
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_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 DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 452

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

  # Execution state for the DataScanJob.
  module State
    # The DataScanJob state is unspecified.
    STATE_UNSPECIFIED = 0

    # The DataScanJob is running.
    RUNNING = 1

    # The DataScanJob is canceling.
    CANCELING = 2

    # The DataScanJob cancellation was successful.
    CANCELLED = 3

    # The DataScanJob completed successfully.
    SUCCEEDED = 4

    # The DataScanJob is no longer running due to an error.
    FAILED = 5

    # The DataScanJob has been created but not started to run yet.
    PENDING = 7
  end
end

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

Returns Output only. The time when the DataScanJob was started.

Returns:



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 452

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

  # Execution state for the DataScanJob.
  module State
    # The DataScanJob state is unspecified.
    STATE_UNSPECIFIED = 0

    # The DataScanJob is running.
    RUNNING = 1

    # The DataScanJob is canceling.
    CANCELING = 2

    # The DataScanJob cancellation was successful.
    CANCELLED = 3

    # The DataScanJob completed successfully.
    SUCCEEDED = 4

    # The DataScanJob is no longer running due to an error.
    FAILED = 5

    # The DataScanJob has been created but not started to run yet.
    PENDING = 7
  end
end

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

Returns Output only. Execution state for the DataScanJob.

Returns:



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 452

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

  # Execution state for the DataScanJob.
  module State
    # The DataScanJob state is unspecified.
    STATE_UNSPECIFIED = 0

    # The DataScanJob is running.
    RUNNING = 1

    # The DataScanJob is canceling.
    CANCELING = 2

    # The DataScanJob cancellation was successful.
    CANCELLED = 3

    # The DataScanJob completed successfully.
    SUCCEEDED = 4

    # The DataScanJob is no longer running due to an error.
    FAILED = 5

    # The DataScanJob has been created but not started to run yet.
    PENDING = 7
  end
end

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

Returns Output only. The type of the parent DataScan.

Returns:



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 452

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

  # Execution state for the DataScanJob.
  module State
    # The DataScanJob state is unspecified.
    STATE_UNSPECIFIED = 0

    # The DataScanJob is running.
    RUNNING = 1

    # The DataScanJob is canceling.
    CANCELING = 2

    # The DataScanJob cancellation was successful.
    CANCELLED = 3

    # The DataScanJob completed successfully.
    SUCCEEDED = 4

    # The DataScanJob is no longer running due to an error.
    FAILED = 5

    # The DataScanJob has been created but not started to run yet.
    PENDING = 7
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. System generated globally unique ID for the DataScanJob.

Returns:

  • (::String) —

    Output only. System generated globally unique ID for the DataScanJob.



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'proto_docs/google/cloud/dataplex/v1/datascans.rb', line 452

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

  # Execution state for the DataScanJob.
  module State
    # The DataScanJob state is unspecified.
    STATE_UNSPECIFIED = 0

    # The DataScanJob is running.
    RUNNING = 1

    # The DataScanJob is canceling.
    CANCELING = 2

    # The DataScanJob cancellation was successful.
    CANCELLED = 3

    # The DataScanJob completed successfully.
    SUCCEEDED = 4

    # The DataScanJob is no longer running due to an error.
    FAILED = 5

    # The DataScanJob has been created but not started to run yet.
    PENDING = 7
  end
end