Documentation

Google_Service_DataCatalog_Resource_ProjectsLocationsTaxonomiesPolicyTags extends Google_Service_Resource
in package

The "policyTags" collection of methods.

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

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_GoogleCloudDatacatalogV1beta1PolicyTag
Creates a policy tag in the specified taxonomy. (policyTags.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_DataCatalog_DatacatalogEmpty
Deletes a policy tag. Also deletes all of its descendant policy tags.
get()  : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1PolicyTag
Gets a policy tag. (policyTags.get)
getIamPolicy()  : Google_Service_DataCatalog_Policy
Gets the IAM policy for a taxonomy or a policy tag. (policyTags.getIamPolicy)
listProjectsLocationsTaxonomiesPolicyTags()  : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1ListPolicyTagsResponse
Lists all policy tags in a taxonomy.
patch()  : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1PolicyTag
Updates a policy tag. (policyTags.patch)
setIamPolicy()  : Google_Service_DataCatalog_Policy
Sets the IAM policy for a taxonomy or a policy tag. (policyTags.setIamPolicy)
testIamPermissions()  : Google_Service_DataCatalog_TestIamPermissionsResponse
Returns the permissions that a caller has on the specified taxonomy or policy tag. (policyTags.testIamPermissions)
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 policy tag in the specified taxonomy. (policyTags.create)

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

Required. Resource name of the taxonomy that the policy tag will belong to.

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

Optional parameters.

Return values
Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1PolicyTag —

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 policy tag. Also deletes all of its descendant policy tags.

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

(policyTags.delete)

Parameters
$name : string

Required. Resource name of the policy tag to be deleted. All of its descendant policy tags will also be deleted.

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

Optional parameters.

Return values
Google_Service_DataCatalog_DatacatalogEmpty —

getIamPolicy()

Gets the IAM policy for a taxonomy or a policy tag. (policyTags.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 —

listProjectsLocationsTaxonomiesPolicyTags()

Lists all policy tags in a taxonomy.

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

(policyTags.listProjectsLocationsTaxonomiesPolicyTags)

Parameters
$parent : string

Required. Resource name of the taxonomy to list the policy tags of.

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

Optional parameters.

Tags
opt_param

string pageToken The next_page_token value returned from a previous List request, if any. If not set, defaults to an empty string.

opt_param

int pageSize The maximum number of items to return. Must be a value between 1 and 1000. If not set, defaults to 50.

Return values
Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1ListPolicyTagsResponse —

patch()

Updates a policy tag. (policyTags.patch)

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

Output only. Resource name of this policy tag, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{tax onomy_id}/policyTags/{id}".

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

Optional parameters.

Tags
opt_param

string updateMask The update mask applies to the resource. Only display_name, description and parent_policy_tag can be updated and thus can be listed in the mask. If update_mask is not provided, all allowed fields (i.e. display_name, description and parent) will be updated. For more information including the FieldMask definition, see https://developers.google.com/protocol- buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.

Return values
Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1PolicyTag —

setIamPolicy()

Sets the IAM policy for a taxonomy or a policy tag. (policyTags.setIamPolicy)

public setIamPolicy(string $resource, Google_Service_DataCatalog_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataCatalog_Policy
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 permissions that a caller has on the specified taxonomy or policy tag. (policyTags.testIamPermissions)

public testIamPermissions(string $resource, Google_Service_DataCatalog_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataCatalog_TestIamPermissionsResponse
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 —

Search results