Google Cloud Dataplex V1 Client - Class Action (0.5.1)

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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 array

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.

Returns
TypeDescription
int

setCategory

The category of issue associated with the action.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getIssue

Detailed description of the issue requiring action.

Returns
TypeDescription
string

setIssue

Detailed description of the issue requiring action.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDetectTime

The time that the issue was detected.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasDetectTime

clearDetectTime

setDetectTime

The time that the issue was detected.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$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}.

Returns
TypeDescription
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}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLake

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

Returns
TypeDescription
string

setLake

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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}.

Returns
TypeDescription
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}.

Parameter
NameDescription
var string
Returns
TypeDescription
$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}.

Returns
TypeDescription
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}.

Parameter
NameDescription
var string
Returns
TypeDescription
$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).

Returns
TypeDescription
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).

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getInvalidDataFormat

Details for issues related to invalid or unsupported data formats.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Action\InvalidDataFormat|null

hasInvalidDataFormat

setInvalidDataFormat

Details for issues related to invalid or unsupported data formats.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Action\InvalidDataFormat
Returns
TypeDescription
$this

getIncompatibleDataSchema

Details for issues related to incompatible schemas detected within data.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Action\IncompatibleDataSchema|null

hasIncompatibleDataSchema

setIncompatibleDataSchema

Details for issues related to incompatible schemas detected within data.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Action\IncompatibleDataSchema
Returns
TypeDescription
$this

getInvalidDataPartition

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

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Action\InvalidDataPartition|null

hasInvalidDataPartition

setInvalidDataPartition

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

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Action\InvalidDataPartition
Returns
TypeDescription
$this

getMissingData

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

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Action\MissingData|null

hasMissingData

setMissingData

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

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Action\MissingData
Returns
TypeDescription
$this

getMissingResource

Details for issues related to absence of a managed resource.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Action\MissingResource|null

hasMissingResource

setMissingResource

Details for issues related to absence of a managed resource.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Action\MissingResource
Returns
TypeDescription
$this

getUnauthorizedResource

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

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Action\UnauthorizedResource|null

hasUnauthorizedResource

setUnauthorizedResource

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

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Action\UnauthorizedResource
Returns
TypeDescription
$this

getFailedSecurityPolicyApply

Details for issues related to applying security policy.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Action\FailedSecurityPolicyApply|null

hasFailedSecurityPolicyApply

setFailedSecurityPolicyApply

Details for issues related to applying security policy.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Action\FailedSecurityPolicyApply
Returns
TypeDescription
$this

getInvalidDataOrganization

Details for issues related to invalid data arrangement.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\Action\InvalidDataOrganization|null

hasInvalidDataOrganization

setInvalidDataOrganization

Details for issues related to invalid data arrangement.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\Action\InvalidDataOrganization
Returns
TypeDescription
$this

getDetails

Returns
TypeDescription
string