Google Cloud Dataplex V1 Client - Class Action (0.1.6)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class Action.

Action represents an issue requiring administrator action for resolution.

Generated from protobuf message google.cloud.dataplex.v1.Action

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ category
int

The category of issue associated with the action.

↳ issue
string

Detailed description of the issue requiring action.

↳ detect_time
Google\Protobuf\Timestamp

The time that the issue was detected.

↳ name
string

Output only. The relative resource name of the action, of the form: projects/{project}/locations/{location}/lakes/{lake}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}/actions/{action} .

↳ lake
string

Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id} .

↳ zone
string

Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id} .

↳ asset
string

Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id} .

↳ data_locations
string[]

The list of data locations associated with this action. Cloud Storage locations are represented as URI paths(E.g. gs://bucket/table1/year=2020/month=Jan/ ). BigQuery locations refer to resource names(E.g. bigquery.googleapis.com/projects/project-id/datasets/dataset-id ).

↳ invalid_data_format
Google\Cloud\Dataplex\V1\Action\InvalidDataFormat

Details for issues related to invalid or unsupported data formats.

↳ incompatible_data_schema
Google\Cloud\Dataplex\V1\Action\IncompatibleDataSchema

Details for issues related to incompatible schemas detected within data.

↳ invalid_data_partition
Google\Cloud\Dataplex\V1\Action\InvalidDataPartition

Details for issues related to invalid or unsupported data partition structure.

↳ missing_data
Google\Cloud\Dataplex\V1\Action\MissingData

Details for issues related to absence of data within managed resources.

↳ missing_resource
Google\Cloud\Dataplex\V1\Action\MissingResource

Details for issues related to absence of a managed resource.

↳ unauthorized_resource
Google\Cloud\Dataplex\V1\Action\UnauthorizedResource

Details for issues related to lack of permissions to access data resources.

↳ failed_security_policy_apply
Google\Cloud\Dataplex\V1\Action\FailedSecurityPolicyApply

Details for issues related to applying security policy.

↳ invalid_data_organization
Google\Cloud\Dataplex\V1\Action\InvalidDataOrganization

Details for issues related to invalid data arrangement.

getCategory

The category of issue associated with the action.

Generated from protobuf field .google.cloud.dataplex.v1.Action.Category category = 1;

Returns
Type
Description
int

setCategory

The category of issue associated with the action.

Generated from protobuf field .google.cloud.dataplex.v1.Action.Category category = 1;

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getIssue

Detailed description of the issue requiring action.

Generated from protobuf field string issue = 2;

Returns
Type
Description
string

setIssue

Detailed description of the issue requiring action.

Generated from protobuf field string issue = 2;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDetectTime

The time that the issue was detected.

Generated from protobuf field .google.protobuf.Timestamp detect_time = 4;

Returns
Type
Description
Google\Protobuf\Timestamp|null

hasDetectTime

clearDetectTime

setDetectTime

The time that the issue was detected.

Generated from protobuf field .google.protobuf.Timestamp detect_time = 4;

Parameter
Name
Description
var
Google\Protobuf\Timestamp
Returns
Type
Description
$this

getName

Output only. The relative resource name of the action, of the form: projects/{project}/locations/{location}/lakes/{lake}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}/actions/{action} .

Generated from protobuf field string name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

Returns
Type
Description
string

setName

Output only. The relative resource name of the action, of the form: projects/{project}/locations/{location}/lakes/{lake}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}/actions/{action} .

Generated from protobuf field string name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getLake

Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id} .

Generated from protobuf field string lake = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

Returns
Type
Description
string

setLake

Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id} .

Generated from protobuf field string lake = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getZone

Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id} .

Generated from protobuf field string zone = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

Returns
Type
Description
string

setZone

Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id} .

Generated from protobuf field string zone = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getAsset

Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id} .

Generated from protobuf field string asset = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

Returns
Type
Description
string

setAsset

Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id} .

Generated from protobuf field string asset = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDataLocations

The list of data locations associated with this action. Cloud Storage locations are represented as URI paths(E.g.

gs://bucket/table1/year=2020/month=Jan/ ). BigQuery locations refer to resource names(E.g. bigquery.googleapis.com/projects/project-id/datasets/dataset-id ).

Generated from protobuf field repeated string data_locations = 9;

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setDataLocations

The list of data locations associated with this action. Cloud Storage locations are represented as URI paths(E.g.

gs://bucket/table1/year=2020/month=Jan/ ). BigQuery locations refer to resource names(E.g. bigquery.googleapis.com/projects/project-id/datasets/dataset-id ).

Generated from protobuf field repeated string data_locations = 9;

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

getInvalidDataFormat

Details for issues related to invalid or unsupported data formats.

Generated from protobuf field .google.cloud.dataplex.v1.Action.InvalidDataFormat invalid_data_format = 10;

Returns
Type
Description

hasInvalidDataFormat

setInvalidDataFormat

Details for issues related to invalid or unsupported data formats.

Generated from protobuf field .google.cloud.dataplex.v1.Action.InvalidDataFormat invalid_data_format = 10;

Parameter
Name
Description
Returns
Type
Description
$this

getIncompatibleDataSchema

Details for issues related to incompatible schemas detected within data.

Generated from protobuf field .google.cloud.dataplex.v1.Action.IncompatibleDataSchema incompatible_data_schema = 11;

hasIncompatibleDataSchema

setIncompatibleDataSchema

Details for issues related to incompatible schemas detected within data.

Generated from protobuf field .google.cloud.dataplex.v1.Action.IncompatibleDataSchema incompatible_data_schema = 11;

Returns
Type
Description
$this

getInvalidDataPartition

Details for issues related to invalid or unsupported data partition structure.

Generated from protobuf field .google.cloud.dataplex.v1.Action.InvalidDataPartition invalid_data_partition = 12;

hasInvalidDataPartition

setInvalidDataPartition

Details for issues related to invalid or unsupported data partition structure.

Generated from protobuf field .google.cloud.dataplex.v1.Action.InvalidDataPartition invalid_data_partition = 12;

Returns
Type
Description
$this

getMissingData

Details for issues related to absence of data within managed resources.

Generated from protobuf field .google.cloud.dataplex.v1.Action.MissingData missing_data = 13;

Returns
Type
Description

hasMissingData

setMissingData

Details for issues related to absence of data within managed resources.

Generated from protobuf field .google.cloud.dataplex.v1.Action.MissingData missing_data = 13;

Parameter
Name
Description
Returns
Type
Description
$this

getMissingResource

Details for issues related to absence of a managed resource.

Generated from protobuf field .google.cloud.dataplex.v1.Action.MissingResource missing_resource = 14;

Returns
Type
Description

hasMissingResource

setMissingResource

Details for issues related to absence of a managed resource.

Generated from protobuf field .google.cloud.dataplex.v1.Action.MissingResource missing_resource = 14;

Parameter
Name
Description
Returns
Type
Description
$this

getUnauthorizedResource

Details for issues related to lack of permissions to access data resources.

Generated from protobuf field .google.cloud.dataplex.v1.Action.UnauthorizedResource unauthorized_resource = 15;

hasUnauthorizedResource

setUnauthorizedResource

Details for issues related to lack of permissions to access data resources.

Generated from protobuf field .google.cloud.dataplex.v1.Action.UnauthorizedResource unauthorized_resource = 15;

Returns
Type
Description
$this

getFailedSecurityPolicyApply

Details for issues related to applying security policy.

Generated from protobuf field .google.cloud.dataplex.v1.Action.FailedSecurityPolicyApply failed_security_policy_apply = 21;

hasFailedSecurityPolicyApply

setFailedSecurityPolicyApply

Details for issues related to applying security policy.

Generated from protobuf field .google.cloud.dataplex.v1.Action.FailedSecurityPolicyApply failed_security_policy_apply = 21;

Returns
Type
Description
$this

getInvalidDataOrganization

Details for issues related to invalid data arrangement.

Generated from protobuf field .google.cloud.dataplex.v1.Action.InvalidDataOrganization invalid_data_organization = 22;

hasInvalidDataOrganization

setInvalidDataOrganization

Details for issues related to invalid data arrangement.

Generated from protobuf field .google.cloud.dataplex.v1.Action.InvalidDataOrganization invalid_data_organization = 22;

Returns
Type
Description
$this

getDetails

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: