Reference documentation and code samples for the Data Loss Prevention V2 Client class InfoTypeDescription.
InfoType description.
Generated from protobuf message google.privacy.dlp.v2.InfoTypeDescription
Namespace
Google \ Cloud \ Dlp \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Internal name of the infoType. |
↳ display_name |
string
Human readable form of the infoType name. |
↳ supported_by |
array
Which parts of the API supports this InfoType. |
↳ description |
string
Description of the infotype. Translated when language is provided in the request. |
↳ location_support |
LocationSupport
Locations at which this feature can be used. May change over time. |
↳ example |
string
A sample that is a true positive for this infoType. |
↳ versions |
array<VersionDescription>
A list of available versions for the infotype. |
↳ categories |
array<InfoTypeCategory>
The category of the infoType. |
↳ sensitivity_score |
SensitivityScore
The default sensitivity of the infoType. |
↳ specific_info_types |
array
If this field is set, this infoType is a general infoType and these specific infoTypes are contained within it. General infoTypes are infoTypes that encompass multiple specific infoTypes. For example, the "GEOGRAPHIC_DATA" general infoType would have set for this field "LOCATION", "LOCATION_COORDINATES", and "STREET_ADDRESS". |
getName
Internal name of the infoType.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Internal name of the infoType.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Human readable form of the infoType name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Human readable form of the infoType name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSupportedBy
Which parts of the API supports this InfoType.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSupportedBy
Which parts of the API supports this InfoType.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Description of the infotype. Translated when language is provided in the request.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Description of the infotype. Translated when language is provided in the request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocationSupport
Locations at which this feature can be used. May change over time.
| Returns | |
|---|---|
| Type | Description |
LocationSupport|null |
|
hasLocationSupport
clearLocationSupport
setLocationSupport
Locations at which this feature can be used. May change over time.
| Parameter | |
|---|---|
| Name | Description |
var |
LocationSupport
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExample
A sample that is a true positive for this infoType.
| Returns | |
|---|---|
| Type | Description |
string |
|
setExample
A sample that is a true positive for this infoType.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVersions
A list of available versions for the infotype.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setVersions
A list of available versions for the infotype.
| Parameter | |
|---|---|
| Name | Description |
var |
array<VersionDescription>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCategories
The category of the infoType.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCategories
The category of the infoType.
| Parameter | |
|---|---|
| Name | Description |
var |
array<InfoTypeCategory>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSensitivityScore
The default sensitivity of the infoType.
| Returns | |
|---|---|
| Type | Description |
SensitivityScore|null |
|
hasSensitivityScore
clearSensitivityScore
setSensitivityScore
The default sensitivity of the infoType.
| Parameter | |
|---|---|
| Name | Description |
var |
SensitivityScore
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSpecificInfoTypes
If this field is set, this infoType is a general infoType and these specific infoTypes are contained within it.
General infoTypes are infoTypes that encompass multiple specific infoTypes. For example, the "GEOGRAPHIC_DATA" general infoType would have set for this field "LOCATION", "LOCATION_COORDINATES", and "STREET_ADDRESS".
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSpecificInfoTypes
If this field is set, this infoType is a general infoType and these specific infoTypes are contained within it.
General infoTypes are infoTypes that encompass multiple specific infoTypes. For example, the "GEOGRAPHIC_DATA" general infoType would have set for this field "LOCATION", "LOCATION_COORDINATES", and "STREET_ADDRESS".
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|