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

ProjectsLocationsCatalogsModels

class ProjectsLocationsCatalogsModels extends Resource (View source)

The "models" collection of methods.

Typical usage is:

 $retailService = new Google\Service\CloudRetail(...);
 $models = $retailService->projects_locations_catalogs_models;

Methods

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

Creates a new model. (models.create)

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

Deletes an existing model. (models.delete)

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

Gets a model. (models.get)

GoogleCloudRetailV2ListModelsResponse
listProjectsLocationsCatalogsModels(string $parent, array $optParams = [])

Lists all the models linked to this event store.

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

Update of model metadata. Only fields that currently can be updated are: filtering_option and periodic_tuning_state. If other values are provided, this API method ignores them. (models.patch)

GoogleCloudRetailV2Model
pause(string $name, GoogleCloudRetailV2PauseModelRequest $postBody, array $optParams = [])

Pauses the training of an existing model. (models.pause)

GoogleCloudRetailV2Model
resume(string $name, GoogleCloudRetailV2ResumeModelRequest $postBody, array $optParams = [])

Resumes the training of an existing model. (models.resume)

GoogleLongrunningOperation
tune(string $name, GoogleCloudRetailV2TuneModelRequest $postBody, array $optParams = [])

Tunes an existing model. (models.tune)

Details

at line 52
GoogleLongrunningOperation create(string $parent, GoogleCloudRetailV2Model $postBody, array $optParams = [])

Creates a new model. (models.create)

Parameters

string $parent

Required. The parent resource under which to create the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
GoogleCloudRetailV2Model $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Deletes an existing model. (models.delete)

Parameters

string $name

Required. The resource name of the Model to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_ id}/models/{model_id}
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

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

Gets a model. (models.get)

Parameters

string $name

Required. The resource name of the Model to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog}/models/ {model_id}
array $optParams

Optional parameters.

Return Value

GoogleCloudRetailV2Model

Exceptions

Exception

at line 105
GoogleCloudRetailV2ListModelsResponse listProjectsLocationsCatalogsModels(string $parent, array $optParams = [])

Lists all the models linked to this event store.

(models.listProjectsLocationsCatalogsModels)

Parameters

string $parent

Required. The parent for which to list models. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
array $optParams

Optional parameters.

Return Value

GoogleCloudRetailV2ListModelsResponse

Exceptions

Exception

at line 128
GoogleCloudRetailV2Model patch(string $name, GoogleCloudRetailV2Model $postBody, array $optParams = [])

Update of model metadata. Only fields that currently can be updated are: filtering_option and periodic_tuning_state. If other values are provided, this API method ignores them. (models.patch)

Parameters

string $name

Required. The fully qualified resource name of the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_ id}/models/{model_id} catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
GoogleCloudRetailV2Model $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudRetailV2Model

Exceptions

Exception

at line 145
GoogleCloudRetailV2Model pause(string $name, GoogleCloudRetailV2PauseModelRequest $postBody, array $optParams = [])

Pauses the training of an existing model. (models.pause)

Parameters

string $name

Required. The name of the model to pause. Format: projec ts/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{mod el_id}
GoogleCloudRetailV2PauseModelRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudRetailV2Model

Exceptions

Exception

at line 162
GoogleCloudRetailV2Model resume(string $name, GoogleCloudRetailV2ResumeModelRequest $postBody, array $optParams = [])

Resumes the training of an existing model. (models.resume)

Parameters

string $name

Required. The name of the model to resume. Format: proje cts/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{mo del_id}
GoogleCloudRetailV2ResumeModelRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudRetailV2Model

Exceptions

Exception

at line 179
GoogleLongrunningOperation tune(string $name, GoogleCloudRetailV2TuneModelRequest $postBody, array $optParams = [])

Tunes an existing model. (models.tune)

Parameters

string $name

Required. The resource name of the model to tune. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/mode ls/{model_id}
GoogleCloudRetailV2TuneModelRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception