Google Cloud Ai Platform V1 Client - Class SearchModelDeploymentMonitoringStatsAnomaliesRequest (0.28.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class SearchModelDeploymentMonitoringStatsAnomaliesRequest.

Request message for JobService.SearchModelDeploymentMonitoringStatsAnomalies.

Generated from protobuf message google.cloud.aiplatform.v1.SearchModelDeploymentMonitoringStatsAnomaliesRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ model_deployment_monitoring_job`	`string` Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
`↳ deployed_model_id`	`string` Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id].
`↳ feature_display_name`	`string` The feature display name. If specified, only return the stats belonging to this feature. Format: ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name, example: "user_destination".
`↳ objectives`	`array<Google\Cloud\AIPlatform\V1\SearchModelDeploymentMonitoringStatsAnomaliesRequest\StatsAnomaliesObjective>` Required. Objectives of the stats to retrieve.
`↳ page_size`	`int` The standard list page size.
`↳ page_token`	`string` A page token received from a previous JobService.SearchModelDeploymentMonitoringStatsAnomalies call.
`↳ start_time`	`Google\Protobuf\Timestamp` The earliest timestamp of stats being generated. If not set, indicates fetching stats till the earliest possible one.
`↳ end_time`	`Google\Protobuf\Timestamp` The latest timestamp of stats being generated. If not set, indicates feching stats till the latest possible one.

getModelDeploymentMonitoringJob

Required. ModelDeploymentMonitoring Job resource name.

Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

Returns
Type	Description
`string`

setModelDeploymentMonitoringJob

Required. ModelDeploymentMonitoring Job resource name.

Format: projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDeployedModelId

Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id].

Returns
Type	Description
`string`

setDeployedModelId

Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id].

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFeatureDisplayName

The feature display name. If specified, only return the stats belonging to this feature. Format: ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name, example: "user_destination".

Returns
Type	Description
`string`

setFeatureDisplayName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getObjectives

Required. Objectives of the stats to retrieve.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setObjectives

Required. Objectives of the stats to retrieve.

Parameter
Name	Description
`var`	`array<Google\Cloud\AIPlatform\V1\SearchModelDeploymentMonitoringStatsAnomaliesRequest\StatsAnomaliesObjective>`

Returns
Type	Description
`$this`

getPageSize

The standard list page size.

Returns
Type	Description
`int`

setPageSize

The standard list page size.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

A page token received from a previous JobService.SearchModelDeploymentMonitoringStatsAnomalies call.

Returns
Type	Description
`string`

setPageToken

A page token received from a previous JobService.SearchModelDeploymentMonitoringStatsAnomalies call.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStartTime

The earliest timestamp of stats being generated.

If not set, indicates fetching stats till the earliest possible one.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasStartTime

clearStartTime

setStartTime

The earliest timestamp of stats being generated.

If not set, indicates fetching stats till the earliest possible one.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getEndTime

The latest timestamp of stats being generated.

If not set, indicates feching stats till the latest possible one.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasEndTime

clearEndTime

setEndTime

The latest timestamp of stats being generated.

If not set, indicates feching stats till the latest possible one.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`modelDeploymentMonitoringJob`	`string` Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}` Please see Google\Cloud\AIPlatform\V1\JobServiceClient::modelDeploymentMonitoringJobName() for help formatting this field.
`deployedModelId`	`string` Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id].

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\SearchModelDeploymentMonitoringStatsAnomaliesRequest`