Documentation

Google_Service_DataCatalog_Resource_ProjectsLocationsTagTemplatesFields extends Google_Service_Resource
in package

The "fields" collection of methods.

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

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_GoogleCloudDatacatalogV1beta1TagTemplateField
Creates a field in 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). (fields.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_DataCatalog_DatacatalogEmpty
Deletes a field in a tag template and all uses of that field. 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).
patch()  : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1TagTemplateField
Updates a field in a tag template. This method cannot be used to update the field type. 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). (fields.patch)
rename()  : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1TagTemplateField
Renames a field in a tag template. The user 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). (fields.rename)
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 field in 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). (fields.create)

public create(string $parent, Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1TagTemplateField $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1TagTemplateField
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/tagTemplates/{tag_template_id}

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

Optional parameters.

Tags
opt_param

string tagTemplateFieldId Required. The ID of the tag template field to create. Field ids can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template.

Return values
Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1TagTemplateField —

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 field in a tag template and all uses of that field. 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

(fields.delete)

Parameters
$name : string

Required. The name of the tag template field to delete. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_templ ate_id}/fields/{tag_template_field_id}

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

Optional parameters.

Tags
opt_param

bool force Required. Currently, this field must always be set to true. This confirms the deletion of this field from any tags using this field. force = false will be supported in the future.

Return values
Google_Service_DataCatalog_DatacatalogEmpty —

patch()

Updates a field in a tag template. This method cannot be used to update the field type. 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). (fields.patch)

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

Required. The name of the tag template field. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fie lds/{tag_template_field_id}

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

Optional parameters.

Tags
opt_param

string updateMask Optional. The field mask specifies the parts of the template to be updated. Allowed fields: * display_name * type.enum_type * is_required If update_mask is not set or empty, all of the allowed fields above will be updated. When updating an enum type, the provided values will be merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted nor renamed. Updating a template field from optional to required is NOT allowed.

Return values
Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1TagTemplateField —

rename()

Renames a field in a tag template. The user 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). (fields.rename)

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

Required. The name of the tag template. Example: * projec ts/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{t ag_template_field_id}

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

Optional parameters.

Return values
Google_Service_DataCatalog_GoogleCloudDatacatalogV1beta1TagTemplateField —

convertToArrayAndStripNulls()

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

Search results