Data Loss Prevention V2 Client - Class CreateStoredInfoTypeRequest (1.11.0)

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
NameDescription
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 Google\Cloud\Dlp\V2\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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getConfig

Required. Configuration of the storedInfoType to create.

Returns
TypeDescription
Google\Cloud\Dlp\V2\StoredInfoTypeConfig|null

hasConfig

clearConfig

setConfig

Required. Configuration of the storedInfoType to create.

Parameter
NameDescription
var Google\Cloud\Dlp\V2\StoredInfoTypeConfig
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getLocationId

Deprecated. This field has no effect.

Returns
TypeDescription
string

setLocationId

Deprecated. This field has no effect.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
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.

config Google\Cloud\Dlp\V2\StoredInfoTypeConfig

Required. Configuration of the storedInfoType to create.

Returns
TypeDescription
Google\Cloud\Dlp\V2\CreateStoredInfoTypeRequest