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 PredictionResult (0.2.1)

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

PredictionResult is the result of using a model to create predictions.

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

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 PredictionResult. format: `/projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}`
`↳ 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 PredictionResult (creating, active, deleting, etc.)
`↳ dataset`	`string` Required. The resource name of the Dataset to do predictions on Format: `/projects/{project_num}/locations/{location}/instances/{instance}/dataset/{dataset_id}`
`↳ model`	`string` Required. The resource name of the Model to use to use to make predictions Format: `/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}`
`↳ end_time`	`Google\Protobuf\Timestamp` Required. Specifies the latest time from which data is used to generate features for predictions. This time should be no later than the end of the date_range of the dataset.
`↳ prediction_periods`	`int` The number of consecutive months to produce predictions for, ending with the last full month prior to end_time according to the dataset's timezone.
`↳ outputs`	`PredictionResult\Outputs` Required. Where to write the output of the predictions.
`↳ line_of_business`	`int` Output only. The line of business (Retail/Commercial) this prediction is for. Determined by Model, cannot be set by user.

getName

Output only. The resource name of the PredictionResult.

format: /projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}

Returns
Type	Description
`string`

setName

Output only. The resource name of the PredictionResult.

format: /projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}

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

Returns
Type	Description
`int`	Enum of type State.

setState

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

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

Returns
Type	Description
`$this`

getDataset

Required. The resource name of the Dataset to do predictions on Format: /projects/{project_num}/locations/{location}/instances/{instance}/dataset/{dataset_id}

Returns
Type	Description
`string`

setDataset

Required. The resource name of the Dataset to do predictions on Format: /projects/{project_num}/locations/{location}/instances/{instance}/dataset/{dataset_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getModel

Required. The resource name of the Model to use to use to make predictions Format: /projects/{project_num}/locations/{location}/instances/{instance}/models/{model}

Returns
Type	Description
`string`

setModel

Required. The resource name of the Model to use to use to make predictions Format: /projects/{project_num}/locations/{location}/instances/{instance}/models/{model}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getEndTime

Required. Specifies the latest time from which data is used to generate features for predictions. This 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. Specifies the latest time from which data is used to generate features for predictions. This 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`

getPredictionPeriods

The number of consecutive months to produce predictions for, ending with the last full month prior to end_time according to the dataset's timezone.

Returns
Type	Description
`int`

setPredictionPeriods

The number of consecutive months to produce predictions for, ending with the last full month prior to end_time according to the dataset's timezone.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getOutputs

Required. Where to write the output of the predictions.

Returns
Type	Description
`PredictionResult\Outputs\|null`

hasOutputs

clearOutputs

setOutputs

Required. Where to write the output of the predictions.

Parameter
Name	Description
`var`	`PredictionResult\Outputs`

Returns
Type	Description
`$this`

getLineOfBusiness

Output only. The line of business (Retail/Commercial) this prediction is for. Determined by Model, cannot be set by user.

Returns
Type	Description
`int`	Enum of type LineOfBusiness.

setLineOfBusiness

Output only. The line of business (Retail/Commercial) this prediction is for. Determined by Model, cannot be set by user.

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

Returns
Type	Description
`$this`