Data Loss Prevention V2 Client - Class ListInspectTemplatesRequest (2.2.0)

Reference documentation and code samples for the Data Loss Prevention V2 Client class ListInspectTemplatesRequest.

Request message for ListInspectTemplates.

Generated from protobuf message google.privacy.dlp.v2.ListInspectTemplatesRequest

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ 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
↳ page_token string

Page token to continue retrieval. Comes from the previous call to ListInspectTemplates.
↳ page_size int

Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
↳ order_by string

Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The 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 the time the template was created. - update_time: corresponds to the time the template was last updated. - name: corresponds to the template's name. - display_name: corresponds to the template's display name.
↳ location_id string

Deprecated. This field has no effect.

getParent

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
Returns
Type Description
string

setParent

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
Parameter
Name Description
var string
Returns
Type Description
$this

getPageToken

Page token to continue retrieval. Comes from the previous call to ListInspectTemplates.

Returns
Type Description
string

setPageToken

Page token to continue retrieval. Comes from the previous call to ListInspectTemplates.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.

Returns
Type Description
int

setPageSize

Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.

Parameter
Name Description
var int
Returns
Type Description
$this

getOrderBy

Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The 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 the time the template was created.
  • update_time: corresponds to the time the template was last updated.
  • name: corresponds to the template's name.
  • display_name: corresponds to the template's display name.
Returns
Type Description
string

setOrderBy

Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The 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 the time the template was created.
  • update_time: corresponds to the time the template was last updated.
  • name: corresponds to the template's name.
  • display_name: corresponds to the template's display name.
Parameter
Name Description
var string
Returns
Type Description
$this

getLocationId

Deprecated. This field has no effect.

Returns
Type Description
string

setLocationId

Deprecated. This field has no effect.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
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 Please see Google\Cloud\Dlp\V2\DlpServiceClient::organizationLocationName() for help formatting this field.
Returns
Type Description
Google\Cloud\Dlp\V2\ListInspectTemplatesRequest