1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Aiplatform
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsModelDeploymentMonitoringJobs

ProjectsLocationsModelDeploymentMonitoringJobs

class ProjectsLocationsModelDeploymentMonitoringJobs extends Resource (View source)

The "modelDeploymentMonitoringJobs" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $modelDeploymentMonitoringJobs = $aiplatformService->projects_locations_modelDeploymentMonitoringJobs;

Methods

GoogleCloudAiplatformV1ModelDeploymentMonitoringJob
create(string $parent, GoogleCloudAiplatformV1ModelDeploymentMonitoringJob $postBody, array $optParams = [])

Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval. (modelDeploymentMonitoringJobs.create)

GoogleLongrunningOperation
delete(string $name, array $optParams = [])

Deletes a ModelDeploymentMonitoringJob.

GoogleCloudAiplatformV1ModelDeploymentMonitoringJob
get(string $name, array $optParams = [])

Gets a ModelDeploymentMonitoringJob. (modelDeploymentMonitoringJobs.get)

GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse
listProjectsLocationsModelDeploymentMonitoringJobs(string $parent, array $optParams = [])

Lists ModelDeploymentMonitoringJobs in a Location. (modelDeploymentMonitoring Jobs.listProjectsLocationsModelDeploymentMonitoringJobs)

GoogleLongrunningOperation
patch(string $name, GoogleCloudAiplatformV1ModelDeploymentMonitoringJob $postBody, array $optParams = [])

Updates a ModelDeploymentMonitoringJob. (modelDeploymentMonitoringJobs.patch)

GoogleProtobufEmpty
pause(string $name, GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest $postBody, array $optParams = [])

Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.

GoogleProtobufEmpty
resume(string $name, GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest $postBody, array $optParams = [])

Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse
searchModelDeploymentMonitoringStatsAnomalies(string $modelDeploymentMonitoringJob, GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest $postBody, array $optParams = [])

Searches Model Monitoring Statistics generated within a given time window.

Details

at line 51
GoogleCloudAiplatformV1ModelDeploymentMonitoringJob create(string $parent, GoogleCloudAiplatformV1ModelDeploymentMonitoringJob $postBody, array $optParams = [])

Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval. (modelDeploymentMonitoringJobs.create)

Parameters

string $parent

Required. The parent of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}
GoogleCloudAiplatformV1ModelDeploymentMonitoringJob $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ModelDeploymentMonitoringJob

Exceptions

Exception

at line 68
GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes a ModelDeploymentMonitoringJob.

(modelDeploymentMonitoringJobs.delete)

Parameters

string $name

Required. The resource name of the model monitoring job to delete. Format: projects/{project}/locations/{location}/modelDeploymentMo nitoringJobs/{model_deployment_monitoring_job}
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 84
GoogleCloudAiplatformV1ModelDeploymentMonitoringJob get(string $name, array $optParams = [])

Gets a ModelDeploymentMonitoringJob. (modelDeploymentMonitoringJobs.get)

Parameters

string $name

Required. The resource name of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location }/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ModelDeploymentMonitoringJob

Exceptions

Exception

at line 115
GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse listProjectsLocationsModelDeploymentMonitoringJobs(string $parent, array $optParams = [])

Lists ModelDeploymentMonitoringJobs in a Location. (modelDeploymentMonitoring Jobs.listProjectsLocationsModelDeploymentMonitoringJobs)

Parameters

string $parent

Required. The parent of the ModelDeploymentMonitoringJob. Format: projects/{project}/locations/{location}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse

Exceptions

Exception

at line 150
GoogleLongrunningOperation patch(string $name, GoogleCloudAiplatformV1ModelDeploymentMonitoringJob $postBody, array $optParams = [])

Updates a ModelDeploymentMonitoringJob. (modelDeploymentMonitoringJobs.patch)

Parameters

string $name

Output only. Resource name of a ModelDeploymentMonitoringJob.
GoogleCloudAiplatformV1ModelDeploymentMonitoringJob $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 170
GoogleProtobufEmpty pause(string $name, GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest $postBody, array $optParams = [])

Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.

(modelDeploymentMonitoringJobs.pause)

Parameters

string $name

Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: projects/{project}/locations/ {location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}
GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

at line 189
GoogleProtobufEmpty resume(string $name, GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest $postBody, array $optParams = [])

Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

(modelDeploymentMonitoringJobs.resume)

Parameters

string $name

Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: projects/{project}/locations /{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}
GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

at line 208
GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse searchModelDeploymentMonitoringStatsAnomalies(string $modelDeploymentMonitoringJob, GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest $postBody, array $optParams = [])

Searches Model Monitoring Statistics generated within a given time window.

(modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies)

Parameters

string $modelDeploymentMonitoringJob

Required. ModelDeploymentMonitoring Job resource name. Format: projects/{project}/loca tions/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_j ob}
GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse

Exceptions

Exception