purpose property

String? purpose
getter/setter pair

A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag.

A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set.

Optional. Possible string values are:

  • "PURPOSE_UNSPECIFIED" : Unspecified purpose.
  • "GCE_FIREWALL" : Purpose for Compute Engine firewalls. A corresponding purpose_data should be set for the network the tag is intended for. The key should be network and the value should be in ## either of these two formats: https://www.googleapis.com/compute/{compute_version}/projects/{project_id}/global/networks/{network_id}
  • {project_id}/{network_name} ## Examples: https://www.googleapis.com/compute/staging_v1/projects/fail-closed-load-testing/global/networks/6992953698831725600
  • fail-closed-load-testing/load-testing-network
  • "DATA_GOVERNANCE" : Purpose for data governance. Tag Values created under a key with this purpose may have Tag Value children. No purpose_data should be set.

Implementation

core.String? purpose;