Class ProjectsResource.LocationsResource.CatalogsResource.ModelsResource

The "models" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.CatalogsResource.ModelsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudRetail.v2

Assembly: Google.Apis.CloudRetail.v2.dll

Syntax

public class ProjectsResource.LocationsResource.CatalogsResource.ModelsResource

Constructors

ModelsResource(IClientService)

Constructs a new resource.

Declaration

public ModelsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(GoogleCloudRetailV2Model, string)

Creates a new model.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.CreateRequest Create(GoogleCloudRetailV2Model body, string parent)

Parameters

Type	Name	Description
GoogleCloudRetailV2Model	body	The body of the request.
string	parent	Required. The parent resource under which to create the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.CreateRequest

Delete(string)

Deletes an existing model.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the Model to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.DeleteRequest

Get(string)

Gets a model.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the Model to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog}/models/{model_id}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.GetRequest

List(string)

Lists all the models linked to this event store.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The parent for which to list models. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.ListRequest

Patch(GoogleCloudRetailV2Model, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.PatchRequest Patch(GoogleCloudRetailV2Model body, string name)

Parameters

Type	Name	Description
GoogleCloudRetailV2Model	body	The body of the request.
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.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.PatchRequest

Pause(GoogleCloudRetailV2PauseModelRequest, string)

Pauses the training of an existing model.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.PauseRequest Pause(GoogleCloudRetailV2PauseModelRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudRetailV2PauseModelRequest	body	The body of the request.
string	name	Required. The name of the model to pause. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.PauseRequest

Resume(GoogleCloudRetailV2ResumeModelRequest, string)

Resumes the training of an existing model.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.ResumeRequest Resume(GoogleCloudRetailV2ResumeModelRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudRetailV2ResumeModelRequest	body	The body of the request.
string	name	Required. The name of the model to resume. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.ResumeRequest

Tune(GoogleCloudRetailV2TuneModelRequest, string)

Tunes an existing model.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.TuneRequest Tune(GoogleCloudRetailV2TuneModelRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudRetailV2TuneModelRequest	body	The body of the request.
string	name	Required. The resource name of the model to tune. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.TuneRequest