Reference documentation and code samples for the Google Cloud Financial Services V1 Client class Model.
Model represents a trained model.
Generated from protobuf message google.cloud.financialservices.v1.Model
Namespace
Google \ Cloud \ FinancialServices \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The resource name of the Model. format: |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The timestamp of creation of this resource. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The timestamp of the most recent update of this resource. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Labels |
↳ state |
int
Output only. State of the model (creating, active, deleting, etc.) |
↳ engine_version |
string
Output only. The EngineVersion used in training this model. This is output only, and is determined from the EngineConfig used. |
↳ engine_config |
string
Required. The resource name of the EngineConfig the model training will be based on. Format: |
↳ primary_dataset |
string
Required. The resource name of the Primary Dataset used in this model training. For information about how primary and auxiliary datasets are used, refer to the engine version's documentation. Format: |
↳ end_time |
Google\Protobuf\Timestamp
Required. End_time specifies the latest time from which labels are used and from which data is used to generate features for training. End_time should be no later than the end of the date_range of the dataset. |
↳ line_of_business |
int
Output only. The line of business (Retail/Commercial) this model is used for. Determined by EngineConfig, cannot be set by user. |
getName
Output only. The resource name of the Model.
format:
/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. The resource name of the Model.
format:
/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The timestamp of creation of this resource.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp of creation of this resource.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The timestamp of the most recent update of this resource.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp of the most recent update of this resource.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Labels
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Labels
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. State of the model (creating, active, deleting, etc.)
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. State of the model (creating, active, deleting, etc.)
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEngineVersion
Output only. The EngineVersion used in training this model. This is output only, and is determined from the EngineConfig used.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEngineVersion
Output only. The EngineVersion used in training this model. This is output only, and is determined from the EngineConfig used.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEngineConfig
Required. The resource name of the EngineConfig the model training will be
based on. Format:
/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engineConfig}
| Returns | |
|---|---|
| Type | Description |
string |
|
setEngineConfig
Required. The resource name of the EngineConfig the model training will be
based on. Format:
/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engineConfig}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrimaryDataset
Required. The resource name of the Primary Dataset used in this model
training. For information about how primary and auxiliary datasets are
used, refer to the engine version's documentation. Format:
/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}
| Returns | |
|---|---|
| Type | Description |
string |
|
setPrimaryDataset
Required. The resource name of the Primary Dataset used in this model
training. For information about how primary and auxiliary datasets are
used, refer to the engine version's documentation. Format:
/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndTime
Required. End_time specifies the latest time from which labels are used and from which data is used to generate features for training. End_time should be no later than the end of the date_range of the dataset.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEndTime
clearEndTime
setEndTime
Required. End_time specifies the latest time from which labels are used and from which data is used to generate features for training. End_time should be no later than the end of the date_range of the dataset.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLineOfBusiness
Output only. The line of business (Retail/Commercial) this model is used for. Determined by EngineConfig, cannot be set by user.
| Returns | |
|---|---|
| Type | Description |
int |
|
setLineOfBusiness
Output only. The line of business (Retail/Commercial) this model is used for. Determined by EngineConfig, cannot be set by user.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|