blob: c669f23840a6a7d5bebf3576a2dcec81156d210f [file] [log] [blame]
{
"clientLibrary": {
"name": "cloud.google.com/go/datacatalog/apiv1",
"version": "1.5.0",
"language": "GO",
"apis": [
{
"id": "google.cloud.datacatalog.v1",
"version": "v1"
}
]
},
"snippets": [
{
"regionTag": "datacatalog_v1_generated_DataCatalog_CreateEntry_sync",
"title": "datacatalog CreateEntry Sample",
"description": "CreateEntry creates an entry.\n\nYou can create entries only with ‘FILESET’, ‘CLUSTER’, ‘DATA_STREAM’,\nor custom types. Data Catalog automatically creates entries with other\ntypes during metadata ingestion from integrated systems.\n\nYou must enable the Data Catalog API in the project identified by\nthe parent parameter. For more information, see Data Catalog resource\nproject (at https: //cloud.google.com/data-catalog/docs/concepts/resource-project).\n\nAn entry group can have a maximum of 100,000 entries.",
"file": "Client/CreateEntry/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CreateEntry",
"fullName": "google.cloud.datacatalog.v1.Client.CreateEntry",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.CreateEntryRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.Entry",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "CreateEntry",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.CreateEntry",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_CreateEntryGroup_sync",
"title": "datacatalog CreateEntryGroup Sample",
"description": "CreateEntryGroup creates an entry group.\n\nAn entry group contains logically related entries together with Cloud\nIdentity and Access Management (at /data-catalog/docs/concepts/iam) policies.\nThese policies specify users who can create, edit, and view entries\nwithin entry groups.\n\nData Catalog automatically creates entry groups with names that start with\nthe @ symbol for the following resources: \n\n\tBigQuery entries (@bigquery)\n\n\tPub/Sub topics (@pubsub)\n\n\tDataproc Metastore services (@dataproc_metastore_{SERVICE_NAME_HASH})\n\nYou can create your own entry groups for Cloud Storage fileset entries\nand custom entries together with the corresponding IAM policies.\nUser-created entry groups can’t contain the @ symbol, it is reserved\nfor automatically created groups.\n\nEntry groups, like entries, can be searched.\n\nA maximum of 10,000 entry groups may be created per organization across all\nlocations.\n\nYou must enable the Data Catalog API in the project identified by\nthe parent parameter. For more information, see Data Catalog resource\nproject (at https: //cloud.google.com/data-catalog/docs/concepts/resource-project).",
"file": "Client/CreateEntryGroup/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CreateEntryGroup",
"fullName": "google.cloud.datacatalog.v1.Client.CreateEntryGroup",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.CreateEntryGroupRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.EntryGroup",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "CreateEntryGroup",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.CreateEntryGroup",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_CreateTag_sync",
"title": "datacatalog CreateTag Sample",
"description": "CreateTag creates a tag and assigns it to: \n\n\tAn Entry if the method name is\n\tprojects.locations.entryGroups.entries.tags.create.\n\n\tOr EntryGroupif the method\n\tname is projects.locations.entryGroups.tags.create.\n\nNote: The project identified by the parent parameter for the [tag]\n(https: //cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters (at https: //cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters))\nand the [tag template]\n(https: //cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters (at https: //cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters))\nused to create the tag must be in the same organization.",
"file": "Client/CreateTag/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CreateTag",
"fullName": "google.cloud.datacatalog.v1.Client.CreateTag",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.CreateTagRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.Tag",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "CreateTag",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.CreateTag",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_CreateTagTemplate_sync",
"title": "datacatalog CreateTagTemplate Sample",
"description": "CreateTagTemplate creates a tag template.\n\nYou must enable the Data Catalog API in the project identified by the\nparent parameter.\nFor more information, see [Data Catalog resource project]\n(https: //cloud.google.com/data-catalog/docs/concepts/resource-project (at https: //cloud.google.com/data-catalog/docs/concepts/resource-project)).",
"file": "Client/CreateTagTemplate/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CreateTagTemplate",
"fullName": "google.cloud.datacatalog.v1.Client.CreateTagTemplate",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.CreateTagTemplateRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.TagTemplate",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "CreateTagTemplate",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplate",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_CreateTagTemplateField_sync",
"title": "datacatalog CreateTagTemplateField Sample",
"description": "CreateTagTemplateField creates a field in a tag template.\n\nYou must enable the Data Catalog API in the project identified by\nthe parent parameter. For more information, see Data Catalog resource\nproject (at https: //cloud.google.com/data-catalog/docs/concepts/resource-project).",
"file": "Client/CreateTagTemplateField/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CreateTagTemplateField",
"fullName": "google.cloud.datacatalog.v1.Client.CreateTagTemplateField",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.CreateTagTemplateFieldRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.TagTemplateField",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "CreateTagTemplateField",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplateField",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_DeleteEntry_sync",
"title": "datacatalog DeleteEntry Sample",
"description": "DeleteEntry deletes an existing entry.\n\nYou can delete only the entries created by the\nCreateEntry\nmethod.\n\nYou must enable the Data Catalog API in the project identified by\nthe name parameter. For more information, see Data Catalog\nresource\nproject (at https: //cloud.google.com/data-catalog/docs/concepts/resource-project).",
"file": "Client/DeleteEntry/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeleteEntry",
"fullName": "google.cloud.datacatalog.v1.Client.DeleteEntry",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.DeleteEntryRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "DeleteEntry",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.DeleteEntry",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 50,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_DeleteEntryGroup_sync",
"title": "datacatalog DeleteEntryGroup Sample",
"description": "DeleteEntryGroup deletes an entry group.\n\nYou must enable the Data Catalog API in the project\nidentified by the name parameter. For more information, see Data Catalog\nresource\nproject (at https: //cloud.google.com/data-catalog/docs/concepts/resource-project).",
"file": "Client/DeleteEntryGroup/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeleteEntryGroup",
"fullName": "google.cloud.datacatalog.v1.Client.DeleteEntryGroup",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.DeleteEntryGroupRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "DeleteEntryGroup",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.DeleteEntryGroup",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 50,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_DeleteTag_sync",
"title": "datacatalog DeleteTag Sample",
"description": "DeleteTag deletes a tag.",
"file": "Client/DeleteTag/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeleteTag",
"fullName": "google.cloud.datacatalog.v1.Client.DeleteTag",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.DeleteTagRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "DeleteTag",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.DeleteTag",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 50,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_DeleteTagTemplate_sync",
"title": "datacatalog DeleteTagTemplate Sample",
"description": "DeleteTagTemplate deletes a tag template and all tags that use it.\n\nYou must enable the Data Catalog API in the project identified by\nthe name parameter. For more information, see Data Catalog resource\nproject (at https: //cloud.google.com/data-catalog/docs/concepts/resource-project).",
"file": "Client/DeleteTagTemplate/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeleteTagTemplate",
"fullName": "google.cloud.datacatalog.v1.Client.DeleteTagTemplate",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.DeleteTagTemplateRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "DeleteTagTemplate",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplate",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 50,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_DeleteTagTemplateField_sync",
"title": "datacatalog DeleteTagTemplateField Sample",
"description": "DeleteTagTemplateField deletes a field in a tag template and all uses of this field from the tags\nbased on this template.\n\nYou must enable the Data Catalog API in the project identified by\nthe name parameter. For more information, see Data Catalog resource\nproject (at https: //cloud.google.com/data-catalog/docs/concepts/resource-project).",
"file": "Client/DeleteTagTemplateField/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeleteTagTemplateField",
"fullName": "google.cloud.datacatalog.v1.Client.DeleteTagTemplateField",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.DeleteTagTemplateFieldRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "DeleteTagTemplateField",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplateField",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 50,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_GetEntry_sync",
"title": "datacatalog GetEntry Sample",
"description": "GetEntry gets an entry.",
"file": "Client/GetEntry/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetEntry",
"fullName": "google.cloud.datacatalog.v1.Client.GetEntry",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.GetEntryRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.Entry",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "GetEntry",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.GetEntry",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_GetEntryGroup_sync",
"title": "datacatalog GetEntryGroup Sample",
"description": "GetEntryGroup gets an entry group.",
"file": "Client/GetEntryGroup/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetEntryGroup",
"fullName": "google.cloud.datacatalog.v1.Client.GetEntryGroup",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.GetEntryGroupRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.EntryGroup",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "GetEntryGroup",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.GetEntryGroup",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_GetIamPolicy_sync",
"title": "datacatalog GetIamPolicy Sample",
"description": "GetIamPolicy gets the access control policy for a resource.\n\nMay return: \n\n\tANOT_FOUND error if the resource doesn’t exist or you don’t have the\n\tpermission to view it.\n\n\tAn empty policy if the resource exists but doesn’t have a set policy.\n\nSupported resources are: \n\n\tTag templates\n\n\tEntry groups\n\nNote: This method doesn’t get policies from Google Cloud Platform\nresources ingested into Data Catalog.\n\nTo call this method, you must have the following Google IAM permissions: \n\n\tdatacatalog.tagTemplates.getIamPolicy to get policies on tag\n\ttemplates.\n\n\tdatacatalog.entryGroups.getIamPolicy to get policies on entry groups.",
"file": "Client/GetIamPolicy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetIamPolicy",
"fullName": "google.cloud.datacatalog.v1.Client.GetIamPolicy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "iampb.GetIamPolicyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "iampb.Policy",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "GetIamPolicy",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.GetIamPolicy",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_GetTagTemplate_sync",
"title": "datacatalog GetTagTemplate Sample",
"description": "GetTagTemplate gets a tag template.",
"file": "Client/GetTagTemplate/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetTagTemplate",
"fullName": "google.cloud.datacatalog.v1.Client.GetTagTemplate",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.GetTagTemplateRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.TagTemplate",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "GetTagTemplate",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.GetTagTemplate",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_ListEntries_sync",
"title": "datacatalog ListEntries Sample",
"description": "ListEntries lists entries.\n\nNote: Currently, this method can list only custom entries.\nTo get a list of both custom and automatically created entries, use\nSearchCatalog.",
"file": "Client/ListEntries/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListEntries",
"fullName": "google.cloud.datacatalog.v1.Client.ListEntries",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.ListEntriesRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "EntryIterator",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "ListEntries",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.ListEntries",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 59,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_ListEntryGroups_sync",
"title": "datacatalog ListEntryGroups Sample",
"description": "ListEntryGroups lists entry groups.",
"file": "Client/ListEntryGroups/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListEntryGroups",
"fullName": "google.cloud.datacatalog.v1.Client.ListEntryGroups",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.ListEntryGroupsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "EntryGroupIterator",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "ListEntryGroups",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 59,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_ListTags_sync",
"title": "datacatalog ListTags Sample",
"description": "ListTags lists tags assigned to an Entry.\nThe columns in the response are\nlowercased.",
"file": "Client/ListTags/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListTags",
"fullName": "google.cloud.datacatalog.v1.Client.ListTags",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.ListTagsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "TagIterator",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "ListTags",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.ListTags",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 59,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_LookupEntry_sync",
"title": "datacatalog LookupEntry Sample",
"description": "LookupEntry gets an entry by its target resource name.\n\nThe resource name comes from the source Google Cloud Platform service.",
"file": "Client/LookupEntry/main.go",
"language": "GO",
"clientMethod": {
"shortName": "LookupEntry",
"fullName": "google.cloud.datacatalog.v1.Client.LookupEntry",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.LookupEntryRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.Entry",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "LookupEntry",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.LookupEntry",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_ModifyEntryContacts_sync",
"title": "datacatalog ModifyEntryContacts Sample",
"description": "ModifyEntryContacts modifies contacts, part of the business context of an\nEntry.\n\nTo call this method, you must have the datacatalog.entries.updateContacts\nIAM permission on the corresponding project.",
"file": "Client/ModifyEntryContacts/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ModifyEntryContacts",
"fullName": "google.cloud.datacatalog.v1.Client.ModifyEntryContacts",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.ModifyEntryContactsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.Contacts",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "ModifyEntryContacts",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.ModifyEntryContacts",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_ModifyEntryOverview_sync",
"title": "datacatalog ModifyEntryOverview Sample",
"description": "ModifyEntryOverview modifies entry overview, part of the business context of an\nEntry.\n\nTo call this method, you must have the datacatalog.entries.updateOverview\nIAM permission on the corresponding project.",
"file": "Client/ModifyEntryOverview/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ModifyEntryOverview",
"fullName": "google.cloud.datacatalog.v1.Client.ModifyEntryOverview",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.ModifyEntryOverviewRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.EntryOverview",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "ModifyEntryOverview",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.ModifyEntryOverview",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_RenameTagTemplateField_sync",
"title": "datacatalog RenameTagTemplateField Sample",
"description": "RenameTagTemplateField renames a field in a tag template.\n\nYou must enable the Data Catalog API in the project identified by the\nname parameter. For more information, see [Data Catalog resource project]\n(https: //cloud.google.com/data-catalog/docs/concepts/resource-project (at https: //cloud.google.com/data-catalog/docs/concepts/resource-project)).",
"file": "Client/RenameTagTemplateField/main.go",
"language": "GO",
"clientMethod": {
"shortName": "RenameTagTemplateField",
"fullName": "google.cloud.datacatalog.v1.Client.RenameTagTemplateField",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.RenameTagTemplateFieldRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.TagTemplateField",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "RenameTagTemplateField",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateField",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_RenameTagTemplateFieldEnumValue_sync",
"title": "datacatalog RenameTagTemplateFieldEnumValue Sample",
"description": "RenameTagTemplateFieldEnumValue renames an enum value in a tag template.\n\nWithin a single enum field, enum values must be unique.",
"file": "Client/RenameTagTemplateFieldEnumValue/main.go",
"language": "GO",
"clientMethod": {
"shortName": "RenameTagTemplateFieldEnumValue",
"fullName": "google.cloud.datacatalog.v1.Client.RenameTagTemplateFieldEnumValue",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.RenameTagTemplateFieldEnumValueRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.TagTemplateField",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "RenameTagTemplateFieldEnumValue",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateFieldEnumValue",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_SearchCatalog_sync",
"title": "datacatalog SearchCatalog Sample",
"description": "SearchCatalog searches Data Catalog for multiple resources like entries and tags that\nmatch a query.\n\nThis is a [Custom Method]\n(https: //cloud.google.com/apis/design/custom_methods (at https: //cloud.google.com/apis/design/custom_methods)) that doesn’t return\nall information on a resource, only its ID and high level fields. To get\nmore information, you can subsequently call specific get methods.\n\nNote: Data Catalog search queries don’t guarantee full recall. Results\nthat match your query might not be returned, even in subsequent\nresult pages. Additionally, returned (and not returned) results can vary\nif you repeat search queries.\n\nFor more information, see [Data Catalog search syntax]\n(https: //cloud.google.com/data-catalog/docs/how-to/search-reference (at https: //cloud.google.com/data-catalog/docs/how-to/search-reference)).",
"file": "Client/SearchCatalog/main.go",
"language": "GO",
"clientMethod": {
"shortName": "SearchCatalog",
"fullName": "google.cloud.datacatalog.v1.Client.SearchCatalog",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.SearchCatalogRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "SearchCatalogResultIterator",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "SearchCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.SearchCatalog",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 59,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_SetIamPolicy_sync",
"title": "datacatalog SetIamPolicy Sample",
"description": "SetIamPolicy sets an access control policy for a resource. Replaces any existing\npolicy.\n\nSupported resources are: \n\n\tTag templates\n\n\tEntry groups\n\nNote: This method sets policies only within Data Catalog and can’t be\nused to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any\nexternal Google Cloud Platform resources synced with the Data Catalog.\n\nTo call this method, you must have the following Google IAM permissions: \n\n\tdatacatalog.tagTemplates.setIamPolicy to set policies on tag\n\ttemplates.\n\n\tdatacatalog.entryGroups.setIamPolicy to set policies on entry groups.",
"file": "Client/SetIamPolicy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "SetIamPolicy",
"fullName": "google.cloud.datacatalog.v1.Client.SetIamPolicy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "iampb.SetIamPolicyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "iampb.Policy",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "SetIamPolicy",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.SetIamPolicy",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_StarEntry_sync",
"title": "datacatalog StarEntry Sample",
"description": "StarEntry marks an Entry as starred by\nthe current user. Starring information is private to each user.",
"file": "Client/StarEntry/main.go",
"language": "GO",
"clientMethod": {
"shortName": "StarEntry",
"fullName": "google.cloud.datacatalog.v1.Client.StarEntry",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.StarEntryRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.StarEntryResponse",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "StarEntry",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.StarEntry",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_TestIamPermissions_sync",
"title": "datacatalog TestIamPermissions Sample",
"description": "TestIamPermissions gets your permissions on a resource.\n\nReturns an empty set of permissions if the resource doesn’t exist.\n\nSupported resources are: \n\n\tTag templates\n\n\tEntry groups\n\nNote: This method gets policies only within Data Catalog and can’t be\nused to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any\nexternal Google Cloud Platform resources ingested into Data Catalog.\n\nNo Google IAM permissions are required to call this method.",
"file": "Client/TestIamPermissions/main.go",
"language": "GO",
"clientMethod": {
"shortName": "TestIamPermissions",
"fullName": "google.cloud.datacatalog.v1.Client.TestIamPermissions",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "iampb.TestIamPermissionsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "iampb.TestIamPermissionsResponse",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "TestIamPermissions",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.TestIamPermissions",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_UnstarEntry_sync",
"title": "datacatalog UnstarEntry Sample",
"description": "UnstarEntry marks an Entry as NOT starred by\nthe current user. Starring information is private to each user.",
"file": "Client/UnstarEntry/main.go",
"language": "GO",
"clientMethod": {
"shortName": "UnstarEntry",
"fullName": "google.cloud.datacatalog.v1.Client.UnstarEntry",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.UnstarEntryRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.UnstarEntryResponse",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "UnstarEntry",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.UnstarEntry",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_UpdateEntry_sync",
"title": "datacatalog UpdateEntry Sample",
"description": "UpdateEntry updates an existing entry.\n\nYou must enable the Data Catalog API in the project identified by\nthe entry.name parameter. For more information, see Data Catalog\nresource\nproject (at https: //cloud.google.com/data-catalog/docs/concepts/resource-project).",
"file": "Client/UpdateEntry/main.go",
"language": "GO",
"clientMethod": {
"shortName": "UpdateEntry",
"fullName": "google.cloud.datacatalog.v1.Client.UpdateEntry",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.UpdateEntryRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.Entry",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "UpdateEntry",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.UpdateEntry",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_UpdateEntryGroup_sync",
"title": "datacatalog UpdateEntryGroup Sample",
"description": "UpdateEntryGroup updates an entry group.\n\nYou must enable the Data Catalog API in the project identified by\nthe entry_group.name parameter. For more information, see Data Catalog\nresource\nproject (at https: //cloud.google.com/data-catalog/docs/concepts/resource-project).",
"file": "Client/UpdateEntryGroup/main.go",
"language": "GO",
"clientMethod": {
"shortName": "UpdateEntryGroup",
"fullName": "google.cloud.datacatalog.v1.Client.UpdateEntryGroup",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.UpdateEntryGroupRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.EntryGroup",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "UpdateEntryGroup",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.UpdateEntryGroup",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_UpdateTag_sync",
"title": "datacatalog UpdateTag Sample",
"description": "UpdateTag updates an existing tag.",
"file": "Client/UpdateTag/main.go",
"language": "GO",
"clientMethod": {
"shortName": "UpdateTag",
"fullName": "google.cloud.datacatalog.v1.Client.UpdateTag",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.UpdateTagRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.Tag",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "UpdateTag",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.UpdateTag",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_UpdateTagTemplate_sync",
"title": "datacatalog UpdateTagTemplate Sample",
"description": "UpdateTagTemplate updates a tag template.\n\nYou can’t update template fields with this method. These fields are\nseparate resources with their own create, update, and delete methods.\n\nYou must enable the Data Catalog API in the project identified by\nthe tag_template.name parameter. For more information, see Data Catalog\nresource\nproject (at https: //cloud.google.com/data-catalog/docs/concepts/resource-project).",
"file": "Client/UpdateTagTemplate/main.go",
"language": "GO",
"clientMethod": {
"shortName": "UpdateTagTemplate",
"fullName": "google.cloud.datacatalog.v1.Client.UpdateTagTemplate",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.UpdateTagTemplateRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.TagTemplate",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "UpdateTagTemplate",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplate",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_DataCatalog_UpdateTagTemplateField_sync",
"title": "datacatalog UpdateTagTemplateField Sample",
"description": "UpdateTagTemplateField updates a field in a tag template.\n\nYou can’t update the field type with this method.\n\nYou must enable the Data Catalog API in the project\nidentified by the name parameter. For more information, see Data Catalog\nresource\nproject (at https: //cloud.google.com/data-catalog/docs/concepts/resource-project).",
"file": "Client/UpdateTagTemplateField/main.go",
"language": "GO",
"clientMethod": {
"shortName": "UpdateTagTemplateField",
"fullName": "google.cloud.datacatalog.v1.Client.UpdateTagTemplateField",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.UpdateTagTemplateFieldRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.TagTemplateField",
"client": {
"shortName": "Client",
"fullName": "google.cloud.datacatalog.v1.Client"
},
"method": {
"shortName": "UpdateTagTemplateField",
"fullName": "google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplateField",
"service": {
"shortName": "DataCatalog",
"fullName": "google.cloud.datacatalog.v1.DataCatalog"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManager_CreatePolicyTag_sync",
"title": "datacatalog CreatePolicyTag Sample",
"description": "CreatePolicyTag creates a policy tag in a taxonomy.",
"file": "PolicyTagManagerClient/CreatePolicyTag/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CreatePolicyTag",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient.CreatePolicyTag",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.CreatePolicyTagRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.PolicyTag",
"client": {
"shortName": "PolicyTagManagerClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient"
},
"method": {
"shortName": "CreatePolicyTag",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager.CreatePolicyTag",
"service": {
"shortName": "PolicyTagManager",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManager_CreateTaxonomy_sync",
"title": "datacatalog CreateTaxonomy Sample",
"description": "CreateTaxonomy creates a taxonomy in a specified project.\n\nThe taxonomy is initially empty, that is, it doesn’t contain policy tags.",
"file": "PolicyTagManagerClient/CreateTaxonomy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "CreateTaxonomy",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient.CreateTaxonomy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.CreateTaxonomyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.Taxonomy",
"client": {
"shortName": "PolicyTagManagerClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient"
},
"method": {
"shortName": "CreateTaxonomy",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager.CreateTaxonomy",
"service": {
"shortName": "PolicyTagManager",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManager_DeletePolicyTag_sync",
"title": "datacatalog DeletePolicyTag Sample",
"description": "DeletePolicyTag deletes a policy tag together with the following: \n\n\tAll of its descendant policy tags, if any\n\n\tPolicies associated with the policy tag and its descendants\n\n\tReferences from BigQuery table schema of the policy tag and its\n\tdescendants",
"file": "PolicyTagManagerClient/DeletePolicyTag/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeletePolicyTag",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient.DeletePolicyTag",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.DeletePolicyTagRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "PolicyTagManagerClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient"
},
"method": {
"shortName": "DeletePolicyTag",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager.DeletePolicyTag",
"service": {
"shortName": "PolicyTagManager",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 50,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManager_DeleteTaxonomy_sync",
"title": "datacatalog DeleteTaxonomy Sample",
"description": "DeleteTaxonomy deletes a taxonomy, including all policy tags in this\ntaxonomy, their associated policies, and the policy tags references from\nBigQuery columns.",
"file": "PolicyTagManagerClient/DeleteTaxonomy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "DeleteTaxonomy",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient.DeleteTaxonomy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.DeleteTaxonomyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"client": {
"shortName": "PolicyTagManagerClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient"
},
"method": {
"shortName": "DeleteTaxonomy",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager.DeleteTaxonomy",
"service": {
"shortName": "PolicyTagManager",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 50,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManager_GetIamPolicy_sync",
"title": "datacatalog GetIamPolicy Sample",
"description": "GetIamPolicy gets the IAM policy for a policy tag or a taxonomy.",
"file": "PolicyTagManagerClient/GetIamPolicy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetIamPolicy",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient.GetIamPolicy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "iampb.GetIamPolicyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "iampb.Policy",
"client": {
"shortName": "PolicyTagManagerClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient"
},
"method": {
"shortName": "GetIamPolicy",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager.GetIamPolicy",
"service": {
"shortName": "PolicyTagManager",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManager_GetPolicyTag_sync",
"title": "datacatalog GetPolicyTag Sample",
"description": "GetPolicyTag gets a policy tag.",
"file": "PolicyTagManagerClient/GetPolicyTag/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetPolicyTag",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient.GetPolicyTag",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.GetPolicyTagRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.PolicyTag",
"client": {
"shortName": "PolicyTagManagerClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient"
},
"method": {
"shortName": "GetPolicyTag",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager.GetPolicyTag",
"service": {
"shortName": "PolicyTagManager",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManager_GetTaxonomy_sync",
"title": "datacatalog GetTaxonomy Sample",
"description": "GetTaxonomy gets a taxonomy.",
"file": "PolicyTagManagerClient/GetTaxonomy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "GetTaxonomy",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient.GetTaxonomy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.GetTaxonomyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.Taxonomy",
"client": {
"shortName": "PolicyTagManagerClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient"
},
"method": {
"shortName": "GetTaxonomy",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager.GetTaxonomy",
"service": {
"shortName": "PolicyTagManager",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManager_ListPolicyTags_sync",
"title": "datacatalog ListPolicyTags Sample",
"description": "ListPolicyTags lists all policy tags in a taxonomy.",
"file": "PolicyTagManagerClient/ListPolicyTags/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListPolicyTags",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient.ListPolicyTags",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.ListPolicyTagsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "PolicyTagIterator",
"client": {
"shortName": "PolicyTagManagerClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient"
},
"method": {
"shortName": "ListPolicyTags",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager.ListPolicyTags",
"service": {
"shortName": "PolicyTagManager",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 59,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManager_ListTaxonomies_sync",
"title": "datacatalog ListTaxonomies Sample",
"description": "ListTaxonomies lists all taxonomies in a project in a particular location that you\nhave a permission to view.",
"file": "PolicyTagManagerClient/ListTaxonomies/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ListTaxonomies",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient.ListTaxonomies",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.ListTaxonomiesRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "TaxonomyIterator",
"client": {
"shortName": "PolicyTagManagerClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient"
},
"method": {
"shortName": "ListTaxonomies",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager.ListTaxonomies",
"service": {
"shortName": "PolicyTagManager",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 59,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManager_SetIamPolicy_sync",
"title": "datacatalog SetIamPolicy Sample",
"description": "SetIamPolicy sets the IAM policy for a policy tag or a taxonomy.",
"file": "PolicyTagManagerClient/SetIamPolicy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "SetIamPolicy",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient.SetIamPolicy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "iampb.SetIamPolicyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "iampb.Policy",
"client": {
"shortName": "PolicyTagManagerClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient"
},
"method": {
"shortName": "SetIamPolicy",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager.SetIamPolicy",
"service": {
"shortName": "PolicyTagManager",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManager_TestIamPermissions_sync",
"title": "datacatalog TestIamPermissions Sample",
"description": "TestIamPermissions returns your permissions on a specified policy tag or\ntaxonomy.",
"file": "PolicyTagManagerClient/TestIamPermissions/main.go",
"language": "GO",
"clientMethod": {
"shortName": "TestIamPermissions",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient.TestIamPermissions",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "iampb.TestIamPermissionsRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "iampb.TestIamPermissionsResponse",
"client": {
"shortName": "PolicyTagManagerClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient"
},
"method": {
"shortName": "TestIamPermissions",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager.TestIamPermissions",
"service": {
"shortName": "PolicyTagManager",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManager_UpdatePolicyTag_sync",
"title": "datacatalog UpdatePolicyTag Sample",
"description": "UpdatePolicyTag updates a policy tag, including its display\nname, description, and parent policy tag.",
"file": "PolicyTagManagerClient/UpdatePolicyTag/main.go",
"language": "GO",
"clientMethod": {
"shortName": "UpdatePolicyTag",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient.UpdatePolicyTag",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.UpdatePolicyTagRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.PolicyTag",
"client": {
"shortName": "PolicyTagManagerClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient"
},
"method": {
"shortName": "UpdatePolicyTag",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager.UpdatePolicyTag",
"service": {
"shortName": "PolicyTagManager",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManager_UpdateTaxonomy_sync",
"title": "datacatalog UpdateTaxonomy Sample",
"description": "UpdateTaxonomy updates a taxonomy, including its display name,\ndescription, and activated policy types.",
"file": "PolicyTagManagerClient/UpdateTaxonomy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "UpdateTaxonomy",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient.UpdateTaxonomy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.UpdateTaxonomyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.Taxonomy",
"client": {
"shortName": "PolicyTagManagerClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient"
},
"method": {
"shortName": "UpdateTaxonomy",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager.UpdateTaxonomy",
"service": {
"shortName": "PolicyTagManager",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManager"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManagerSerialization_ExportTaxonomies_sync",
"title": "datacatalog ExportTaxonomies Sample",
"description": "ExportTaxonomies exports taxonomies in the requested type and returns them,\nincluding their policy tags. The requested taxonomies must belong to the\nsame project.\n\nThis method generates SerializedTaxonomy protocol buffers with nested\npolicy tags that can be used as input for ImportTaxonomies calls.",
"file": "PolicyTagManagerSerializationClient/ExportTaxonomies/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ExportTaxonomies",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerializationClient.ExportTaxonomies",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.ExportTaxonomiesRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.ExportTaxonomiesResponse",
"client": {
"shortName": "PolicyTagManagerSerializationClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerializationClient"
},
"method": {
"shortName": "ExportTaxonomies",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ExportTaxonomies",
"service": {
"shortName": "PolicyTagManagerSerialization",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerialization"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManagerSerialization_ImportTaxonomies_sync",
"title": "datacatalog ImportTaxonomies Sample",
"description": "ImportTaxonomies creates new taxonomies (including their policy tags) in a given project\nby importing from inlined or cross-regional sources.\n\nFor a cross-regional source, new taxonomies are created by copying\nfrom a source in another region.\n\nFor an inlined source, taxonomies and policy tags are created in bulk using\nnested protocol buffer structures.",
"file": "PolicyTagManagerSerializationClient/ImportTaxonomies/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ImportTaxonomies",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerializationClient.ImportTaxonomies",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.ImportTaxonomiesRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.ImportTaxonomiesResponse",
"client": {
"shortName": "PolicyTagManagerSerializationClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerializationClient"
},
"method": {
"shortName": "ImportTaxonomies",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ImportTaxonomies",
"service": {
"shortName": "PolicyTagManagerSerialization",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerialization"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
},
{
"regionTag": "datacatalog_v1_generated_PolicyTagManagerSerialization_ReplaceTaxonomy_sync",
"title": "datacatalog ReplaceTaxonomy Sample",
"description": "ReplaceTaxonomy replaces (updates) a taxonomy and all its policy tags.\n\nThe taxonomy and its entire hierarchy of policy tags must be\nrepresented literally by SerializedTaxonomy and the nested\nSerializedPolicyTag messages.\n\nThis operation automatically does the following: \n\n\tDeletes the existing policy tags that are missing from the\n\tSerializedPolicyTag.\n\n\tCreates policy tags that don’t have resource names. They are considered\n\tnew.\n\n\tUpdates policy tags with valid resources names accordingly.",
"file": "PolicyTagManagerSerializationClient/ReplaceTaxonomy/main.go",
"language": "GO",
"clientMethod": {
"shortName": "ReplaceTaxonomy",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerializationClient.ReplaceTaxonomy",
"parameters": [
{
"type": "context.Context",
"name": "ctx"
},
{
"type": "datacatalogpb.ReplaceTaxonomyRequest",
"name": "req"
},
{
"type": "...gax.CallOption",
"name": "opts"
}
],
"resultType": "datacatalogpb.Taxonomy",
"client": {
"shortName": "PolicyTagManagerSerializationClient",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerializationClient"
},
"method": {
"shortName": "ReplaceTaxonomy",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ReplaceTaxonomy",
"service": {
"shortName": "PolicyTagManagerSerialization",
"fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerialization"
}
}
},
"origin": "API_DEFINITION",
"segments": [
{
"start": 18,
"end": 52,
"type": "FULL"
}
]
}
]
}