Documentation

Google_Service_DataCatalog_Resource_ProjectsLocationsEntryGroupsEntriesTags extends Google_Service_Resource
in package

The "tags" collection of methods.

Typical usage is: $datacatalogService = new Google_Service_DataCatalog(...); $tags = $datacatalogService->tags;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Tag
Creates a tag on an Entry. Note: The project identified by the `parent` parameter for the [tag](https://cloud.google.com/data-catalog/docs/reference/ rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path- parameters) and the [tag template](https://cloud.google.com/data- catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create #path-parameters) used to create the tag must be from the same organization.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_DataCatalog_DatacatalogEmpty
Deletes a tag. (tags.delete)
listProjectsLocationsEntryGroupsEntriesTags()  : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1ListTagsResponse
Lists the tags on an Entry.
patch()  : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Tag
Updates an existing tag. (tags.patch)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

create()

Creates a tag on an Entry. Note: The project identified by the `parent` parameter for the [tag](https://cloud.google.com/data-catalog/docs/reference/ rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path- parameters) and the [tag template](https://cloud.google.com/data- catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create #path-parameters) used to create the tag must be from the same organization.

public create(string $parent, Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Tag $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Tag

(tags.create)

Parameters
$parent : string

Required. The name of the resource to attach this tag to. Tags can be attached to Entries. Example: * projects/{project_id}/locatio ns/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Tag and its child resources may not actually be stored in the location in this name.

$postBody : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Tag
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Tag

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

Deletes a tag. (tags.delete)

public delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataCatalog_DatacatalogEmpty
Parameters
$name : string

Required. The name of the tag to delete. Example: * proje cts/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{e ntry_id}/tags/{tag_id}

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_DataCatalog_DatacatalogEmpty

listProjectsLocationsEntryGroupsEntriesTags()

Lists the tags on an Entry.

public listProjectsLocationsEntryGroupsEntriesTags(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1ListTagsResponse

(tags.listProjectsLocationsEntryGroupsEntriesTags)

Parameters
$parent : string

Required. The name of the Data Catalog resource to list the tags of. The resource could be an Entry or an EntryGroup. Examples: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} * pro jects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/ {entry_id}

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken Token that specifies which page is requested. If empty, the first page is returned.

opt_param

int pageSize The maximum number of tags to return. Default is 10. Max limit is 1000.

Return values
Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1ListTagsResponse

patch()

Updates an existing tag. (tags.patch)

public patch(string $name, Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Tag $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Tag
Parameters
$name : string

The resource name of the tag in URL format. Example: * pr ojects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries /{entry_id}/tags/{tag_id} where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.

$postBody : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Tag
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask The fields to update on the Tag. If absent or empty, all modifiable fields are updated. Currently the only modifiable field is the field fields.

Return values
Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Tag

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results