Oracle Cloud Infrastructure

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

getDiscoveryJobsResult

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

Gets the details of the specified discovery result.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testDiscoveryJobsResult = Output.Create(Oci.DataSafe.GetDiscoveryJobsResult.InvokeAsync(new Oci.DataSafe.GetDiscoveryJobsResultArgs
        {
            DiscoveryJobId = oci_data_safe_discovery_job.Test_discovery_job.Id,
            ResultKey = @var.Discovery_jobs_result_result_key,
        }));
    }

}
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.GetDiscoveryJobsResult(ctx, &datasafe.GetDiscoveryJobsResultArgs{
			DiscoveryJobId: oci_data_safe_discovery_job.Test_discovery_job.Id,
			ResultKey:      _var.Discovery_jobs_result_result_key,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_discovery_jobs_result = oci.DataSafe.get_discovery_jobs_result(discovery_job_id=oci_data_safe_discovery_job["test_discovery_job"]["id"],
    result_key=var["discovery_jobs_result_result_key"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDiscoveryJobsResult = oci.DataSafe.getDiscoveryJobsResult({
    discoveryJobId: oci_data_safe_discovery_job.test_discovery_job.id,
    resultKey: _var.discovery_jobs_result_result_key,
});

Coming soon!

Using getDiscoveryJobsResult

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 getDiscoveryJobsResult(args: GetDiscoveryJobsResultArgs, opts?: InvokeOptions): Promise<GetDiscoveryJobsResultResult>
function getDiscoveryJobsResultOutput(args: GetDiscoveryJobsResultOutputArgs, opts?: InvokeOptions): Output<GetDiscoveryJobsResultResult>
def get_discovery_jobs_result(discovery_job_id: Optional[str] = None,
                              result_key: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetDiscoveryJobsResultResult
def get_discovery_jobs_result_output(discovery_job_id: Optional[pulumi.Input[str]] = None,
                              result_key: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetDiscoveryJobsResultResult]
func GetDiscoveryJobsResult(ctx *Context, args *GetDiscoveryJobsResultArgs, opts ...InvokeOption) (*GetDiscoveryJobsResultResult, error)
func GetDiscoveryJobsResultOutput(ctx *Context, args *GetDiscoveryJobsResultOutputArgs, opts ...InvokeOption) GetDiscoveryJobsResultResultOutput

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

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

The following arguments are supported:

DiscoveryJobId string

The OCID of the discovery job.

ResultKey string

The unique key that identifies the discovery result.

DiscoveryJobId string

The OCID of the discovery job.

ResultKey string

The unique key that identifies the discovery result.

discoveryJobId String

The OCID of the discovery job.

resultKey String

The unique key that identifies the discovery result.

discoveryJobId string

The OCID of the discovery job.

resultKey string

The unique key that identifies the discovery result.

discovery_job_id str

The OCID of the discovery job.

result_key str

The unique key that identifies the discovery result.

discoveryJobId String

The OCID of the discovery job.

resultKey String

The unique key that identifies the discovery result.

getDiscoveryJobsResult Result

The following output properties are available:

AppDefinedChildColumnKeys List<string>

Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

AppName string

The name of the application. An application is an entity that is identified by a schema and stores sensitive information for that schema. Its value will be same as schemaName, if no value is passed.

ColumnName string

The name of the sensitive column.

DataType string

The data type of the sensitive column.

DbDefinedChildColumnKeys List<string>

Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

DiscoveryJobId string
DiscoveryType string

The type of the discovery result. It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified.

EstimatedDataValueCount string

The estimated number of data values the column has in the associated database.

Id string
IsResultApplied bool

Indicates if the discovery result has been processed. You can update this attribute using the PatchDiscoveryJobResults operation to track whether the discovery result has already been processed and applied to the sensitive data model.

Key string

The unique key that identifies the discovery result.

ModifiedAttributes List<GetDiscoveryJobsResultModifiedAttribute>

The attributes of a sensitive column that have been modified in the target database. It's populated only in the case of MODIFIED discovery results and shows the new values of the modified attributes.

Object string

The database object that contains the sensitive column.

ObjectType string

The type of the database object that contains the sensitive column.

ParentColumnKeys List<string>

Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.

PlannedAction string

Specifies how to process the discovery result. It's set to NONE by default. Use the PatchDiscoveryJobResults operation to update this attribute. You can choose one of the following options: ACCEPT: To accept the discovery result and update the sensitive data model to reflect the changes. REJECT: To reject the discovery result so that it doesn't change the sensitive data model. INVALIDATE: To invalidate a newly discovered column. It adds the column to the sensitive data model but marks it as invalid. It helps track false positives and ensure that they aren't reported by future discovery jobs. After specifying the planned action, you can use the ApplyDiscoveryJobResults operation to automatically process the discovery results.

RelationType string

The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.

ResultKey string
SampleDataValues List<string>

Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.

SchemaName string

The database schema that contains the sensitive column.

SensitiveColumnkey string

The unique key that identifies the sensitive column represented by the discovery result.

SensitiveTypeId string

The OCID of the sensitive type associated with the sensitive column.

AppDefinedChildColumnKeys []string

Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

AppName string

The name of the application. An application is an entity that is identified by a schema and stores sensitive information for that schema. Its value will be same as schemaName, if no value is passed.

ColumnName string

The name of the sensitive column.

DataType string

The data type of the sensitive column.

DbDefinedChildColumnKeys []string

Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

DiscoveryJobId string
DiscoveryType string

The type of the discovery result. It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified.

EstimatedDataValueCount string

The estimated number of data values the column has in the associated database.

Id string
IsResultApplied bool

Indicates if the discovery result has been processed. You can update this attribute using the PatchDiscoveryJobResults operation to track whether the discovery result has already been processed and applied to the sensitive data model.

Key string

The unique key that identifies the discovery result.

ModifiedAttributes []GetDiscoveryJobsResultModifiedAttribute

The attributes of a sensitive column that have been modified in the target database. It's populated only in the case of MODIFIED discovery results and shows the new values of the modified attributes.

Object string

The database object that contains the sensitive column.

ObjectType string

The type of the database object that contains the sensitive column.

ParentColumnKeys []string

Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.

PlannedAction string

Specifies how to process the discovery result. It's set to NONE by default. Use the PatchDiscoveryJobResults operation to update this attribute. You can choose one of the following options: ACCEPT: To accept the discovery result and update the sensitive data model to reflect the changes. REJECT: To reject the discovery result so that it doesn't change the sensitive data model. INVALIDATE: To invalidate a newly discovered column. It adds the column to the sensitive data model but marks it as invalid. It helps track false positives and ensure that they aren't reported by future discovery jobs. After specifying the planned action, you can use the ApplyDiscoveryJobResults operation to automatically process the discovery results.

RelationType string

The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.

ResultKey string
SampleDataValues []string

Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.

SchemaName string

The database schema that contains the sensitive column.

SensitiveColumnkey string

The unique key that identifies the sensitive column represented by the discovery result.

SensitiveTypeId string

The OCID of the sensitive type associated with the sensitive column.

appDefinedChildColumnKeys List<String>

Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

appName String

The name of the application. An application is an entity that is identified by a schema and stores sensitive information for that schema. Its value will be same as schemaName, if no value is passed.

columnName String

The name of the sensitive column.

dataType String

The data type of the sensitive column.

dbDefinedChildColumnKeys List<String>

Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

discoveryJobId String
discoveryType String

The type of the discovery result. It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified.

estimatedDataValueCount String

The estimated number of data values the column has in the associated database.

id String
isResultApplied Boolean

Indicates if the discovery result has been processed. You can update this attribute using the PatchDiscoveryJobResults operation to track whether the discovery result has already been processed and applied to the sensitive data model.

key String

The unique key that identifies the discovery result.

modifiedAttributes List<GetDiscoveryJobsResultModifiedAttribute>

The attributes of a sensitive column that have been modified in the target database. It's populated only in the case of MODIFIED discovery results and shows the new values of the modified attributes.

object String

The database object that contains the sensitive column.

objectType String

The type of the database object that contains the sensitive column.

parentColumnKeys List<String>

Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.

plannedAction String

Specifies how to process the discovery result. It's set to NONE by default. Use the PatchDiscoveryJobResults operation to update this attribute. You can choose one of the following options: ACCEPT: To accept the discovery result and update the sensitive data model to reflect the changes. REJECT: To reject the discovery result so that it doesn't change the sensitive data model. INVALIDATE: To invalidate a newly discovered column. It adds the column to the sensitive data model but marks it as invalid. It helps track false positives and ensure that they aren't reported by future discovery jobs. After specifying the planned action, you can use the ApplyDiscoveryJobResults operation to automatically process the discovery results.

relationType String

The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.

resultKey String
sampleDataValues List<String>

Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.

schemaName String

The database schema that contains the sensitive column.

sensitiveColumnkey String

The unique key that identifies the sensitive column represented by the discovery result.

sensitiveTypeId String

The OCID of the sensitive type associated with the sensitive column.

appDefinedChildColumnKeys string[]

Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

appName string

The name of the application. An application is an entity that is identified by a schema and stores sensitive information for that schema. Its value will be same as schemaName, if no value is passed.

columnName string

The name of the sensitive column.

dataType string

The data type of the sensitive column.

dbDefinedChildColumnKeys string[]

Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

discoveryJobId string
discoveryType string

The type of the discovery result. It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified.

estimatedDataValueCount string

The estimated number of data values the column has in the associated database.

id string
isResultApplied boolean

Indicates if the discovery result has been processed. You can update this attribute using the PatchDiscoveryJobResults operation to track whether the discovery result has already been processed and applied to the sensitive data model.

key string

The unique key that identifies the discovery result.

modifiedAttributes GetDiscoveryJobsResultModifiedAttribute[]

The attributes of a sensitive column that have been modified in the target database. It's populated only in the case of MODIFIED discovery results and shows the new values of the modified attributes.

object string

The database object that contains the sensitive column.

objectType string

The type of the database object that contains the sensitive column.

parentColumnKeys string[]

Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.

plannedAction string

Specifies how to process the discovery result. It's set to NONE by default. Use the PatchDiscoveryJobResults operation to update this attribute. You can choose one of the following options: ACCEPT: To accept the discovery result and update the sensitive data model to reflect the changes. REJECT: To reject the discovery result so that it doesn't change the sensitive data model. INVALIDATE: To invalidate a newly discovered column. It adds the column to the sensitive data model but marks it as invalid. It helps track false positives and ensure that they aren't reported by future discovery jobs. After specifying the planned action, you can use the ApplyDiscoveryJobResults operation to automatically process the discovery results.

relationType string

The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.

resultKey string
sampleDataValues string[]

Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.

schemaName string

The database schema that contains the sensitive column.

sensitiveColumnkey string

The unique key that identifies the sensitive column represented by the discovery result.

sensitiveTypeId string

The OCID of the sensitive type associated with the sensitive column.

app_defined_child_column_keys Sequence[str]

Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

app_name str

The name of the application. An application is an entity that is identified by a schema and stores sensitive information for that schema. Its value will be same as schemaName, if no value is passed.

column_name str

The name of the sensitive column.

data_type str

The data type of the sensitive column.

db_defined_child_column_keys Sequence[str]

Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

discovery_job_id str
discovery_type str

The type of the discovery result. It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified.

estimated_data_value_count str

The estimated number of data values the column has in the associated database.

id str
is_result_applied bool

Indicates if the discovery result has been processed. You can update this attribute using the PatchDiscoveryJobResults operation to track whether the discovery result has already been processed and applied to the sensitive data model.

key str

The unique key that identifies the discovery result.

modified_attributes GetDiscoveryJobsResultModifiedAttribute]

The attributes of a sensitive column that have been modified in the target database. It's populated only in the case of MODIFIED discovery results and shows the new values of the modified attributes.

object str

The database object that contains the sensitive column.

object_type str

The type of the database object that contains the sensitive column.

parent_column_keys Sequence[str]

Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.

planned_action str

Specifies how to process the discovery result. It's set to NONE by default. Use the PatchDiscoveryJobResults operation to update this attribute. You can choose one of the following options: ACCEPT: To accept the discovery result and update the sensitive data model to reflect the changes. REJECT: To reject the discovery result so that it doesn't change the sensitive data model. INVALIDATE: To invalidate a newly discovered column. It adds the column to the sensitive data model but marks it as invalid. It helps track false positives and ensure that they aren't reported by future discovery jobs. After specifying the planned action, you can use the ApplyDiscoveryJobResults operation to automatically process the discovery results.

relation_type str

The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.

result_key str
sample_data_values Sequence[str]

Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.

schema_name str

The database schema that contains the sensitive column.

sensitive_columnkey str

The unique key that identifies the sensitive column represented by the discovery result.

sensitive_type_id str

The OCID of the sensitive type associated with the sensitive column.

appDefinedChildColumnKeys List<String>

Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

appName String

The name of the application. An application is an entity that is identified by a schema and stores sensitive information for that schema. Its value will be same as schemaName, if no value is passed.

columnName String

The name of the sensitive column.

dataType String

The data type of the sensitive column.

dbDefinedChildColumnKeys List<String>

Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

discoveryJobId String
discoveryType String

The type of the discovery result. It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified.

estimatedDataValueCount String

The estimated number of data values the column has in the associated database.

id String
isResultApplied Boolean

Indicates if the discovery result has been processed. You can update this attribute using the PatchDiscoveryJobResults operation to track whether the discovery result has already been processed and applied to the sensitive data model.

key String

The unique key that identifies the discovery result.

modifiedAttributes List<Property Map>

The attributes of a sensitive column that have been modified in the target database. It's populated only in the case of MODIFIED discovery results and shows the new values of the modified attributes.

object String

The database object that contains the sensitive column.

objectType String

The type of the database object that contains the sensitive column.

parentColumnKeys List<String>

Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.

plannedAction String

Specifies how to process the discovery result. It's set to NONE by default. Use the PatchDiscoveryJobResults operation to update this attribute. You can choose one of the following options: ACCEPT: To accept the discovery result and update the sensitive data model to reflect the changes. REJECT: To reject the discovery result so that it doesn't change the sensitive data model. INVALIDATE: To invalidate a newly discovered column. It adds the column to the sensitive data model but marks it as invalid. It helps track false positives and ensure that they aren't reported by future discovery jobs. After specifying the planned action, you can use the ApplyDiscoveryJobResults operation to automatically process the discovery results.

relationType String

The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.

resultKey String
sampleDataValues List<String>

Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.

schemaName String

The database schema that contains the sensitive column.

sensitiveColumnkey String

The unique key that identifies the sensitive column represented by the discovery result.

sensitiveTypeId String

The OCID of the sensitive type associated with the sensitive column.

Supporting Types

GetDiscoveryJobsResultModifiedAttribute

AppDefinedChildColumnKeys List<string>

Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

DbDefinedChildColumnKeys List<string>

Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

AppDefinedChildColumnKeys []string

Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

DbDefinedChildColumnKeys []string

Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

appDefinedChildColumnKeys List<String>

Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

dbDefinedChildColumnKeys List<String>

Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

appDefinedChildColumnKeys string[]

Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

dbDefinedChildColumnKeys string[]

Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

app_defined_child_column_keys Sequence[str]

Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

db_defined_child_column_keys Sequence[str]

Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

appDefinedChildColumnKeys List<String>

Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

dbDefinedChildColumnKeys List<String>

Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

Package Details

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

This Pulumi package is based on the oci Terraform Provider.