Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

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

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

The EngineConfig resource creates the configuration for training a model.

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

Namespace

Google \ Cloud \ FinancialServices \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. The resource name of the EngineConfig. format: `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`
`↳ 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 EngineConfig (creating, active, deleting, etc.)
`↳ engine_version`	`string` Required. The resource name of the EngineVersion used in this model tuning. format: `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`
`↳ tuning`	`EngineConfig\Tuning` Optional. Configuration for tuning in creation of the EngineConfig. This field is required if `hyperparameter_source.type` is not `INHERITED`, and output-only otherwise.
`↳ performance_target`	`EngineConfig\PerformanceTarget` Optional. PerformanceTarget gives information on how the tuning and training will be evaluated. This field is required if `hyperparameter_source.type` is not `INHERITED`, and output-only otherwise.
`↳ line_of_business`	`int` Output only. The line of business (Retail/Commercial) this engine config is used for. Determined by EngineVersion, cannot be set by user.
`↳ hyperparameter_source_type`	`int` Optional. The origin of hyperparameters for the created EngineConfig. The default is `TUNING`. In this case, the hyperparameters are selected as a result of a tuning run.
`↳ hyperparameter_source`	`EngineConfig\HyperparameterSource` Optional. Configuration of hyperparameters source EngineConfig.

getName

Output only. The resource name of the EngineConfig.

format: /projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}

Returns
Type	Description
`string`

setName

Output only. The resource name of the EngineConfig.

format: /projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}

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 EngineConfig (creating, active, deleting, etc.)

Returns
Type	Description
`int`	Enum of type State.

setState

Output only. State of the EngineConfig (creating, active, deleting, etc.)

Parameter
Name	Description
`var`	`int` Enum of type State.

Returns
Type	Description
`$this`

getEngineVersion

Required. The resource name of the EngineVersion used in this model tuning.

format: /projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}

Returns
Type	Description
`string`

setEngineVersion

Required. The resource name of the EngineVersion used in this model tuning.

format: /projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTuning

Optional. Configuration for tuning in creation of the EngineConfig.

This field is required if hyperparameter_source.type is not INHERITED, and output-only otherwise.

Returns
Type	Description
`EngineConfig\Tuning\|null`

hasTuning

clearTuning

setTuning

Optional. Configuration for tuning in creation of the EngineConfig.

This field is required if hyperparameter_source.type is not INHERITED, and output-only otherwise.

Parameter
Name	Description
`var`	`EngineConfig\Tuning`

Returns
Type	Description
`$this`

getPerformanceTarget

Optional. PerformanceTarget gives information on how the tuning and training will be evaluated. This field is required if hyperparameter_source.type is not INHERITED, and output-only otherwise.

Returns
Type	Description
`EngineConfig\PerformanceTarget\|null`

hasPerformanceTarget

clearPerformanceTarget

setPerformanceTarget

Optional. PerformanceTarget gives information on how the tuning and training will be evaluated. This field is required if hyperparameter_source.type is not INHERITED, and output-only otherwise.

Parameter
Name	Description
`var`	`EngineConfig\PerformanceTarget`

Returns
Type	Description
`$this`

getLineOfBusiness

Output only. The line of business (Retail/Commercial) this engine config is used for. Determined by EngineVersion, cannot be set by user.

Returns
Type	Description
`int`	Enum of type LineOfBusiness.

setLineOfBusiness

Output only. The line of business (Retail/Commercial) this engine config is used for. Determined by EngineVersion, cannot be set by user.

Parameter
Name	Description
`var`	`int` Enum of type LineOfBusiness.

Returns
Type	Description
`$this`

getHyperparameterSourceType

Optional. The origin of hyperparameters for the created EngineConfig. The default is TUNING. In this case, the hyperparameters are selected as a result of a tuning run.

Returns
Type	Description
`int`	Enum of type HyperparameterSourceType.

setHyperparameterSourceType

Optional. The origin of hyperparameters for the created EngineConfig. The default is TUNING. In this case, the hyperparameters are selected as a result of a tuning run.

Parameter
Name	Description
`var`	`int` Enum of type HyperparameterSourceType.

Returns
Type	Description
`$this`

getHyperparameterSource

Optional. Configuration of hyperparameters source EngineConfig.

Returns
Type	Description
`EngineConfig\HyperparameterSource\|null`

hasHyperparameterSource

clearHyperparameterSource

setHyperparameterSource

Optional. Configuration of hyperparameters source EngineConfig.

Parameter
Name	Description
`var`	`EngineConfig\HyperparameterSource`

Returns
Type	Description
`$this`