Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.DataScansResource

The "dataScans" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.DataScansResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudDataplex.v1
Assembly: Google.Apis.CloudDataplex.v1.dll
Syntax
public class ProjectsResource.LocationsResource.DataScansResource

Constructors

DataScansResource(IClientService)

Constructs a new resource.

Declaration
public DataScansResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Jobs

Gets the Jobs resource.

Declaration
public virtual ProjectsResource.LocationsResource.DataScansResource.JobsResource Jobs { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.DataScansResource.JobsResource

Methods

Create(GoogleCloudDataplexV1DataScan, string)

Creates a DataScan resource.

Declaration
public virtual ProjectsResource.LocationsResource.DataScansResource.CreateRequest Create(GoogleCloudDataplexV1DataScan body, string parent)
Parameters
Type Name Description
GoogleCloudDataplexV1DataScan body

The body of the request.

string parent

Required. The resource name of the parent location: projects/{project}/locations/{location_id} where project refers to a project_id or project_number and location_id refers to a GCP region.

Returns
Type Description
ProjectsResource.LocationsResource.DataScansResource.CreateRequest

Delete(string)

Deletes a DataScan resource.

Declaration
public virtual ProjectsResource.LocationsResource.DataScansResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The resource name of the dataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where project refers to a project_id or project_number and location_id refers to a GCP region.

Returns
Type Description
ProjectsResource.LocationsResource.DataScansResource.DeleteRequest

GenerateDataQualityRules(GoogleCloudDataplexV1GenerateDataQualityRulesRequest, string)

Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.

Declaration
public virtual ProjectsResource.LocationsResource.DataScansResource.GenerateDataQualityRulesRequest GenerateDataQualityRules(GoogleCloudDataplexV1GenerateDataQualityRulesRequest body, string name)
Parameters
Type Name Description
GoogleCloudDataplexV1GenerateDataQualityRulesRequest body

The body of the request.

string name

Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling)

Returns
Type Description
ProjectsResource.LocationsResource.DataScansResource.GenerateDataQualityRulesRequest

Get(string)

Gets a DataScan resource.

Declaration
public virtual ProjectsResource.LocationsResource.DataScansResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The resource name of the dataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where project refers to a project_id or project_number and location_id refers to a GCP region.

Returns
Type Description
ProjectsResource.LocationsResource.DataScansResource.GetRequest

GetIamPolicy(string)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Declaration
public virtual ProjectsResource.LocationsResource.DataScansResource.GetIamPolicyRequest GetIamPolicy(string resource)
Parameters
Type Name Description
string resource

REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.DataScansResource.GetIamPolicyRequest

List(string)

Lists DataScans.

Declaration
public virtual ProjectsResource.LocationsResource.DataScansResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The resource name of the parent location: projects/{project}/locations/{location_id} where project refers to a project_id or project_number and location_id refers to a GCP region.

Returns
Type Description
ProjectsResource.LocationsResource.DataScansResource.ListRequest

Patch(GoogleCloudDataplexV1DataScan, string)

Updates a DataScan resource.

Declaration
public virtual ProjectsResource.LocationsResource.DataScansResource.PatchRequest Patch(GoogleCloudDataplexV1DataScan body, string name)
Parameters
Type Name Description
GoogleCloudDataplexV1DataScan body

The body of the request.

string name

Output only. Identifier. 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
Type Description
ProjectsResource.LocationsResource.DataScansResource.PatchRequest

Run(GoogleCloudDataplexV1RunDataScanRequest, string)

Runs an on-demand execution of a DataScan

Declaration
public virtual ProjectsResource.LocationsResource.DataScansResource.RunRequest Run(GoogleCloudDataplexV1RunDataScanRequest body, string name)
Parameters
Type Name Description
GoogleCloudDataplexV1RunDataScanRequest body

The body of the request.

string name

Required. The resource name of the DataScan: projects/{project}/locations/{location_id}/dataScans/{data_scan_id}. where project refers to a project_id or project_number and location_id refers to a GCP region.Only OnDemand data scans are allowed.

Returns
Type Description
ProjectsResource.LocationsResource.DataScansResource.RunRequest

SetIamPolicy(GoogleIamV1SetIamPolicyRequest, string)

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Declaration
public virtual ProjectsResource.LocationsResource.DataScansResource.SetIamPolicyRequest SetIamPolicy(GoogleIamV1SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
GoogleIamV1SetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.DataScansResource.SetIamPolicyRequest

TestIamPermissions(GoogleIamV1TestIamPermissionsRequest, string)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Declaration
public virtual ProjectsResource.LocationsResource.DataScansResource.TestIamPermissionsRequest TestIamPermissions(GoogleIamV1TestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
GoogleIamV1TestIamPermissionsRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.DataScansResource.TestIamPermissionsRequest
In this article
Back to top Generated by DocFX