Data Loss Prevention V2 Client - Class CreateStoredInfoTypeRequest (2.2.1)

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

Request message for CreateStoredInfoType.

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

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
↳ config StoredInfoTypeConfig

Required. Configuration of the storedInfoType to create.
↳ stored_info_type_id string

The storedInfoType ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.
↳ 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

getConfig

Required. Configuration of the storedInfoType to create.

Returns
Type Description
StoredInfoTypeConfig|null

hasConfig

clearConfig

setConfig

Required. Configuration of the storedInfoType to create.

Parameter
Name Description
var StoredInfoTypeConfig
Returns
Type Description
$this

getStoredInfoTypeId

The storedInfoType ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

Returns
Type Description
string

setStoredInfoTypeId

The storedInfoType ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

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

Parameters
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 DlpServiceClient::organizationLocationName() for help formatting this field.
config StoredInfoTypeConfig

Required. Configuration of the storedInfoType to create.
Returns
Type Description
CreateStoredInfoTypeRequest