Documentation

Google_Service_DataCatalog_Resource_ProjectsLocationsTagTemplates extends Google_Service_Resource
in package

Application

The "tagTemplates" collection of methods.

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

$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_GoogleCloudDatacatalogV1beta1TagTemplate: Creates a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource- project) for more information). (tagTemplates.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_DataCatalog_DatacatalogEmpty: Deletes a tag template and all tags using the template. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data- catalog/docs/concepts/resource-project) for more information).
get() : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1TagTemplate: Gets a tag template. (tagTemplates.get)
getIamPolicy() : Google_Service_DataCatalog_Policy: Gets the access control policy for a resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. (tagTemplates.getIamPolicy)
patch() : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1TagTemplate: Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. Users should enable the Data Catalog API in the project identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). (tagTemplates.patch)
setIamPolicy() : Google_Service_DataCatalog_Policy: Sets the access control policy for a resource. Replaces any existing policy.
testIamPermissions() : Google_Service_DataCatalog_TestIamPermissionsResponse: Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a `NOT_FOUND` error). Supported resources are: - Tag templates. - Entries. - Entry groups.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

Return values

Google_Http_Request|expectedClass —

create()

Creates a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource- project) for more information). (tagTemplates.create)


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

Parameters

$parent : string: Required. The name of the project and the template location [region](https://cloud.google.com/data- catalog/docs/concepts/regions. Example: * projects/{project_id}/locations/us- central1
$postBody : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1TagTemplate
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1TagTemplate —

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>

Return values

string —

$requestUrl

delete()

Deletes a tag template and all tags using the template. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data- catalog/docs/concepts/resource-project) for more information).


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

(tagTemplates.delete)

Parameters

$name : string: Required. The name of the tag template to delete. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DataCatalog_DatacatalogEmpty —

get()

Gets a tag template. (tagTemplates.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1TagTemplate

Parameters

$name : string: Required. The name of the tag template. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1TagTemplate —

getIamPolicy()

Gets the access control policy for a resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. (tagTemplates.getIamPolicy)


    public
                getIamPolicy(string $resource, Google_Service_DataCatalog_GetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataCatalog_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_DataCatalog_GetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DataCatalog_Policy —

patch()

Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. Users should enable the Data Catalog API in the project identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). (tagTemplates.patch)


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

Parameters

$name : string: The resource name of the tag template in URL format. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} Note that this TagTemplate and its child resources may not actually be stored in the location in this name.
$postBody : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1TagTemplate
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1TagTemplate —

setIamPolicy()

Sets the access control policy for a resource. Replaces any existing policy.


    public
                setIamPolicy(string $resource, Google_Service_DataCatalog_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataCatalog_Policy

Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission - datacatalog.tagTemplates.setIamPolicy to set policies on tag templates. - datacatalog.entries.setIamPolicy to set policies on entries. - datacatalog.entryGroups.setIamPolicy to set policies on entry groups. (tagTemplates.setIamPolicy)

Parameters

$resource : string: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_DataCatalog_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DataCatalog_Policy —

testIamPermissions()

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a `NOT_FOUND` error). Supported resources are: - Tag templates. - Entries. - Entry groups.


    public
                testIamPermissions(string $resource, Google_Service_DataCatalog_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataCatalog_TestIamPermissionsResponse

Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. A caller is not required to have Google IAM permission to make this request. (tagTemplates.testIamPermissions)

Parameters

$resource : string: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_DataCatalog_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DataCatalog_TestIamPermissionsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —