Class ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource

The "servingConfigs" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource

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.ServingConfigsResource

Constructors

ServingConfigsResource(IClientService)

Constructs a new resource.

Declaration

public ServingConfigsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

AddControl(GoogleCloudRetailV2AddControlRequest, string)

Enables a Control on the specified ServingConfig. The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.AddControlRequest AddControl(GoogleCloudRetailV2AddControlRequest body, string servingConfig)

Parameters

Type	Name	Description
GoogleCloudRetailV2AddControlRequest	body	The body of the request.
string	servingConfig	Required. The source ServingConfig resource name . Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.AddControlRequest

Create(GoogleCloudRetailV2ServingConfig, string)

Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.CreateRequest Create(GoogleCloudRetailV2ServingConfig body, string parent)

Parameters

Type	Name	Description
GoogleCloudRetailV2ServingConfig	body	The body of the request.
string	parent	Required. Full resource name of parent. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.CreateRequest

Delete(string)

Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

Declaration

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

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.DeleteRequest

Get(string)

Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

Declaration

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

Parameters

Type	Name	Description
string	name	Required. The resource name of the ServingConfig to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.GetRequest

List(string)

Lists all ServingConfigs linked to this catalog.

Declaration

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

Parameters

Type	Name	Description
string	parent	Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.ListRequest

Patch(GoogleCloudRetailV2ServingConfig, string)

Updates a ServingConfig.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.PatchRequest Patch(GoogleCloudRetailV2ServingConfig body, string name)

Parameters

Type	Name	Description
GoogleCloudRetailV2ServingConfig	body	The body of the request.
string	name	Immutable. Fully qualified name projects/*/locations/global/catalogs/*/servingConfig/*

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.PatchRequest

Predict(GoogleCloudRetailV2PredictRequest, string)

Makes a recommendation prediction.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.PredictRequest Predict(GoogleCloudRetailV2PredictRequest body, string placement)

Parameters

Type	Name	Description
GoogleCloudRetailV2PredictRequest	body	The body of the request.
string	placement	Required. Full resource name of the format: {placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*} or {placement=projects/*/locations/global/catalogs/default_catalog/placements/*}. We recommend using the servingConfigs resource. placements is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Manage serving configs] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.PredictRequest

RemoveControl(GoogleCloudRetailV2RemoveControlRequest, string)

Disables a Control on the specified ServingConfig. The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.RemoveControlRequest RemoveControl(GoogleCloudRetailV2RemoveControlRequest body, string servingConfig)

Parameters

Type	Name	Description
GoogleCloudRetailV2RemoveControlRequest	body	The body of the request.
string	servingConfig	Required. The source ServingConfig resource name . Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.RemoveControlRequest

Search(GoogleCloudRetailV2SearchRequest, string)

Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.SearchRequest Search(GoogleCloudRetailV2SearchRequest body, string placement)

Parameters

Type	Name	Description
GoogleCloudRetailV2SearchRequest	body	The body of the request.
string	placement	Required. The resource name of the Retail Search serving config, such as projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config or the name of the legacy placement resource, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search. This field is used to identify the serving config name and the set of models that are used to make the search.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.SearchRequest