Common Protos for Google Cloud APIs Client - Class TableDataRead (0.4.2)

Reference documentation and code samples for the Common Protos for Google Cloud APIs Client class TableDataRead.

Table data read event.

Generated from protobuf message google.cloud.audit.BigQueryAuditMetadata.TableDataRead

Namespace

Google \ Cloud \ Audit \ BigQueryAuditMetadata

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ fields array

List of the accessed fields. Entire list is truncated if the record size exceeds 100K.

↳ fields_truncated bool

True if the fields list was truncated.

↳ policy_tags array

List of the referenced policy tags. That is, policy tags attached to the accessed fields or their ancestors. Policy tag resource name is a string of the format: projects/<project_id>/locations/<location_id>/taxonomies/<taxonomy_id>/policyTags/<policy_tag_id>

↳ policy_tags_truncated bool

True if the policy tag list was truncated. At most 100 policy tags can be saved.

↳ reason int

Describes how the table data was read.

↳ job_name string

The URI of the job that read a table. Present if the reason is JOB but can be redacted for privacy reasons. Format: projects/<project_id>/jobs/<job_id>.

↳ session_name string

The URI of the read session that read a table. Present if the reason is CREATE_READ_SESSION. Format: projects/<project_id>/locations/<location>/sessions/<session_id>.

getFields

List of the accessed fields. Entire list is truncated if the record size exceeds 100K.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setFields

List of the accessed fields. Entire list is truncated if the record size exceeds 100K.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getFieldsTruncated

True if the fields list was truncated.

Returns
TypeDescription
bool

setFieldsTruncated

True if the fields list was truncated.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getPolicyTags

List of the referenced policy tags. That is, policy tags attached to the accessed fields or their ancestors.

Policy tag resource name is a string of the format: projects/<project_id>/locations/<location_id>/taxonomies/<taxonomy_id>/policyTags/<policy_tag_id>

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setPolicyTags

List of the referenced policy tags. That is, policy tags attached to the accessed fields or their ancestors.

Policy tag resource name is a string of the format: projects/<project_id>/locations/<location_id>/taxonomies/<taxonomy_id>/policyTags/<policy_tag_id>

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getPolicyTagsTruncated

True if the policy tag list was truncated. At most 100 policy tags can be saved.

Returns
TypeDescription
bool

setPolicyTagsTruncated

True if the policy tag list was truncated. At most 100 policy tags can be saved.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getReason

Describes how the table data was read.

Returns
TypeDescription
int

setReason

Describes how the table data was read.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getJobName

The URI of the job that read a table.

Present if the reason is JOB but can be redacted for privacy reasons. Format: projects/<project_id>/jobs/<job_id>.

Returns
TypeDescription
string

setJobName

The URI of the job that read a table.

Present if the reason is JOB but can be redacted for privacy reasons. Format: projects/<project_id>/jobs/<job_id>.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSessionName

The URI of the read session that read a table.

Present if the reason is CREATE_READ_SESSION. Format: projects/<project_id>/locations/<location>/sessions/<session_id>.

Returns
TypeDescription
string

setSessionName

The URI of the read session that read a table.

Present if the reason is CREATE_READ_SESSION. Format: projects/<project_id>/locations/<location>/sessions/<session_id>.

Parameter
NameDescription
var string
Returns
TypeDescription
$this