Documentation

Google_Service_DLP_Resource_OrganizationsDeidentifyTemplates extends Google_Service_Resource
in package

The "deidentifyTemplates" collection of methods.

Typical usage is: $dlpService = new Google_Service_DLP(...); $deidentifyTemplates = $dlpService->deidentifyTemplates;

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_DLP_GooglePrivacyDlpV2DeidentifyTemplate
Creates a DeidentifyTemplate for re-using frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_DLP_GoogleProtobufEmpty
Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating- templates-deid to learn more. (deidentifyTemplates.delete)
get()  : Google_Service_DLP_GooglePrivacyDlpV2DeidentifyTemplate
Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating- templates-deid to learn more. (deidentifyTemplates.get)
listOrganizationsDeidentifyTemplates()  : Google_Service_DLP_GooglePrivacyDlpV2ListDeidentifyTemplatesResponse
Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating- templates-deid to learn more.
patch()  : Google_Service_DLP_GooglePrivacyDlpV2DeidentifyTemplate
Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs /creating-templates-deid to learn more. (deidentifyTemplates.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 DeidentifyTemplate for re-using frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

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

(deidentifyTemplates.create)

Parameters
$parent : string

Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location: + Projects scope, location specified: projects/PROJECT_ID/locations/LOCATION_ID + Projects scope, no location specified (defaults to global): projects/PROJECT_ID + Organizations scope, location specified: organizations/ORG_ID/locations/LOCATION_ID + Organizations scope, no location specified (defaults to global): organizations/ORG_ID The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data: parent=projects/example-project/locations/europe-west3

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

Optional parameters.

Return values
Google_Service_DLP_GooglePrivacyDlpV2DeidentifyTemplate —

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 DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating- templates-deid to learn more. (deidentifyTemplates.delete)

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

Required. Resource name of the organization and deidentify template to be deleted, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project- id/deidentifyTemplates/432452342.

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

Optional parameters.

Return values
Google_Service_DLP_GoogleProtobufEmpty —

get()

Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating- templates-deid to learn more. (deidentifyTemplates.get)

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

Required. Resource name of the organization and deidentify template to be read, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project- id/deidentifyTemplates/432452342.

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

Optional parameters.

Return values
Google_Service_DLP_GooglePrivacyDlpV2DeidentifyTemplate —

listOrganizationsDeidentifyTemplates()

Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating- templates-deid to learn more.

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

(deidentifyTemplates.listOrganizationsDeidentifyTemplates)

Parameters
$parent : string

Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location: + Projects scope, location specified: projects/PROJECT_ID/locations/LOCATION_ID + Projects scope, no location specified (defaults to global): projects/PROJECT_ID + Organizations scope, location specified: organizations/ORG_ID/locations/LOCATION_ID + Organizations scope, no location specified (defaults to global): organizations/ORG_ID The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data: parent=projects/example-project/locations/europe-west3

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

Optional parameters.

Tags
opt_param

string locationId Deprecated. This field has no effect.

opt_param

string orderBy Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: name asc,update_time, create_time desc Supported fields are: - create_time: corresponds to time the template was created. - update_time: corresponds to time the template was last updated. - name: corresponds to template's name. - display_name: corresponds to template's display name.

opt_param

string pageToken Page token to continue retrieval. Comes from previous call to ListDeidentifyTemplates.

opt_param

int pageSize Size of the page, can be limited by server. If zero server returns a page of max size 100.

Return values
Google_Service_DLP_GooglePrivacyDlpV2ListDeidentifyTemplatesResponse —

patch()

Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs /creating-templates-deid to learn more. (deidentifyTemplates.patch)

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

Required. Resource name of organization and deidentify template to be updated, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project- id/deidentifyTemplates/432452342.

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

Optional parameters.

Return values
Google_Service_DLP_GooglePrivacyDlpV2DeidentifyTemplate —

convertToArrayAndStripNulls()

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

Search results