Google Cloud Financial Services V1 Client - Class ImportRegisteredPartiesRequest (0.2.1)

Version latest

• 0.2.1 (latest)
• 0.2.0
• 0.1.1

Reference documentation and code samples for the Google Cloud Financial Services V1 Client class ImportRegisteredPartiesRequest.

Request for adding/removing registered parties from BigQuery tables specified by the customer.

Generated from protobuf message google.cloud.financialservices.v1.ImportRegisteredPartiesRequest

Namespace

Google \ Cloud \ FinancialServices \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Required. The full path to the Instance resource in this API. format: projects/{project}/locations/{location}/instances/{instance}
↳ party_tables	array Optional. List of BigQuery tables. Union of tables will be taken if there is more than one table. VPC-SC restrictions apply. format: bq://{project}.{bqDatasetID}.{bqTableID} Use of datasets is preferred over the latter due to its simplicity and the reduced risk of errors party_tables and datasets must not be provided at the same time
↳ mode	int Required. Mode of the request.
↳ validate_only	bool Optional. If the request will not register the parties, just determine what would happen.
↳ line_of_business	int Required. LineOfBusiness for the specified registered parties.

getName

Required. The full path to the Instance resource in this API.

format: projects/{project}/locations/{location}/instances/{instance}

Returns
Type	Description
string

setName

Required. The full path to the Instance resource in this API.

format: projects/{project}/locations/{location}/instances/{instance}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPartyTables

Optional. List of BigQuery tables. Union of tables will be taken if there is more than one table. VPC-SC restrictions apply. format: bq://{project}.{bqDatasetID}.{bqTableID} Use of datasets is preferred over the latter due to its simplicity and the reduced risk of errors party_tables and datasets must not be provided at the same time

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setPartyTables

Optional. List of BigQuery tables. Union of tables will be taken if there is more than one table. VPC-SC restrictions apply. format: bq://{project}.{bqDatasetID}.{bqTableID} Use of datasets is preferred over the latter due to its simplicity and the reduced risk of errors party_tables and datasets must not be provided at the same time

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getMode

Required. Mode of the request.

Returns
Type	Description
int	Enum of type UpdateMode.

setMode

Required. Mode of the request.

Parameter
Name	Description
var	int Enum of type UpdateMode.

Returns
Type	Description
$this

getValidateOnly

Optional. If the request will not register the parties, just determine what would happen.

Returns
Type	Description
bool

setValidateOnly

Optional. If the request will not register the parties, just determine what would happen.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getLineOfBusiness

Required. LineOfBusiness for the specified registered parties.

Returns
Type	Description
int	Enum of type LineOfBusiness.

setLineOfBusiness

Required. LineOfBusiness for the specified registered parties.

Parameter
Name	Description
var	int Enum of type LineOfBusiness.

Returns
Type	Description
$this

static::build

Parameters
Name	Description
name	string Required. The full path to the Instance resource in this API. format: projects/{project}/locations/{location}/instances/{instance} Please see AMLClient::instanceName() for help formatting this field.
mode	int Required. Mode of the request. For allowed values, use constants defined on ImportRegisteredPartiesRequest\UpdateMode
lineOfBusiness	int Required. LineOfBusiness for the specified registered parties. For allowed values, use constants defined on LineOfBusiness
partyTables	string[] Optional. List of BigQuery tables. Union of tables will be taken if there is more than one table. VPC-SC restrictions apply. format: bq://{project}.{bqDatasetID}.{bqTableID} Use of datasets is preferred over the latter due to its simplicity and the reduced risk of errors party_tables and datasets must not be provided at the same time

Returns
Type	Description
ImportRegisteredPartiesRequest