Documentation

Google_Service_DataCatalog_Resource_ProjectsLocationsTaxonomies extends Google_Service_Resource
in package

Application

The "taxonomies" collection of methods.

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

$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_GoogleCloudDatacatalogV1beta1Taxonomy: Creates a taxonomy in the specified project. (taxonomies.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_DataCatalog_DatacatalogEmpty: Deletes a taxonomy. This operation will also delete all policy tags in this taxonomy along with their associated policies. (taxonomies.delete)
export() : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1ExportTaxonomiesResponse: Exports all taxonomies and their policy tags in a project. This method generates SerializedTaxonomy protos with nested policy tags that can be used as an input for future ImportTaxonomies calls. (taxonomies.export)
get() : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Taxonomy: Gets a taxonomy. (taxonomies.get)
getIamPolicy() : Google_Service_DataCatalog_Policy: Gets the IAM policy for a taxonomy or a policy tag. (taxonomies.getIamPolicy)
import() : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1ImportTaxonomiesResponse: Imports all taxonomies and their policy tags to a project as new taxonomies.
listProjectsLocationsTaxonomies() : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1ListTaxonomiesResponse: Lists all taxonomies in a project in a particular location that the caller has permission to view. (taxonomies.listProjectsLocationsTaxonomies)
patch() : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Taxonomy: Updates a taxonomy. (taxonomies.patch)
setIamPolicy() : Google_Service_DataCatalog_Policy: Sets the IAM policy for a taxonomy or a policy tag. (taxonomies.setIamPolicy)
testIamPermissions() : Google_Service_DataCatalog_TestIamPermissionsResponse: Returns the permissions that a caller has on the specified taxonomy or policy tag. (taxonomies.testIamPermissions)
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 taxonomy in the specified project. (taxonomies.create)


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

Parameters

$parent : string: Required. Resource name of the project that the taxonomy will belong to.
$postBody : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Taxonomy
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Taxonomy —

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 taxonomy. This operation will also delete all policy tags in this taxonomy along with their associated policies. (taxonomies.delete)


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

Parameters

$name : string: Required. Resource name of the taxonomy to be deleted. All policy tags in this taxonomy will also be deleted.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DataCatalog_DatacatalogEmpty —

export()

Exports all taxonomies and their policy tags in a project. This method generates SerializedTaxonomy protos with nested policy tags that can be used as an input for future ImportTaxonomies calls. (taxonomies.export)


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

Parameters

$parent : string: Required. Resource name of the project that taxonomies to be exported will share.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1ExportTaxonomiesResponse —

get()

Gets a taxonomy. (taxonomies.get)


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

Parameters

$name : string: Required. Resource name of the requested taxonomy.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Taxonomy —

getIamPolicy()

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

import()

Imports all taxonomies and their policy tags to a project as new taxonomies.


    public
                import(string $parent, Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1ImportTaxonomiesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1ImportTaxonomiesResponse

This method provides a bulk taxonomy / policy tag creation using nested proto structure. (taxonomies.import)

Parameters

$parent : string: Required. Resource name of project that the imported taxonomies will belong to.
$postBody : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1ImportTaxonomiesRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1ImportTaxonomiesResponse —

listProjectsLocationsTaxonomies()

Lists all taxonomies in a project in a particular location that the caller has permission to view. (taxonomies.listProjectsLocationsTaxonomies)


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

Parameters

$parent : string: Required. Resource name of the project to list the taxonomies of.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1ListTaxonomiesResponse —

patch()

Updates a taxonomy. (taxonomies.patch)


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

Parameters

$name : string: Output only. Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}".
$postBody : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Taxonomy
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1Taxonomy —

setIamPolicy()

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