Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DataQualityRuleTemplate.
DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules.
Generated from protobuf message google.cloud.dataplex.v1.DataQualityRuleTemplate
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The name of the rule template in the format: |
↳ dimension |
string
Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. |
↳ sql_collection |
array<DataQualityRuleTemplate\Sql>
Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. |
↳ input_parameters |
array|Google\Protobuf\Internal\MapField
Output only. Description for input parameters |
↳ capabilities |
string[]
Output only. A list of features or properties supported by this rule template. |
getName
Output only. The name of the rule template in the format:
projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. The name of the rule template in the format:
projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDimension
Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDimension
Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSqlCollection
Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<DataQualityRuleTemplate\Sql> |
|
setSqlCollection
Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.
| Parameter | |
|---|---|
| Name | Description |
var |
array<DataQualityRuleTemplate\Sql>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInputParameters
Output only. Description for input parameters
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setInputParameters
Output only. Description for input parameters
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCapabilities
Output only. A list of features or properties supported by this rule template.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setCapabilities
Output only. A list of features or properties supported by this rule template.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|