Class ProjectsResource.LocationsResource.CatalogsResource

The "catalogs" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.CatalogsResource

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

Constructors

CatalogsResource(IClientService)

Constructs a new resource.

Declaration

public CatalogsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

AttributesConfig

Gets the AttributesConfig resource.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.AttributesConfigResource AttributesConfig { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.AttributesConfigResource

Branches

Gets the Branches resource.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.BranchesResource Branches { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource

CompletionData

Gets the CompletionData resource.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.CompletionDataResource CompletionData { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.CompletionDataResource

Controls

Gets the Controls resource.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ControlsResource Controls { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ControlsResource

GenerativeQuestion

Gets the GenerativeQuestion resource.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.GenerativeQuestionResource GenerativeQuestion { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.GenerativeQuestionResource

GenerativeQuestions

Gets the GenerativeQuestions resource.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.GenerativeQuestionsResource GenerativeQuestions { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.GenerativeQuestionsResource

Models

Gets the Models resource.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ModelsResource Models { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource

Operations

Gets the Operations resource.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.OperationsResource Operations { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.OperationsResource

Placements

Gets the Placements resource.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.PlacementsResource Placements { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.PlacementsResource

ServingConfigs

Gets the ServingConfigs resource.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource ServingConfigs { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource

UserEvents

Gets the UserEvents resource.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource UserEvents { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource

Methods

CompleteQuery(string)

Completes the specified prefix with keyword suggestions. 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.CompleteQueryRequest CompleteQuery(string catalog)

Parameters

Type	Name	Description
string	catalog	Required. Catalog for which the completion is performed. Full resource name of catalog, such as projects/*/locations/global/catalogs/default_catalog.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.CompleteQueryRequest

ExportAnalyticsMetrics(GoogleCloudRetailV2ExportAnalyticsMetricsRequest, string)

Exports analytics metrics. Operation.response is of type ExportAnalyticsMetricsResponse. Operation.metadata is of type ExportMetadata.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.ExportAnalyticsMetricsRequest ExportAnalyticsMetrics(GoogleCloudRetailV2ExportAnalyticsMetricsRequest body, string catalog)

Parameters

Type	Name	Description
GoogleCloudRetailV2ExportAnalyticsMetricsRequest	body	The body of the request.
string	catalog	Required. Full resource name of the parent catalog. Expected format: projects/*/locations/*/catalogs/*

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ExportAnalyticsMetricsRequest

GetAttributesConfig(string)

Gets an AttributesConfig.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.GetAttributesConfigRequest GetAttributesConfig(string name)

Parameters

Type	Name	Description
string	name	Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.GetAttributesConfigRequest

GetCompletionConfig(string)

Gets a CompletionConfig.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.GetCompletionConfigRequest GetCompletionConfig(string name)

Parameters

Type	Name	Description
string	name	Required. Full CompletionConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.GetCompletionConfigRequest

GetDefaultBranch(string)

Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.GetDefaultBranchRequest GetDefaultBranch(string catalog)

Parameters

Type	Name	Description
string	catalog	The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.GetDefaultBranchRequest

GetGenerativeQuestionFeature(string)

Manages overal generative question feature state -- enables toggling feature on and off.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.GetGenerativeQuestionFeatureRequest GetGenerativeQuestionFeature(string catalog)

Parameters

Type	Name	Description
string	catalog	Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.GetGenerativeQuestionFeatureRequest

List(string)

Lists all the Catalogs associated with the project.

Declaration

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

Parameters

Type	Name	Description
string	parent	Required. The account resource name with an associated location. If the caller does not have permission to list Catalogs under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.ListRequest

Patch(GoogleCloudRetailV2Catalog, string)

Updates the Catalogs.

Declaration

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

Parameters

Type	Name	Description
GoogleCloudRetailV2Catalog	body	The body of the request.
string	name	Required. Immutable. The fully qualified resource name of the catalog.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.PatchRequest

SetDefaultBranch(GoogleCloudRetailV2SetDefaultBranchRequest, string)

Set a specified branch id as default branch. API methods such as SearchService.Search, ProductService.GetProduct, ProductService.ListProducts will treat requests using "default_branch" to the actual branch id set as default. For example, if projects/*/locations/*/catalogs/*/branches/1 is set as default, setting SearchRequest.branch to projects/*/locations/*/catalogs/*/branches/default_branch is equivalent to setting SearchRequest.branch to projects/*/locations/*/catalogs/*/branches/1. Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using projects/*/locations/*/catalogs/*/branches/default_branch as SearchRequest.branch to route the traffic to this staging branch. CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one. More specifically: * PredictionService will only return product IDs from branch {newBranch}. * SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set). * UserEventService will only join events with products from branch {newBranch}.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.SetDefaultBranchRequest SetDefaultBranch(GoogleCloudRetailV2SetDefaultBranchRequest body, string catalog)

Parameters

Type	Name	Description
GoogleCloudRetailV2SetDefaultBranchRequest	body	The body of the request.
string	catalog	Full resource name of the catalog, such as projects/*/locations/global/catalogs/default_catalog.

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.SetDefaultBranchRequest

UpdateAttributesConfig(GoogleCloudRetailV2AttributesConfig, string)

Updates the AttributesConfig. The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.UpdateAttributesConfigRequest UpdateAttributesConfig(GoogleCloudRetailV2AttributesConfig body, string name)

Parameters

Type	Name	Description
GoogleCloudRetailV2AttributesConfig	body	The body of the request.
string	name	Required. Immutable. The fully qualified resource name of the attribute config. Format: projects/*/locations/*/catalogs/*/attributesConfig

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.UpdateAttributesConfigRequest

UpdateCompletionConfig(GoogleCloudRetailV2CompletionConfig, string)

Updates the CompletionConfigs.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.UpdateCompletionConfigRequest UpdateCompletionConfig(GoogleCloudRetailV2CompletionConfig body, string name)

Parameters

Type	Name	Description
GoogleCloudRetailV2CompletionConfig	body	The body of the request.
string	name	Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.UpdateCompletionConfigRequest

UpdateGenerativeQuestion(GoogleCloudRetailV2GenerativeQuestionConfig, string)

Allows management of individual questions.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.UpdateGenerativeQuestionRequest UpdateGenerativeQuestion(GoogleCloudRetailV2GenerativeQuestionConfig body, string catalog)

Parameters

Type	Name	Description
GoogleCloudRetailV2GenerativeQuestionConfig	body	The body of the request.
string	catalog	Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.UpdateGenerativeQuestionRequest

UpdateGenerativeQuestionFeature(GoogleCloudRetailV2GenerativeQuestionsFeatureConfig, string)

Manages overal generative question feature state -- enables toggling feature on and off.

Declaration

public virtual ProjectsResource.LocationsResource.CatalogsResource.UpdateGenerativeQuestionFeatureRequest UpdateGenerativeQuestionFeature(GoogleCloudRetailV2GenerativeQuestionsFeatureConfig body, string catalog)

Parameters

Type	Name	Description
GoogleCloudRetailV2GenerativeQuestionsFeatureConfig	body	The body of the request.
string	catalog	Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}

Returns

Type	Description
ProjectsResource.LocationsResource.CatalogsResource.UpdateGenerativeQuestionFeatureRequest