Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getDiscoveryJob

This data source provides details about a specific Discovery Job resource in Oracle Cloud Infrastructure Data Safe service.

Gets the details of the specified discovery job.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testDiscoveryJob = Output.Create(Oci.DataSafe.GetDiscoveryJob.InvokeAsync(new Oci.DataSafe.GetDiscoveryJobArgs
        {
            DiscoveryJobId = oci_data_safe_discovery_job.Test_discovery_job.Id,
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/DataSafe"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataSafe.GetDiscoveryJob(ctx, &datasafe.GetDiscoveryJobArgs{
			DiscoveryJobId: oci_data_safe_discovery_job.Test_discovery_job.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_discovery_job = oci.DataSafe.get_discovery_job(discovery_job_id=oci_data_safe_discovery_job["test_discovery_job"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDiscoveryJob = oci.DataSafe.getDiscoveryJob({
    discoveryJobId: oci_data_safe_discovery_job.test_discovery_job.id,
});

Coming soon!

Using getDiscoveryJob

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDiscoveryJob(args: GetDiscoveryJobArgs, opts?: InvokeOptions): Promise<GetDiscoveryJobResult>
function getDiscoveryJobOutput(args: GetDiscoveryJobOutputArgs, opts?: InvokeOptions): Output<GetDiscoveryJobResult>
def get_discovery_job(discovery_job_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetDiscoveryJobResult
def get_discovery_job_output(discovery_job_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetDiscoveryJobResult]
func GetDiscoveryJob(ctx *Context, args *GetDiscoveryJobArgs, opts ...InvokeOption) (*GetDiscoveryJobResult, error)
func GetDiscoveryJobOutput(ctx *Context, args *GetDiscoveryJobOutputArgs, opts ...InvokeOption) GetDiscoveryJobResultOutput

> Note: This function is named GetDiscoveryJob in the Go SDK.

public static class GetDiscoveryJob 
{
    public static Task<GetDiscoveryJobResult> InvokeAsync(GetDiscoveryJobArgs args, InvokeOptions? opts = null)
    public static Output<GetDiscoveryJobResult> Invoke(GetDiscoveryJobInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDiscoveryJobResult> getDiscoveryJob(GetDiscoveryJobArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:DataSafe/getDiscoveryJob:getDiscoveryJob
  Arguments:
    # Arguments dictionary

The following arguments are supported:

DiscoveryJobId string

The OCID of the discovery job.

DiscoveryJobId string

The OCID of the discovery job.

discoveryJobId String

The OCID of the discovery job.

discoveryJobId string

The OCID of the discovery job.

discovery_job_id str

The OCID of the discovery job.

discoveryJobId String

The OCID of the discovery job.

getDiscoveryJob Result

The following output properties are available:

CompartmentId string

The OCID of the compartment that contains the discovery job.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

DiscoveryJobId string
DiscoveryType string

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

DisplayName string

The display name of the discovery job.

FreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

Id string

The OCID of the discovery job.

IsAppDefinedRelationDiscoveryEnabled bool

Indicates if the discovery job should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.

IsIncludeAllSchemas bool

Indicates if all the schemas in the associated target database are used for data discovery. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used.

IsIncludeAllSensitiveTypes bool

Indicates if all the existing sensitive types are used for data discovery. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used.

IsSampleDataCollectionEnabled bool

Indicates if the discovery job should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.

SchemasForDiscoveries List<string>

The schemas used for data discovery.

SensitiveDataModelId string

The OCID of the sensitive data model associated with the discovery job.

SensitiveTypeIdsForDiscoveries List<string>

The OCIDs of the sensitive types used for data discovery.

State string

The current state of the discovery job.

SystemTags Dictionary<string, object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TargetId string

The OCID of the target database associated with the discovery job.

TimeFinished string

The date and time the discovery job finished, in the format defined by RFC3339..

TimeStarted string

The date and time the discovery job started, in the format defined by RFC3339.

TotalColumnsScanned string

The total number of columns scanned by the discovery job.

TotalDeletedSensitiveColumns string

The total number of deleted sensitive columns identified by the discovery job.

TotalModifiedSensitiveColumns string

The total number of modified sensitive columns identified by the discovery job.

TotalNewSensitiveColumns string

The total number of new sensitive columns identified by the discovery job.

TotalObjectsScanned string

The total number of objects (tables and editioning views) scanned by the discovery job.

TotalSchemasScanned string

The total number of schemas scanned by the discovery job.

CompartmentId string

The OCID of the compartment that contains the discovery job.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

DiscoveryJobId string
DiscoveryType string

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

DisplayName string

The display name of the discovery job.

FreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

Id string

The OCID of the discovery job.

IsAppDefinedRelationDiscoveryEnabled bool

Indicates if the discovery job should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.

IsIncludeAllSchemas bool

Indicates if all the schemas in the associated target database are used for data discovery. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used.

IsIncludeAllSensitiveTypes bool

Indicates if all the existing sensitive types are used for data discovery. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used.

IsSampleDataCollectionEnabled bool

Indicates if the discovery job should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.

SchemasForDiscoveries []string

The schemas used for data discovery.

SensitiveDataModelId string

The OCID of the sensitive data model associated with the discovery job.

SensitiveTypeIdsForDiscoveries []string

The OCIDs of the sensitive types used for data discovery.

State string

The current state of the discovery job.

SystemTags map[string]interface{}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TargetId string

The OCID of the target database associated with the discovery job.

TimeFinished string

The date and time the discovery job finished, in the format defined by RFC3339..

TimeStarted string

The date and time the discovery job started, in the format defined by RFC3339.

TotalColumnsScanned string

The total number of columns scanned by the discovery job.

TotalDeletedSensitiveColumns string

The total number of deleted sensitive columns identified by the discovery job.

TotalModifiedSensitiveColumns string

The total number of modified sensitive columns identified by the discovery job.

TotalNewSensitiveColumns string

The total number of new sensitive columns identified by the discovery job.

TotalObjectsScanned string

The total number of objects (tables and editioning views) scanned by the discovery job.

TotalSchemasScanned string

The total number of schemas scanned by the discovery job.

compartmentId String

The OCID of the compartment that contains the discovery job.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

discoveryJobId String
discoveryType String

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

displayName String

The display name of the discovery job.

freeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

id String

The OCID of the discovery job.

isAppDefinedRelationDiscoveryEnabled Boolean

Indicates if the discovery job should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.

isIncludeAllSchemas Boolean

Indicates if all the schemas in the associated target database are used for data discovery. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used.

isIncludeAllSensitiveTypes Boolean

Indicates if all the existing sensitive types are used for data discovery. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used.

isSampleDataCollectionEnabled Boolean

Indicates if the discovery job should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.

schemasForDiscoveries List<String>

The schemas used for data discovery.

sensitiveDataModelId String

The OCID of the sensitive data model associated with the discovery job.

sensitiveTypeIdsForDiscoveries List<String>

The OCIDs of the sensitive types used for data discovery.

state String

The current state of the discovery job.

systemTags Map<String,Object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

targetId String

The OCID of the target database associated with the discovery job.

timeFinished String

The date and time the discovery job finished, in the format defined by RFC3339..

timeStarted String

The date and time the discovery job started, in the format defined by RFC3339.

totalColumnsScanned String

The total number of columns scanned by the discovery job.

totalDeletedSensitiveColumns String

The total number of deleted sensitive columns identified by the discovery job.

totalModifiedSensitiveColumns String

The total number of modified sensitive columns identified by the discovery job.

totalNewSensitiveColumns String

The total number of new sensitive columns identified by the discovery job.

totalObjectsScanned String

The total number of objects (tables and editioning views) scanned by the discovery job.

totalSchemasScanned String

The total number of schemas scanned by the discovery job.

compartmentId string

The OCID of the compartment that contains the discovery job.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

discoveryJobId string
discoveryType string

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

displayName string

The display name of the discovery job.

freeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

id string

The OCID of the discovery job.

isAppDefinedRelationDiscoveryEnabled boolean

Indicates if the discovery job should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.

isIncludeAllSchemas boolean

Indicates if all the schemas in the associated target database are used for data discovery. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used.

isIncludeAllSensitiveTypes boolean

Indicates if all the existing sensitive types are used for data discovery. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used.

isSampleDataCollectionEnabled boolean

Indicates if the discovery job should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.

schemasForDiscoveries string[]

The schemas used for data discovery.

sensitiveDataModelId string

The OCID of the sensitive data model associated with the discovery job.

sensitiveTypeIdsForDiscoveries string[]

The OCIDs of the sensitive types used for data discovery.

state string

The current state of the discovery job.

systemTags {[key: string]: any}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

targetId string

The OCID of the target database associated with the discovery job.

timeFinished string

The date and time the discovery job finished, in the format defined by RFC3339..

timeStarted string

The date and time the discovery job started, in the format defined by RFC3339.

totalColumnsScanned string

The total number of columns scanned by the discovery job.

totalDeletedSensitiveColumns string

The total number of deleted sensitive columns identified by the discovery job.

totalModifiedSensitiveColumns string

The total number of modified sensitive columns identified by the discovery job.

totalNewSensitiveColumns string

The total number of new sensitive columns identified by the discovery job.

totalObjectsScanned string

The total number of objects (tables and editioning views) scanned by the discovery job.

totalSchemasScanned string

The total number of schemas scanned by the discovery job.

compartment_id str

The OCID of the compartment that contains the discovery job.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

discovery_job_id str
discovery_type str

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

display_name str

The display name of the discovery job.

freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

id str

The OCID of the discovery job.

is_app_defined_relation_discovery_enabled bool

Indicates if the discovery job should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.

is_include_all_schemas bool

Indicates if all the schemas in the associated target database are used for data discovery. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used.

is_include_all_sensitive_types bool

Indicates if all the existing sensitive types are used for data discovery. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used.

is_sample_data_collection_enabled bool

Indicates if the discovery job should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.

schemas_for_discoveries Sequence[str]

The schemas used for data discovery.

sensitive_data_model_id str

The OCID of the sensitive data model associated with the discovery job.

sensitive_type_ids_for_discoveries Sequence[str]

The OCIDs of the sensitive types used for data discovery.

state str

The current state of the discovery job.

system_tags Mapping[str, Any]

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

target_id str

The OCID of the target database associated with the discovery job.

time_finished str

The date and time the discovery job finished, in the format defined by RFC3339..

time_started str

The date and time the discovery job started, in the format defined by RFC3339.

total_columns_scanned str

The total number of columns scanned by the discovery job.

total_deleted_sensitive_columns str

The total number of deleted sensitive columns identified by the discovery job.

total_modified_sensitive_columns str

The total number of modified sensitive columns identified by the discovery job.

total_new_sensitive_columns str

The total number of new sensitive columns identified by the discovery job.

total_objects_scanned str

The total number of objects (tables and editioning views) scanned by the discovery job.

total_schemas_scanned str

The total number of schemas scanned by the discovery job.

compartmentId String

The OCID of the compartment that contains the discovery job.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

discoveryJobId String
discoveryType String

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

displayName String

The display name of the discovery job.

freeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}

id String

The OCID of the discovery job.

isAppDefinedRelationDiscoveryEnabled Boolean

Indicates if the discovery job should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.

isIncludeAllSchemas Boolean

Indicates if all the schemas in the associated target database are used for data discovery. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used.

isIncludeAllSensitiveTypes Boolean

Indicates if all the existing sensitive types are used for data discovery. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used.

isSampleDataCollectionEnabled Boolean

Indicates if the discovery job should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.

schemasForDiscoveries List<String>

The schemas used for data discovery.

sensitiveDataModelId String

The OCID of the sensitive data model associated with the discovery job.

sensitiveTypeIdsForDiscoveries List<String>

The OCIDs of the sensitive types used for data discovery.

state String

The current state of the discovery job.

systemTags Map<Any>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

targetId String

The OCID of the target database associated with the discovery job.

timeFinished String

The date and time the discovery job finished, in the format defined by RFC3339..

timeStarted String

The date and time the discovery job started, in the format defined by RFC3339.

totalColumnsScanned String

The total number of columns scanned by the discovery job.

totalDeletedSensitiveColumns String

The total number of deleted sensitive columns identified by the discovery job.

totalModifiedSensitiveColumns String

The total number of modified sensitive columns identified by the discovery job.

totalNewSensitiveColumns String

The total number of new sensitive columns identified by the discovery job.

totalObjectsScanned String

The total number of objects (tables and editioning views) scanned by the discovery job.

totalSchemasScanned String

The total number of schemas scanned by the discovery job.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.